439 строки
35 KiB
YAML
439 строки
35 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate"
|
|
name: "ClusterForUpdate"
|
|
nameWithType: "ClusterForUpdate"
|
|
summary: "Represents a cluster for update."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **ClusterForUpdate**"
|
|
constructors:
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.ClusterForUpdate()"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.ClusterForUpdate()"
|
|
name: "ClusterForUpdate()"
|
|
nameWithType: "ClusterForUpdate.ClusterForUpdate()"
|
|
summary: "Creates an instance of Cluster<wbr>For<wbr>Update class."
|
|
syntax: "public ClusterForUpdate()"
|
|
desc: "Creates an instance of ClusterForUpdate class."
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.administratorLoginPassword()"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.administratorLoginPassword()"
|
|
name: "administratorLoginPassword()"
|
|
nameWithType: "ClusterForUpdate.administratorLoginPassword()"
|
|
summary: "Get the administrator<wbr>Login<wbr>Password property: The password of the administrator login."
|
|
syntax: "public String administratorLoginPassword()"
|
|
desc: "Get the administratorLoginPassword property: The password of the administrator login. Each cluster is created with pre-defined administrative role called \\\\u2018citus\\\\u2019.\\\\u202f."
|
|
returns:
|
|
description: "the administratorLoginPassword value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.citusVersion()"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.citusVersion()"
|
|
name: "citusVersion()"
|
|
nameWithType: "ClusterForUpdate.citusVersion()"
|
|
summary: "Get the citus<wbr>Version property: The Citus extension version on all cluster servers."
|
|
syntax: "public String citusVersion()"
|
|
desc: "Get the citusVersion property: The Citus extension version on all cluster servers."
|
|
returns:
|
|
description: "the citusVersion value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.coordinatorEnablePublicIpAccess()"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.coordinatorEnablePublicIpAccess()"
|
|
name: "coordinatorEnablePublicIpAccess()"
|
|
nameWithType: "ClusterForUpdate.coordinatorEnablePublicIpAccess()"
|
|
summary: "Get the coordinator<wbr>Enable<wbr>Public<wbr>IpAccess property: If public access is enabled on coordinator."
|
|
syntax: "public Boolean coordinatorEnablePublicIpAccess()"
|
|
desc: "Get the coordinatorEnablePublicIpAccess property: If public access is enabled on coordinator."
|
|
returns:
|
|
description: "the coordinatorEnablePublicIpAccess value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.coordinatorServerEdition()"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.coordinatorServerEdition()"
|
|
name: "coordinatorServerEdition()"
|
|
nameWithType: "ClusterForUpdate.coordinatorServerEdition()"
|
|
summary: "Get the coordinator<wbr>Server<wbr>Edition property: The edition of the coordinator (default: General<wbr>Purpose)."
|
|
syntax: "public String coordinatorServerEdition()"
|
|
desc: "Get the coordinatorServerEdition property: The edition of the coordinator (default: GeneralPurpose)."
|
|
returns:
|
|
description: "the coordinatorServerEdition value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.coordinatorStorageQuotaInMb()"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.coordinatorStorageQuotaInMb()"
|
|
name: "coordinatorStorageQuotaInMb()"
|
|
nameWithType: "ClusterForUpdate.coordinatorStorageQuotaInMb()"
|
|
summary: "Get the coordinator<wbr>Storage<wbr>Quota<wbr>InMb property: The storage of the coordinator in MB."
|
|
syntax: "public Integer coordinatorStorageQuotaInMb()"
|
|
desc: "Get the coordinatorStorageQuotaInMb property: The storage of the coordinator in MB."
|
|
returns:
|
|
description: "the coordinatorStorageQuotaInMb value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.coordinatorVCores()"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.coordinatorVCores()"
|
|
name: "coordinatorVCores()"
|
|
nameWithType: "ClusterForUpdate.coordinatorVCores()"
|
|
summary: "Get the coordinator<wbr>VCores property: The v<wbr>Cores count of the coordinator (max: 96)."
|
|
syntax: "public Integer coordinatorVCores()"
|
|
desc: "Get the coordinatorVCores property: The vCores count of the coordinator (max: 96)."
|
|
returns:
|
|
description: "the coordinatorVCores value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.enableHa()"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.enableHa()"
|
|
name: "enableHa()"
|
|
nameWithType: "ClusterForUpdate.enableHa()"
|
|
summary: "Get the enable<wbr>Ha property: If high availability (HA) is enabled or not for the cluster."
|
|
syntax: "public Boolean enableHa()"
|
|
desc: "Get the enableHa property: If high availability (HA) is enabled or not for the cluster."
|
|
returns:
|
|
description: "the enableHa value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.enableShardsOnCoordinator()"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.enableShardsOnCoordinator()"
|
|
name: "enableShardsOnCoordinator()"
|
|
nameWithType: "ClusterForUpdate.enableShardsOnCoordinator()"
|
|
summary: "Get the enable<wbr>Shards<wbr>OnCoordinator property: If distributed tables are placed on coordinator or not."
|
|
syntax: "public Boolean enableShardsOnCoordinator()"
|
|
desc: "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:
|
|
description: "the enableShardsOnCoordinator value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.maintenanceWindow()"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.maintenanceWindow()"
|
|
name: "maintenanceWindow()"
|
|
nameWithType: "ClusterForUpdate.maintenanceWindow()"
|
|
summary: "Get the maintenance<wbr>Window property: Maintenance window of a cluster."
|
|
syntax: "public MaintenanceWindow maintenanceWindow()"
|
|
desc: "Get the maintenanceWindow property: Maintenance window of a cluster."
|
|
returns:
|
|
description: "the maintenanceWindow value."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmosdbforpostgresql.models.MaintenanceWindow?alt=com.azure.resourcemanager.cosmosdbforpostgresql.models.MaintenanceWindow&text=MaintenanceWindow\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.nodeCount()"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.nodeCount()"
|
|
name: "nodeCount()"
|
|
nameWithType: "ClusterForUpdate.nodeCount()"
|
|
summary: "Get the node<wbr>Count property: Worker node count of the cluster."
|
|
syntax: "public Integer nodeCount()"
|
|
desc: "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."
|
|
returns:
|
|
description: "the nodeCount value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.nodeEnablePublicIpAccess()"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.nodeEnablePublicIpAccess()"
|
|
name: "nodeEnablePublicIpAccess()"
|
|
nameWithType: "ClusterForUpdate.nodeEnablePublicIpAccess()"
|
|
summary: "Get the node<wbr>Enable<wbr>Public<wbr>IpAccess property: If public access is enabled on worker nodes."
|
|
syntax: "public Boolean nodeEnablePublicIpAccess()"
|
|
desc: "Get the nodeEnablePublicIpAccess property: If public access is enabled on worker nodes."
|
|
returns:
|
|
description: "the nodeEnablePublicIpAccess value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.nodeServerEdition()"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.nodeServerEdition()"
|
|
name: "nodeServerEdition()"
|
|
nameWithType: "ClusterForUpdate.nodeServerEdition()"
|
|
summary: "Get the node<wbr>Server<wbr>Edition property: The edition of a node (default: Memory<wbr>Optimized)."
|
|
syntax: "public String nodeServerEdition()"
|
|
desc: "Get the nodeServerEdition property: The edition of a node (default: MemoryOptimized)."
|
|
returns:
|
|
description: "the nodeServerEdition value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.nodeStorageQuotaInMb()"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.nodeStorageQuotaInMb()"
|
|
name: "nodeStorageQuotaInMb()"
|
|
nameWithType: "ClusterForUpdate.nodeStorageQuotaInMb()"
|
|
summary: "Get the node<wbr>Storage<wbr>Quota<wbr>InMb property: The storage in MB on each worker node."
|
|
syntax: "public Integer nodeStorageQuotaInMb()"
|
|
desc: "Get the nodeStorageQuotaInMb property: The storage in MB on each worker node."
|
|
returns:
|
|
description: "the nodeStorageQuotaInMb value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.nodeVCores()"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.nodeVCores()"
|
|
name: "nodeVCores()"
|
|
nameWithType: "ClusterForUpdate.nodeVCores()"
|
|
summary: "Get the node<wbr>VCores property: The compute in v<wbr>Cores on each worker node (max: 104)."
|
|
syntax: "public Integer nodeVCores()"
|
|
desc: "Get the nodeVCores property: The compute in vCores on each worker node (max: 104)."
|
|
returns:
|
|
description: "the nodeVCores value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.postgresqlVersion()"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.postgresqlVersion()"
|
|
name: "postgresqlVersion()"
|
|
nameWithType: "ClusterForUpdate.postgresqlVersion()"
|
|
summary: "Get the postgresql<wbr>Version property: The major PostgreSQL version on all cluster servers."
|
|
syntax: "public String postgresqlVersion()"
|
|
desc: "Get the postgresqlVersion property: The major PostgreSQL version on all cluster servers."
|
|
returns:
|
|
description: "the postgresqlVersion value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.preferredPrimaryZone()"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.preferredPrimaryZone()"
|
|
name: "preferredPrimaryZone()"
|
|
nameWithType: "ClusterForUpdate.preferredPrimaryZone()"
|
|
summary: "Get the preferred<wbr>Primary<wbr>Zone property: Preferred primary availability zone (AZ) for all cluster servers."
|
|
syntax: "public String preferredPrimaryZone()"
|
|
desc: "Get the preferredPrimaryZone property: Preferred primary availability zone (AZ) for all cluster servers."
|
|
returns:
|
|
description: "the preferredPrimaryZone value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.tags()"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.tags()"
|
|
name: "tags()"
|
|
nameWithType: "ClusterForUpdate.tags()"
|
|
summary: "Get the tags property: Application-specific metadata in the form of key-value pairs."
|
|
syntax: "public Map<String,String> tags()"
|
|
desc: "Get the tags property: Application-specific metadata in the form of key-value pairs."
|
|
returns:
|
|
description: "the tags value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.validate()"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.validate()"
|
|
name: "validate()"
|
|
nameWithType: "ClusterForUpdate.validate()"
|
|
summary: "Validates the instance."
|
|
syntax: "public void validate()"
|
|
desc: "Validates the instance."
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withAdministratorLoginPassword(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withAdministratorLoginPassword(String administratorLoginPassword)"
|
|
name: "withAdministratorLoginPassword(String administratorLoginPassword)"
|
|
nameWithType: "ClusterForUpdate.withAdministratorLoginPassword(String administratorLoginPassword)"
|
|
summary: "Set the administrator<wbr>Login<wbr>Password property: The password of the administrator login."
|
|
parameters:
|
|
- description: "the administratorLoginPassword value to set."
|
|
name: "administratorLoginPassword"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ClusterForUpdate withAdministratorLoginPassword(String administratorLoginPassword)"
|
|
desc: "Set the administratorLoginPassword property: The password of the administrator login. Each cluster is created with pre-defined administrative role called \\\\u2018citus\\\\u2019.\\\\u202f."
|
|
returns:
|
|
description: "the ClusterForUpdate object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate?alt=com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate&text=ClusterForUpdate\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withCitusVersion(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withCitusVersion(String citusVersion)"
|
|
name: "withCitusVersion(String citusVersion)"
|
|
nameWithType: "ClusterForUpdate.withCitusVersion(String citusVersion)"
|
|
summary: "Set the citus<wbr>Version property: The Citus extension version on all cluster servers."
|
|
parameters:
|
|
- description: "the citusVersion value to set."
|
|
name: "citusVersion"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ClusterForUpdate withCitusVersion(String citusVersion)"
|
|
desc: "Set the citusVersion property: The Citus extension version on all cluster servers."
|
|
returns:
|
|
description: "the ClusterForUpdate object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate?alt=com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate&text=ClusterForUpdate\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withCoordinatorEnablePublicIpAccess(java.lang.Boolean)"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withCoordinatorEnablePublicIpAccess(Boolean coordinatorEnablePublicIpAccess)"
|
|
name: "withCoordinatorEnablePublicIpAccess(Boolean coordinatorEnablePublicIpAccess)"
|
|
nameWithType: "ClusterForUpdate.withCoordinatorEnablePublicIpAccess(Boolean coordinatorEnablePublicIpAccess)"
|
|
summary: "Set the coordinator<wbr>Enable<wbr>Public<wbr>IpAccess property: If public access is enabled on coordinator."
|
|
parameters:
|
|
- description: "the coordinatorEnablePublicIpAccess value to set."
|
|
name: "coordinatorEnablePublicIpAccess"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public ClusterForUpdate withCoordinatorEnablePublicIpAccess(Boolean coordinatorEnablePublicIpAccess)"
|
|
desc: "Set the coordinatorEnablePublicIpAccess property: If public access is enabled on coordinator."
|
|
returns:
|
|
description: "the ClusterForUpdate object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate?alt=com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate&text=ClusterForUpdate\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withCoordinatorServerEdition(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withCoordinatorServerEdition(String coordinatorServerEdition)"
|
|
name: "withCoordinatorServerEdition(String coordinatorServerEdition)"
|
|
nameWithType: "ClusterForUpdate.withCoordinatorServerEdition(String coordinatorServerEdition)"
|
|
summary: "Set the coordinator<wbr>Server<wbr>Edition property: The edition of the coordinator (default: General<wbr>Purpose)."
|
|
parameters:
|
|
- description: "the coordinatorServerEdition value to set."
|
|
name: "coordinatorServerEdition"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ClusterForUpdate withCoordinatorServerEdition(String coordinatorServerEdition)"
|
|
desc: "Set the coordinatorServerEdition property: The edition of the coordinator (default: GeneralPurpose)."
|
|
returns:
|
|
description: "the ClusterForUpdate object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate?alt=com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate&text=ClusterForUpdate\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withCoordinatorStorageQuotaInMb(java.lang.Integer)"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withCoordinatorStorageQuotaInMb(Integer coordinatorStorageQuotaInMb)"
|
|
name: "withCoordinatorStorageQuotaInMb(Integer coordinatorStorageQuotaInMb)"
|
|
nameWithType: "ClusterForUpdate.withCoordinatorStorageQuotaInMb(Integer coordinatorStorageQuotaInMb)"
|
|
summary: "Set the coordinator<wbr>Storage<wbr>Quota<wbr>InMb property: The storage of the coordinator in MB."
|
|
parameters:
|
|
- description: "the coordinatorStorageQuotaInMb value to set."
|
|
name: "coordinatorStorageQuotaInMb"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public ClusterForUpdate withCoordinatorStorageQuotaInMb(Integer coordinatorStorageQuotaInMb)"
|
|
desc: "Set the coordinatorStorageQuotaInMb property: The storage of the coordinator in MB."
|
|
returns:
|
|
description: "the ClusterForUpdate object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate?alt=com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate&text=ClusterForUpdate\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withCoordinatorVCores(java.lang.Integer)"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withCoordinatorVCores(Integer coordinatorVCores)"
|
|
name: "withCoordinatorVCores(Integer coordinatorVCores)"
|
|
nameWithType: "ClusterForUpdate.withCoordinatorVCores(Integer coordinatorVCores)"
|
|
summary: "Set the coordinator<wbr>VCores property: The v<wbr>Cores count of the coordinator (max: 96)."
|
|
parameters:
|
|
- description: "the coordinatorVCores value to set."
|
|
name: "coordinatorVCores"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public ClusterForUpdate withCoordinatorVCores(Integer coordinatorVCores)"
|
|
desc: "Set the coordinatorVCores property: The vCores count of the coordinator (max: 96)."
|
|
returns:
|
|
description: "the ClusterForUpdate object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate?alt=com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate&text=ClusterForUpdate\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withEnableHa(java.lang.Boolean)"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withEnableHa(Boolean enableHa)"
|
|
name: "withEnableHa(Boolean enableHa)"
|
|
nameWithType: "ClusterForUpdate.withEnableHa(Boolean enableHa)"
|
|
summary: "Set the enable<wbr>Ha property: If high availability (HA) is enabled or not for the cluster."
|
|
parameters:
|
|
- description: "the enableHa value to set."
|
|
name: "enableHa"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public ClusterForUpdate withEnableHa(Boolean enableHa)"
|
|
desc: "Set the enableHa property: If high availability (HA) is enabled or not for the cluster."
|
|
returns:
|
|
description: "the ClusterForUpdate object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate?alt=com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate&text=ClusterForUpdate\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withEnableShardsOnCoordinator(java.lang.Boolean)"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withEnableShardsOnCoordinator(Boolean enableShardsOnCoordinator)"
|
|
name: "withEnableShardsOnCoordinator(Boolean enableShardsOnCoordinator)"
|
|
nameWithType: "ClusterForUpdate.withEnableShardsOnCoordinator(Boolean enableShardsOnCoordinator)"
|
|
summary: "Set the enable<wbr>Shards<wbr>OnCoordinator property: If distributed tables are placed on coordinator or not."
|
|
parameters:
|
|
- description: "the enableShardsOnCoordinator value to set."
|
|
name: "enableShardsOnCoordinator"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public ClusterForUpdate withEnableShardsOnCoordinator(Boolean enableShardsOnCoordinator)"
|
|
desc: "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."
|
|
returns:
|
|
description: "the ClusterForUpdate object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate?alt=com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate&text=ClusterForUpdate\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withMaintenanceWindow(com.azure.resourcemanager.cosmosdbforpostgresql.models.MaintenanceWindow)"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withMaintenanceWindow(MaintenanceWindow maintenanceWindow)"
|
|
name: "withMaintenanceWindow(MaintenanceWindow maintenanceWindow)"
|
|
nameWithType: "ClusterForUpdate.withMaintenanceWindow(MaintenanceWindow maintenanceWindow)"
|
|
summary: "Set the maintenance<wbr>Window property: Maintenance window of a cluster."
|
|
parameters:
|
|
- description: "the maintenanceWindow value to set."
|
|
name: "maintenanceWindow"
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmosdbforpostgresql.models.MaintenanceWindow?alt=com.azure.resourcemanager.cosmosdbforpostgresql.models.MaintenanceWindow&text=MaintenanceWindow\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ClusterForUpdate withMaintenanceWindow(MaintenanceWindow maintenanceWindow)"
|
|
desc: "Set the maintenanceWindow property: Maintenance window of a cluster."
|
|
returns:
|
|
description: "the ClusterForUpdate object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate?alt=com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate&text=ClusterForUpdate\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withNodeCount(java.lang.Integer)"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withNodeCount(Integer nodeCount)"
|
|
name: "withNodeCount(Integer nodeCount)"
|
|
nameWithType: "ClusterForUpdate.withNodeCount(Integer nodeCount)"
|
|
summary: "Set the node<wbr>Count property: Worker node count of the cluster."
|
|
parameters:
|
|
- description: "the nodeCount value to set."
|
|
name: "nodeCount"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public ClusterForUpdate withNodeCount(Integer nodeCount)"
|
|
desc: "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."
|
|
returns:
|
|
description: "the ClusterForUpdate object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate?alt=com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate&text=ClusterForUpdate\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withNodeServerEdition(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withNodeServerEdition(String nodeServerEdition)"
|
|
name: "withNodeServerEdition(String nodeServerEdition)"
|
|
nameWithType: "ClusterForUpdate.withNodeServerEdition(String nodeServerEdition)"
|
|
summary: "Set the node<wbr>Server<wbr>Edition property: The edition of a node (default: Memory<wbr>Optimized)."
|
|
parameters:
|
|
- description: "the nodeServerEdition value to set."
|
|
name: "nodeServerEdition"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ClusterForUpdate withNodeServerEdition(String nodeServerEdition)"
|
|
desc: "Set the nodeServerEdition property: The edition of a node (default: MemoryOptimized)."
|
|
returns:
|
|
description: "the ClusterForUpdate object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate?alt=com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate&text=ClusterForUpdate\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withNodeStorageQuotaInMb(java.lang.Integer)"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withNodeStorageQuotaInMb(Integer nodeStorageQuotaInMb)"
|
|
name: "withNodeStorageQuotaInMb(Integer nodeStorageQuotaInMb)"
|
|
nameWithType: "ClusterForUpdate.withNodeStorageQuotaInMb(Integer nodeStorageQuotaInMb)"
|
|
summary: "Set the node<wbr>Storage<wbr>Quota<wbr>InMb property: The storage in MB on each worker node."
|
|
parameters:
|
|
- description: "the nodeStorageQuotaInMb value to set."
|
|
name: "nodeStorageQuotaInMb"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public ClusterForUpdate withNodeStorageQuotaInMb(Integer nodeStorageQuotaInMb)"
|
|
desc: "Set the nodeStorageQuotaInMb property: The storage in MB on each worker node."
|
|
returns:
|
|
description: "the ClusterForUpdate object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate?alt=com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate&text=ClusterForUpdate\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withNodeVCores(java.lang.Integer)"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withNodeVCores(Integer nodeVCores)"
|
|
name: "withNodeVCores(Integer nodeVCores)"
|
|
nameWithType: "ClusterForUpdate.withNodeVCores(Integer nodeVCores)"
|
|
summary: "Set the node<wbr>VCores property: The compute in v<wbr>Cores on each worker node (max: 104)."
|
|
parameters:
|
|
- description: "the nodeVCores value to set."
|
|
name: "nodeVCores"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public ClusterForUpdate withNodeVCores(Integer nodeVCores)"
|
|
desc: "Set the nodeVCores property: The compute in vCores on each worker node (max: 104)."
|
|
returns:
|
|
description: "the ClusterForUpdate object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate?alt=com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate&text=ClusterForUpdate\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withPostgresqlVersion(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withPostgresqlVersion(String postgresqlVersion)"
|
|
name: "withPostgresqlVersion(String postgresqlVersion)"
|
|
nameWithType: "ClusterForUpdate.withPostgresqlVersion(String postgresqlVersion)"
|
|
summary: "Set the postgresql<wbr>Version property: The major PostgreSQL version on all cluster servers."
|
|
parameters:
|
|
- description: "the postgresqlVersion value to set."
|
|
name: "postgresqlVersion"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ClusterForUpdate withPostgresqlVersion(String postgresqlVersion)"
|
|
desc: "Set the postgresqlVersion property: The major PostgreSQL version on all cluster servers."
|
|
returns:
|
|
description: "the ClusterForUpdate object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate?alt=com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate&text=ClusterForUpdate\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withPreferredPrimaryZone(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withPreferredPrimaryZone(String preferredPrimaryZone)"
|
|
name: "withPreferredPrimaryZone(String preferredPrimaryZone)"
|
|
nameWithType: "ClusterForUpdate.withPreferredPrimaryZone(String preferredPrimaryZone)"
|
|
summary: "Set the preferred<wbr>Primary<wbr>Zone property: Preferred primary availability zone (AZ) for all cluster servers."
|
|
parameters:
|
|
- description: "the preferredPrimaryZone value to set."
|
|
name: "preferredPrimaryZone"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ClusterForUpdate withPreferredPrimaryZone(String preferredPrimaryZone)"
|
|
desc: "Set the preferredPrimaryZone property: Preferred primary availability zone (AZ) for all cluster servers."
|
|
returns:
|
|
description: "the ClusterForUpdate object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate?alt=com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate&text=ClusterForUpdate\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withTags(java.util.Map<java.lang.String,java.lang.String>)"
|
|
fullName: "com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate.withTags(Map<String,String> tags)"
|
|
name: "withTags(Map<String,String> tags)"
|
|
nameWithType: "ClusterForUpdate.withTags(Map<String,String> tags)"
|
|
summary: "Set the tags property: Application-specific metadata in the form of key-value pairs."
|
|
parameters:
|
|
- description: "the tags value to set."
|
|
name: "tags"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
syntax: "public ClusterForUpdate withTags(Map<String,String> tags)"
|
|
desc: "Set the tags property: Application-specific metadata in the form of key-value pairs."
|
|
returns:
|
|
description: "the ClusterForUpdate object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate?alt=com.azure.resourcemanager.cosmosdbforpostgresql.models.ClusterForUpdate&text=ClusterForUpdate\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Represents a cluster for update."
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.cosmosdbforpostgresql.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-cosmosdbforpostgresql:1.0.0
|