Class RestoreParameters

java.lang.Object
com.azure.resourcemanager.cosmos.models.RestoreParametersBase
com.azure.resourcemanager.cosmos.models.RestoreParameters
All Implemented Interfaces:
com.azure.json.JsonSerializable<RestoreParametersBase>
public final class RestoreParameters extends RestoreParametersBase
Parameters to indicate the information about the restore.

  • Constructor Details

    • RestoreParameters

      public RestoreParameters()
      Creates an instance of RestoreParameters class.

  • Method Details

    • restoreMode

      public RestoreMode restoreMode()
      Get the restoreMode property: Describes the mode of the restore.
      Returns:
      the restoreMode value.

    • 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.

    • databasesToRestore

      public List<DatabaseRestoreResource> databasesToRestore()
      Get the databasesToRestore property: List of specific databases available for restore.
      Returns:
      the databasesToRestore value.

    • withDatabasesToRestore

      public RestoreParameters withDatabasesToRestore(List<DatabaseRestoreResource> databasesToRestore)
      Set the databasesToRestore property: List of specific databases available for restore.
      Parameters:
      databasesToRestore - the databasesToRestore value to set.
      Returns:
      the RestoreParameters object itself.

    • gremlinDatabasesToRestore

      public List<GremlinDatabaseRestoreResource> gremlinDatabasesToRestore()
      Get the gremlinDatabasesToRestore property: List of specific gremlin databases available for restore.
      Returns:
      the gremlinDatabasesToRestore value.

    • withGremlinDatabasesToRestore

      public RestoreParameters withGremlinDatabasesToRestore(List<GremlinDatabaseRestoreResource> 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.

    • tablesToRestore

      public List<String> tablesToRestore()
      Get the tablesToRestore property: List of specific tables available for restore.
      Returns:
      the tablesToRestore value.

    • withTablesToRestore

      public RestoreParameters withTablesToRestore(List<String> tablesToRestore)
      Set the tablesToRestore property: List of specific tables available for restore.
      Parameters:
      tablesToRestore - the tablesToRestore value to set.
      Returns:
      the RestoreParameters object itself.

    • sourceBackupLocation

      public String sourceBackupLocation()
      Get the sourceBackupLocation property: The source backup location for restore.
      Returns:
      the sourceBackupLocation value.

    • withSourceBackupLocation

      public RestoreParameters withSourceBackupLocation(String sourceBackupLocation)
      Set the sourceBackupLocation property: The source backup location for restore.
      Parameters:
      sourceBackupLocation - the sourceBackupLocation 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:
      withRestoreSource in class RestoreParametersBase
      Parameters:
      restoreSource - the restoreSource value to set.
      Returns:
      the RestoreParametersBase object itself.

    • withRestoreTimestampInUtc

      public RestoreParameters withRestoreTimestampInUtc(OffsetDateTime restoreTimestampInUtc)
      Set the restoreTimestampInUtc property: Time to which the account has to be restored (ISO-8601 format).
      Overrides:
      withRestoreTimestampInUtc in class RestoreParametersBase
      Parameters:
      restoreTimestampInUtc - the restoreTimestampInUtc value to set.
      Returns:
      the RestoreParametersBase object itself.

    • 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:
      withRestoreWithTtlDisabled in class RestoreParametersBase
      Parameters:
      restoreWithTtlDisabled - the restoreWithTtlDisabled value to set.
      Returns:
      the RestoreParametersBase object itself.

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class RestoreParametersBase
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<RestoreParametersBase>
      Overrides:
      toJson in class RestoreParametersBase
      Throws:
      IOException

    • fromJson

      public static RestoreParameters fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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.