ClusterInner Class

Package:

com.azure.resourcemanager.cosmosdbforpostgresql.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-cosmosdbforpostgresql:1.0.0

• java.lang.Object
• • com.azure.core.management.ProxyResource
  • • com.azure.core.management.Resource
    • • com.azure.resourcemanager.cosmosdbforpostgresql.fluent.models.ClusterInner

public final class ClusterInner
extends Resource

Represents a cluster.

Constructor Summary

Constructor	Description
ClusterInner()	Creates an instance of ClusterInner class.

Method Summary

Modifier and Type	Method and Description
String	administratorLogin() Get the administratorLogin property: The administrator's login name of the servers in the cluster.
String	administratorLoginPassword() Get the administratorLoginPassword property: The password of the administrator login.
String	citusVersion() Get the citusVersion property: The Citus extension version on all cluster servers.
Boolean	coordinatorEnablePublicIpAccess() Get the coordinatorEnablePublicIpAccess property: If public access is enabled on coordinator.
String	coordinatorServerEdition() Get the coordinatorServerEdition property: The edition of a coordinator server (default: GeneralPurpose).
Integer	coordinatorStorageQuotaInMb() Get the coordinatorStorageQuotaInMb property: The storage of a server in MB.
Integer	coordinatorVCores() Get the coordinatorVCores property: The vCores count of a server (max: 96).
OffsetDateTime	earliestRestoreTime() Get the earliestRestoreTime property: The earliest restore point time (ISO8601 format) for the cluster.
Boolean	enableHa() Get the enableHa property: If high availability (HA) is enabled or not for the cluster.
Boolean	enableShardsOnCoordinator() Get the enableShardsOnCoordinator property: If distributed tables are placed on coordinator or not.
MaintenanceWindow	maintenanceWindow() Get the maintenanceWindow property: Maintenance window of a cluster.
Integer	nodeCount() Get the nodeCount property: Worker node count of the cluster.
Boolean	nodeEnablePublicIpAccess() Get the nodeEnablePublicIpAccess property: If public access is enabled on worker nodes.
String	nodeServerEdition() Get the nodeServerEdition property: The edition of a node server (default: MemoryOptimized).
Integer	nodeStorageQuotaInMb() Get the nodeStorageQuotaInMb property: The storage in MB on each worker node.
Integer	nodeVCores() Get the nodeVCores property: The compute in vCores on each worker node (max: 104).
OffsetDateTime	pointInTimeUtc() Get the pointInTimeUtc property: Date and time in UTC (ISO8601 format) for cluster restore.
String	postgresqlVersion() Get the postgresqlVersion property: The major PostgreSQL version on all cluster servers.
String	preferredPrimaryZone() Get the preferredPrimaryZone property: Preferred primary availability zone (AZ) for all cluster servers.
List<SimplePrivateEndpointConnection>	privateEndpointConnections() Get the privateEndpointConnections property: The private endpoint connections for a cluster.
String	provisioningState() Get the provisioningState property: Provisioning state of the cluster.
List<String>	readReplicas() Get the readReplicas property: The array of read replica clusters.
List<ServerNameItem>	serverNames() Get the serverNames property: The list of server names in the cluster.
String	sourceLocation() Get the sourceLocation property: The Azure region of source cluster for read replica clusters.
String	sourceResourceId() Get the sourceResourceId property: The resource id of source cluster for read replica clusters.
String	state() Get the state property: A state of a cluster/server that is visible to user.
SystemData	systemData() Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
void	validate() Validates the instance.
ClusterInner	withAdministratorLoginPassword(String administratorLoginPassword) Set the administratorLoginPassword property: The password of the administrator login.
ClusterInner	withCitusVersion(String citusVersion) Set the citusVersion property: The Citus extension version on all cluster servers.
ClusterInner	withCoordinatorEnablePublicIpAccess(Boolean coordinatorEnablePublicIpAccess) Set the coordinatorEnablePublicIpAccess property: If public access is enabled on coordinator.
ClusterInner	withCoordinatorServerEdition(String coordinatorServerEdition) Set the coordinatorServerEdition property: The edition of a coordinator server (default: GeneralPurpose).
ClusterInner	withCoordinatorStorageQuotaInMb(Integer coordinatorStorageQuotaInMb) Set the coordinatorStorageQuotaInMb property: The storage of a server in MB.
ClusterInner	withCoordinatorVCores(Integer coordinatorVCores) Set the coordinatorVCores property: The vCores count of a server (max: 96).
ClusterInner	withEnableHa(Boolean enableHa) Set the enableHa property: If high availability (HA) is enabled or not for the cluster.
ClusterInner	withEnableShardsOnCoordinator(Boolean enableShardsOnCoordinator) Set the enableShardsOnCoordinator property: If distributed tables are placed on coordinator or not.
ClusterInner	withLocation(String location)
ClusterInner	withMaintenanceWindow(MaintenanceWindow maintenanceWindow) Set the maintenanceWindow property: Maintenance window of a cluster.
ClusterInner	withNodeCount(Integer nodeCount) Set the nodeCount property: Worker node count of the cluster.
ClusterInner	withNodeEnablePublicIpAccess(Boolean nodeEnablePublicIpAccess) Set the nodeEnablePublicIpAccess property: If public access is enabled on worker nodes.
ClusterInner	withNodeServerEdition(String nodeServerEdition) Set the nodeServerEdition property: The edition of a node server (default: MemoryOptimized).
ClusterInner	withNodeStorageQuotaInMb(Integer nodeStorageQuotaInMb) Set the nodeStorageQuotaInMb property: The storage in MB on each worker node.
ClusterInner	withNodeVCores(Integer nodeVCores) Set the nodeVCores property: The compute in vCores on each worker node (max: 104).
ClusterInner	withPointInTimeUtc(OffsetDateTime pointInTimeUtc) Set the pointInTimeUtc property: Date and time in UTC (ISO8601 format) for cluster restore.
ClusterInner	withPostgresqlVersion(String postgresqlVersion) Set the postgresqlVersion property: The major PostgreSQL version on all cluster servers.
ClusterInner	withPreferredPrimaryZone(String preferredPrimaryZone) Set the preferredPrimaryZone property: Preferred primary availability zone (AZ) for all cluster servers.
ClusterInner	withSourceLocation(String sourceLocation) Set the sourceLocation property: The Azure region of source cluster for read replica clusters.
ClusterInner	withSourceResourceId(String sourceResourceId) Set the sourceResourceId property: The resource id of source cluster for read replica clusters.
ClusterInner	withTags(Map<String,String> tags)

Methods inherited from ProxyResource

id name type

Methods inherited from Resource

location tags withLocation withTags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ClusterInner

public ClusterInner()

Creates an instance of ClusterInner class.

Method Details

administratorLogin

public String administratorLogin()

Get the administratorLogin property: The administrator's login name of the servers in the cluster.

Returns:

the administratorLogin value.

administratorLoginPassword

public String administratorLoginPassword()

Get the administratorLoginPassword property: The password of the administrator login. Required for creation.

Returns:

the administratorLoginPassword value.

citusVersion

public String citusVersion()

Get the citusVersion property: The Citus extension version on all cluster servers.

Returns:

the citusVersion value.

coordinatorEnablePublicIpAccess

public Boolean coordinatorEnablePublicIpAccess()

Get the coordinatorEnablePublicIpAccess property: If public access is enabled on coordinator.

Returns:

the coordinatorEnablePublicIpAccess value.

coordinatorServerEdition

public String coordinatorServerEdition()

Get the coordinatorServerEdition property: The edition of a coordinator server (default: GeneralPurpose). Required for creation.

Returns:

the coordinatorServerEdition value.

coordinatorStorageQuotaInMb

public Integer coordinatorStorageQuotaInMb()

Get 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:

the coordinatorStorageQuotaInMb value.

coordinatorVCores

public Integer coordinatorVCores()

Get 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:

the coordinatorVCores value.

earliestRestoreTime

public OffsetDateTime earliestRestoreTime()

Get the earliestRestoreTime property: The earliest restore point time (ISO8601 format) for the cluster.

Returns:

the earliestRestoreTime value.

enableHa

public Boolean enableHa()

Get the enableHa property: If high availability (HA) is enabled or not for the cluster.

Returns:

the enableHa value.

enableShardsOnCoordinator

public Boolean enableShardsOnCoordinator()

