Interface GceClusterConfigOrBuilder (4.20.0)

Version 4.20.0

• 4.52.0 (latest)
• 4.51.0
• 4.50.0
• 4.49.0
• 4.48.0
• 4.46.0
• 4.45.0
• 4.44.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.34.0
• 4.33.0
• 4.32.0
• 4.31.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.16.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.0
• 4.8.0
• 4.6.0
• 4.5.0
• 4.4.0
• 4.3.0
• 4.2.0
• 4.1.0
• 4.0.8
• 3.1.2
• 3.0.3
• 2.3.1

public interface GceClusterConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsMetadata(String key)

public abstract boolean containsMetadata(String key)

The Compute Engine metadata entries to add to all instances (see Project and instance metadata).

map<string, string> metadata = 5;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getConfidentialInstanceConfig()

public abstract ConfidentialInstanceConfig getConfidentialInstanceConfig()

Optional. Confidential Instance Config for clusters using Confidential VMs.

.google.cloud.dataproc.v1.ConfidentialInstanceConfig confidential_instance_config = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ConfidentialInstanceConfig	The confidentialInstanceConfig.

getConfidentialInstanceConfigOrBuilder()

public abstract ConfidentialInstanceConfigOrBuilder getConfidentialInstanceConfigOrBuilder()

Optional. Confidential Instance Config for clusters using Confidential VMs.

.google.cloud.dataproc.v1.ConfidentialInstanceConfig confidential_instance_config = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ConfidentialInstanceConfigOrBuilder

getInternalIpOnly()

public abstract boolean getInternalIpOnly()

Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.

optional bool internal_ip_only = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The internalIpOnly.

getMetadata()

public abstract Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
Type	Description
Map<String,String>

getMetadataCount()

public abstract int getMetadataCount()

The Compute Engine metadata entries to add to all instances (see Project and instance metadata).

map<string, string> metadata = 5;

Returns
Type	Description
int

getMetadataMap()

public abstract Map<String,String> getMetadataMap()

The Compute Engine metadata entries to add to all instances (see Project and instance metadata).

map<string, string> metadata = 5;

Returns
Type	Description
Map<String,String>

getMetadataOrDefault(String key, String defaultValue)

public abstract String getMetadataOrDefault(String key, String defaultValue)

The Compute Engine metadata entries to add to all instances (see Project and instance metadata).

map<string, string> metadata = 5;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getMetadataOrThrow(String key)

public abstract String getMetadataOrThrow(String key)

The Compute Engine metadata entries to add to all instances (see Project and instance metadata).

map<string, string> metadata = 5;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getNetworkUri()

public abstract String getNetworkUri()

Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks for more information).

A full URL, partial URI, or short name are valid. Examples:

• https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default
• projects/[project_id]/global/networks/default
• default

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

Returns
Type	Description
String	The networkUri.

getNetworkUriBytes()

public abstract ByteString getNetworkUriBytes()

Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks for more information).

A full URL, partial URI, or short name are valid. Examples:

• https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default
• projects/[project_id]/global/networks/default
• default

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

Returns
Type	Description
ByteString	The bytes for networkUri.

getNodeGroupAffinity()

public abstract NodeGroupAffinity getNodeGroupAffinity()

Optional. Node Group Affinity for sole-tenant clusters.

.google.cloud.dataproc.v1.NodeGroupAffinity node_group_affinity = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
NodeGroupAffinity	The nodeGroupAffinity.

getNodeGroupAffinityOrBuilder()

public abstract NodeGroupAffinityOrBuilder getNodeGroupAffinityOrBuilder()

Optional. Node Group Affinity for sole-tenant clusters.

.google.cloud.dataproc.v1.NodeGroupAffinity node_group_affinity = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
NodeGroupAffinityOrBuilder

getPrivateIpv6GoogleAccess()

public abstract GceClusterConfig.PrivateIpv6GoogleAccess getPrivateIpv6GoogleAccess()

Optional. The type of IPv6 access for a cluster.

.google.cloud.dataproc.v1.GceClusterConfig.PrivateIpv6GoogleAccess private_ipv6_google_access = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
GceClusterConfig.PrivateIpv6GoogleAccess	The privateIpv6GoogleAccess.

