152 строки
10 KiB
YAML
152 строки
10 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.management.cosmosdb.Location"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.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: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public class **Location**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.management.cosmosdb.Location.Location()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.Location.Location()"
|
|
name: "Location()"
|
|
nameWithType: "Location.Location()"
|
|
syntax: "public Location()"
|
|
methods:
|
|
- uid: "com.microsoft.azure.management.cosmosdb.Location.documentEndpoint()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.Location.documentEndpoint()"
|
|
name: "documentEndpoint()"
|
|
nameWithType: "Location.documentEndpoint()"
|
|
summary: "Get the connection endpoint for the specific region."
|
|
syntax: "public String documentEndpoint()"
|
|
desc: "Get the connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/."
|
|
returns:
|
|
description: "the documentEndpoint value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.Location.failoverPriority()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.Location.failoverPriority()"
|
|
name: "failoverPriority()"
|
|
nameWithType: "Location.failoverPriority()"
|
|
summary: "Get the failover priority of the region."
|
|
syntax: "public Integer failoverPriority()"
|
|
desc: "Get 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: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.Location.id()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.Location.id()"
|
|
name: "id()"
|
|
nameWithType: "Location.id()"
|
|
summary: "Get the unique identifier of the region within the database account."
|
|
syntax: "public String id()"
|
|
desc: "Get the unique identifier of the region within the database account. Example: <accountName>-<locationName>."
|
|
returns:
|
|
description: "the id value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.Location.isZoneRedundant()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.Location.isZoneRedundant()"
|
|
name: "isZoneRedundant()"
|
|
nameWithType: "Location.isZoneRedundant()"
|
|
summary: "Get flag to indicate whether or not this region is an Availability<wbr>Zone region."
|
|
syntax: "public Boolean isZoneRedundant()"
|
|
desc: "Get flag to indicate whether or not this region is an AvailabilityZone region."
|
|
returns:
|
|
description: "the isZoneRedundant value"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.Location.locationName()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.Location.locationName()"
|
|
name: "locationName()"
|
|
nameWithType: "Location.locationName()"
|
|
summary: "Get the name of the region."
|
|
syntax: "public String locationName()"
|
|
desc: "Get the name of the region."
|
|
returns:
|
|
description: "the locationName value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.Location.provisioningState()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.Location.provisioningState()"
|
|
name: "provisioningState()"
|
|
nameWithType: "Location.provisioningState()"
|
|
summary: "Get the provisioning<wbr>State value."
|
|
syntax: "public String provisioningState()"
|
|
desc: "Get the provisioningState value."
|
|
returns:
|
|
description: "the provisioningState value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.Location.withFailoverPriority(java.lang.Integer)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.Location.withFailoverPriority(Integer failoverPriority)"
|
|
name: "withFailoverPriority(Integer failoverPriority)"
|
|
nameWithType: "Location.withFailoverPriority(Integer failoverPriority)"
|
|
summary: "Set the failover priority of the region."
|
|
parameters:
|
|
- description: "the failoverPriority value to set"
|
|
name: "failoverPriority"
|
|
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Location withFailoverPriority(Integer failoverPriority)"
|
|
desc: "Set 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.microsoft.azure.management.cosmosdb.Location?alt=com.microsoft.azure.management.cosmosdb.Location&text=Location\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.Location.withIsZoneRedundant(java.lang.Boolean)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.Location.withIsZoneRedundant(Boolean isZoneRedundant)"
|
|
name: "withIsZoneRedundant(Boolean isZoneRedundant)"
|
|
nameWithType: "Location.withIsZoneRedundant(Boolean isZoneRedundant)"
|
|
summary: "Set flag to indicate whether or not this region is an Availability<wbr>Zone region."
|
|
parameters:
|
|
- description: "the isZoneRedundant value to set"
|
|
name: "isZoneRedundant"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Location withIsZoneRedundant(Boolean isZoneRedundant)"
|
|
desc: "Set flag to indicate whether or not this region is an AvailabilityZone region."
|
|
returns:
|
|
description: "the Location object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.Location?alt=com.microsoft.azure.management.cosmosdb.Location&text=Location\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.Location.withLocationName(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.Location.withLocationName(String locationName)"
|
|
name: "withLocationName(String locationName)"
|
|
nameWithType: "Location.withLocationName(String locationName)"
|
|
summary: "Set the name of the region."
|
|
parameters:
|
|
- description: "the locationName value to set"
|
|
name: "locationName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Location withLocationName(String locationName)"
|
|
desc: "Set the name of the region."
|
|
returns:
|
|
description: "the Location object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.Location?alt=com.microsoft.azure.management.cosmosdb.Location&text=Location\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.Location.withProvisioningState(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.Location.withProvisioningState(String provisioningState)"
|
|
name: "withProvisioningState(String provisioningState)"
|
|
nameWithType: "Location.withProvisioningState(String provisioningState)"
|
|
summary: "Set the provisioning<wbr>State value."
|
|
parameters:
|
|
- description: "the provisioningState value to set"
|
|
name: "provisioningState"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Location withProvisioningState(String provisioningState)"
|
|
desc: "Set the provisioningState value."
|
|
returns:
|
|
description: "the Location object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.Location?alt=com.microsoft.azure.management.cosmosdb.Location&text=Location\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "A region in which the Azure Cosmos DB database account is deployed."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.management.cosmosdb"
|
|
artifact: com.microsoft.azure:azure-mgmt-cosmosdb:1.41.4
|