LongTermRetentionBackupInner Class

public final class LongTermRetentionBackupInner
extends ProxyResource

A long term retention backup.

Constructor Summary

Constructor Description
LongTermRetentionBackupInner()

Creates an instance of LongTermRetentionBackupInner class.

Method Summary

Modifier and Type Method and Description
OffsetDateTime backupExpirationTime()

Get the backupExpirationTime property: The time the long term retention backup will expire.

BackupStorageAccessTier backupStorageAccessTier()

Get the backupStorageAccessTier property: The BackupStorageAccessTier for the LTR backup.

BackupStorageRedundancy backupStorageRedundancy()

Get the backupStorageRedundancy property: The storage redundancy type of the backup.

OffsetDateTime backupTime()

Get the backupTime property: The time the backup was taken.

OffsetDateTime databaseDeletionTime()

Get the databaseDeletionTime property: The delete time of the database.

String databaseName()

Get the databaseName property: The name of the database the backup belong to.

static LongTermRetentionBackupInner fromJson(JsonReader jsonReader)

Reads an instance of LongTermRetentionBackupInner from the JsonReader.

String id()

Get the id property: Fully qualified resource Id for the resource.

Boolean isBackupImmutable()

Get the isBackupImmutable property: The setting whether the LTR backup is immutable.

SetLegalHoldImmutability legalHoldImmutability()

Get the legalHoldImmutability property: The setting for whether LegalHold is enabled or disabled on the LTR backup.

String name()

Get the name property: The name of the resource.

BackupStorageRedundancy requestedBackupStorageRedundancy()

Get the requestedBackupStorageRedundancy property: The storage redundancy type of the backup.

OffsetDateTime serverCreateTime()

Get the serverCreateTime property: The create time of the server.

String serverName()

Get the serverName property: The server name that the backup database belong to.

TimeBasedImmutability timeBasedImmutability()

Get the timeBasedImmutability property: The setting for whether or not time-based immutability is enabled for the LTR backup.

TimeBasedImmutabilityMode timeBasedImmutabilityMode()

Get the timeBasedImmutabilityMode property: The time-based immutability mode.

JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The type of the resource.

void validate()

Validates the instance.

LongTermRetentionBackupInner withIsBackupImmutable(Boolean isBackupImmutable)

Set the isBackupImmutable property: The setting whether the LTR backup is immutable.

LongTermRetentionBackupInner withLegalHoldImmutability(SetLegalHoldImmutability legalHoldImmutability)

Set the legalHoldImmutability property: The setting for whether LegalHold is enabled or disabled on the LTR backup.

LongTermRetentionBackupInner withRequestedBackupStorageRedundancy(BackupStorageRedundancy requestedBackupStorageRedundancy)

Set the requestedBackupStorageRedundancy property: The storage redundancy type of the backup.

LongTermRetentionBackupInner withTimeBasedImmutability(TimeBasedImmutability timeBasedImmutability)

Set the timeBasedImmutability property: The setting for whether or not time-based immutability is enabled for the LTR backup.

LongTermRetentionBackupInner withTimeBasedImmutabilityMode(TimeBasedImmutabilityMode timeBasedImmutabilityMode)

Set the timeBasedImmutabilityMode property: The time-based immutability mode.

Methods inherited from ProxyResource

Methods inherited from java.lang.Object

Constructor Details

LongTermRetentionBackupInner

public LongTermRetentionBackupInner()

Creates an instance of LongTermRetentionBackupInner class.

Method Details

backupExpirationTime

public OffsetDateTime backupExpirationTime()

Get the backupExpirationTime property: The time the long term retention backup will expire.

Returns:

the backupExpirationTime value.

backupStorageAccessTier

public BackupStorageAccessTier backupStorageAccessTier()

Get the backupStorageAccessTier property: The BackupStorageAccessTier for the LTR backup.

Returns:

the backupStorageAccessTier value.

backupStorageRedundancy

public BackupStorageRedundancy backupStorageRedundancy()

Get the backupStorageRedundancy property: The storage redundancy type of the backup.

Returns:

the backupStorageRedundancy value.

backupTime

public OffsetDateTime backupTime()

Get the backupTime property: The time the backup was taken.

Returns:

the backupTime value.

databaseDeletionTime

public OffsetDateTime databaseDeletionTime()

Get the databaseDeletionTime property: The delete time of the database.

Returns:

