com.pulumi.azurenative.dbforpostgresql.outputs.GetClusterResult Maven / Gradle / Ivy
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.azurenative.dbforpostgresql.outputs;
import com.pulumi.azurenative.dbforpostgresql.outputs.MaintenanceWindowResponse;
import com.pulumi.azurenative.dbforpostgresql.outputs.ServerNameItemResponse;
import com.pulumi.azurenative.dbforpostgresql.outputs.SimplePrivateEndpointConnectionResponse;
import com.pulumi.azurenative.dbforpostgresql.outputs.SystemDataResponse;
import com.pulumi.core.annotations.CustomType;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.Boolean;
import java.lang.Integer;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
@CustomType
public final class GetClusterResult {
/**
* @return The administrator's login name of the servers in the cluster.
*
*/
private String administratorLogin;
/**
* @return The Citus extension version on all cluster servers.
*
*/
private @Nullable String citusVersion;
/**
* @return If public access is enabled on coordinator.
*
*/
private @Nullable Boolean coordinatorEnablePublicIpAccess;
/**
* @return The edition of a coordinator server (default: GeneralPurpose). Required for creation.
*
*/
private @Nullable String coordinatorServerEdition;
/**
* @return The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
*
*/
private @Nullable Integer coordinatorStorageQuotaInMb;
/**
* @return 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.
*
*/
private @Nullable Integer coordinatorVCores;
/**
* @return The earliest restore point time (ISO8601 format) for the cluster.
*
*/
private String earliestRestoreTime;
/**
* @return If high availability (HA) is enabled or not for the cluster.
*
*/
private @Nullable Boolean enableHa;
/**
* @return 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.
*
*/
private @Nullable Boolean enableShardsOnCoordinator;
/**
* @return Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
*
*/
private String id;
/**
* @return The geo-location where the resource lives
*
*/
private String location;
/**
* @return Maintenance window of a cluster.
*
*/
private @Nullable MaintenanceWindowResponse maintenanceWindow;
/**
* @return The name of the resource
*
*/
private String name;
/**
* @return 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.
*
*/
private @Nullable Integer nodeCount;
/**
* @return If public access is enabled on worker nodes.
*
*/
private @Nullable Boolean nodeEnablePublicIpAccess;
/**
* @return The edition of a node server (default: MemoryOptimized).
*
*/
private @Nullable String nodeServerEdition;
/**
* @return The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
*
*/
private @Nullable Integer nodeStorageQuotaInMb;
/**
* @return The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
*
*/
private @Nullable Integer nodeVCores;
/**
* @return Date and time in UTC (ISO8601 format) for cluster restore.
*
*/
private @Nullable String pointInTimeUTC;
/**
* @return The major PostgreSQL version on all cluster servers.
*
*/
private @Nullable String postgresqlVersion;
/**
* @return Preferred primary availability zone (AZ) for all cluster servers.
*
*/
private @Nullable String preferredPrimaryZone;
/**
* @return The private endpoint connections for a cluster.
*
*/
private List privateEndpointConnections;
/**
* @return Provisioning state of the cluster
*
*/
private String provisioningState;
/**
* @return The array of read replica clusters.
*
*/
private List readReplicas;
/**
* @return The list of server names in the cluster
*
*/
private List serverNames;
/**
* @return The Azure region of source cluster for read replica clusters.
*
*/
private @Nullable String sourceLocation;
/**
* @return The resource id of source cluster for read replica clusters.
*
*/
private @Nullable String sourceResourceId;
/**
* @return A state of a cluster/server that is visible to user.
*
*/
private String state;
/**
* @return Azure Resource Manager metadata containing createdBy and modifiedBy information.
*
*/
private SystemDataResponse systemData;
/**
* @return Resource tags.
*
*/
private @Nullable Map tags;
/**
* @return The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*
*/
private String type;
private GetClusterResult() {}
/**
* @return The administrator's login name of the servers in the cluster.
*
*/
public String administratorLogin() {
return this.administratorLogin;
}
/**
* @return The Citus extension version on all cluster servers.
*
*/
public Optional citusVersion() {
return Optional.ofNullable(this.citusVersion);
}
/**
* @return If public access is enabled on coordinator.
*
*/
public Optional coordinatorEnablePublicIpAccess() {
return Optional.ofNullable(this.coordinatorEnablePublicIpAccess);
}
/**
* @return The edition of a coordinator server (default: GeneralPurpose). Required for creation.
*
*/
public Optional coordinatorServerEdition() {
return Optional.ofNullable(this.coordinatorServerEdition);
}
/**
* @return The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
*
*/
public Optional coordinatorStorageQuotaInMb() {
return Optional.ofNullable(this.coordinatorStorageQuotaInMb);
}
/**
* @return 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.
*
*/
public Optional coordinatorVCores() {
return Optional.ofNullable(this.coordinatorVCores);
}
/**
* @return The earliest restore point time (ISO8601 format) for the cluster.
*
*/
public String earliestRestoreTime() {
return this.earliestRestoreTime;
}
/**
* @return If high availability (HA) is enabled or not for the cluster.
*
*/
public Optional enableHa() {
return Optional.ofNullable(this.enableHa);
}
/**
* @return 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.
*
*/
public Optional enableShardsOnCoordinator() {
return Optional.ofNullable(this.enableShardsOnCoordinator);
}
/**
* @return Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
*
*/
public String id() {
return this.id;
}
/**
* @return The geo-location where the resource lives
*
*/
public String location() {
return this.location;
}
/**
* @return Maintenance window of a cluster.
*
*/
public Optional maintenanceWindow() {
return Optional.ofNullable(this.maintenanceWindow);
}
/**
* @return The name of the resource
*
*/
public String name() {
return this.name;
}
/**
* @return 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.
*
*/
public Optional nodeCount() {
return Optional.ofNullable(this.nodeCount);
}
/**
* @return If public access is enabled on worker nodes.
*
*/
public Optional nodeEnablePublicIpAccess() {
return Optional.ofNullable(this.nodeEnablePublicIpAccess);
}
/**
* @return The edition of a node server (default: MemoryOptimized).
*
*/
public Optional nodeServerEdition() {
return Optional.ofNullable(this.nodeServerEdition);
}
/**
* @return The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
*
*/
public Optional nodeStorageQuotaInMb() {
return Optional.ofNullable(this.nodeStorageQuotaInMb);
}
/**
* @return The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
*
*/
public Optional nodeVCores() {
return Optional.ofNullable(this.nodeVCores);
}
/**
* @return Date and time in UTC (ISO8601 format) for cluster restore.
*
*/
public Optional pointInTimeUTC() {
return Optional.ofNullable(this.pointInTimeUTC);
}
/**
* @return The major PostgreSQL version on all cluster servers.
*
*/
public Optional postgresqlVersion() {
return Optional.ofNullable(this.postgresqlVersion);
}
/**
* @return Preferred primary availability zone (AZ) for all cluster servers.
*
*/
public Optional preferredPrimaryZone() {
return Optional.ofNullable(this.preferredPrimaryZone);
}
/**
* @return The private endpoint connections for a cluster.
*
*/
public List privateEndpointConnections() {
return this.privateEndpointConnections;
}
/**
* @return Provisioning state of the cluster
*
*/
public String provisioningState() {
return this.provisioningState;
}
/**
* @return The array of read replica clusters.
*
*/
public List readReplicas() {
return this.readReplicas;
}
/**
* @return The list of server names in the cluster
*
*/
public List serverNames() {
return this.serverNames;
}
/**
* @return The Azure region of source cluster for read replica clusters.
*
*/
public Optional sourceLocation() {
return Optional.ofNullable(this.sourceLocation);
}
/**
* @return The resource id of source cluster for read replica clusters.
*
*/
public Optional sourceResourceId() {
return Optional.ofNullable(this.sourceResourceId);
}
/**
* @return A state of a cluster/server that is visible to user.
*
*/
public String state() {
return this.state;
}
/**
* @return Azure Resource Manager metadata containing createdBy and modifiedBy information.
*
*/
public SystemDataResponse systemData() {
return this.systemData;
}
/**
* @return Resource tags.
*
*/
public Map tags() {
return this.tags == null ? Map.of() : this.tags;
}
/**
* @return The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*
*/
public String type() {
return this.type;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(GetClusterResult defaults) {
return new Builder(defaults);
}
@CustomType.Builder
public static final class Builder {
private String administratorLogin;
private @Nullable String citusVersion;
private @Nullable Boolean coordinatorEnablePublicIpAccess;
private @Nullable String coordinatorServerEdition;
private @Nullable Integer coordinatorStorageQuotaInMb;
private @Nullable Integer coordinatorVCores;
private String earliestRestoreTime;
private @Nullable Boolean enableHa;
private @Nullable Boolean enableShardsOnCoordinator;
private String id;
private String location;
private @Nullable MaintenanceWindowResponse maintenanceWindow;
private String name;
private @Nullable Integer nodeCount;
private @Nullable Boolean nodeEnablePublicIpAccess;
private @Nullable String nodeServerEdition;
private @Nullable Integer nodeStorageQuotaInMb;
private @Nullable Integer nodeVCores;
private @Nullable String pointInTimeUTC;
private @Nullable String postgresqlVersion;
private @Nullable String preferredPrimaryZone;
private List privateEndpointConnections;
private String provisioningState;
private List readReplicas;
private List serverNames;
private @Nullable String sourceLocation;
private @Nullable String sourceResourceId;
private String state;
private SystemDataResponse systemData;
private @Nullable Map tags;
private String type;
public Builder() {}
public Builder(GetClusterResult defaults) {
Objects.requireNonNull(defaults);
this.administratorLogin = defaults.administratorLogin;
this.citusVersion = defaults.citusVersion;
this.coordinatorEnablePublicIpAccess = defaults.coordinatorEnablePublicIpAccess;
this.coordinatorServerEdition = defaults.coordinatorServerEdition;
this.coordinatorStorageQuotaInMb = defaults.coordinatorStorageQuotaInMb;
this.coordinatorVCores = defaults.coordinatorVCores;
this.earliestRestoreTime = defaults.earliestRestoreTime;
this.enableHa = defaults.enableHa;
this.enableShardsOnCoordinator = defaults.enableShardsOnCoordinator;
this.id = defaults.id;
this.location = defaults.location;
this.maintenanceWindow = defaults.maintenanceWindow;
this.name = defaults.name;
this.nodeCount = defaults.nodeCount;
this.nodeEnablePublicIpAccess = defaults.nodeEnablePublicIpAccess;
this.nodeServerEdition = defaults.nodeServerEdition;
this.nodeStorageQuotaInMb = defaults.nodeStorageQuotaInMb;
this.nodeVCores = defaults.nodeVCores;
this.pointInTimeUTC = defaults.pointInTimeUTC;
this.postgresqlVersion = defaults.postgresqlVersion;
this.preferredPrimaryZone = defaults.preferredPrimaryZone;
this.privateEndpointConnections = defaults.privateEndpointConnections;
this.provisioningState = defaults.provisioningState;
this.readReplicas = defaults.readReplicas;
this.serverNames = defaults.serverNames;
this.sourceLocation = defaults.sourceLocation;
this.sourceResourceId = defaults.sourceResourceId;
this.state = defaults.state;
this.systemData = defaults.systemData;
this.tags = defaults.tags;
this.type = defaults.type;
}
@CustomType.Setter
public Builder administratorLogin(String administratorLogin) {
if (administratorLogin == null) {
throw new MissingRequiredPropertyException("GetClusterResult", "administratorLogin");
}
this.administratorLogin = administratorLogin;
return this;
}
@CustomType.Setter
public Builder citusVersion(@Nullable String citusVersion) {
this.citusVersion = citusVersion;
return this;
}
@CustomType.Setter
public Builder coordinatorEnablePublicIpAccess(@Nullable Boolean coordinatorEnablePublicIpAccess) {
this.coordinatorEnablePublicIpAccess = coordinatorEnablePublicIpAccess;
return this;
}
@CustomType.Setter
public Builder coordinatorServerEdition(@Nullable String coordinatorServerEdition) {
this.coordinatorServerEdition = coordinatorServerEdition;
return this;
}
@CustomType.Setter
public Builder coordinatorStorageQuotaInMb(@Nullable Integer coordinatorStorageQuotaInMb) {
this.coordinatorStorageQuotaInMb = coordinatorStorageQuotaInMb;
return this;
}
@CustomType.Setter
public Builder coordinatorVCores(@Nullable Integer coordinatorVCores) {
this.coordinatorVCores = coordinatorVCores;
return this;
}
@CustomType.Setter
public Builder earliestRestoreTime(String earliestRestoreTime) {
if (earliestRestoreTime == null) {
throw new MissingRequiredPropertyException("GetClusterResult", "earliestRestoreTime");
}
this.earliestRestoreTime = earliestRestoreTime;
return this;
}
@CustomType.Setter
public Builder enableHa(@Nullable Boolean enableHa) {
this.enableHa = enableHa;
return this;
}
@CustomType.Setter
public Builder enableShardsOnCoordinator(@Nullable Boolean enableShardsOnCoordinator) {
this.enableShardsOnCoordinator = enableShardsOnCoordinator;
return this;
}
@CustomType.Setter
public Builder id(String id) {
if (id == null) {
throw new MissingRequiredPropertyException("GetClusterResult", "id");
}
this.id = id;
return this;
}
@CustomType.Setter
public Builder location(String location) {
if (location == null) {
throw new MissingRequiredPropertyException("GetClusterResult", "location");
}
this.location = location;
return this;
}
@CustomType.Setter
public Builder maintenanceWindow(@Nullable MaintenanceWindowResponse maintenanceWindow) {
this.maintenanceWindow = maintenanceWindow;
return this;
}
@CustomType.Setter
public Builder name(String name) {
if (name == null) {
throw new MissingRequiredPropertyException("GetClusterResult", "name");
}
this.name = name;
return this;
}
@CustomType.Setter
public Builder nodeCount(@Nullable Integer nodeCount) {
this.nodeCount = nodeCount;
return this;
}
@CustomType.Setter
public Builder nodeEnablePublicIpAccess(@Nullable Boolean nodeEnablePublicIpAccess) {
this.nodeEnablePublicIpAccess = nodeEnablePublicIpAccess;
return this;
}
@CustomType.Setter
public Builder nodeServerEdition(@Nullable String nodeServerEdition) {
this.nodeServerEdition = nodeServerEdition;
return this;
}
@CustomType.Setter
public Builder nodeStorageQuotaInMb(@Nullable Integer nodeStorageQuotaInMb) {
this.nodeStorageQuotaInMb = nodeStorageQuotaInMb;
return this;
}
@CustomType.Setter
public Builder nodeVCores(@Nullable Integer nodeVCores) {
this.nodeVCores = nodeVCores;
return this;
}
@CustomType.Setter
public Builder pointInTimeUTC(@Nullable String pointInTimeUTC) {
this.pointInTimeUTC = pointInTimeUTC;
return this;
}
@CustomType.Setter
public Builder postgresqlVersion(@Nullable String postgresqlVersion) {
this.postgresqlVersion = postgresqlVersion;
return this;
}
@CustomType.Setter
public Builder preferredPrimaryZone(@Nullable String preferredPrimaryZone) {
this.preferredPrimaryZone = preferredPrimaryZone;
return this;
}
@CustomType.Setter
public Builder privateEndpointConnections(List privateEndpointConnections) {
if (privateEndpointConnections == null) {
throw new MissingRequiredPropertyException("GetClusterResult", "privateEndpointConnections");
}
this.privateEndpointConnections = privateEndpointConnections;
return this;
}
public Builder privateEndpointConnections(SimplePrivateEndpointConnectionResponse... privateEndpointConnections) {
return privateEndpointConnections(List.of(privateEndpointConnections));
}
@CustomType.Setter
public Builder provisioningState(String provisioningState) {
if (provisioningState == null) {
throw new MissingRequiredPropertyException("GetClusterResult", "provisioningState");
}
this.provisioningState = provisioningState;
return this;
}
@CustomType.Setter
public Builder readReplicas(List readReplicas) {
if (readReplicas == null) {
throw new MissingRequiredPropertyException("GetClusterResult", "readReplicas");
}
this.readReplicas = readReplicas;
return this;
}
public Builder readReplicas(String... readReplicas) {
return readReplicas(List.of(readReplicas));
}
@CustomType.Setter
public Builder serverNames(List serverNames) {
if (serverNames == null) {
throw new MissingRequiredPropertyException("GetClusterResult", "serverNames");
}
this.serverNames = serverNames;
return this;
}
public Builder serverNames(ServerNameItemResponse... serverNames) {
return serverNames(List.of(serverNames));
}
@CustomType.Setter
public Builder sourceLocation(@Nullable String sourceLocation) {
this.sourceLocation = sourceLocation;
return this;
}
@CustomType.Setter
public Builder sourceResourceId(@Nullable String sourceResourceId) {
this.sourceResourceId = sourceResourceId;
return this;
}
@CustomType.Setter
public Builder state(String state) {
if (state == null) {
throw new MissingRequiredPropertyException("GetClusterResult", "state");
}
this.state = state;
return this;
}
@CustomType.Setter
public Builder systemData(SystemDataResponse systemData) {
if (systemData == null) {
throw new MissingRequiredPropertyException("GetClusterResult", "systemData");
}
this.systemData = systemData;
return this;
}
@CustomType.Setter
public Builder tags(@Nullable Map tags) {
this.tags = tags;
return this;
}
@CustomType.Setter
public Builder type(String type) {
if (type == null) {
throw new MissingRequiredPropertyException("GetClusterResult", "type");
}
this.type = type;
return this;
}
public GetClusterResult build() {
final var _resultValue = new GetClusterResult();
_resultValue.administratorLogin = administratorLogin;
_resultValue.citusVersion = citusVersion;
_resultValue.coordinatorEnablePublicIpAccess = coordinatorEnablePublicIpAccess;
_resultValue.coordinatorServerEdition = coordinatorServerEdition;
_resultValue.coordinatorStorageQuotaInMb = coordinatorStorageQuotaInMb;
_resultValue.coordinatorVCores = coordinatorVCores;
_resultValue.earliestRestoreTime = earliestRestoreTime;
_resultValue.enableHa = enableHa;
_resultValue.enableShardsOnCoordinator = enableShardsOnCoordinator;
_resultValue.id = id;
_resultValue.location = location;
_resultValue.maintenanceWindow = maintenanceWindow;
_resultValue.name = name;
_resultValue.nodeCount = nodeCount;
_resultValue.nodeEnablePublicIpAccess = nodeEnablePublicIpAccess;
_resultValue.nodeServerEdition = nodeServerEdition;
_resultValue.nodeStorageQuotaInMb = nodeStorageQuotaInMb;
_resultValue.nodeVCores = nodeVCores;
_resultValue.pointInTimeUTC = pointInTimeUTC;
_resultValue.postgresqlVersion = postgresqlVersion;
_resultValue.preferredPrimaryZone = preferredPrimaryZone;
_resultValue.privateEndpointConnections = privateEndpointConnections;
_resultValue.provisioningState = provisioningState;
_resultValue.readReplicas = readReplicas;
_resultValue.serverNames = serverNames;
_resultValue.sourceLocation = sourceLocation;
_resultValue.sourceResourceId = sourceResourceId;
_resultValue.state = state;
_resultValue.systemData = systemData;
_resultValue.tags = tags;
_resultValue.type = type;
return _resultValue;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy