Package com.google.cloud.gkemulticloud.v1

Interface AwsControlPlaneOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

AwsControlPlane, AwsControlPlane.Builder

public interface AwsControlPlaneOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method	Description
boolean	containsTags(String key)	Optional.
AwsServicesAuthentication	getAwsServicesAuthentication()	Required.
AwsServicesAuthenticationOrBuilder	getAwsServicesAuthenticationOrBuilder()	Required.
AwsConfigEncryption	getConfigEncryption()	Required.
AwsConfigEncryptionOrBuilder	getConfigEncryptionOrBuilder()	Required.
AwsDatabaseEncryption	getDatabaseEncryption()	Required.
AwsDatabaseEncryptionOrBuilder	getDatabaseEncryptionOrBuilder()	Required.
String	getIamInstanceProfile()	Required.
com.google.protobuf.ByteString	getIamInstanceProfileBytes()	Required.
AwsInstancePlacement	getInstancePlacement()	Optional.
AwsInstancePlacementOrBuilder	getInstancePlacementOrBuilder()	Optional.
String	getInstanceType()	Optional.
com.google.protobuf.ByteString	getInstanceTypeBytes()	Optional.
AwsVolumeTemplate	getMainVolume()	Optional.
AwsVolumeTemplateOrBuilder	getMainVolumeOrBuilder()	Optional.
AwsProxyConfig	getProxyConfig()	Optional.
AwsProxyConfigOrBuilder	getProxyConfigOrBuilder()	Optional.
AwsVolumeTemplate	getRootVolume()	Optional.
AwsVolumeTemplateOrBuilder	getRootVolumeOrBuilder()	Optional.
String	getSecurityGroupIds(int index)	Optional.
com.google.protobuf.ByteString	getSecurityGroupIdsBytes(int index)	Optional.
int	getSecurityGroupIdsCount()	Optional.
List<String>	getSecurityGroupIdsList()	Optional.
AwsSshConfig	getSshConfig()	Optional.
AwsSshConfigOrBuilder	getSshConfigOrBuilder()	Optional.
String	getSubnetIds(int index)	Required.
com.google.protobuf.ByteString	getSubnetIdsBytes(int index)	Required.
int	getSubnetIdsCount()	Required.
List<String>	getSubnetIdsList()	Required.
Map<String,String>	getTags()	Deprecated.
int	getTagsCount()	Optional.
Map<String,String>	getTagsMap()	Optional.
String	getTagsOrDefault(String key, String defaultValue)	Optional.
String	getTagsOrThrow(String key)	Optional.
String	getVersion()	Required.
com.google.protobuf.ByteString	getVersionBytes()	Required.
boolean	hasAwsServicesAuthentication()	Required.
boolean	hasConfigEncryption()	Required.
boolean	hasDatabaseEncryption()	Required.
boolean	hasInstancePlacement()	Optional.
boolean	hasMainVolume()	Optional.
boolean	hasProxyConfig()	Optional.
boolean	hasRootVolume()	Optional.
boolean	hasSshConfig()	Optional.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Detail

getVersion

String getVersion()

 Required. The Kubernetes version to run on control plane replicas
 (e.g. `1.19.10-gke.1000`).

 You can list all supported versions on a given Google Cloud region by
 calling
 [GetAwsServerConfig][google.cloud.gkemulticloud.v1.AwsClusters.GetAwsServerConfig].
 

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

Returns:

The version.

getVersionBytes

com.google.protobuf.ByteString getVersionBytes()

 Required. The Kubernetes version to run on control plane replicas
 (e.g. `1.19.10-gke.1000`).

 You can list all supported versions on a given Google Cloud region by
 calling
 [GetAwsServerConfig][google.cloud.gkemulticloud.v1.AwsClusters.GetAwsServerConfig].
 

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

Returns:

The bytes for version.

getInstanceType

String getInstanceType()

 Optional. The AWS instance type.

 When unspecified, it uses a default based on the cluster's version.
 

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

Returns:

The instanceType.

getInstanceTypeBytes

com.google.protobuf.ByteString getInstanceTypeBytes()

 Optional. The AWS instance type.

 When unspecified, it uses a default based on the cluster's version.
 

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

Returns:

The bytes for instanceType.

hasSshConfig

boolean hasSshConfig()

 Optional. SSH configuration for how to access the underlying control plane
 machines.
 

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

Returns:

Whether the sshConfig field is set.

getSshConfig

AwsSshConfig getSshConfig()

 Optional. SSH configuration for how to access the underlying control plane
 machines.
 

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

Returns:

The sshConfig.

getSshConfigOrBuilder

AwsSshConfigOrBuilder getSshConfigOrBuilder()

 Optional. SSH configuration for how to access the underlying control plane
 machines.
 

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

getSubnetIdsList

List<String> getSubnetIdsList()

 Required. The list of subnets where control plane replicas will run.
 A replica will be provisioned on each subnet and up to three values
 can be provided.
 Each subnet must be in a different AWS Availability Zone (AZ).
 

