Cluster Interface
public interface Cluster
An immutable client-side representation of Cluster.
Method Summary
| Modifier and Type | Method and Description |
|---|---|
| abstract String |
administratorLogin()
Gets the administrator |
| abstract String |
administratorLoginPassword()
Gets the administrator |
| abstract String |
citusVersion()
Gets the citus |
| abstract Boolean |
coordinatorEnablePublicIpAccess()
Gets the coordinator |
| abstract String |
coordinatorServerEdition()
Gets the coordinator |
| abstract Integer |
coordinatorStorageQuotaInMb()
Gets the coordinator |
| abstract Integer |
coordinatorVCores()
Gets the coordinator |
|
abstract
Offset |
earliestRestoreTime()
Gets the earliest |
| abstract Boolean |
enableHa()
Gets the enable |
| abstract Boolean |
enableShardsOnCoordinator()
Gets the enable |
| abstract String |
id()
Gets the id property: Fully qualified resource Id for the resource. |
|
abstract
Cluster |
innerModel()
Gets the inner com. |
| abstract String |
location()
Gets the location property: The geo-location where the resource lives. |
|
abstract
Maintenance |
maintenanceWindow()
Gets the maintenance |
| abstract String |
name()
Gets the name property: The name of the resource. |
| abstract Integer |
nodeCount()
Gets the node |
| abstract Boolean |
nodeEnablePublicIpAccess()
Gets the node |
| abstract String |
nodeServerEdition()
Gets the node |
| abstract Integer |
nodeStorageQuotaInMb()
Gets the node |
| abstract Integer |
nodeVCores()
Gets the node |
|
abstract
Offset |
pointInTimeUtc()
Gets the point |
| abstract String |
postgresqlVersion()
Gets the postgresql |
| abstract String |
preferredPrimaryZone()
Gets the preferred |
|
abstract
List<Simple |
privateEndpointConnections()
Gets the private |
| abstract void |
promoteReadReplica()
Promotes read replica cluster to an independent read-write cluster. |
| abstract void |
promoteReadReplica(Context context)
Promotes read replica cluster to an independent read-write cluster. |
| abstract String |
provisioningState()
Gets the provisioning |
| abstract List<String> |
readReplicas()
Gets the read |
| abstract Cluster |
refresh()
Refreshes the resource to sync with Azure. |
| abstract Cluster |
refresh(Context context)
Refreshes the resource to sync with Azure. |
| abstract Region |
region()
Gets the region of the resource. |
| abstract String |
regionName()
Gets the name of the resource region. |
| abstract String |
resourceGroupName()
Gets the name of the resource group. |
| abstract void |
restart()
Restarts all nodes in the cluster. |
| abstract void |
restart(Context context)
Restarts all nodes in the cluster. |
|
abstract
List<Server |
serverNames()
Gets the server |
| abstract String |
sourceLocation()
Gets the source |
| abstract String |
sourceResourceId()
Gets the source |
| abstract void |
start()
Starts stopped compute on all cluster nodes. |
| abstract void |
start(Context context)
Starts stopped compute on all cluster nodes. |
| abstract String |
state()
Gets the state property: A state of a cluster/server that is visible to user. |
| abstract void |
stop()
Stops compute on all cluster nodes. |
| abstract void |
stop(Context context)
Stops compute on all cluster nodes. |
|
abstract
System |
systemData()
Gets the system |
| abstract Map<String,String> |
tags()
Gets the tags property: Resource tags. |
| abstract String |
type()
Gets the type property: The type of the resource. |
| abstract Update |
update()
Begins update for the Cluster resource. |
Method Details
administratorLogin
public abstract String administratorLogin()
Gets the administratorLogin property: The administrator's login name of the servers in the cluster.
Returns:
administratorLoginPassword
public abstract String administratorLoginPassword()
Gets the administratorLoginPassword property: The password of the administrator login. Required for creation.
Returns:
citusVersion
public abstract String citusVersion()
Gets the citusVersion property: The Citus extension version on all cluster servers.
Returns:
coordinatorEnablePublicIpAccess
public abstract Boolean coordinatorEnablePublicIpAccess()
Gets the coordinatorEnablePublicIpAccess property: If public access is enabled on coordinator.
Returns:
coordinatorServerEdition
public abstract String coordinatorServerEdition()
Gets the coordinatorServerEdition property: The edition of a coordinator server (default: GeneralPurpose). Required for creation.
Returns:
coordinatorStorageQuotaInMb
public abstract Integer coordinatorStorageQuotaInMb()
Gets the coordinatorStorageQuotaInMb property: The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
Returns:
coordinatorVCores
public abstract Integer coordinatorVCores()
Gets the coordinatorVCores property: The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
Returns:
earliestRestoreTime
public abstract OffsetDateTime earliestRestoreTime()
Gets the earliestRestoreTime property: The earliest restore point time (ISO8601 format) for the cluster.
Returns:
enableHa
public abstract Boolean enableHa()
Gets the enableHa property: If high availability (HA) is enabled or not for the cluster.
Returns:
enableShardsOnCoordinator
public abstract Boolean enableShardsOnCoordinator()
Gets the enableShardsOnCoordinator property: If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed.
Returns:
id
public abstract String id()
Gets the id property: Fully qualified resource Id for the resource.
Returns:
innerModel
public abstract ClusterInner innerModel()
Gets the inner com.azure.resourcemanager.cosmosdbforpostgresql.fluent.models.ClusterInner object.
Returns:
location
public abstract String location()
Gets the location property: The geo-location where the resource lives.
Returns:
maintenanceWindow
public abstract MaintenanceWindow maintenanceWindow()
Gets the maintenanceWindow property: Maintenance window of a cluster.
Returns:
name
public abstract String name()
Gets the name property: The name of the resource.
Returns:
nodeCount
public abstract Integer nodeCount()
Gets the nodeCount property: Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation.
Returns:
nodeEnablePublicIpAccess
public abstract Boolean nodeEnablePublicIpAccess()
Gets the nodeEnablePublicIpAccess property: If public access is enabled on worker nodes.
Returns:
nodeServerEdition
public abstract String nodeServerEdition()
Gets the nodeServerEdition property: The edition of a node server (default: MemoryOptimized).
Returns:
nodeStorageQuotaInMb
public abstract Integer nodeStorageQuotaInMb()
Gets the nodeStorageQuotaInMb property: The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
Returns:
nodeVCores
public abstract Integer nodeVCores()
Gets the nodeVCores property: The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
Returns:
pointInTimeUtc
public abstract OffsetDateTime pointInTimeUtc()
Gets the pointInTimeUtc property: Date and time in UTC (ISO8601 format) for cluster restore.
Returns:
postgresqlVersion
public abstract String postgresqlVersion()
Gets the postgresqlVersion property: The major PostgreSQL version on all cluster servers.
Returns:
preferredPrimaryZone
public abstract String preferredPrimaryZone()
Gets the preferredPrimaryZone property: Preferred primary availability zone (AZ) for all cluster servers.
Returns:
privateEndpointConnections
public abstract List<SimplePrivateEndpointConnection> privateEndpointConnections()
Gets the privateEndpointConnections property: The private endpoint connections for a cluster.
Returns:
promoteReadReplica
public abstract void promoteReadReplica()
Promotes read replica cluster to an independent read-write cluster.
promoteReadReplica
public abstract void promoteReadReplica(Context context)
Promotes read replica cluster to an independent read-write cluster.
Parameters:
provisioningState
public abstract String provisioningState()
Gets the provisioningState property: Provisioning state of the cluster.
Returns:
readReplicas
public abstract List<String> readReplicas()
Gets the readReplicas property: The array of read replica clusters.
Returns:
refresh
public abstract Cluster refresh()
Refreshes the resource to sync with Azure.
Returns:
refresh
public abstract Cluster refresh(Context context)
Refreshes the resource to sync with Azure.
Parameters:
Returns:
region
public abstract Region region()
Gets the region of the resource.
Returns:
regionName
public abstract String regionName()
Gets the name of the resource region.
Returns:
resourceGroupName
public abstract String resourceGroupName()
Gets the name of the resource group.
Returns:
restart
public abstract void restart()
Restarts all nodes in the cluster.
restart
public abstract void restart(Context context)
Restarts all nodes in the cluster.
Parameters:
serverNames
public abstract List<ServerNameItem> serverNames()
Gets the serverNames property: The list of server names in the cluster.
Returns:
sourceLocation
public abstract String sourceLocation()
Gets the sourceLocation property: The Azure region of source cluster for read replica clusters.
Returns:
sourceResourceId
public abstract String sourceResourceId()
Gets the sourceResourceId property: The resource id of source cluster for read replica clusters.
Returns:
start
public abstract void start()
Starts stopped compute on all cluster nodes.
start
public abstract void start(Context context)
Starts stopped compute on all cluster nodes.
Parameters:
state
public abstract String state()
Gets the state property: A state of a cluster/server that is visible to user.
Returns:
stop
public abstract void stop()
Stops compute on all cluster nodes.
stop
public abstract void stop(Context context)
Stops compute on all cluster nodes.
Parameters:
systemData
public abstract SystemData systemData()
Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Returns:
tags
public abstract Map<String,String> tags()
Gets the tags property: Resource tags.
Returns:
type
public abstract String type()
Gets the type property: The type of the resource.
Returns:
update
public abstract Cluster.Update update()
Begins update for the Cluster resource.
Returns:
