94 строки
6.7 KiB
YAML
94 строки
6.7 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.management.cosmosdb.FailoverPolicy"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.FailoverPolicy"
|
|
name: "FailoverPolicy"
|
|
nameWithType: "FailoverPolicy"
|
|
summary: "The failover policy for a given region of a database account."
|
|
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 **FailoverPolicy**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.management.cosmosdb.FailoverPolicy.FailoverPolicy()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.FailoverPolicy.FailoverPolicy()"
|
|
name: "FailoverPolicy()"
|
|
nameWithType: "FailoverPolicy.FailoverPolicy()"
|
|
syntax: "public FailoverPolicy()"
|
|
methods:
|
|
- uid: "com.microsoft.azure.management.cosmosdb.FailoverPolicy.failoverPriority()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.FailoverPolicy.failoverPriority()"
|
|
name: "failoverPriority()"
|
|
nameWithType: "FailoverPolicy.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.FailoverPolicy.id()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.FailoverPolicy.id()"
|
|
name: "id()"
|
|
nameWithType: "FailoverPolicy.id()"
|
|
summary: "Get the unique identifier of the region in which the database account replicates to."
|
|
syntax: "public String id()"
|
|
desc: "Get the unique identifier of the region in which the database account replicates to. 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.FailoverPolicy.locationName()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.FailoverPolicy.locationName()"
|
|
name: "locationName()"
|
|
nameWithType: "FailoverPolicy.locationName()"
|
|
summary: "Get the name of the region in which the database account exists."
|
|
syntax: "public String locationName()"
|
|
desc: "Get the name of the region in which the database account exists."
|
|
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.FailoverPolicy.withFailoverPriority(java.lang.Integer)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.FailoverPolicy.withFailoverPriority(Integer failoverPriority)"
|
|
name: "withFailoverPriority(Integer failoverPriority)"
|
|
nameWithType: "FailoverPolicy.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 FailoverPolicy 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 FailoverPolicy object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.FailoverPolicy?alt=com.microsoft.azure.management.cosmosdb.FailoverPolicy&text=FailoverPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.FailoverPolicy.withLocationName(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.FailoverPolicy.withLocationName(String locationName)"
|
|
name: "withLocationName(String locationName)"
|
|
nameWithType: "FailoverPolicy.withLocationName(String locationName)"
|
|
summary: "Set the name of the region in which the database account exists."
|
|
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 FailoverPolicy withLocationName(String locationName)"
|
|
desc: "Set the name of the region in which the database account exists."
|
|
returns:
|
|
description: "the FailoverPolicy object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.FailoverPolicy?alt=com.microsoft.azure.management.cosmosdb.FailoverPolicy&text=FailoverPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "The failover policy for a given region of a database account."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.management.cosmosdb"
|
|
artifact: com.microsoft.azure:azure-mgmt-cosmosdb:1.41.4
|