Class BackupPolicy

java.lang.Object
com.azure.resourcemanager.cosmos.models.BackupPolicy
All Implemented Interfaces:
com.azure.json.JsonSerializable<BackupPolicy>
Direct Known Subclasses:
ContinuousModeBackupPolicy, PeriodicModeBackupPolicy

public class BackupPolicy extends Object implements com.azure.json.JsonSerializable<BackupPolicy>
The object representing the policy for taking backups on an account.
  • Constructor Details

    • BackupPolicy

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

    • type

      public BackupPolicyType type()
      Get the type property: Describes the mode of backups.
      Returns:
      the type value.
    • migrationState

      public BackupPolicyMigrationState migrationState()
      Get the migrationState property: The object representing the state of the migration between the backup policies.
      Returns:
      the migrationState value.
    • withMigrationState

      public BackupPolicy withMigrationState(BackupPolicyMigrationState migrationState)
      Set the migrationState property: The object representing the state of the migration between the backup policies.
      Parameters:
      migrationState - the migrationState value to set.
      Returns:
      the BackupPolicy 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<BackupPolicy>
      Throws:
      IOException
    • fromJson

      public static BackupPolicy fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of BackupPolicy from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of BackupPolicy 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 BackupPolicy.