Share via

RestoreParameters Class

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

public final class RestoreParameters
extends RestoreParametersBase

Parameters to indicate the information about the restore.

Constructor Summary

Constructor Description
RestoreParameters()

Creates an instance of RestoreParameters class.

Method Summary

Modifier and Type Method and Description
List<DatabaseRestoreResource> databasesToRestore()

Get the databasesToRestore property: List of specific databases available for restore.
static RestoreParameters fromJson(JsonReader jsonReader)

Reads an instance of RestoreParameters from the JsonReader.
List<GremlinDatabaseRestoreResource> gremlinDatabasesToRestore()

Get the gremlinDatabasesToRestore property: List of specific gremlin databases available for restore.
RestoreMode restoreMode()

Get the restoreMode property: Describes the mode of the restore.
List<String> tablesToRestore()

Get the tablesToRestore property: List of specific tables available for restore.
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
RestoreParameters withDatabasesToRestore(List<DatabaseRestoreResource> databasesToRestore)

Set the databasesToRestore property: List of specific databases available for restore.
RestoreParameters withGremlinDatabasesToRestore(List<GremlinDatabaseRestoreResource> gremlinDatabasesToRestore)

Set the gremlinDatabasesToRestore property: List of specific gremlin databases available for restore.
RestoreParameters withRestoreMode(RestoreMode restoreMode)

Set the restoreMode property: Describes the mode of the restore.
RestoreParameters withRestoreSource(String restoreSource)

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

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

Set the restoreWithTtlDisabled property: Specifies whether the restored account will have Time-To-Live disabled upon the successful restore.
RestoreParameters withTablesToRestore(List<String> tablesToRestore)

Set the tablesToRestore property: List of specific tables available for 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

RestoreParameters

public RestoreParameters()

Creates an instance of RestoreParameters class.

Method Details

databasesToRestore

public List databasesToRestore()

Get the databasesToRestore property: List of specific databases available for restore.

Returns:

the databasesToRestore value.

fromJson

public static RestoreParameters fromJson(JsonReader jsonReader)

Reads an instance of RestoreParameters from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

gremlinDatabasesToRestore

public List gremlinDatabasesToRestore()

Get the gremlinDatabasesToRestore property: List of specific gremlin databases available for restore.

Returns:

the gremlinDatabasesToRestore value.

restoreMode

public RestoreMode restoreMode()

Get the restoreMode property: Describes the mode of the restore.

Returns:

the restoreMode value.

tablesToRestore

public List tablesToRestore()

Get the tablesToRestore property: List of specific tables available for restore.

Returns:

the tablesToRestore value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

RestoreParameters.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

Overrides:

RestoreParameters.validate()

withDatabasesToRestore

public RestoreParameters withDatabasesToRestore(List databasesToRestore)

Set the databasesToRestore property: List of specific databases available for restore.

Parameters:

databasesToRestore - the databasesToRestore value to set.

Returns:

the RestoreParameters object itself.

withGremlinDatabasesToRestore

public RestoreParameters withGremlinDatabasesToRestore(List gremlinDatabasesToRestore)

Set the gremlinDatabasesToRestore property: List of specific gremlin databases available for restore.

Parameters:

gremlinDatabasesToRestore - the gremlinDatabasesToRestore value to set.

Returns:

the RestoreParameters object itself.

withRestoreMode

public RestoreParameters withRestoreMode(RestoreMode restoreMode)

Set the restoreMode property: Describes the mode of the restore.

Parameters:

restoreMode - the restoreMode value to set.

Returns:

the RestoreParameters object itself.

withRestoreSource

public RestoreParameters 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:

RestoreParameters.withRestoreSource(String restoreSource)

Parameters:

restoreSource

withRestoreTimestampInUtc

public RestoreParameters withRestoreTimestampInUtc(OffsetDateTime restoreTimestampInUtc)

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

Overrides:

RestoreParameters.withRestoreTimestampInUtc(OffsetDateTime restoreTimestampInUtc)

Parameters:

restoreTimestampInUtc

withRestoreWithTtlDisabled

public RestoreParameters withRestoreWithTtlDisabled(Boolean restoreWithTtlDisabled)

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

Overrides:

RestoreParameters.withRestoreWithTtlDisabled(Boolean restoreWithTtlDisabled)

Parameters:

restoreWithTtlDisabled

withTablesToRestore

public RestoreParameters withTablesToRestore(List tablesToRestore)

Set the tablesToRestore property: List of specific tables available for restore.

Parameters:

tablesToRestore - the tablesToRestore value to set.

Returns:

the RestoreParameters object itself.

Applies to