Share via

FailoverPolicy Class

  • Reference
Package:
com.azure.resourcemanager.cosmos.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-cosmos:2.44.1
  • java.lang.Object
    • com.azure.resourcemanager.cosmos.models.FailoverPolicy

Implements

JsonSerializable<FailoverPolicy>

public final class FailoverPolicy
implements JsonSerializable<FailoverPolicy>

The failover policy for a given region of a database account.

Constructor Summary

Constructor Description
FailoverPolicy()

Creates an instance of FailoverPolicy class.

Method Summary

Modifier and Type Method and Description
Integer failoverPriority()

Get the failoverPriority property: The failover priority of the region.
static FailoverPolicy fromJson(JsonReader jsonReader)

Reads an instance of FailoverPolicy from the JsonReader.
String id()

Get the id property: The unique identifier of the region in which the database account replicates to.
String locationName()

Get the locationName property: The name of the region in which the database account exists.
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
FailoverPolicy withFailoverPriority(Integer failoverPriority)

Set the failoverPriority property: The failover priority of the region.
FailoverPolicy withLocationName(String locationName)

Set the locationName property: The name of the region in which the database account exists.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

FailoverPolicy

public FailoverPolicy()

Creates an instance of FailoverPolicy class.

Method Details

failoverPriority

public Integer failoverPriority()

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:

the failoverPriority value.

fromJson

public static FailoverPolicy fromJson(JsonReader jsonReader)

Reads an instance of FailoverPolicy from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of FailoverPolicy if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If an error occurs while reading the FailoverPolicy.

id

public String id()

Get the id property: The unique identifier of the region in which the database account replicates to. Example: -.

Returns:

the id value.

locationName

public String locationName()

Get the locationName property: The name of the region in which the database account exists.

Returns:

the locationName value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withFailoverPriority

public FailoverPolicy withFailoverPriority(Integer failoverPriority)

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.

Parameters:

failoverPriority - the failoverPriority value to set.

Returns:

the FailoverPolicy object itself.

withLocationName

public FailoverPolicy withLocationName(String locationName)

Set the locationName property: The name of the region in which the database account exists.

Parameters:

locationName - the locationName value to set.

Returns:

the FailoverPolicy object itself.

Applies to