LongTermRetentionPolicyInner Class

Package:

com.azure.resourcemanager.sql.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-sql:2.54.0

• java.lang.Object
• • com.azure.core.management.ProxyResource
  • • com.azure.resourcemanager.sql.fluent.models.LongTermRetentionPolicyInner

public final class LongTermRetentionPolicyInner
extends ProxyResource

A long term retention policy.

Constructor Summary

Constructor	Description
LongTermRetentionPolicyInner()	Creates an instance of LongTermRetentionPolicyInner class.

Method Summary

Modifier and Type	Method and Description
static LongTermRetentionPolicyInner	fromJson(JsonReader jsonReader) Reads an instance of LongTermRetentionPolicyInner from the JsonReader.
String	id() Get the id property: Fully qualified resource Id for the resource.
String	monthlyRetention() Get the monthlyRetention property: The monthly retention policy for an LTR backup in an ISO 8601 format.
String	name() Get the name property: The name of the resource.
SystemData	systemData() Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
TimeBasedImmutability	timeBasedImmutability() Get the timeBasedImmutability property: The setting for whether to enable time-based immutability for future backups.
TimeBasedImmutabilityMode	timeBasedImmutabilityMode() Get the timeBasedImmutabilityMode property: The setting for time-based immutability mode for future backup (Value can be either Locked or UnLocked.
JsonWriter	toJson(JsonWriter jsonWriter)
String	type() Get the type property: The type of the resource.
void	validate() Validates the instance.
String	weeklyRetention() Get the weeklyRetention property: The weekly retention policy for an LTR backup in an ISO 8601 format.
Integer	weekOfYear() Get the weekOfYear property: The week of year to take the yearly backup in an ISO 8601 format.
LongTermRetentionPolicyInner	withMonthlyRetention(String monthlyRetention) Set the monthlyRetention property: The monthly retention policy for an LTR backup in an ISO 8601 format.
LongTermRetentionPolicyInner	withTimeBasedImmutability(TimeBasedImmutability timeBasedImmutability) Set the timeBasedImmutability property: The setting for whether to enable time-based immutability for future backups.
LongTermRetentionPolicyInner	withTimeBasedImmutabilityMode(TimeBasedImmutabilityMode timeBasedImmutabilityMode) Set the timeBasedImmutabilityMode property: The setting for time-based immutability mode for future backup (Value can be either Locked or UnLocked.
LongTermRetentionPolicyInner	withWeeklyRetention(String weeklyRetention) Set the weeklyRetention property: The weekly retention policy for an LTR backup in an ISO 8601 format.
LongTermRetentionPolicyInner	withWeekOfYear(Integer weekOfYear) Set the weekOfYear property: The week of year to take the yearly backup in an ISO 8601 format.
LongTermRetentionPolicyInner	withYearlyRetention(String yearlyRetention) Set the yearlyRetention property: The yearly retention policy for an LTR backup in an ISO 8601 format.
String	yearlyRetention() Get the yearlyRetention property: The yearly retention policy for an LTR backup in an ISO 8601 format.

Methods inherited from ProxyResource

fromJson id name toJson type

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

LongTermRetentionPolicyInner

public LongTermRetentionPolicyInner()

Creates an instance of LongTermRetentionPolicyInner class.

Method Details

fromJson

public static LongTermRetentionPolicyInner fromJson(JsonReader jsonReader)

Reads an instance of LongTermRetentionPolicyInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of LongTermRetentionPolicyInner 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:

LongTermRetentionPolicyInner.id()

Returns:

the id value.

monthlyRetention

public String monthlyRetention()

Get the monthlyRetention property: The monthly retention policy for an LTR backup in an ISO 8601 format.

Returns:

the monthlyRetention value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

LongTermRetentionPolicyInner.name()

Returns:

the name value.

systemData

public SystemData systemData()

Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.

Returns:

the systemData value.

timeBasedImmutability

public TimeBasedImmutability timeBasedImmutability()

Get the timeBasedImmutability property: The setting for whether to enable time-based immutability for future backups. When set, future backups will have TimeBasedImmutability enabled.

Returns:

the timeBasedImmutability value.

timeBasedImmutabilityMode

public TimeBasedImmutabilityMode timeBasedImmutabilityMode()

Get the timeBasedImmutabilityMode property: The setting for time-based immutability mode for future backup (Value can be either Locked or UnLocked. Only effective if TimeBasedImmutability is enabled). Caution: Immutability of LTR backup cannot be removed if TimeBasedImmutabilityMode is Locked.

Returns:

the timeBasedImmutabilityMode value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

LongTermRetentionPolicyInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public String type()

Get the type property: The type of the resource.

Overrides:

LongTermRetentionPolicyInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

weeklyRetention

public String weeklyRetention()

Get the weeklyRetention property: The weekly retention policy for an LTR backup in an ISO 8601 format.

Returns:

the weeklyRetention value.

weekOfYear

public Integer weekOfYear()

Get the weekOfYear property: The week of year to take the yearly backup in an ISO 8601 format.

Returns:

the weekOfYear value.

withMonthlyRetention

public LongTermRetentionPolicyInner withMonthlyRetention(String monthlyRetention)

Set the monthlyRetention property: The monthly retention policy for an LTR backup in an ISO 8601 format.

Parameters:

monthlyRetention - the monthlyRetention value to set.

Returns:

the LongTermRetentionPolicyInner object itself.

withTimeBasedImmutability

public LongTermRetentionPolicyInner withTimeBasedImmutability(TimeBasedImmutability timeBasedImmutability)

Set the timeBasedImmutability property: The setting for whether to enable time-based immutability for future backups. When set, future backups will have TimeBasedImmutability enabled.

Parameters:

timeBasedImmutability - the timeBasedImmutability value to set.

Returns:

the LongTermRetentionPolicyInner object itself.

withTimeBasedImmutabilityMode

public LongTermRetentionPolicyInner withTimeBasedImmutabilityMode(TimeBasedImmutabilityMode timeBasedImmutabilityMode)

Set the timeBasedImmutabilityMode property: The setting for time-based immutability mode for future backup (Value can be either Locked or UnLocked. Only effective if TimeBasedImmutability is enabled). Caution: Immutability of LTR backup cannot be removed if TimeBasedImmutabilityMode is Locked.

Parameters:

timeBasedImmutabilityMode - the timeBasedImmutabilityMode value to set.

Returns:

the LongTermRetentionPolicyInner object itself.

withWeeklyRetention

public LongTermRetentionPolicyInner withWeeklyRetention(String weeklyRetention)

Set the weeklyRetention property: The weekly retention policy for an LTR backup in an ISO 8601 format.

Parameters:

weeklyRetention - the weeklyRetention value to set.

Returns:

the LongTermRetentionPolicyInner object itself.

withWeekOfYear

public LongTermRetentionPolicyInner withWeekOfYear(Integer weekOfYear)

Set the weekOfYear property: The week of year to take the yearly backup in an ISO 8601 format.

Parameters:

weekOfYear - the weekOfYear value to set.

Returns:

the LongTermRetentionPolicyInner object itself.

withYearlyRetention

public LongTermRetentionPolicyInner withYearlyRetention(String yearlyRetention)

Set the yearlyRetention property: The yearly retention policy for an LTR backup in an ISO 8601 format.

Parameters:

yearlyRetention - the yearlyRetention value to set.

Returns:

the LongTermRetentionPolicyInner object itself.

yearlyRetention

public String yearlyRetention()

Get the yearlyRetention property: The yearly retention policy for an LTR backup in an ISO 8601 format.

Returns:

the yearlyRetention value.