the databaseDeletionTime value.

databaseName

public String databaseName()

Get the databaseName property: The name of the database the backup belong to.

Returns:

the databaseName value.

fromJson

public static LongTermRetentionBackupInner fromJson(JsonReader jsonReader)

Reads an instance of LongTermRetentionBackupInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of LongTermRetentionBackupInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

LongTermRetentionBackupInner.id()

Returns:

the id value.

isBackupImmutable

public Boolean isBackupImmutable()

Get the isBackupImmutable property: The setting whether the LTR backup is immutable.

Returns:

the isBackupImmutable value.

legalHoldImmutability

public SetLegalHoldImmutability legalHoldImmutability()

Get the legalHoldImmutability property: The setting for whether LegalHold is enabled or disabled on the LTR backup. When LegalHold is enabled, the backup cannot be deleted until the LegalHold is removed.

Returns:

the legalHoldImmutability value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

LongTermRetentionBackupInner.name()

Returns:

the name value.

requestedBackupStorageRedundancy

public BackupStorageRedundancy requestedBackupStorageRedundancy()

Get the requestedBackupStorageRedundancy property: The storage redundancy type of the backup.

Returns:

the requestedBackupStorageRedundancy value.

serverCreateTime

public OffsetDateTime serverCreateTime()

Get the serverCreateTime property: The create time of the server.

Returns:

the serverCreateTime value.

serverName

public String serverName()

Get the serverName property: The server name that the backup database belong to.

Returns:

the serverName value.

timeBasedImmutability

public TimeBasedImmutability timeBasedImmutability()

Get the timeBasedImmutability property: The setting for whether or not time-based immutability is enabled for the LTR backup. When time-based immutability is enabled and locked, the backup cannot be deleted until BackupExpirationTime.

Returns:

the timeBasedImmutability value.

timeBasedImmutabilityMode

public TimeBasedImmutabilityMode timeBasedImmutabilityMode()

Get the timeBasedImmutabilityMode property: The time-based immutability mode. Only applicable if time-based immutability is enabled.

Returns:

the timeBasedImmutabilityMode value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

LongTermRetentionBackupInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource.

Overrides:

LongTermRetentionBackupInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

withIsBackupImmutable

public LongTermRetentionBackupInner withIsBackupImmutable(Boolean isBackupImmutable)

Set the isBackupImmutable property: The setting whether the LTR backup is immutable.

Parameters:

isBackupImmutable - the isBackupImmutable value to set.

Returns:

the LongTermRetentionBackupInner object itself.

withLegalHoldImmutability

public LongTermRetentionBackupInner withLegalHoldImmutability(SetLegalHoldImmutability legalHoldImmutability)

Set the legalHoldImmutability property: The setting for whether LegalHold is enabled or disabled on the LTR backup. When LegalHold is enabled, the backup cannot be deleted until the LegalHold is removed.

Parameters:

legalHoldImmutability - the legalHoldImmutability value to set.

Returns:

the LongTermRetentionBackupInner object itself.

withRequestedBackupStorageRedundancy

public LongTermRetentionBackupInner withRequestedBackupStorageRedundancy(BackupStorageRedundancy requestedBackupStorageRedundancy)

Set the requestedBackupStorageRedundancy property: The storage redundancy type of the backup.

Parameters:

requestedBackupStorageRedundancy - the requestedBackupStorageRedundancy value to set.

Returns:

the LongTermRetentionBackupInner object itself.

withTimeBasedImmutability

public LongTermRetentionBackupInner withTimeBasedImmutability(TimeBasedImmutability timeBasedImmutability)

Set the timeBasedImmutability property: The setting for whether or not time-based immutability is enabled for the LTR backup. When time-based immutability is enabled and locked, the backup cannot be deleted until BackupExpirationTime.

Parameters:

timeBasedImmutability - the timeBasedImmutability value to set.

Returns:

the LongTermRetentionBackupInner object itself.

withTimeBasedImmutabilityMode

public LongTermRetentionBackupInner withTimeBasedImmutabilityMode(TimeBasedImmutabilityMode timeBasedImmutabilityMode)

Set the timeBasedImmutabilityMode property: The time-based immutability mode. Only applicable if time-based immutability is enabled.

Parameters:

timeBasedImmutabilityMode - the timeBasedImmutabilityMode value to set.

Returns:

the LongTermRetentionBackupInner object itself.

Applies to