Interface AwsNodeConfigOrBuilder (0.38.0)

Version 0.38.0

• 0.53.0 (latest)
• 0.52.0
• 0.51.0
• 0.50.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.6
• 0.1.0

public interface AwsNodeConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Optional. The initial labels assigned to nodes of this node pool. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

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

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

containsTags(String key)

public abstract boolean containsTags(String key)

Optional. Key/value metadata to assign to each underlying AWS resource. Specify at most 50 pairs containing alphanumerics, spaces, and symbols (.+-=_:@/). Keys can be up to 127 Unicode characters. Values can be up to 255 Unicode characters.

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

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAutoscalingMetricsCollection()

public abstract AwsAutoscalingGroupMetricsCollection getAutoscalingMetricsCollection()

Optional. Configuration related to CloudWatch metrics collection on the Auto Scaling group of the node pool.

When unspecified, metrics collection is disabled.

.google.cloud.gkemulticloud.v1.AwsAutoscalingGroupMetricsCollection autoscaling_metrics_collection = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AwsAutoscalingGroupMetricsCollection	The autoscalingMetricsCollection.

getAutoscalingMetricsCollectionOrBuilder()

public abstract AwsAutoscalingGroupMetricsCollectionOrBuilder getAutoscalingMetricsCollectionOrBuilder()

Optional. Configuration related to CloudWatch metrics collection on the Auto Scaling group of the node pool.

When unspecified, metrics collection is disabled.

.google.cloud.gkemulticloud.v1.AwsAutoscalingGroupMetricsCollection autoscaling_metrics_collection = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AwsAutoscalingGroupMetricsCollectionOrBuilder

getConfigEncryption()

public abstract AwsConfigEncryption getConfigEncryption()

Required. Config encryption for user data.

.google.cloud.gkemulticloud.v1.AwsConfigEncryption config_encryption = 13 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
AwsConfigEncryption	The configEncryption.

getConfigEncryptionOrBuilder()

public abstract AwsConfigEncryptionOrBuilder getConfigEncryptionOrBuilder()

Required. Config encryption for user data.

.google.cloud.gkemulticloud.v1.AwsConfigEncryption config_encryption = 13 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
AwsConfigEncryptionOrBuilder

getIamInstanceProfile()

public abstract String getIamInstanceProfile()

Required. The name or ARN of the AWS IAM role assigned to nodes in the pool.

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

Returns
Type	Description
String	The iamInstanceProfile.

getIamInstanceProfileBytes()

public abstract ByteString getIamInstanceProfileBytes()

Required. The name or ARN of the AWS IAM role assigned to nodes in the pool.

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

Returns
Type	Description
ByteString	The bytes for iamInstanceProfile.

getImageType()

public abstract String getImageType()

Optional. The OS image type to use on node pool instances. Can be unspecified, or have a value of ubuntu.

When unspecified, it defaults to ubuntu.

string image_type = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The imageType.

getImageTypeBytes()

public abstract ByteString getImageTypeBytes()

Optional. The OS image type to use on node pool instances. Can be unspecified, or have a value of ubuntu.

When unspecified, it defaults to ubuntu.

string image_type = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for imageType.

getInstancePlacement()

public abstract AwsInstancePlacement getInstancePlacement()

Optional. Placement related info for this node. When unspecified, the VPC's default tenancy will be used.

.google.cloud.gkemulticloud.v1.AwsInstancePlacement instance_placement = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AwsInstancePlacement	The instancePlacement.

getInstancePlacementOrBuilder()

public abstract AwsInstancePlacementOrBuilder getInstancePlacementOrBuilder()

Optional. Placement related info for this node. When unspecified, the VPC's default tenancy will be used.

.google.cloud.gkemulticloud.v1.AwsInstancePlacement instance_placement = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AwsInstancePlacementOrBuilder

getInstanceType()

public abstract String getInstanceType()

Optional. The EC2 instance type when creating on-Demand instances.

If unspecified during node pool creation, a default will be chosen based on the node pool version, and assigned to this field.

string instance_type = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The instanceType.

getInstanceTypeBytes()

public abstract ByteString getInstanceTypeBytes()

Optional. The EC2 instance type when creating on-Demand instances.

If unspecified during node pool creation, a default will be chosen based on the node pool version, and assigned to this field.

string instance_type = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for instanceType.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Optional. The initial labels assigned to nodes of this node pool. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

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

Returns
Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Optional. The initial labels assigned to nodes of this node pool. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

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

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Optional. The initial labels assigned to nodes of this node pool. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

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

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Optional. The initial labels assigned to nodes of this node pool. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

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

Parameter
Name	Description
key	String

Returns
Type	Description
String

getProxyConfig()

public abstract AwsProxyConfig getProxyConfig()

Optional. Proxy configuration for outbound HTTP(S) traffic.

.google.cloud.gkemulticloud.v1.AwsProxyConfig proxy_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AwsProxyConfig	The proxyConfig.

getProxyConfigOrBuilder()

public abstract AwsProxyConfigOrBuilder getProxyConfigOrBuilder()

Optional. Proxy configuration for outbound HTTP(S) traffic.

.google.cloud.gkemulticloud.v1.AwsProxyConfig proxy_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AwsProxyConfigOrBuilder

getRootVolume()

public abstract AwsVolumeTemplate getRootVolume()

Optional. Template for the root volume provisioned for node pool nodes. Volumes will be provisioned in the availability zone assigned to the node pool subnet.

When unspecified, it defaults to 32 GiB with the GP2 volume type.

.google.cloud.gkemulticloud.v1.AwsVolumeTemplate root_volume = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AwsVolumeTemplate	The rootVolume.

getRootVolumeOrBuilder()

public abstract AwsVolumeTemplateOrBuilder getRootVolumeOrBuilder()

Optional. Template for the root volume provisioned for node pool nodes. Volumes will be provisioned in the availability zone assigned to the node pool subnet.

When unspecified, it defaults to 32 GiB with the GP2 volume type.

.google.cloud.gkemulticloud.v1.AwsVolumeTemplate root_volume = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AwsVolumeTemplateOrBuilder

getSecurityGroupIds(int index)

public abstract String getSecurityGroupIds(int index)

Optional. The IDs of additional security groups to add to nodes in this pool. The manager will automatically create security groups with minimum rules needed for a functioning cluster.

repeated string security_group_ids = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The securityGroupIds at the given index.

getSecurityGroupIdsBytes(int index)

public abstract ByteString getSecurityGroupIdsBytes(int index)

Optional. The IDs of additional security groups to add to nodes in this pool. The manager will automatically create security groups with minimum rules needed for a functioning cluster.

repeated string security_group_ids = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the securityGroupIds at the given index.

getSecurityGroupIdsCount()

public abstract int getSecurityGroupIdsCount()

Optional. The IDs of additional security groups to add to nodes in this pool. The manager will automatically create security groups with minimum rules needed for a functioning cluster.

repeated string security_group_ids = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The count of securityGroupIds.

getSecurityGroupIdsList()

public abstract List<String> getSecurityGroupIdsList()

Optional. The IDs of additional security groups to add to nodes in this pool. The manager will automatically create security groups with minimum rules needed for a functioning cluster.

repeated string security_group_ids = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<String>	A list containing the securityGroupIds.

getSpotConfig()

public abstract SpotConfig getSpotConfig()

Optional. Configuration for provisioning EC2 Spot instances

When specified, the node pool will provision Spot instances from the set of spot_config.instance_types. This field is mutually exclusive with instance_type.

.google.cloud.gkemulticloud.v1.SpotConfig spot_config = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SpotConfig	The spotConfig.

getSpotConfigOrBuilder()

public abstract SpotConfigOrBuilder getSpotConfigOrBuilder()

Optional. Configuration for provisioning EC2 Spot instances

When specified, the node pool will provision Spot instances from the set of spot_config.instance_types. This field is mutually exclusive with instance_type.

.google.cloud.gkemulticloud.v1.SpotConfig spot_config = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SpotConfigOrBuilder

getSshConfig()

public abstract AwsSshConfig getSshConfig()

Optional. The SSH configuration.

.google.cloud.gkemulticloud.v1.AwsSshConfig ssh_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AwsSshConfig	The sshConfig.

getSshConfigOrBuilder()

public abstract AwsSshConfigOrBuilder getSshConfigOrBuilder()

Optional. The SSH configuration.

.google.cloud.gkemulticloud.v1.AwsSshConfig ssh_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AwsSshConfigOrBuilder

getTags() (deprecated)

public abstract Map<String,String> getTags()

Use #getTagsMap() instead.

Returns
Type	Description
Map<String,String>

getTagsCount()

public abstract int getTagsCount()

Optional. Key/value metadata to assign to each underlying AWS resource. Specify at most 50 pairs containing alphanumerics, spaces, and symbols (.+-=_:@/). Keys can be up to 127 Unicode characters. Values can be up to 255 Unicode characters.

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