repeated string subnet_ids = 4 [(.google.api.field_behavior) = REQUIRED];

Returns:

A list containing the subnetIds.

getSubnetIdsCount

int getSubnetIdsCount()

 Required. The list of subnets where control plane replicas will run.
 A replica will be provisioned on each subnet and up to three values
 can be provided.
 Each subnet must be in a different AWS Availability Zone (AZ).
 

repeated string subnet_ids = 4 [(.google.api.field_behavior) = REQUIRED];

Returns:

The count of subnetIds.

getSubnetIds

String getSubnetIds(int index)

 Required. The list of subnets where control plane replicas will run.
 A replica will be provisioned on each subnet and up to three values
 can be provided.
 Each subnet must be in a different AWS Availability Zone (AZ).
 

repeated string subnet_ids = 4 [(.google.api.field_behavior) = REQUIRED];

Parameters:

index - The index of the element to return.

Returns:

The subnetIds at the given index.

getSubnetIdsBytes

com.google.protobuf.ByteString getSubnetIdsBytes(int index)

 Required. The list of subnets where control plane replicas will run.
 A replica will be provisioned on each subnet and up to three values
 can be provided.
 Each subnet must be in a different AWS Availability Zone (AZ).
 

repeated string subnet_ids = 4 [(.google.api.field_behavior) = REQUIRED];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the subnetIds at the given index.

getSecurityGroupIdsList

List<String> getSecurityGroupIdsList()

 Optional. The IDs of additional security groups to add to control plane
 replicas. The Anthos Multi-Cloud API will automatically create and manage
 security groups with the minimum rules needed for a functioning cluster.
 

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

Returns:

A list containing the securityGroupIds.

getSecurityGroupIdsCount

int getSecurityGroupIdsCount()

 Optional. The IDs of additional security groups to add to control plane
 replicas. The Anthos Multi-Cloud API will automatically create and manage
 security groups with the minimum rules needed for a functioning cluster.
 

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

Returns:

The count of securityGroupIds.

getSecurityGroupIds

String getSecurityGroupIds(int index)

 Optional. The IDs of additional security groups to add to control plane
 replicas. The Anthos Multi-Cloud API will automatically create and manage
 security groups with the minimum rules needed for a functioning cluster.
 

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

Parameters:

index - The index of the element to return.

Returns:

The securityGroupIds at the given index.

getSecurityGroupIdsBytes

com.google.protobuf.ByteString getSecurityGroupIdsBytes(int index)

 Optional. The IDs of additional security groups to add to control plane
 replicas. The Anthos Multi-Cloud API will automatically create and manage
 security groups with the minimum rules needed for a functioning cluster.
 

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

Parameters:

index - The index of the value to return.

Returns:

The bytes of the securityGroupIds at the given index.

getIamInstanceProfile

String getIamInstanceProfile()

 Required. The name or ARN of the AWS IAM instance profile to assign to each
 control plane replica.
 

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

Returns:

The iamInstanceProfile.

getIamInstanceProfileBytes

com.google.protobuf.ByteString getIamInstanceProfileBytes()

 Required. The name or ARN of the AWS IAM instance profile to assign to each
 control plane replica.
 

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

Returns:

The bytes for iamInstanceProfile.

hasRootVolume

boolean hasRootVolume()

 Optional. Configuration related to the root volume provisioned for each
 control plane replica.

 Volumes will be provisioned in the availability zone associated
 with the corresponding subnet.

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

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

Returns:

Whether the rootVolume field is set.

getRootVolume

AwsVolumeTemplate getRootVolume()

 Optional. Configuration related to the root volume provisioned for each
 control plane replica.

 Volumes will be provisioned in the availability zone associated
 with the corresponding subnet.

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

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

Returns:

The rootVolume.

getRootVolumeOrBuilder

AwsVolumeTemplateOrBuilder getRootVolumeOrBuilder()

 Optional. Configuration related to the root volume provisioned for each
 control plane replica.

 Volumes will be provisioned in the availability zone associated
 with the corresponding subnet.

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

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

hasMainVolume

boolean hasMainVolume()

 Optional. Configuration related to the main volume provisioned for each
 control plane replica.
 The main volume is in charge of storing all of the cluster's etcd state.

 Volumes will be provisioned in the availability zone associated
 with the corresponding subnet.

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

.google.cloud.gkemulticloud.v1.AwsVolumeTemplate main_volume = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the mainVolume field is set.

getMainVolume

AwsVolumeTemplate getMainVolume()

 Optional. Configuration related to the main volume provisioned for each
 control plane replica.
 The main volume is in charge of storing all of the cluster's etcd state.

 Volumes will be provisioned in the availability zone associated
 with the corresponding subnet.

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

.google.cloud.gkemulticloud.v1.AwsVolumeTemplate main_volume = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The mainVolume.

getMainVolumeOrBuilder

AwsVolumeTemplateOrBuilder getMainVolumeOrBuilder()

 Optional. Configuration related to the main volume provisioned for each
 control plane replica.
 The main volume is in charge of storing all of the cluster's etcd state.

 Volumes will be provisioned in the availability zone associated
 with the corresponding subnet.

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

.google.cloud.gkemulticloud.v1.AwsVolumeTemplate main_volume = 9 [(.google.api.field_behavior) = OPTIONAL];

hasDatabaseEncryption

boolean hasDatabaseEncryption()

 Required. The ARN of the AWS KMS key used to encrypt cluster secrets.
 

.google.cloud.gkemulticloud.v1.AwsDatabaseEncryption database_encryption = 10 [(.google.api.field_behavior) = REQUIRED];

Returns:

Whether the databaseEncryption field is set.

getDatabaseEncryption

AwsDatabaseEncryption getDatabaseEncryption()

 Required. The ARN of the AWS KMS key used to encrypt cluster secrets.
 

.google.cloud.gkemulticloud.v1.AwsDatabaseEncryption database_encryption = 10 [(.google.api.field_behavior) = REQUIRED];

Returns:

The databaseEncryption.

getDatabaseEncryptionOrBuilder

AwsDatabaseEncryptionOrBuilder getDatabaseEncryptionOrBuilder()

 Required. The ARN of the AWS KMS key used to encrypt cluster secrets.
 

.google.cloud.gkemulticloud.v1.AwsDatabaseEncryption database_encryption = 10 [(.google.api.field_behavior) = REQUIRED];

getTagsCount

int getTagsCount()

 Optional. A set of AWS resource tags to propagate to all underlying managed
 AWS resources.

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

containsTags

boolean containsTags(String key)

 Optional. A set of AWS resource tags to propagate to all underlying managed
 AWS resources.

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

getTags

@Deprecated
Map<String,String> getTags()

Deprecated.

Use getTagsMap() instead.

getTagsMap

Map<String,String> getTagsMap()

 Optional. A set of AWS resource tags to propagate to all underlying managed
 AWS resources.

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

getTagsOrDefault

String getTagsOrDefault(String key,
                        String defaultValue)

 Optional. A set of AWS resource tags to propagate to all underlying managed
 AWS resources.

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

getTagsOrThrow

String getTagsOrThrow(String key)

 Optional. A set of AWS resource tags to propagate to all underlying managed
 AWS resources.

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

hasAwsServicesAuthentication

boolean hasAwsServicesAuthentication()

 Required. Authentication configuration for management of AWS resources.
 

.google.cloud.gkemulticloud.v1.AwsServicesAuthentication aws_services_authentication = 12 [(.google.api.field_behavior) = REQUIRED];

Returns:

Whether the awsServicesAuthentication field is set.

getAwsServicesAuthentication

AwsServicesAuthentication getAwsServicesAuthentication()

 Required. Authentication configuration for management of AWS resources.
 

.google.cloud.gkemulticloud.v1.AwsServicesAuthentication aws_services_authentication = 12 [(.google.api.field_behavior) = REQUIRED];

Returns:

The awsServicesAuthentication.

getAwsServicesAuthenticationOrBuilder

AwsServicesAuthenticationOrBuilder getAwsServicesAuthenticationOrBuilder()

 Required. Authentication configuration for management of AWS resources.
 

.google.cloud.gkemulticloud.v1.AwsServicesAuthentication aws_services_authentication = 12 [(.google.api.field_behavior) = REQUIRED];

hasProxyConfig

boolean hasProxyConfig()

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

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

Returns:

Whether the proxyConfig field is set.

getProxyConfig

AwsProxyConfig getProxyConfig()

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

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

Returns:

The proxyConfig.

getProxyConfigOrBuilder

AwsProxyConfigOrBuilder getProxyConfigOrBuilder()

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

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

hasConfigEncryption

boolean hasConfigEncryption()

 Required. Config encryption for user data.
 

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

Returns:

Whether the configEncryption field is set.

getConfigEncryption

AwsConfigEncryption getConfigEncryption()

 Required. Config encryption for user data.
 

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

Returns:

The configEncryption.

getConfigEncryptionOrBuilder

AwsConfigEncryptionOrBuilder getConfigEncryptionOrBuilder()

 Required. Config encryption for user data.
 

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

hasInstancePlacement

boolean hasInstancePlacement()

 Optional. The placement to use on control plane instances.
 When unspecified, the VPC's default tenancy will be used.
 

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

Returns:

Whether the instancePlacement field is set.

getInstancePlacement

AwsInstancePlacement getInstancePlacement()

 Optional. The placement to use on control plane instances.
 When unspecified, the VPC's default tenancy will be used.
 

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

Returns:

The instancePlacement.

getInstancePlacementOrBuilder

AwsInstancePlacementOrBuilder getInstancePlacementOrBuilder()

 Optional. The placement to use on control plane instances.
 When unspecified, the VPC's default tenancy will be used.
 

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