Class RestoreParametersBase

java.lang.Object
com.azure.resourcemanager.cosmos.models.RestoreParametersBase
All Implemented Interfaces:
com.azure.json.JsonSerializable<RestoreParametersBase>
Direct Known Subclasses:
ResourceRestoreParameters, RestoreParameters

public class RestoreParametersBase extends Object implements com.azure.json.JsonSerializable<RestoreParametersBase>
Parameters to indicate the information about the restore.
  • Constructor Details

    • RestoreParametersBase

      public RestoreParametersBase()
      Creates an instance of RestoreParametersBase class.
  • Method Details

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

      public OffsetDateTime restoreTimestampInUtc()
      Get the restoreTimestampInUtc property: Time to which the account has to be restored (ISO-8601 format).
      Returns:
      the restoreTimestampInUtc value.
    • 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.
    • 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.
    • 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.
    • validate

      public void validate()
      Validates the instance.
      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>
      Throws:
      IOException
    • fromJson

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