Returns
Type	Description
int

getTagsMap()

public abstract Map<String,String> getTagsMap()

Optional. Key/value metadata to assign to each underlying AWS resource. Specify at most 50 pairs containing alphanumerics, spaces, and symbols (.+-=_:@/). Keys can be up to 127 Unicode characters. Values can be up to 255 Unicode characters.

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

Returns
Type	Description
Map<String,String>

getTagsOrDefault(String key, String defaultValue)

public abstract String getTagsOrDefault(String key, String defaultValue)

Optional. Key/value metadata to assign to each underlying AWS resource. Specify at most 50 pairs containing alphanumerics, spaces, and symbols (.+-=_:@/). Keys can be up to 127 Unicode characters. Values can be up to 255 Unicode characters.

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

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getTagsOrThrow(String key)

public abstract String getTagsOrThrow(String key)

Optional. Key/value metadata to assign to each underlying AWS resource. Specify at most 50 pairs containing alphanumerics, spaces, and symbols (.+-=_:@/). Keys can be up to 127 Unicode characters. Values can be up to 255 Unicode characters.

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

Parameter
Name	Description
key	String

Returns
Type	Description
String

getTaints(int index)

public abstract NodeTaint getTaints(int index)

Optional. The initial taints assigned to nodes of this node pool.

repeated .google.cloud.gkemulticloud.v1.NodeTaint taints = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
NodeTaint

getTaintsCount()

public abstract int getTaintsCount()

Optional. The initial taints assigned to nodes of this node pool.

repeated .google.cloud.gkemulticloud.v1.NodeTaint taints = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getTaintsList()

public abstract List<NodeTaint> getTaintsList()

Optional. The initial taints assigned to nodes of this node pool.

repeated .google.cloud.gkemulticloud.v1.NodeTaint taints = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<NodeTaint>

getTaintsOrBuilder(int index)

public abstract NodeTaintOrBuilder getTaintsOrBuilder(int index)

Optional. The initial taints assigned to nodes of this node pool.

repeated .google.cloud.gkemulticloud.v1.NodeTaint taints = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
NodeTaintOrBuilder

getTaintsOrBuilderList()

public abstract List<? extends NodeTaintOrBuilder> getTaintsOrBuilderList()

Optional. The initial taints assigned to nodes of this node pool.

repeated .google.cloud.gkemulticloud.v1.NodeTaint taints = 3 [(.google.api.field_behavior) = OPTIONAL];

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

hasAutoscalingMetricsCollection()

public abstract boolean hasAutoscalingMetricsCollection()

Optional. Configuration related to CloudWatch metrics collection on the Auto Scaling group of the node pool.

When unspecified, metrics collection is disabled.

.google.cloud.gkemulticloud.v1.AwsAutoscalingGroupMetricsCollection autoscaling_metrics_collection = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the autoscalingMetricsCollection field is set.

hasConfigEncryption()

public abstract boolean hasConfigEncryption()

Required. Config encryption for user data.

.google.cloud.gkemulticloud.v1.AwsConfigEncryption config_encryption = 13 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the configEncryption field is set.

hasInstancePlacement()

public abstract boolean hasInstancePlacement()

Optional. Placement related info for this node. When unspecified, the VPC's default tenancy will be used.

.google.cloud.gkemulticloud.v1.AwsInstancePlacement instance_placement = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the instancePlacement field is set.

hasProxyConfig()

public abstract boolean hasProxyConfig()

Optional. Proxy configuration for outbound HTTP(S) traffic.

.google.cloud.gkemulticloud.v1.AwsProxyConfig proxy_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the proxyConfig field is set.

hasRootVolume()

public abstract boolean hasRootVolume()

Optional. Template for the root volume provisioned for node pool nodes. Volumes will be provisioned in the availability zone assigned to the node pool subnet.

When unspecified, it defaults to 32 GiB with the GP2 volume type.

.google.cloud.gkemulticloud.v1.AwsVolumeTemplate root_volume = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the rootVolume field is set.

hasSpotConfig()

public abstract boolean hasSpotConfig()

Optional. Configuration for provisioning EC2 Spot instances

When specified, the node pool will provision Spot instances from the set of spot_config.instance_types. This field is mutually exclusive with instance_type.

.google.cloud.gkemulticloud.v1.SpotConfig spot_config = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the spotConfig field is set.

hasSshConfig()

public abstract boolean hasSshConfig()

Optional. The SSH configuration.

.google.cloud.gkemulticloud.v1.AwsSshConfig ssh_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the sshConfig field is set.