Class AzureNodePool (0.43.0)

public final class AzureNodePool extends GeneratedMessageV3 implements AzureNodePoolOrBuilder

An Anthos node pool running on Azure.

Protobuf type google.cloud.gkemulticloud.v1.AzureNodePool

Static Fields

ANNOTATIONS_FIELD_NUMBER

public static final int ANNOTATIONS_FIELD_NUMBER
Field Value
Type Description
int

AUTOSCALING_FIELD_NUMBER

public static final int AUTOSCALING_FIELD_NUMBER
Field Value
Type Description
int

AZURE_AVAILABILITY_ZONE_FIELD_NUMBER

public static final int AZURE_AVAILABILITY_ZONE_FIELD_NUMBER
Field Value
Type Description
int

CONFIG_FIELD_NUMBER

public static final int CONFIG_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

ERRORS_FIELD_NUMBER

public static final int ERRORS_FIELD_NUMBER
Field Value
Type Description
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

MANAGEMENT_FIELD_NUMBER

public static final int MANAGEMENT_FIELD_NUMBER
Field Value
Type Description
int

MAX_PODS_CONSTRAINT_FIELD_NUMBER

public static final int MAX_PODS_CONSTRAINT_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

RECONCILING_FIELD_NUMBER

public static final int RECONCILING_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

SUBNET_ID_FIELD_NUMBER

public static final int SUBNET_ID_FIELD_NUMBER
Field Value
Type Description
int

UID_FIELD_NUMBER

public static final int UID_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

VERSION_FIELD_NUMBER

public static final int VERSION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AzureNodePool getDefaultInstance()
Returns
Type Description
AzureNodePool

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AzureNodePool.Builder newBuilder()
Returns
Type Description
AzureNodePool.Builder

newBuilder(AzureNodePool prototype)

public static AzureNodePool.Builder newBuilder(AzureNodePool prototype)
Parameter
Name Description
prototype AzureNodePool
Returns
Type Description
AzureNodePool.Builder

parseDelimitedFrom(InputStream input)

public static AzureNodePool parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AzureNodePool
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AzureNodePool parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AzureNodePool
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AzureNodePool parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AzureNodePool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AzureNodePool parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AzureNodePool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AzureNodePool parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AzureNodePool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AzureNodePool parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AzureNodePool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AzureNodePool parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AzureNodePool
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AzureNodePool parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AzureNodePool
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AzureNodePool parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AzureNodePool
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AzureNodePool parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AzureNodePool
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AzureNodePool parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AzureNodePool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AzureNodePool parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AzureNodePool
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AzureNodePool> parser()
Returns
Type Description
Parser<AzureNodePool>

Methods

containsAnnotations(String key)

public 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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAnnotations() (deprecated)

public Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type Description
Map<String,String>

getAnnotationsCount()

public 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 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 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 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 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 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 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 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 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 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 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 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

getDefaultInstanceForType()

public AzureNodePool getDefaultInstanceForType()
Returns
Type Description
AzureNodePool

getErrors(int index)

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

getParserForType()

public Parser<AzureNodePool> getParserForType()
Returns
Type Description
Parser<AzureNodePool>
Overrides

getReconciling()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AzureNodePool.Builder newBuilderForType()
Returns
Type Description
AzureNodePool.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AzureNodePool.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AzureNodePool.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AzureNodePool.Builder toBuilder()
Returns
Type Description
AzureNodePool.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException