Share via

RestoreParametersBase Class

  • Reference
Package:
com.azure.resourcemanager.cosmos.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-cosmos:2.44.1
  • java.lang.Object
    • com.azure.resourcemanager.cosmos.models.RestoreParametersBase

Implements

JsonSerializable<RestoreParametersBase>

public class RestoreParametersBase
implements JsonSerializable<RestoreParametersBase>

Parameters to indicate the information about the restore.

Constructor Summary

Constructor Description
RestoreParametersBase()

Creates an instance of RestoreParametersBase class.

Method Summary

Modifier and Type Method and Description
static RestoreParametersBase fromJson(JsonReader jsonReader)

Reads an instance of RestoreParametersBase from the JsonReader.
String restoreSource()

Get the restoreSource property: The id of the restorable database account from which the restore has to be initiated.
OffsetDateTime restoreTimestampInUtc()

Get the restoreTimestampInUtc property: Time to which the account has to be restored (ISO-8601 format).
Boolean restoreWithTtlDisabled()

Get the restoreWithTtlDisabled property: Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
RestoreParametersBase withRestoreSource(String restoreSource)

Set the restoreSource property: The id of the restorable database account from which the restore has to be initiated.
RestoreParametersBase withRestoreTimestampInUtc(OffsetDateTime restoreTimestampInUtc)

Set the restoreTimestampInUtc property: Time to which the account has to be restored (ISO-8601 format).
RestoreParametersBase withRestoreWithTtlDisabled(Boolean restoreWithTtlDisabled)

Set the restoreWithTtlDisabled property: Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

RestoreParametersBase

public RestoreParametersBase()

Creates an instance of RestoreParametersBase class.

Method Details

fromJson

public static RestoreParametersBase fromJson(JsonReader jsonReader)

Reads an instance of RestoreParametersBase from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

 - If an error occurs while reading the RestoreParametersBase.

restoreSource

public String restoreSource()

Get the restoreSource property: The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}.

Returns:

the restoreSource value.

restoreTimestampInUtc

public OffsetDateTime restoreTimestampInUtc()

Get the restoreTimestampInUtc property: Time to which the account has to be restored (ISO-8601 format).

Returns:

the restoreTimestampInUtc value.

restoreWithTtlDisabled

public Boolean restoreWithTtlDisabled()

Get the restoreWithTtlDisabled property: Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.

Returns:

the restoreWithTtlDisabled value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withRestoreSource

public RestoreParametersBase withRestoreSource(String restoreSource)

Set the restoreSource property: The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}.

Parameters:

restoreSource - the restoreSource value to set.

Returns:

the RestoreParametersBase object itself.

withRestoreTimestampInUtc

public RestoreParametersBase withRestoreTimestampInUtc(OffsetDateTime restoreTimestampInUtc)

Set the restoreTimestampInUtc property: Time to which the account has to be restored (ISO-8601 format).

Parameters:

restoreTimestampInUtc - the restoreTimestampInUtc value to set.

Returns:

the RestoreParametersBase object itself.

withRestoreWithTtlDisabled

public RestoreParametersBase withRestoreWithTtlDisabled(Boolean restoreWithTtlDisabled)

Set the restoreWithTtlDisabled property: Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.

Parameters:

restoreWithTtlDisabled - the restoreWithTtlDisabled value to set.

Returns:

the RestoreParametersBase object itself.

Applies to