Interface AzureControlPlaneOrBuilder (0.45.0)

Version 0.45.0

• 0.52.0 (latest)
• 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 AzureControlPlaneOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsTags(String key)

public abstract 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
Name	Description
key	String

Returns
Type	Description
boolean

getConfigEncryption()

public abstract AzureConfigEncryption getConfigEncryption()

Optional. Configuration related to vm config encryption.

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

Returns
Type	Description
AzureConfigEncryption	The configEncryption.

getConfigEncryptionOrBuilder()

public abstract AzureConfigEncryptionOrBuilder getConfigEncryptionOrBuilder()

Optional. Configuration related to vm config encryption.

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

Returns
Type	Description
AzureConfigEncryptionOrBuilder

getDatabaseEncryption()

public abstract AzureDatabaseEncryption getDatabaseEncryption()

Optional. Configuration related to application-layer secrets encryption.

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

Returns
Type	Description
AzureDatabaseEncryption	The databaseEncryption.

getDatabaseEncryptionOrBuilder()

public abstract AzureDatabaseEncryptionOrBuilder getDatabaseEncryptionOrBuilder()

Optional. Configuration related to application-layer secrets encryption.

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

Returns
Type	Description
AzureDatabaseEncryptionOrBuilder

getEndpointSubnetId()

public abstract 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
Type	Description
String	The endpointSubnetId.

getEndpointSubnetIdBytes()

public abstract 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
Type	Description
ByteString	The bytes for endpointSubnetId.

getMainVolume()

public abstract 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
Type	Description
AzureDiskTemplate	The mainVolume.

getMainVolumeOrBuilder()

public abstract 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
Type	Description
AzureDiskTemplateOrBuilder

getProxyConfig()

public abstract AzureProxyConfig getProxyConfig()

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

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

Returns
Type	Description
AzureProxyConfig	The proxyConfig.

getProxyConfigOrBuilder()

public abstract AzureProxyConfigOrBuilder getProxyConfigOrBuilder()

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

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

Returns
Type	Description
AzureProxyConfigOrBuilder

getReplicaPlacements(int index)

public abstract 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
Name	Description
index	int

Returns
Type	Description
ReplicaPlacement

getReplicaPlacementsCount()

public abstract 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
Type	Description
int

getReplicaPlacementsList()

public abstract 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
Type	Description
List<ReplicaPlacement>

getReplicaPlacementsOrBuilder(int index)

public abstract 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
Name	Description
index	int

Returns
Type	Description
ReplicaPlacementOrBuilder

getReplicaPlacementsOrBuilderList()

public abstract 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
Type	Description
List<? extends com.google.cloud.gkemulticloud.v1.ReplicaPlacementOrBuilder>

getRootVolume()

public abstract 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
Type	Description
AzureDiskTemplate	The rootVolume.

getRootVolumeOrBuilder()

public abstract 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
Type	Description
AzureDiskTemplateOrBuilder

getSshConfig()

public abstract 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
Type	Description
AzureSshConfig	The sshConfig.

getSshConfigOrBuilder()

public abstract 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
Type	Description
AzureSshConfigOrBuilder

getSubnetId()

public abstract 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
Type	Description
String	The subnetId.

getSubnetIdBytes()

public abstract 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
Type	Description
ByteString	The bytes for subnetId.

getTags() (deprecated)

public abstract Map<String,String> getTags()

Use #getTagsMap() instead.

Returns
Type	Description
Map<String,String>

getTagsCount()

public abstract 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
Type	Description
int

getTagsMap()

public abstract 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
Type	Description
Map<String,String>

getTagsOrDefault(String key, String defaultValue)

public abstract 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
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getTagsOrThrow(String key)

public abstract 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
Name	Description
key	String

Returns
Type	Description
String

getVersion()

public abstract 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
Type	Description
String	The version.

getVersionBytes()

public abstract 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
Type	Description
ByteString	The bytes for version.

getVmSize()

public abstract 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
Type	Description
String	The vmSize.

getVmSizeBytes()

public abstract 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
Type	Description
ByteString	The bytes for vmSize.

hasConfigEncryption()

public abstract boolean hasConfigEncryption()

Optional. Configuration related to vm config encryption.

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

Returns
Type	Description
boolean	Whether the configEncryption field is set.

hasDatabaseEncryption()

public abstract boolean hasDatabaseEncryption()

Optional. Configuration related to application-layer secrets encryption.

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

Returns
Type	Description
boolean	Whether the databaseEncryption field is set.

hasMainVolume()

public abstract 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
Type	Description
boolean	Whether the mainVolume field is set.

hasProxyConfig()

public abstract boolean hasProxyConfig()

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

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

Returns
Type	Description
boolean	Whether the proxyConfig field is set.

hasRootVolume()

public abstract 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
Type	Description
boolean	Whether the rootVolume field is set.

hasSshConfig()

public abstract 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
Type	Description
boolean	Whether the sshConfig field is set.