azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.c...

112 строки
8.1 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.cosmos.models.BackupPolicy"
fullName: "com.azure.resourcemanager.cosmos.models.BackupPolicy"
name: "BackupPolicy"
nameWithType: "BackupPolicy"
summary: "The object representing the policy for taking backups on an account."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public class **BackupPolicy**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.cosmos.models.BackupPolicy?alt=com.azure.resourcemanager.cosmos.models.BackupPolicy&text=BackupPolicy\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.resourcemanager.cosmos.models.BackupPolicy.BackupPolicy()"
fullName: "com.azure.resourcemanager.cosmos.models.BackupPolicy.BackupPolicy()"
name: "BackupPolicy()"
nameWithType: "BackupPolicy.BackupPolicy()"
summary: "Creates an instance of Backup<wbr>Policy class."
syntax: "public BackupPolicy()"
desc: "Creates an instance of BackupPolicy class."
methods:
- uid: "com.azure.resourcemanager.cosmos.models.BackupPolicy.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.resourcemanager.cosmos.models.BackupPolicy.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "BackupPolicy.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of Backup<wbr>Policy from the Json<wbr>Reader."
modifiers:
- "static"
parameters:
- description: "The JsonReader being read."
name: "jsonReader"
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static BackupPolicy fromJson(JsonReader jsonReader)"
exceptions:
- description: "If an error occurs while reading the BackupPolicy."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Reads an instance of BackupPolicy from the JsonReader."
returns:
description: "An instance of BackupPolicy if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.BackupPolicy?alt=com.azure.resourcemanager.cosmos.models.BackupPolicy&text=BackupPolicy\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cosmos.models.BackupPolicy.migrationState()"
fullName: "com.azure.resourcemanager.cosmos.models.BackupPolicy.migrationState()"
name: "migrationState()"
nameWithType: "BackupPolicy.migrationState()"
summary: "Get the migration<wbr>State property: The object representing the state of the migration between the backup policies."
syntax: "public BackupPolicyMigrationState migrationState()"
desc: "Get the migrationState property: The object representing the state of the migration between the backup policies."
returns:
description: "the migrationState value."
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.BackupPolicyMigrationState?alt=com.azure.resourcemanager.cosmos.models.BackupPolicyMigrationState&text=BackupPolicyMigrationState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cosmos.models.BackupPolicy.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.resourcemanager.cosmos.models.BackupPolicy.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "BackupPolicy.toJson(JsonWriter jsonWriter)"
parameters:
- name: "jsonWriter"
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
exceptions:
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
returns:
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cosmos.models.BackupPolicy.type()"
fullName: "com.azure.resourcemanager.cosmos.models.BackupPolicy.type()"
name: "type()"
nameWithType: "BackupPolicy.type()"
summary: "Get the type property: Describes the mode of backups."
syntax: "public BackupPolicyType type()"
desc: "Get the type property: Describes the mode of backups."
returns:
description: "the type value."
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.BackupPolicyType?alt=com.azure.resourcemanager.cosmos.models.BackupPolicyType&text=BackupPolicyType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cosmos.models.BackupPolicy.validate()"
fullName: "com.azure.resourcemanager.cosmos.models.BackupPolicy.validate()"
name: "validate()"
nameWithType: "BackupPolicy.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.cosmos.models.BackupPolicy.withMigrationState(com.azure.resourcemanager.cosmos.models.BackupPolicyMigrationState)"
fullName: "com.azure.resourcemanager.cosmos.models.BackupPolicy.withMigrationState(BackupPolicyMigrationState migrationState)"
name: "withMigrationState(BackupPolicyMigrationState migrationState)"
nameWithType: "BackupPolicy.withMigrationState(BackupPolicyMigrationState migrationState)"
summary: "Set the migration<wbr>State property: The object representing the state of the migration between the backup policies."
parameters:
- description: "the migrationState value to set."
name: "migrationState"
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.BackupPolicyMigrationState?alt=com.azure.resourcemanager.cosmos.models.BackupPolicyMigrationState&text=BackupPolicyMigrationState\" data-throw-if-not-resolved=\"False\" />"
syntax: "public BackupPolicy withMigrationState(BackupPolicyMigrationState migrationState)"
desc: "Set the migrationState property: The object representing the state of the migration between the backup policies."
returns:
description: "the BackupPolicy object itself."
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.BackupPolicy?alt=com.azure.resourcemanager.cosmos.models.BackupPolicy&text=BackupPolicy\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "The object representing the policy for taking backups on an account."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.cosmos.models.BackupPolicy?alt=com.azure.resourcemanager.cosmos.models.BackupPolicy&text=BackupPolicy\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.resourcemanager.cosmos.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-cosmos:2.42.0