Class AwsNodePool (0.5.0)

public final class AwsNodePool extends GeneratedMessageV3 implements AwsNodePoolOrBuilder

An Anthos node pool running on AWS.

Protobuf type google.cloud.gkemulticloud.v1.AwsNodePool

Static Fields

ANNOTATIONS_FIELD_NUMBER

public static final int ANNOTATIONS_FIELD_NUMBER
Field Value
TypeDescription
int

AUTOSCALING_FIELD_NUMBER

public static final int AUTOSCALING_FIELD_NUMBER
Field Value
TypeDescription
int

CONFIG_FIELD_NUMBER

public static final int CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
TypeDescription
int

MAX_PODS_CONSTRAINT_FIELD_NUMBER

public static final int MAX_PODS_CONSTRAINT_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

RECONCILING_FIELD_NUMBER

public static final int RECONCILING_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

SUBNET_ID_FIELD_NUMBER

public static final int SUBNET_ID_FIELD_NUMBER
Field Value
TypeDescription
int

UID_FIELD_NUMBER

public static final int UID_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

VERSION_FIELD_NUMBER

public static final int VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static AwsNodePool getDefaultInstance()
Returns
TypeDescription
AwsNodePool

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static AwsNodePool.Builder newBuilder()
Returns
TypeDescription
AwsNodePool.Builder

newBuilder(AwsNodePool prototype)

public static AwsNodePool.Builder newBuilder(AwsNodePool prototype)
Parameter
NameDescription
prototypeAwsNodePool
Returns
TypeDescription
AwsNodePool.Builder

parseDelimitedFrom(InputStream input)

public static AwsNodePool parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AwsNodePool
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AwsNodePool parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AwsNodePool
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static AwsNodePool parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
AwsNodePool
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AwsNodePool parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AwsNodePool
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AwsNodePool parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
AwsNodePool
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AwsNodePool parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AwsNodePool
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AwsNodePool parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
AwsNodePool
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AwsNodePool parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AwsNodePool
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static AwsNodePool parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AwsNodePool
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AwsNodePool parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AwsNodePool
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static AwsNodePool parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
AwsNodePool
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AwsNodePool parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AwsNodePool
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<AwsNodePool> parser()
Returns
TypeDescription
Parser<AwsNodePool>

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. Key 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 = 22 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAnnotations()

public Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
TypeDescription
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. Key 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 = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
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. Key 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 = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
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. Key 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 = 22 [(.google.api.field_behavior) = OPTIONAL];

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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. Key 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 = 22 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getAutoscaling()

public AwsNodePoolAutoscaling getAutoscaling()

Required. Autoscaler configuration for this node pool.

.google.cloud.gkemulticloud.v1.AwsNodePoolAutoscaling autoscaling = 25 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
AwsNodePoolAutoscaling

The autoscaling.

getAutoscalingOrBuilder()

public AwsNodePoolAutoscalingOrBuilder getAutoscalingOrBuilder()

Required. Autoscaler configuration for this node pool.

.google.cloud.gkemulticloud.v1.AwsNodePoolAutoscaling autoscaling = 25 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
AwsNodePoolAutoscalingOrBuilder

getConfig()

public AwsNodeConfig getConfig()

Required. The configuration of the node pool.

.google.cloud.gkemulticloud.v1.AwsNodeConfig config = 28 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
AwsNodeConfig

The config.

getConfigOrBuilder()

public AwsNodeConfigOrBuilder getConfigOrBuilder()

Required. The configuration of the node pool.

.google.cloud.gkemulticloud.v1.AwsNodeConfig config = 28 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
AwsNodeConfigOrBuilder

getCreateTime()

public Timestamp getCreateTime()

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

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

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

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

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

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public AwsNodePool getDefaultInstanceForType()
Returns
TypeDescription
AwsNodePool

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 = 21;

Returns
TypeDescription
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 = 21;

Returns
TypeDescription
ByteString

The bytes for etag.

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 = 27 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
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 = 27 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
MaxPodsConstraintOrBuilder

getName()

public String getName()

The name of this resource. Node pool names are formatted as projects/<project-number>/locations/<region>/awsClusters/<cluster-id>/awsNodePools/<node-pool-id>. For more details on Google Cloud resource names, see Resource Names

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name of this resource. Node pool names are formatted as projects/<project-number>/locations/<region>/awsClusters/<cluster-id>/awsNodePools/<node-pool-id>. For more details on Google Cloud resource names, see Resource Names

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<AwsNodePool> getParserForType()
Returns
TypeDescription
Parser<AwsNodePool>
Overrides

getReconciling()

public boolean getReconciling()

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

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

Returns
TypeDescription
boolean

The reconciling.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getState()

public AwsNodePool.State getState()

Output only. The lifecycle state of the node pool.

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

Returns
TypeDescription
AwsNodePool.State

The state.

getStateValue()

public int getStateValue()

Output only. The lifecycle state of the node pool.

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

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getSubnetId()

public String getSubnetId()

Required. The subnet where the node pool node run.

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

Returns
TypeDescription
String

The subnetId.

getSubnetIdBytes()

public ByteString getSubnetIdBytes()

Required. The subnet where the node pool node run.

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

Returns
TypeDescription
ByteString

The bytes for subnetId.

getUid()

public String getUid()

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

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

Returns
TypeDescription
String

The uid.

getUidBytes()

public ByteString getUidBytes()

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

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

Returns
TypeDescription
ByteString

The bytes for uid.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

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

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

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

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

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

Returns
TypeDescription
TimestampOrBuilder

getVersion()

public String getVersion()

Required. The Kubernetes version to run on this node pool (e.g. 1.19.10-gke.1000). You can list all supported versions on a given Google Cloud region by calling GetAwsServerConfig.

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

Returns
TypeDescription
String

The version.

getVersionBytes()

public ByteString getVersionBytes()

Required. The Kubernetes version to run on this node pool (e.g. 1.19.10-gke.1000). You can list all supported versions on a given Google Cloud region by calling GetAwsServerConfig.

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

Returns
TypeDescription
ByteString

The bytes for version.

hasAutoscaling()

public boolean hasAutoscaling()

Required. Autoscaler configuration for this node pool.

.google.cloud.gkemulticloud.v1.AwsNodePoolAutoscaling autoscaling = 25 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the autoscaling field is set.

hasConfig()

public boolean hasConfig()

Required. The configuration of the node pool.

.google.cloud.gkemulticloud.v1.AwsNodeConfig config = 28 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
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 = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the createTime 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 = 27 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
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 = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public AwsNodePool.Builder newBuilderForType()
Returns
TypeDescription
AwsNodePool.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AwsNodePool.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
AwsNodePool.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public AwsNodePool.Builder toBuilder()
Returns
TypeDescription
AwsNodePool.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException