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 Details

    • Location

      public Location()

  • Method Details

    • 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.

    • isZoneRedundant

      public Boolean isZoneRedundant()
      Get flag to indicate whether or not this region is an AvailabilityZone region.
      Returns:
      the isZoneRedundant value

    • withIsZoneRedundant

      public Location withIsZoneRedundant(Boolean isZoneRedundant)
      Set flag to indicate whether or not this region is an AvailabilityZone region.
      Parameters:
      isZoneRedundant - the isZoneRedundant value to set
      Returns:
      the Location object itself.