Interface AzureNodePoolOrBuilder (0.43.0)

public interface AzureNodePoolOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAnnotations(String key)

public abstract boolean containsAnnotations(String key)

Optional. Annotations on the node pool.

This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Keys can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.

map<string, string> annotations = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getAnnotations() (deprecated)

public abstract Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type Description
Map<String,String>

getAnnotationsCount()

public abstract int getAnnotationsCount()

Optional. Annotations on the node pool.

This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Keys can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.

map<string, string> annotations = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getAnnotationsMap()

public abstract Map<String,String> getAnnotationsMap()

Optional. Annotations on the node pool.

This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Keys can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.

map<string, string> annotations = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

public abstract String getAnnotationsOrDefault(String key, String defaultValue)

Optional. Annotations on the node pool.

This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Keys can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.

map<string, string> annotations = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getAnnotationsOrThrow(String key)

public abstract String getAnnotationsOrThrow(String key)

Optional. Annotations on the node pool.

This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Keys can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.

map<string, string> annotations = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getAutoscaling()

public abstract AzureNodePoolAutoscaling getAutoscaling()

Required. Autoscaler configuration for this node pool.

.google.cloud.gkemulticloud.v1.AzureNodePoolAutoscaling autoscaling = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AzureNodePoolAutoscaling

The autoscaling.

getAutoscalingOrBuilder()

public abstract AzureNodePoolAutoscalingOrBuilder getAutoscalingOrBuilder()

Required. Autoscaler configuration for this node pool.

.google.cloud.gkemulticloud.v1.AzureNodePoolAutoscaling autoscaling = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AzureNodePoolAutoscalingOrBuilder

getAzureAvailabilityZone()

public abstract String getAzureAvailabilityZone()

Optional. The Azure availability zone of the nodes in this nodepool.

When unspecified, it defaults to 1.

string azure_availability_zone = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The azureAvailabilityZone.

getAzureAvailabilityZoneBytes()

public abstract ByteString getAzureAvailabilityZoneBytes()

Optional. The Azure availability zone of the nodes in this nodepool.

When unspecified, it defaults to 1.

string azure_availability_zone = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for azureAvailabilityZone.

getConfig()

public abstract AzureNodeConfig getConfig()

Required. The node configuration of the node pool.

.google.cloud.gkemulticloud.v1.AzureNodeConfig config = 22 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AzureNodeConfig

The config.

getConfigOrBuilder()

public abstract AzureNodeConfigOrBuilder getConfigOrBuilder()

Required. The node configuration of the node pool.

.google.cloud.gkemulticloud.v1.AzureNodeConfig config = 22 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AzureNodeConfigOrBuilder

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The time at which this node pool was created.

.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time at which this node pool was created.

.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getErrors(int index)

public abstract AzureNodePoolError getErrors(int index)

Output only. A set of errors found in the node pool.

repeated .google.cloud.gkemulticloud.v1.AzureNodePoolError errors = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
AzureNodePoolError

getErrorsCount()

public abstract int getErrorsCount()

Output only. A set of errors found in the node pool.

repeated .google.cloud.gkemulticloud.v1.AzureNodePoolError errors = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getErrorsList()

public abstract List<AzureNodePoolError> getErrorsList()

Output only. A set of errors found in the node pool.

repeated .google.cloud.gkemulticloud.v1.AzureNodePoolError errors = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<AzureNodePoolError>

getErrorsOrBuilder(int index)

public abstract AzureNodePoolErrorOrBuilder getErrorsOrBuilder(int index)

Output only. A set of errors found in the node pool.

repeated .google.cloud.gkemulticloud.v1.AzureNodePoolError errors = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
AzureNodePoolErrorOrBuilder

getErrorsOrBuilderList()

public abstract List<? extends AzureNodePoolErrorOrBuilder> getErrorsOrBuilderList()

Output only. A set of errors found in the node pool.

repeated .google.cloud.gkemulticloud.v1.AzureNodePoolError errors = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.gkemulticloud.v1.AzureNodePoolErrorOrBuilder>

getEtag()

public abstract String getEtag()

Allows clients to perform consistent read-modify-writes through optimistic concurrency control.

Can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

string etag = 12;

Returns
Type Description
String

The etag.

getEtagBytes()

public abstract ByteString getEtagBytes()

Allows clients to perform consistent read-modify-writes through optimistic concurrency control.

Can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

string etag = 12;

Returns
Type Description
ByteString

The bytes for etag.

getManagement()

public abstract AzureNodeManagement getManagement()

Optional. The Management configuration for this node pool.

.google.cloud.gkemulticloud.v1.AzureNodeManagement management = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AzureNodeManagement

The management.

getManagementOrBuilder()

public abstract AzureNodeManagementOrBuilder getManagementOrBuilder()

Optional. The Management configuration for this node pool.

.google.cloud.gkemulticloud.v1.AzureNodeManagement management = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AzureNodeManagementOrBuilder

getMaxPodsConstraint()

public abstract MaxPodsConstraint getMaxPodsConstraint()

Required. The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.

.google.cloud.gkemulticloud.v1.MaxPodsConstraint max_pods_constraint = 21 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
MaxPodsConstraint

The maxPodsConstraint.

getMaxPodsConstraintOrBuilder()

public abstract MaxPodsConstraintOrBuilder getMaxPodsConstraintOrBuilder()

Required. The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.

.google.cloud.gkemulticloud.v1.MaxPodsConstraint max_pods_constraint = 21 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
MaxPodsConstraintOrBuilder

getName()

public abstract String getName()

The name of this resource.

Node pool names are formatted as projects/<project-number>/locations/<region>/azureClusters/<cluster-id>/azureNodePools/<node-pool-id>.

For more details on Google Cloud resource names, see Resource Names

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

The name of this resource.

Node pool names are formatted as projects/<project-number>/locations/<region>/azureClusters/<cluster-id>/azureNodePools/<node-pool-id>.

For more details on Google Cloud resource names, see Resource Names

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getReconciling()

public abstract boolean getReconciling()

Output only. If set, there are currently pending changes to the node pool.

bool reconciling = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The reconciling.

getState()

public abstract AzureNodePool.State getState()

Output only. The current state of the node pool.

.google.cloud.gkemulticloud.v1.AzureNodePool.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AzureNodePool.State

The state.

getStateValue()

public abstract int getStateValue()

Output only. The current state of the node pool.

.google.cloud.gkemulticloud.v1.AzureNodePool.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getSubnetId()

public abstract String getSubnetId()

Required. The ARM ID of the subnet where the node pool VMs run. Make sure it's a subnet under the virtual network in the cluster configuration.

string subnet_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The subnetId.

getSubnetIdBytes()

public abstract ByteString getSubnetIdBytes()

Required. The ARM ID of the subnet where the node pool VMs run. Make sure it's a subnet under the virtual network in the cluster configuration.

string subnet_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for subnetId.

getUid()

public abstract String getUid()

Output only. A globally unique identifier for the node pool.

string uid = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The uid.

getUidBytes()

public abstract ByteString getUidBytes()

Output only. A globally unique identifier for the node pool.

string uid = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for uid.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. The time at which this node pool was last updated.

.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time at which this node pool was last updated.

.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getVersion()

public abstract String getVersion()

Required. The Kubernetes version (e.g. 1.19.10-gke.1000) running on this node pool.

string version = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The version.

getVersionBytes()

public abstract ByteString getVersionBytes()

Required. The Kubernetes version (e.g. 1.19.10-gke.1000) running on this node pool.

string version = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for version.

hasAutoscaling()

public abstract boolean hasAutoscaling()

Required. Autoscaler configuration for this node pool.

.google.cloud.gkemulticloud.v1.AzureNodePoolAutoscaling autoscaling = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the autoscaling field is set.

hasConfig()

public abstract boolean hasConfig()

Required. The node configuration of the node pool.

.google.cloud.gkemulticloud.v1.AzureNodeConfig config = 22 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the config field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The time at which this node pool was created.

.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasManagement()

public abstract boolean hasManagement()

Optional. The Management configuration for this node pool.

.google.cloud.gkemulticloud.v1.AzureNodeManagement management = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the management field is set.

hasMaxPodsConstraint()

public abstract boolean hasMaxPodsConstraint()

Required. The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.

.google.cloud.gkemulticloud.v1.MaxPodsConstraint max_pods_constraint = 21 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the maxPodsConstraint field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. The time at which this node pool was last updated.

.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.