Interface AzureClusterOrBuilder (0.17.0)

public interface AzureClusterOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAnnotations(String key)

public abstract boolean containsAnnotations(String key)

Optional. Annotations on the cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Keys 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 = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getAnnotations()

public abstract Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
TypeDescription
Map<String,String>

getAnnotationsCount()

public abstract int getAnnotationsCount()

Optional. Annotations on the cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Keys 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 = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

getAnnotationsMap()

public abstract Map<String,String> getAnnotationsMap()

Optional. Annotations on the cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Keys 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 = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

public abstract String getAnnotationsOrDefault(String key, String defaultValue)

Optional. Annotations on the cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Keys 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 = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getAnnotationsOrThrow(String key)

public abstract String getAnnotationsOrThrow(String key)

Optional. Annotations on the cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Keys 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 = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getAuthorization()

public abstract AzureAuthorization getAuthorization()

Required. Configuration related to the cluster RBAC settings.

.google.cloud.gkemulticloud.v1.AzureAuthorization authorization = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
AzureAuthorization

The authorization.

getAuthorizationOrBuilder()

public abstract AzureAuthorizationOrBuilder getAuthorizationOrBuilder()

Required. Configuration related to the cluster RBAC settings.

.google.cloud.gkemulticloud.v1.AzureAuthorization authorization = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
AzureAuthorizationOrBuilder

getAzureClient()

public abstract String getAzureClient()

Optional. Name of the AzureClient that contains authentication configuration for how the Anthos Multi-Cloud API connects to Azure APIs. The AzureClient resource must reside on the same Google Cloud Platform project and region as the AzureCluster. AzureClient names are formatted as projects/<project-number>/locations/<region>/azureClients/<client-id>. See Resource Names for more details on Google Cloud resource names.

string azure_client = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The azureClient.

getAzureClientBytes()

public abstract ByteString getAzureClientBytes()

Optional. Name of the AzureClient that contains authentication configuration for how the Anthos Multi-Cloud API connects to Azure APIs. The AzureClient resource must reside on the same Google Cloud Platform project and region as the AzureCluster. AzureClient names are formatted as projects/<project-number>/locations/<region>/azureClients/<client-id>. See Resource Names for more details on Google Cloud resource names.

string azure_client = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for azureClient.

getAzureRegion()

public abstract String getAzureRegion()

Required. The Azure region where the cluster runs. Each Google Cloud region supports a subset of nearby Azure regions. You can call GetAzureServerConfig to list all supported Azure regions within a given Google Cloud region.

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

Returns
TypeDescription
String

The azureRegion.

getAzureRegionBytes()

public abstract ByteString getAzureRegionBytes()

Required. The Azure region where the cluster runs. Each Google Cloud region supports a subset of nearby Azure regions. You can call GetAzureServerConfig to list all supported Azure regions within a given Google Cloud region.

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

Returns
TypeDescription
ByteString

The bytes for azureRegion.

getAzureServicesAuthentication()

public abstract AzureServicesAuthentication getAzureServicesAuthentication()

Optional. Authentication configuration for management of Azure resources.

.google.cloud.gkemulticloud.v1.AzureServicesAuthentication azure_services_authentication = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
AzureServicesAuthentication

The azureServicesAuthentication.

getAzureServicesAuthenticationOrBuilder()

public abstract AzureServicesAuthenticationOrBuilder getAzureServicesAuthenticationOrBuilder()

Optional. Authentication configuration for management of Azure resources.

.google.cloud.gkemulticloud.v1.AzureServicesAuthentication azure_services_authentication = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
AzureServicesAuthenticationOrBuilder

getClusterCaCertificate()

public abstract String getClusterCaCertificate()

Output only. PEM encoded x509 certificate of the cluster root of trust.

string cluster_ca_certificate = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The clusterCaCertificate.

getClusterCaCertificateBytes()

public abstract ByteString getClusterCaCertificateBytes()

Output only. PEM encoded x509 certificate of the cluster root of trust.

string cluster_ca_certificate = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for clusterCaCertificate.

getControlPlane()

public abstract AzureControlPlane getControlPlane()

Required. Configuration related to the cluster control plane.

.google.cloud.gkemulticloud.v1.AzureControlPlane control_plane = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
AzureControlPlane

The controlPlane.

getControlPlaneOrBuilder()

public abstract AzureControlPlaneOrBuilder getControlPlaneOrBuilder()

Required. Configuration related to the cluster control plane.

.google.cloud.gkemulticloud.v1.AzureControlPlane control_plane = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
AzureControlPlaneOrBuilder

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The time at which this cluster was created.

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

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time at which this cluster was created.

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

Returns
TypeDescription
TimestampOrBuilder

getDescription()

public abstract String getDescription()

Optional. A human readable description of this cluster. Cannot be longer than 255 UTF-8 encoded bytes.

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

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. A human readable description of this cluster. Cannot be longer than 255 UTF-8 encoded bytes.

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

Returns
TypeDescription
ByteString

The bytes for description.

getEndpoint()

public abstract String getEndpoint()

Output only. The endpoint of the cluster's API server.

string endpoint = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The endpoint.

getEndpointBytes()

public abstract ByteString getEndpointBytes()

Output only. The endpoint of the cluster's API server.

string endpoint = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for endpoint.

getErrors(int index)

public abstract AzureClusterError getErrors(int index)

Output only. A set of errors found in the cluster.

repeated .google.cloud.gkemulticloud.v1.AzureClusterError errors = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
AzureClusterError

getErrorsCount()

public abstract int getErrorsCount()

Output only. A set of errors found in the cluster.

repeated .google.cloud.gkemulticloud.v1.AzureClusterError errors = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

getErrorsList()

public abstract List<AzureClusterError> getErrorsList()

Output only. A set of errors found in the cluster.

repeated .google.cloud.gkemulticloud.v1.AzureClusterError errors = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<AzureClusterError>

getErrorsOrBuilder(int index)

public abstract AzureClusterErrorOrBuilder getErrorsOrBuilder(int index)

Output only. A set of errors found in the cluster.

repeated .google.cloud.gkemulticloud.v1.AzureClusterError errors = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
AzureClusterErrorOrBuilder

getErrorsOrBuilderList()

public abstract List<? extends AzureClusterErrorOrBuilder> getErrorsOrBuilderList()

Output only. A set of errors found in the cluster.

repeated .google.cloud.gkemulticloud.v1.AzureClusterError errors = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

getEtag()

public abstract 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 = 13;

Returns
TypeDescription
String

The etag.

getEtagBytes()

public abstract 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 = 13;

Returns
TypeDescription
ByteString

The bytes for etag.

getFleet()

public abstract Fleet getFleet()

Required. Fleet configuration.

.google.cloud.gkemulticloud.v1.Fleet fleet = 20 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Fleet

The fleet.

getFleetOrBuilder()

public abstract FleetOrBuilder getFleetOrBuilder()

Required. Fleet configuration.

.google.cloud.gkemulticloud.v1.Fleet fleet = 20 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
FleetOrBuilder

getLoggingConfig()

public abstract LoggingConfig getLoggingConfig()

Optional. Logging configuration for this cluster.

.google.cloud.gkemulticloud.v1.LoggingConfig logging_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
LoggingConfig

The loggingConfig.

getLoggingConfigOrBuilder()

public abstract LoggingConfigOrBuilder getLoggingConfigOrBuilder()

Optional. Logging configuration for this cluster.

.google.cloud.gkemulticloud.v1.LoggingConfig logging_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
LoggingConfigOrBuilder

getManagedResources()

public abstract AzureClusterResources getManagedResources()

Output only. Managed Azure resources for this cluster.

.google.cloud.gkemulticloud.v1.AzureClusterResources managed_resources = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
AzureClusterResources

The managedResources.

getManagedResourcesOrBuilder()

public abstract AzureClusterResourcesOrBuilder getManagedResourcesOrBuilder()

Output only. Managed Azure resources for this cluster.

.google.cloud.gkemulticloud.v1.AzureClusterResources managed_resources = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
AzureClusterResourcesOrBuilder

getMonitoringConfig()

public abstract MonitoringConfig getMonitoringConfig()

Optional. Monitoring configuration for this cluster.

.google.cloud.gkemulticloud.v1.MonitoringConfig monitoring_config = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
MonitoringConfig

The monitoringConfig.

getMonitoringConfigOrBuilder()

public abstract MonitoringConfigOrBuilder getMonitoringConfigOrBuilder()

Optional. Monitoring configuration for this cluster.

.google.cloud.gkemulticloud.v1.MonitoringConfig monitoring_config = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
MonitoringConfigOrBuilder

getName()

public abstract String getName()

The name of this resource. Cluster names are formatted as projects/<project-number>/locations/<region>/azureClusters/<cluster-id>. See Resource Names for more details on Google Cloud Platform resource names.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

The name of this resource. Cluster names are formatted as projects/<project-number>/locations/<region>/azureClusters/<cluster-id>. See Resource Names for more details on Google Cloud Platform resource names.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getNetworking()