Get 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:

the enableShardsOnCoordinator value.

maintenanceWindow

public MaintenanceWindow maintenanceWindow()

Get the maintenanceWindow property: Maintenance window of a cluster.

Returns:

the maintenanceWindow value.

nodeCount

public Integer nodeCount()

Get 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:

the nodeCount value.

nodeEnablePublicIpAccess

public Boolean nodeEnablePublicIpAccess()

Get the nodeEnablePublicIpAccess property: If public access is enabled on worker nodes.

Returns:

the nodeEnablePublicIpAccess value.

nodeServerEdition

public String nodeServerEdition()

Get the nodeServerEdition property: The edition of a node server (default: MemoryOptimized).

Returns:

the nodeServerEdition value.

nodeStorageQuotaInMb

public Integer nodeStorageQuotaInMb()

Get 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:

the nodeStorageQuotaInMb value.

nodeVCores

public Integer nodeVCores()

Get 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:

the nodeVCores value.

pointInTimeUtc

public OffsetDateTime pointInTimeUtc()

Get the pointInTimeUtc property: Date and time in UTC (ISO8601 format) for cluster restore.

Returns:

the pointInTimeUtc value.

postgresqlVersion

public String postgresqlVersion()

Get the postgresqlVersion property: The major PostgreSQL version on all cluster servers.

Returns:

the postgresqlVersion value.

preferredPrimaryZone

public String preferredPrimaryZone()

Get the preferredPrimaryZone property: Preferred primary availability zone (AZ) for all cluster servers.

Returns:

the preferredPrimaryZone value.

privateEndpointConnections

public List privateEndpointConnections()

Get the privateEndpointConnections property: The private endpoint connections for a cluster.

Returns:

the privateEndpointConnections value.

provisioningState

public String provisioningState()

Get the provisioningState property: Provisioning state of the cluster.

Returns:

the provisioningState value.

readReplicas

public List readReplicas()

Get the readReplicas property: The array of read replica clusters.

Returns:

the readReplicas value.

serverNames

public List serverNames()

Get the serverNames property: The list of server names in the cluster.

Returns:

the serverNames value.

sourceLocation

public String sourceLocation()

Get the sourceLocation property: The Azure region of source cluster for read replica clusters.

Returns:

the sourceLocation value.

sourceResourceId

public String sourceResourceId()

Get the sourceResourceId property: The resource id of source cluster for read replica clusters.

Returns:

the sourceResourceId value.

state

public String state()

Get the state property: A state of a cluster/server that is visible to user.

Returns:

the state value.

systemData

public SystemData systemData()

Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.

Returns:

the systemData value.

validate

public void validate()

Validates the instance.

withAdministratorLoginPassword

public ClusterInner withAdministratorLoginPassword(String administratorLoginPassword)

Set the administratorLoginPassword property: The password of the administrator login. Required for creation.

Parameters:

administratorLoginPassword - the administratorLoginPassword value to set.

Returns:

the ClusterInner object itself.

withCitusVersion

public ClusterInner withCitusVersion(String citusVersion)

Set the citusVersion property: The Citus extension version on all cluster servers.

Parameters:

citusVersion - the citusVersion value to set.

Returns:

the ClusterInner object itself.

withCoordinatorEnablePublicIpAccess

public ClusterInner withCoordinatorEnablePublicIpAccess(Boolean coordinatorEnablePublicIpAccess)

Set the coordinatorEnablePublicIpAccess property: If public access is enabled on coordinator.

Parameters:

coordinatorEnablePublicIpAccess - the coordinatorEnablePublicIpAccess value to set.

Returns:

the ClusterInner object itself.

withCoordinatorServerEdition

public ClusterInner withCoordinatorServerEdition(String coordinatorServerEdition)

Set the coordinatorServerEdition property: The edition of a coordinator server (default: GeneralPurpose). Required for creation.

Parameters:

coordinatorServerEdition - the coordinatorServerEdition value to set.

Returns:

the ClusterInner object itself.

withCoordinatorStorageQuotaInMb

public ClusterInner withCoordinatorStorageQuotaInMb(Integer coordinatorStorageQuotaInMb)

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

Parameters:

coordinatorStorageQuotaInMb - the coordinatorStorageQuotaInMb value to set.

Returns:

the ClusterInner object itself.

withCoordinatorVCores

public ClusterInner withCoordinatorVCores(Integer coordinatorVCores)

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

Parameters:

coordinatorVCores - the coordinatorVCores value to set.

Returns:

the ClusterInner object itself.

withEnableHa

public ClusterInner withEnableHa(Boolean enableHa)

Set the enableHa property: If high availability (HA) is enabled or not for the cluster.

Parameters:

enableHa - the enableHa value to set.

Returns:

the ClusterInner object itself.

withEnableShardsOnCoordinator

public ClusterInner withEnableShardsOnCoordinator(Boolean enableShardsOnCoordinator)

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

Parameters:

enableShardsOnCoordinator - the enableShardsOnCoordinator value to set.

Returns:

the ClusterInner object itself.

withLocation

public ClusterInner withLocation(String location)

Overrides:

ClusterInner.withLocation(String location)

Parameters:

location

withMaintenanceWindow

public ClusterInner withMaintenanceWindow(MaintenanceWindow maintenanceWindow)

Set the maintenanceWindow property: Maintenance window of a cluster.

Parameters:

maintenanceWindow - the maintenanceWindow value to set.

Returns:

the ClusterInner object itself.

withNodeCount

public ClusterInner withNodeCount(Integer nodeCount)

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

Parameters:

nodeCount - the nodeCount value to set.

Returns:

the ClusterInner object itself.

withNodeEnablePublicIpAccess

public ClusterInner withNodeEnablePublicIpAccess(Boolean nodeEnablePublicIpAccess)

Set the nodeEnablePublicIpAccess property: If public access is enabled on worker nodes.

Parameters:

nodeEnablePublicIpAccess - the nodeEnablePublicIpAccess value to set.

Returns:

the ClusterInner object itself.

withNodeServerEdition

public ClusterInner withNodeServerEdition(String nodeServerEdition)

Set the nodeServerEdition property: The edition of a node server (default: MemoryOptimized).

Parameters:

nodeServerEdition - the nodeServerEdition value to set.

Returns:

the ClusterInner object itself.

withNodeStorageQuotaInMb

public ClusterInner withNodeStorageQuotaInMb(Integer nodeStorageQuotaInMb)

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

Parameters:

nodeStorageQuotaInMb - the nodeStorageQuotaInMb value to set.

Returns:

the ClusterInner object itself.

withNodeVCores

public ClusterInner withNodeVCores(Integer nodeVCores)

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

Parameters:

nodeVCores - the nodeVCores value to set.

Returns:

the ClusterInner object itself.

withPointInTimeUtc

public ClusterInner withPointInTimeUtc(OffsetDateTime pointInTimeUtc)

Set the pointInTimeUtc property: Date and time in UTC (ISO8601 format) for cluster restore.

Parameters:

pointInTimeUtc - the pointInTimeUtc value to set.

Returns:

the ClusterInner object itself.

withPostgresqlVersion

public ClusterInner withPostgresqlVersion(String postgresqlVersion)

Set the postgresqlVersion property: The major PostgreSQL version on all cluster servers.

Parameters:

postgresqlVersion - the postgresqlVersion value to set.

Returns:

the ClusterInner object itself.

withPreferredPrimaryZone

public ClusterInner withPreferredPrimaryZone(String preferredPrimaryZone)

Set the preferredPrimaryZone property: Preferred primary availability zone (AZ) for all cluster servers.

Parameters:

preferredPrimaryZone - the preferredPrimaryZone value to set.

Returns:

the ClusterInner object itself.

withSourceLocation

public ClusterInner withSourceLocation(String sourceLocation)

Set the sourceLocation property: The Azure region of source cluster for read replica clusters.

Parameters:

sourceLocation - the sourceLocation value to set.

Returns:

the ClusterInner object itself.

withSourceResourceId

public ClusterInner withSourceResourceId(String sourceResourceId)

Set the sourceResourceId property: The resource id of source cluster for read replica clusters.

Parameters:

sourceResourceId - the sourceResourceId value to set.

Returns:

the ClusterInner object itself.

withTags

public ClusterInner withTags(Map tags)

Overrides:

ClusterInner.withTags(Map<String,String> tags)

Parameters:

tags