Share via

ResourceRestoreParameters Class

  • Reference
Package:
com.azure.resourcemanager.cosmos.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-cosmos:2.44.1

public final class ResourceRestoreParameters
extends RestoreParametersBase

Parameters to indicate the information about the restore.

Constructor Summary

Constructor Description
ResourceRestoreParameters()

Creates an instance of ResourceRestoreParameters class.

Method Summary

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

Reads an instance of ResourceRestoreParameters from the JsonReader.
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
ResourceRestoreParameters withRestoreSource(String restoreSource)

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

Set the restoreTimestampInUtc property: Time to which the account has to be restored (ISO-8601 format).
ResourceRestoreParameters 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 RestoreParametersBase

fromJson restoreSource restoreTimestampInUtc restoreWithTtlDisabled toJson validate withRestoreSource withRestoreTimestampInUtc withRestoreWithTtlDisabled

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ResourceRestoreParameters

public ResourceRestoreParameters()

Creates an instance of ResourceRestoreParameters class.

Method Details

fromJson

public static ResourceRestoreParameters fromJson(JsonReader jsonReader)

Reads an instance of ResourceRestoreParameters from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ResourceRestoreParameters 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 ResourceRestoreParameters.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ResourceRestoreParameters.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

Overrides:

ResourceRestoreParameters.validate()

withRestoreSource

public ResourceRestoreParameters 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}.

Overrides:

ResourceRestoreParameters.withRestoreSource(String restoreSource)

Parameters:

restoreSource

withRestoreTimestampInUtc

public ResourceRestoreParameters withRestoreTimestampInUtc(OffsetDateTime restoreTimestampInUtc)

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

Overrides:

ResourceRestoreParameters.withRestoreTimestampInUtc(OffsetDateTime restoreTimestampInUtc)

Parameters:

restoreTimestampInUtc

withRestoreWithTtlDisabled

public ResourceRestoreParameters withRestoreWithTtlDisabled(Boolean restoreWithTtlDisabled)

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

Overrides:

ResourceRestoreParameters.withRestoreWithTtlDisabled(Boolean restoreWithTtlDisabled)

Parameters:

restoreWithTtlDisabled

Applies to