public abstract AzureClusterNetworking getNetworking()

Required. Cluster-wide networking configuration.

.google.cloud.gkemulticloud.v1.AzureClusterNetworking networking = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
AzureClusterNetworking

The networking.

getNetworkingOrBuilder()

public abstract AzureClusterNetworkingOrBuilder getNetworkingOrBuilder()

Required. Cluster-wide networking configuration.

.google.cloud.gkemulticloud.v1.AzureClusterNetworking networking = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
AzureClusterNetworkingOrBuilder

getReconciling()

public abstract boolean getReconciling()

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

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

Returns
TypeDescription
boolean

The reconciling.

getResourceGroupId()

public abstract String getResourceGroupId()

Required. The ARM ID of the resource group where the cluster resources are deployed. For example: /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>

string resource_group_id = 17 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The resourceGroupId.

getResourceGroupIdBytes()

public abstract ByteString getResourceGroupIdBytes()

Required. The ARM ID of the resource group where the cluster resources are deployed. For example: /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>

string resource_group_id = 17 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for resourceGroupId.

getState()

public abstract AzureCluster.State getState()

Output only. The current state of the cluster.

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

Returns
TypeDescription
AzureCluster.State

The state.

getStateValue()

public abstract int getStateValue()

Output only. The current state of the cluster.

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

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getUid()

public abstract String getUid()

Output only. A globally unique identifier for the cluster.

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

Returns
TypeDescription
String

The uid.

getUidBytes()

public abstract ByteString getUidBytes()

Output only. A globally unique identifier for the cluster.

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

Returns
TypeDescription
ByteString

The bytes for uid.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. The time at which this cluster was last updated.

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

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time at which this cluster was last updated.

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

Returns
TypeDescription
TimestampOrBuilder

getWorkloadIdentityConfig()

public abstract WorkloadIdentityConfig getWorkloadIdentityConfig()

Output only. Workload Identity settings.

.google.cloud.gkemulticloud.v1.WorkloadIdentityConfig workload_identity_config = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
WorkloadIdentityConfig

The workloadIdentityConfig.

getWorkloadIdentityConfigOrBuilder()

public abstract WorkloadIdentityConfigOrBuilder getWorkloadIdentityConfigOrBuilder()

Output only. Workload Identity settings.

.google.cloud.gkemulticloud.v1.WorkloadIdentityConfig workload_identity_config = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
WorkloadIdentityConfigOrBuilder

hasAuthorization()

public abstract boolean hasAuthorization()

Required. Configuration related to the cluster RBAC settings.

.google.cloud.gkemulticloud.v1.AzureAuthorization authorization = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the authorization field is set.

hasAzureServicesAuthentication()

public abstract boolean hasAzureServicesAuthentication()

Optional. Authentication configuration for management of Azure resources.

.google.cloud.gkemulticloud.v1.AzureServicesAuthentication azure_services_authentication = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the azureServicesAuthentication field is set.

hasControlPlane()

public abstract boolean hasControlPlane()

Required. Configuration related to the cluster control plane.

.google.cloud.gkemulticloud.v1.AzureControlPlane control_plane = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the controlPlane field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The time at which this cluster was created.

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

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasFleet()

public abstract boolean hasFleet()

Required. Fleet configuration.

.google.cloud.gkemulticloud.v1.Fleet fleet = 20 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the fleet field is set.

hasLoggingConfig()

public abstract boolean hasLoggingConfig()

Optional. Logging configuration for this cluster.

.google.cloud.gkemulticloud.v1.LoggingConfig logging_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the loggingConfig field is set.

hasManagedResources()

public abstract boolean hasManagedResources()

Output only. Managed Azure resources for this cluster.

.google.cloud.gkemulticloud.v1.AzureClusterResources managed_resources = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the managedResources field is set.

hasMonitoringConfig()

public abstract boolean hasMonitoringConfig()

Optional. Monitoring configuration for this cluster.

.google.cloud.gkemulticloud.v1.MonitoringConfig monitoring_config = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the monitoringConfig field is set.

hasNetworking()

public abstract boolean hasNetworking()

Required. Cluster-wide networking configuration.

.google.cloud.gkemulticloud.v1.AzureClusterNetworking networking = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the networking field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. The time at which this cluster was last updated.

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

Returns
TypeDescription
boolean

Whether the updateTime field is set.

hasWorkloadIdentityConfig()

public abstract boolean hasWorkloadIdentityConfig()

Output only. Workload Identity settings.

.google.cloud.gkemulticloud.v1.WorkloadIdentityConfig workload_identity_config = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the workloadIdentityConfig field is set.