180 строки
13 KiB
YAML
180 строки
13 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.cosmos.models.Location"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.Location"
|
|
name: "Location"
|
|
nameWithType: "Location"
|
|
summary: "A region in which the Azure Cosmos DB database account is deployed."
|
|
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 final class **Location**</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.Location?alt=com.azure.resourcemanager.cosmos.models.Location&text=Location\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.resourcemanager.cosmos.models.Location.Location()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.Location.Location()"
|
|
name: "Location()"
|
|
nameWithType: "Location.Location()"
|
|
summary: "Creates an instance of Location class."
|
|
syntax: "public Location()"
|
|
desc: "Creates an instance of Location class."
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.cosmos.models.Location.documentEndpoint()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.Location.documentEndpoint()"
|
|
name: "documentEndpoint()"
|
|
nameWithType: "Location.documentEndpoint()"
|
|
summary: "Get the document<wbr>Endpoint property: The connection endpoint for the specific region."
|
|
syntax: "public String documentEndpoint()"
|
|
desc: "Get the documentEndpoint property: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/."
|
|
returns:
|
|
description: "the documentEndpoint value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.Location.failoverPriority()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.Location.failoverPriority()"
|
|
name: "failoverPriority()"
|
|
nameWithType: "Location.failoverPriority()"
|
|
summary: "Get the failover<wbr>Priority property: The failover priority of the region."
|
|
syntax: "public Integer failoverPriority()"
|
|
desc: "Get the failoverPriority property: The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists."
|
|
returns:
|
|
description: "the failoverPriority value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.Location.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.Location.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "Location.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of Location 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 Location fromJson(JsonReader jsonReader)"
|
|
exceptions:
|
|
- description: "If an error occurs while reading the Location."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reads an instance of Location from the JsonReader."
|
|
returns:
|
|
description: "An instance of Location if the JsonReader was pointing to an instance of it, or null if it was pointing\n to JSON null."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.Location?alt=com.azure.resourcemanager.cosmos.models.Location&text=Location\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.Location.id()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.Location.id()"
|
|
name: "id()"
|
|
nameWithType: "Location.id()"
|
|
summary: "Get the id property: The unique identifier of the region within the database account."
|
|
syntax: "public String id()"
|
|
desc: "Get the id property: The unique identifier of the region within the database account. Example: <accountName>-<locationName>."
|
|
returns:
|
|
description: "the id value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.Location.isZoneRedundant()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.Location.isZoneRedundant()"
|
|
name: "isZoneRedundant()"
|
|
nameWithType: "Location.isZoneRedundant()"
|
|
summary: "Get the is<wbr>Zone<wbr>Redundant property: Flag to indicate whether or not this region is an Availability<wbr>Zone region."
|
|
syntax: "public Boolean isZoneRedundant()"
|
|
desc: "Get the isZoneRedundant property: Flag to indicate whether or not this region is an AvailabilityZone region."
|
|
returns:
|
|
description: "the isZoneRedundant value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.Location.locationName()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.Location.locationName()"
|
|
name: "locationName()"
|
|
nameWithType: "Location.locationName()"
|
|
summary: "Get the location<wbr>Name property: The name of the region."
|
|
syntax: "public String locationName()"
|
|
desc: "Get the locationName property: The name of the region."
|
|
returns:
|
|
description: "the locationName value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.Location.provisioningState()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.Location.provisioningState()"
|
|
name: "provisioningState()"
|
|
nameWithType: "Location.provisioningState()"
|
|
summary: "Get the provisioning<wbr>State property: The status of the Cosmos DB account at the time the operation was called."
|
|
syntax: "public String provisioningState()"
|
|
desc: "Get the provisioningState property: The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' \\\\u2013 the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' \\\\u2013 the Cosmos DB account is active for use. 'Updating' \\\\u2013 the Cosmos DB account is being updated. 'Deleting' \\\\u2013 the Cosmos DB account is being deleted. 'Failed' \\\\u2013 the Cosmos DB account failed creation. 'DeletionFailed' \\\\u2013 the Cosmos DB account deletion failed."
|
|
returns:
|
|
description: "the provisioningState value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.Location.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.Location.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "Location.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.Location.validate()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.Location.validate()"
|
|
name: "validate()"
|
|
nameWithType: "Location.validate()"
|
|
summary: "Validates the instance."
|
|
syntax: "public void validate()"
|
|
desc: "Validates the instance."
|
|
- uid: "com.azure.resourcemanager.cosmos.models.Location.withFailoverPriority(java.lang.Integer)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.Location.withFailoverPriority(Integer failoverPriority)"
|
|
name: "withFailoverPriority(Integer failoverPriority)"
|
|
nameWithType: "Location.withFailoverPriority(Integer failoverPriority)"
|
|
summary: "Set the failover<wbr>Priority property: The failover priority of the region."
|
|
parameters:
|
|
- description: "the failoverPriority value to set."
|
|
name: "failoverPriority"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public Location withFailoverPriority(Integer failoverPriority)"
|
|
desc: "Set the failoverPriority property: The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists."
|
|
returns:
|
|
description: "the Location object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.Location?alt=com.azure.resourcemanager.cosmos.models.Location&text=Location\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.Location.withIsZoneRedundant(java.lang.Boolean)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.Location.withIsZoneRedundant(Boolean isZoneRedundant)"
|
|
name: "withIsZoneRedundant(Boolean isZoneRedundant)"
|
|
nameWithType: "Location.withIsZoneRedundant(Boolean isZoneRedundant)"
|
|
summary: "Set the is<wbr>Zone<wbr>Redundant property: Flag to indicate whether or not this region is an Availability<wbr>Zone region."
|
|
parameters:
|
|
- description: "the isZoneRedundant value to set."
|
|
name: "isZoneRedundant"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public Location withIsZoneRedundant(Boolean isZoneRedundant)"
|
|
desc: "Set the isZoneRedundant property: Flag to indicate whether or not this region is an AvailabilityZone region."
|
|
returns:
|
|
description: "the Location object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.Location?alt=com.azure.resourcemanager.cosmos.models.Location&text=Location\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.Location.withLocationName(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.Location.withLocationName(String locationName)"
|
|
name: "withLocationName(String locationName)"
|
|
nameWithType: "Location.withLocationName(String locationName)"
|
|
summary: "Set the location<wbr>Name property: The name of the region."
|
|
parameters:
|
|
- description: "the locationName value to set."
|
|
name: "locationName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public Location withLocationName(String locationName)"
|
|
desc: "Set the locationName property: The name of the region."
|
|
returns:
|
|
description: "the Location object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.Location?alt=com.azure.resourcemanager.cosmos.models.Location&text=Location\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "A region in which the Azure Cosmos DB database account is deployed."
|
|
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.Location?alt=com.azure.resourcemanager.cosmos.models.Location&text=Location\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.cosmos.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-cosmos:2.44.0
|