Class AzureControlPlane (0.35.0)

public final class AzureControlPlane extends GeneratedMessageV3 implements AzureControlPlaneOrBuilder

AzureControlPlane represents the control plane configurations.

Protobuf type google.cloud.gkemulticloud.v1.AzureControlPlane

Static Fields

CONFIG_ENCRYPTION_FIELD_NUMBER

public static final int CONFIG_ENCRYPTION_FIELD_NUMBER
Field Value
TypeDescription
int

DATABASE_ENCRYPTION_FIELD_NUMBER

public static final int DATABASE_ENCRYPTION_FIELD_NUMBER
Field Value
TypeDescription
int

ENDPOINT_SUBNET_ID_FIELD_NUMBER

public static final int ENDPOINT_SUBNET_ID_FIELD_NUMBER
Field Value
TypeDescription
int

MAIN_VOLUME_FIELD_NUMBER

public static final int MAIN_VOLUME_FIELD_NUMBER
Field Value
TypeDescription
int

PROXY_CONFIG_FIELD_NUMBER

public static final int PROXY_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

REPLICA_PLACEMENTS_FIELD_NUMBER

public static final int REPLICA_PLACEMENTS_FIELD_NUMBER
Field Value
TypeDescription
int

ROOT_VOLUME_FIELD_NUMBER

public static final int ROOT_VOLUME_FIELD_NUMBER
Field Value
TypeDescription
int

SSH_CONFIG_FIELD_NUMBER

public static final int SSH_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

SUBNET_ID_FIELD_NUMBER

public static final int SUBNET_ID_FIELD_NUMBER
Field Value
TypeDescription
int

TAGS_FIELD_NUMBER

public static final int TAGS_FIELD_NUMBER
Field Value
TypeDescription
int

VERSION_FIELD_NUMBER

public static final int VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

VM_SIZE_FIELD_NUMBER

public static final int VM_SIZE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static AzureControlPlane getDefaultInstance()
Returns
TypeDescription
AzureControlPlane

getDescriptor()

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

newBuilder()

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

newBuilder(AzureControlPlane prototype)

public static AzureControlPlane.Builder newBuilder(AzureControlPlane prototype)
Parameter
NameDescription
prototypeAzureControlPlane
Returns
TypeDescription
AzureControlPlane.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsTags(String key)

public boolean containsTags(String key)

Optional. A set of tags to apply to all underlying control plane Azure resources.

map<string, string> tags = 7 [(.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

getConfigEncryption()

public AzureConfigEncryption getConfigEncryption()

Optional. Configuration related to vm config encryption.

.google.cloud.gkemulticloud.v1.AzureConfigEncryption config_encryption = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
AzureConfigEncryption

The configEncryption.

getConfigEncryptionOrBuilder()

public AzureConfigEncryptionOrBuilder getConfigEncryptionOrBuilder()

Optional. Configuration related to vm config encryption.

.google.cloud.gkemulticloud.v1.AzureConfigEncryption config_encryption = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
AzureConfigEncryptionOrBuilder

getDatabaseEncryption()

public AzureDatabaseEncryption getDatabaseEncryption()

Optional. Configuration related to application-layer secrets encryption.

.google.cloud.gkemulticloud.v1.AzureDatabaseEncryption database_encryption = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
AzureDatabaseEncryption

The databaseEncryption.

getDatabaseEncryptionOrBuilder()

public AzureDatabaseEncryptionOrBuilder getDatabaseEncryptionOrBuilder()

Optional. Configuration related to application-layer secrets encryption.

.google.cloud.gkemulticloud.v1.AzureDatabaseEncryption database_encryption = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
AzureDatabaseEncryptionOrBuilder

getDefaultInstanceForType()

public AzureControlPlane getDefaultInstanceForType()
Returns
TypeDescription
AzureControlPlane

getEndpointSubnetId()

public String getEndpointSubnetId()

Optional. The ARM ID of the subnet where the control plane load balancer is deployed. When unspecified, it defaults to AzureControlPlane.subnet_id.

Example: "/subscriptions/d00494d6-6f3c-4280-bbb2-899e163d1d30/resourceGroups/anthos_cluster_gkeust4/providers/Microsoft.Network/virtualNetworks/gke-vnet-gkeust4/subnets/subnetid123"

string endpoint_subnet_id = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The endpointSubnetId.

getEndpointSubnetIdBytes()

public ByteString getEndpointSubnetIdBytes()

Optional. The ARM ID of the subnet where the control plane load balancer is deployed. When unspecified, it defaults to AzureControlPlane.subnet_id.

Example: "/subscriptions/d00494d6-6f3c-4280-bbb2-899e163d1d30/resourceGroups/anthos_cluster_gkeust4/providers/Microsoft.Network/virtualNetworks/gke-vnet-gkeust4/subnets/subnetid123"

string endpoint_subnet_id = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for endpointSubnetId.

getMainVolume()

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

When unspecified, it defaults to a 8-GiB Azure Disk.

.google.cloud.gkemulticloud.v1.AzureDiskTemplate main_volume = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
AzureDiskTemplate

The mainVolume.

getMainVolumeOrBuilder()

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

When unspecified, it defaults to a 8-GiB Azure Disk.

.google.cloud.gkemulticloud.v1.AzureDiskTemplate main_volume = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
AzureDiskTemplateOrBuilder

getParserForType()

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

getProxyConfig()

public AzureProxyConfig getProxyConfig()

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

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

Returns
TypeDescription
AzureProxyConfig

The proxyConfig.

getProxyConfigOrBuilder()

public AzureProxyConfigOrBuilder getProxyConfigOrBuilder()

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

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

Returns
TypeDescription
AzureProxyConfigOrBuilder

getReplicaPlacements(int index)

public ReplicaPlacement getReplicaPlacements(int index)

Optional. Configuration for where to place the control plane replicas.

Up to three replica placement instances can be specified. If replica_placements is set, the replica placement instances will be applied to the three control plane replicas as evenly as possible.

repeated .google.cloud.gkemulticloud.v1.ReplicaPlacement replica_placements = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint
Returns
TypeDescription
ReplicaPlacement

getReplicaPlacementsCount()

public int getReplicaPlacementsCount()

Optional. Configuration for where to place the control plane replicas.

Up to three replica placement instances can be specified. If replica_placements is set, the replica placement instances will be applied to the three control plane replicas as evenly as possible.

repeated .google.cloud.gkemulticloud.v1.ReplicaPlacement replica_placements = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

getReplicaPlacementsList()

public List<ReplicaPlacement> getReplicaPlacementsList()

Optional. Configuration for where to place the control plane replicas.

Up to three replica placement instances can be specified. If replica_placements is set, the replica placement instances will be applied to the three control plane replicas as evenly as possible.

repeated .google.cloud.gkemulticloud.v1.ReplicaPlacement replica_placements = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
List<ReplicaPlacement>

getReplicaPlacementsOrBuilder(int index)

public ReplicaPlacementOrBuilder getReplicaPlacementsOrBuilder(int index)

Optional. Configuration for where to place the control plane replicas.

Up to three replica placement instances can be specified. If replica_placements is set, the replica placement instances will be applied to the three control plane replicas as evenly as possible.

repeated .google.cloud.gkemulticloud.v1.ReplicaPlacement replica_placements = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint
Returns
TypeDescription
ReplicaPlacementOrBuilder

getReplicaPlacementsOrBuilderList()

public List<? extends ReplicaPlacementOrBuilder> getReplicaPlacementsOrBuilderList()

Optional. Configuration for where to place the control plane replicas.

Up to three replica placement instances can be specified. If replica_placements is set, the replica placement instances will be applied to the three control plane replicas as evenly as possible.

repeated .google.cloud.gkemulticloud.v1.ReplicaPlacement replica_placements = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
List<? extends com.google.cloud.gkemulticloud.v1.ReplicaPlacementOrBuilder>

getRootVolume()

public AzureDiskTemplate getRootVolume()

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

When unspecified, it defaults to 32-GiB Azure Disk.

.google.cloud.gkemulticloud.v1.AzureDiskTemplate root_volume = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
AzureDiskTemplate

The rootVolume.

getRootVolumeOrBuilder()

public AzureDiskTemplateOrBuilder getRootVolumeOrBuilder()

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

When unspecified, it defaults to 32-GiB Azure Disk.

.google.cloud.gkemulticloud.v1.AzureDiskTemplate root_volume = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
AzureDiskTemplateOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSshConfig()

public AzureSshConfig getSshConfig()

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

.google.cloud.gkemulticloud.v1.AzureSshConfig ssh_config = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
AzureSshConfig

The sshConfig.

getSshConfigOrBuilder()

public AzureSshConfigOrBuilder getSshConfigOrBuilder()

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

.google.cloud.gkemulticloud.v1.AzureSshConfig ssh_config = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
AzureSshConfigOrBuilder

getSubnetId()

public String getSubnetId()

Optional. The ARM ID of the default subnet for the control plane. The control plane VMs are deployed in this subnet, unless AzureControlPlane.replica_placements is specified. This subnet will also be used as default for AzureControlPlane.endpoint_subnet_id if AzureControlPlane.endpoint_subnet_id is not specified. Similarly it will be used as default for AzureClusterNetworking.service_load_balancer_subnet_id.

Example: /subscriptions/<subscription-id>/resourceGroups/<resource-group-id>/providers/Microsoft.Network/virtualNetworks/<vnet-id>/subnets/default.

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

Returns
TypeDescription
String

The subnetId.

getSubnetIdBytes()

public ByteString getSubnetIdBytes()

Optional. The ARM ID of the default subnet for the control plane. The control plane VMs are deployed in this subnet, unless AzureControlPlane.replica_placements is specified. This subnet will also be used as default for AzureControlPlane.endpoint_subnet_id if AzureControlPlane.endpoint_subnet_id is not specified. Similarly it will be used as default for AzureClusterNetworking.service_load_balancer_subnet_id.

Example: /subscriptions/<subscription-id>/resourceGroups/<resource-group-id>/providers/Microsoft.Network/virtualNetworks/<vnet-id>/subnets/default.

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

Returns
TypeDescription
ByteString

The bytes for subnetId.

getTags() (deprecated)

public Map<String,String> getTags()

Use #getTagsMap() instead.

Returns
TypeDescription
Map<String,String>

getTagsCount()

public int getTagsCount()

Optional. A set of tags to apply to all underlying control plane Azure resources.

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

Returns
TypeDescription
int

getTagsMap()

public Map<String,String> getTagsMap()

Optional. A set of tags to apply to all underlying control plane Azure resources.

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

Returns
TypeDescription
Map<String,String>

getTagsOrDefault(String key, String defaultValue)

public String getTagsOrDefault(String key, String defaultValue)

Optional. A set of tags to apply to all underlying control plane Azure resources.

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

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getTagsOrThrow(String key)

public String getTagsOrThrow(String key)

Optional. A set of tags to apply to all underlying control plane Azure resources.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getVersion()

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

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

Returns
TypeDescription
String

The version.

getVersionBytes()

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

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

Returns
TypeDescription
ByteString

The bytes for version.

getVmSize()

public String getVmSize()

Optional. The Azure VM size name. Example: Standard_DS2_v2.

For available VM sizes, see https://docs.microsoft.com/en-us/azure/virtual-machines/vm-naming-conventions.

When unspecified, it defaults to Standard_DS2_v2.

string vm_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The vmSize.

getVmSizeBytes()

public ByteString getVmSizeBytes()

Optional. The Azure VM size name. Example: Standard_DS2_v2.

For available VM sizes, see https://docs.microsoft.com/en-us/azure/virtual-machines/vm-naming-conventions.

When unspecified, it defaults to Standard_DS2_v2.

string vm_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for vmSize.

hasConfigEncryption()

public boolean hasConfigEncryption()

Optional. Configuration related to vm config encryption.

.google.cloud.gkemulticloud.v1.AzureConfigEncryption config_encryption = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the configEncryption field is set.

hasDatabaseEncryption()

public boolean hasDatabaseEncryption()

Optional. Configuration related to application-layer secrets encryption.

.google.cloud.gkemulticloud.v1.AzureDatabaseEncryption database_encryption = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the databaseEncryption field is set.

hasMainVolume()

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

When unspecified, it defaults to a 8-GiB Azure Disk.

.google.cloud.gkemulticloud.v1.AzureDiskTemplate main_volume = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the mainVolume field is set.

hasProxyConfig()

public boolean hasProxyConfig()

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

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

Returns
TypeDescription
boolean

Whether the proxyConfig field is set.

hasRootVolume()

public boolean hasRootVolume()

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

When unspecified, it defaults to 32-GiB Azure Disk.

.google.cloud.gkemulticloud.v1.AzureDiskTemplate root_volume = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the rootVolume field is set.

hasSshConfig()

public boolean hasSshConfig()

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

.google.cloud.gkemulticloud.v1.AzureSshConfig ssh_config = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the sshConfig field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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