150 строки
12 KiB
YAML
150 строки
12 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.cosmos.models.RestoreParametersBase"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.RestoreParametersBase"
|
|
name: "RestoreParametersBase"
|
|
nameWithType: "RestoreParametersBase"
|
|
summary: "Parameters to indicate the information about the restore."
|
|
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 **RestoreParametersBase**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.cosmos.models.RestoreParametersBase?alt=com.azure.resourcemanager.cosmos.models.RestoreParametersBase&text=RestoreParametersBase\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.resourcemanager.cosmos.models.RestoreParametersBase.RestoreParametersBase()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.RestoreParametersBase.RestoreParametersBase()"
|
|
name: "RestoreParametersBase()"
|
|
nameWithType: "RestoreParametersBase.RestoreParametersBase()"
|
|
summary: "Creates an instance of Restore<wbr>Parameters<wbr>Base class."
|
|
syntax: "public RestoreParametersBase()"
|
|
desc: "Creates an instance of RestoreParametersBase class."
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.cosmos.models.RestoreParametersBase.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.RestoreParametersBase.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "RestoreParametersBase.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of Restore<wbr>Parameters<wbr>Base 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 RestoreParametersBase fromJson(JsonReader jsonReader)"
|
|
exceptions:
|
|
- description: "If an error occurs while reading the RestoreParametersBase."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reads an instance of RestoreParametersBase from the JsonReader."
|
|
returns:
|
|
description: "An instance of RestoreParametersBase if the JsonReader was pointing to an instance of it, or null if it\n was pointing to JSON null."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.RestoreParametersBase?alt=com.azure.resourcemanager.cosmos.models.RestoreParametersBase&text=RestoreParametersBase\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.RestoreParametersBase.restoreSource()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.RestoreParametersBase.restoreSource()"
|
|
name: "restoreSource()"
|
|
nameWithType: "RestoreParametersBase.restoreSource()"
|
|
summary: "Get the restore<wbr>Source property: The id of the restorable database account from which the restore has to be initiated."
|
|
syntax: "public String restoreSource()"
|
|
desc: "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:
|
|
description: "the restoreSource value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.RestoreParametersBase.restoreTimestampInUtc()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.RestoreParametersBase.restoreTimestampInUtc()"
|
|
name: "restoreTimestampInUtc()"
|
|
nameWithType: "RestoreParametersBase.restoreTimestampInUtc()"
|
|
summary: "Get the restore<wbr>Timestamp<wbr>InUtc property: Time to which the account has to be restored (ISO-8601 format)."
|
|
syntax: "public OffsetDateTime restoreTimestampInUtc()"
|
|
desc: "Get the restoreTimestampInUtc property: Time to which the account has to be restored (ISO-8601 format)."
|
|
returns:
|
|
description: "the restoreTimestampInUtc value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.RestoreParametersBase.restoreWithTtlDisabled()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.RestoreParametersBase.restoreWithTtlDisabled()"
|
|
name: "restoreWithTtlDisabled()"
|
|
nameWithType: "RestoreParametersBase.restoreWithTtlDisabled()"
|
|
summary: "Get the restore<wbr>With<wbr>Ttl<wbr>Disabled property: Specifies whether the restored account will have Time-To-Live disabled upon the successful restore."
|
|
syntax: "public Boolean restoreWithTtlDisabled()"
|
|
desc: "Get the restoreWithTtlDisabled property: Specifies whether the restored account will have Time-To-Live disabled upon the successful restore."
|
|
returns:
|
|
description: "the restoreWithTtlDisabled value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.RestoreParametersBase.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.RestoreParametersBase.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "RestoreParametersBase.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.RestoreParametersBase.validate()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.RestoreParametersBase.validate()"
|
|
name: "validate()"
|
|
nameWithType: "RestoreParametersBase.validate()"
|
|
summary: "Validates the instance."
|
|
syntax: "public void validate()"
|
|
desc: "Validates the instance."
|
|
- uid: "com.azure.resourcemanager.cosmos.models.RestoreParametersBase.withRestoreSource(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.RestoreParametersBase.withRestoreSource(String restoreSource)"
|
|
name: "withRestoreSource(String restoreSource)"
|
|
nameWithType: "RestoreParametersBase.withRestoreSource(String restoreSource)"
|
|
summary: "Set the restore<wbr>Source property: The id of the restorable database account from which the restore has to be initiated."
|
|
parameters:
|
|
- description: "the restoreSource value to set."
|
|
name: "restoreSource"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public RestoreParametersBase withRestoreSource(String restoreSource)"
|
|
desc: "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\\}."
|
|
returns:
|
|
description: "the RestoreParametersBase object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.RestoreParametersBase?alt=com.azure.resourcemanager.cosmos.models.RestoreParametersBase&text=RestoreParametersBase\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.RestoreParametersBase.withRestoreTimestampInUtc(java.time.OffsetDateTime)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.RestoreParametersBase.withRestoreTimestampInUtc(OffsetDateTime restoreTimestampInUtc)"
|
|
name: "withRestoreTimestampInUtc(OffsetDateTime restoreTimestampInUtc)"
|
|
nameWithType: "RestoreParametersBase.withRestoreTimestampInUtc(OffsetDateTime restoreTimestampInUtc)"
|
|
summary: "Set the restore<wbr>Timestamp<wbr>InUtc property: Time to which the account has to be restored (ISO-8601 format)."
|
|
parameters:
|
|
- description: "the restoreTimestampInUtc value to set."
|
|
name: "restoreTimestampInUtc"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
syntax: "public RestoreParametersBase withRestoreTimestampInUtc(OffsetDateTime restoreTimestampInUtc)"
|
|
desc: "Set the restoreTimestampInUtc property: Time to which the account has to be restored (ISO-8601 format)."
|
|
returns:
|
|
description: "the RestoreParametersBase object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.RestoreParametersBase?alt=com.azure.resourcemanager.cosmos.models.RestoreParametersBase&text=RestoreParametersBase\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.RestoreParametersBase.withRestoreWithTtlDisabled(java.lang.Boolean)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.RestoreParametersBase.withRestoreWithTtlDisabled(Boolean restoreWithTtlDisabled)"
|
|
name: "withRestoreWithTtlDisabled(Boolean restoreWithTtlDisabled)"
|
|
nameWithType: "RestoreParametersBase.withRestoreWithTtlDisabled(Boolean restoreWithTtlDisabled)"
|
|
summary: "Set the restore<wbr>With<wbr>Ttl<wbr>Disabled property: Specifies whether the restored account will have Time-To-Live disabled upon the successful restore."
|
|
parameters:
|
|
- description: "the restoreWithTtlDisabled value to set."
|
|
name: "restoreWithTtlDisabled"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public RestoreParametersBase withRestoreWithTtlDisabled(Boolean restoreWithTtlDisabled)"
|
|
desc: "Set the restoreWithTtlDisabled property: Specifies whether the restored account will have Time-To-Live disabled upon the successful restore."
|
|
returns:
|
|
description: "the RestoreParametersBase object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.RestoreParametersBase?alt=com.azure.resourcemanager.cosmos.models.RestoreParametersBase&text=RestoreParametersBase\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Parameters to indicate the information about the restore."
|
|
implements:
|
|
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.cosmos.models.RestoreParametersBase?alt=com.azure.resourcemanager.cosmos.models.RestoreParametersBase&text=RestoreParametersBase\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.cosmos.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-cosmos:2.44.0
|