getPrivateIpv6GoogleAccessValue()

public abstract int getPrivateIpv6GoogleAccessValue()

Optional. The type of IPv6 access for a cluster.

.google.cloud.dataproc.v1.GceClusterConfig.PrivateIpv6GoogleAccess private_ipv6_google_access = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for privateIpv6GoogleAccess.

getReservationAffinity()

public abstract ReservationAffinity getReservationAffinity()

Optional. Reservation Affinity for consuming Zonal reservation.

.google.cloud.dataproc.v1.ReservationAffinity reservation_affinity = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ReservationAffinity	The reservationAffinity.

getReservationAffinityOrBuilder()

public abstract ReservationAffinityOrBuilder getReservationAffinityOrBuilder()

Optional. Reservation Affinity for consuming Zonal reservation.

.google.cloud.dataproc.v1.ReservationAffinity reservation_affinity = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ReservationAffinityOrBuilder

getServiceAccount()

public abstract String getServiceAccount()

Optional. The Dataproc service account (also see VM Data Plane identity) used by Dataproc cluster VM instances to access Google Cloud Platform services.

If not specified, the Compute Engine default service account is used.

string service_account = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The serviceAccount.

getServiceAccountBytes()

public abstract ByteString getServiceAccountBytes()

Optional. The Dataproc service account (also see VM Data Plane identity) used by Dataproc cluster VM instances to access Google Cloud Platform services.

If not specified, the Compute Engine default service account is used.

string service_account = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for serviceAccount.

getServiceAccountScopes(int index)

public abstract String getServiceAccountScopes(int index)

Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:

• https://www.googleapis.com/auth/cloud.useraccounts.readonly
• https://www.googleapis.com/auth/devstorage.read_write

• https://www.googleapis.com/auth/logging.write

  If no scopes are specified, the following defaults are also provided:

• https://www.googleapis.com/auth/bigquery

• https://www.googleapis.com/auth/bigtable.admin.table
• https://www.googleapis.com/auth/bigtable.data
• https://www.googleapis.com/auth/devstorage.full_control

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

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

Returns
Type	Description
String	The serviceAccountScopes at the given index.

getServiceAccountScopesBytes(int index)

public abstract ByteString getServiceAccountScopesBytes(int index)

Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:

• https://www.googleapis.com/auth/cloud.useraccounts.readonly
• https://www.googleapis.com/auth/devstorage.read_write

• https://www.googleapis.com/auth/logging.write

  If no scopes are specified, the following defaults are also provided:

• https://www.googleapis.com/auth/bigquery

• https://www.googleapis.com/auth/bigtable.admin.table
• https://www.googleapis.com/auth/bigtable.data
• https://www.googleapis.com/auth/devstorage.full_control

