Package com.microsoft.azure.management.cosmosdb

Class Location

java.lang.Object

com.microsoft.azure.management.cosmosdb.Location

public class Location
extends Object

A region in which the Azure Cosmos DB database account is deployed.

Constructor Summary

Constructors

Constructor	Description
Location()

Method Summary

Modifier and Type	Method	Description
String	documentEndpoint()	Get the connection endpoint for the specific region.
Integer	failoverPriority()	Get the failover priority of the region.
String	id()	Get the unique identifier of the region within the database account.
String	locationName()	Get the name of the region.
String	provisioningState()	Get the provisioningState value.
Location	withFailoverPriority(Integer failoverPriority)	Set the failover priority of the region.
Location	withLocationName(String locationName)	Set the name of the region.
Location	withProvisioningState(String provisioningState)	Set the provisioningState value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Location

public Location()

Method Detail

id

public String id()

Get the unique identifier of the region within the database account. Example: <accountName>-<locationName>.

Returns:

the id value

locationName

public String locationName()

Get the name of the region.

Returns:

the locationName value

withLocationName

public Location withLocationName(String locationName)

Set the name of the region.

Parameters:

locationName - the locationName value to set

Returns:

the Location object itself.

documentEndpoint

public String documentEndpoint()

Get the connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/.

Returns:

the documentEndpoint value

provisioningState

public String provisioningState()

Get the provisioningState value.

Returns:

the provisioningState value

withProvisioningState

public Location withProvisioningState(String provisioningState)

Set the provisioningState value.

Parameters:

provisioningState - the provisioningState value to set

Returns:

the Location object itself.

failoverPriority

public Integer failoverPriority()

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:

the failoverPriority value

withFailoverPriority

public Location withFailoverPriority(Integer failoverPriority)

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.

Parameters:

failoverPriority - the failoverPriority value to set

Returns:

the Location object itself.