repeated string service_account_scopes = 3 [(.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 serviceAccountScopes at the given index.

getServiceAccountScopesCount()

public abstract int getServiceAccountScopesCount()

Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:

• https://www.googleapis.com/auth/cloud.useraccounts.readonly
• https://www.googleapis.com/auth/devstorage.read_write

• https://www.googleapis.com/auth/logging.write

  If no scopes are specified, the following defaults are also provided:

• https://www.googleapis.com/auth/bigquery

• https://www.googleapis.com/auth/bigtable.admin.table
• https://www.googleapis.com/auth/bigtable.data
• https://www.googleapis.com/auth/devstorage.full_control

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

Returns
Type	Description
int	The count of serviceAccountScopes.

getServiceAccountScopesList()

public abstract List<String> getServiceAccountScopesList()

Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:

• https://www.googleapis.com/auth/cloud.useraccounts.readonly
• https://www.googleapis.com/auth/devstorage.read_write

• https://www.googleapis.com/auth/logging.write

  If no scopes are specified, the following defaults are also provided:

• https://www.googleapis.com/auth/bigquery

• https://www.googleapis.com/auth/bigtable.admin.table
• https://www.googleapis.com/auth/bigtable.data
• https://www.googleapis.com/auth/devstorage.full_control

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

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

getShieldedInstanceConfig()

public abstract ShieldedInstanceConfig getShieldedInstanceConfig()

Optional. Shielded Instance Config for clusters using Compute Engine Shielded VMs.

.google.cloud.dataproc.v1.ShieldedInstanceConfig shielded_instance_config = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ShieldedInstanceConfig	The shieldedInstanceConfig.

getShieldedInstanceConfigOrBuilder()

public abstract ShieldedInstanceConfigOrBuilder getShieldedInstanceConfigOrBuilder()

Optional. Shielded Instance Config for clusters using Compute Engine Shielded VMs.

.google.cloud.dataproc.v1.ShieldedInstanceConfig shielded_instance_config = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ShieldedInstanceConfigOrBuilder

getSubnetworkUri()

public abstract String getSubnetworkUri()

Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.

A full URL, partial URI, or short name are valid. Examples:

• https://www.googleapis.com/compute/v1/projects/[project_id]/regions/[region]/subnetworks/sub0
• projects/[project_id]/regions/[region]/subnetworks/sub0
• sub0

string subnetwork_uri = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The subnetworkUri.

getSubnetworkUriBytes()

public abstract ByteString getSubnetworkUriBytes()

Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.

A full URL, partial URI, or short name are valid. Examples:

• https://www.googleapis.com/compute/v1/projects/[project_id]/regions/[region]/subnetworks/sub0
• projects/[project_id]/regions/[region]/subnetworks/sub0
• sub0

string subnetwork_uri = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for subnetworkUri.

getTags(int index)

public abstract String getTags(int index)

The Compute Engine tags to add to all instances (see Tagging instances).

repeated string tags = 4;

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

Returns
Type	Description
String	The tags at the given index.

getTagsBytes(int index)

public abstract ByteString getTagsBytes(int index)

The Compute Engine tags to add to all instances (see Tagging instances).

repeated string tags = 4;

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

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

getTagsCount()

public abstract int getTagsCount()

The Compute Engine tags to add to all instances (see Tagging instances).

repeated string tags = 4;

Returns
Type	Description
int	The count of tags.

getTagsList()

public abstract List<String> getTagsList()

The Compute Engine tags to add to all instances (see Tagging instances).

repeated string tags = 4;

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

getZoneUri()

public abstract String getZoneUri()

Optional. The Compute Engine zone where the Dataproc cluster will be located. If omitted, the service will pick a zone in the cluster's Compute Engine region. On a get request, zone will always be present.

A full URL, partial URI, or short name are valid. Examples:

• https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]
• projects/[project_id]/zones/[zone]
• [zone]

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

Returns
Type	Description
String	The zoneUri.

getZoneUriBytes()

public abstract ByteString getZoneUriBytes()

Optional. The Compute Engine zone where the Dataproc cluster will be located. If omitted, the service will pick a zone in the cluster's Compute Engine region. On a get request, zone will always be present.

A full URL, partial URI, or short name are valid. Examples:

• https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]
• projects/[project_id]/zones/[zone]
• [zone]

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

Returns
Type	Description
ByteString	The bytes for zoneUri.

hasConfidentialInstanceConfig()

public abstract boolean hasConfidentialInstanceConfig()

Optional. Confidential Instance Config for clusters using Confidential VMs.

.google.cloud.dataproc.v1.ConfidentialInstanceConfig confidential_instance_config = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the confidentialInstanceConfig field is set.

hasInternalIpOnly()

public abstract boolean hasInternalIpOnly()

Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.

optional bool internal_ip_only = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the internalIpOnly field is set.

hasNodeGroupAffinity()

public abstract boolean hasNodeGroupAffinity()

Optional. Node Group Affinity for sole-tenant clusters.

.google.cloud.dataproc.v1.NodeGroupAffinity node_group_affinity = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the nodeGroupAffinity field is set.

hasReservationAffinity()

public abstract boolean hasReservationAffinity()

Optional. Reservation Affinity for consuming Zonal reservation.

.google.cloud.dataproc.v1.ReservationAffinity reservation_affinity = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the reservationAffinity field is set.

hasShieldedInstanceConfig()

public abstract boolean hasShieldedInstanceConfig()

Optional. Shielded Instance Config for clusters using Compute Engine Shielded VMs.

.google.cloud.dataproc.v1.ShieldedInstanceConfig shielded_instance_config = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the shieldedInstanceConfig field is set.