com.google.cloud.dataproc.v1

Interface GceClusterConfigOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

GceClusterConfig, GceClusterConfig.Builder

public interface GceClusterConfigOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsMetadata(String key) The Compute Engine metadata entries to add to all instances (see [Project and instance metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
ConfidentialInstanceConfig	getConfidentialInstanceConfig() Optional.
ConfidentialInstanceConfigOrBuilder	getConfidentialInstanceConfigOrBuilder() Optional.
boolean	getInternalIpOnly() Optional.
Map<String,String>	getMetadata() Deprecated.
int	getMetadataCount() The Compute Engine metadata entries to add to all instances (see [Project and instance metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
Map<String,String>	getMetadataMap() The Compute Engine metadata entries to add to all instances (see [Project and instance metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
String	getMetadataOrDefault(String key, String defaultValue) The Compute Engine metadata entries to add to all instances (see [Project and instance metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
String	getMetadataOrThrow(String key) The Compute Engine metadata entries to add to all instances (see [Project and instance metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
String	getNetworkUri() Optional.
ByteString	getNetworkUriBytes() Optional.
NodeGroupAffinity	getNodeGroupAffinity() Optional.
NodeGroupAffinityOrBuilder	getNodeGroupAffinityOrBuilder() Optional.
GceClusterConfig.PrivateIpv6GoogleAccess	getPrivateIpv6GoogleAccess() Optional.
int	getPrivateIpv6GoogleAccessValue() Optional.
ReservationAffinity	getReservationAffinity() Optional.
ReservationAffinityOrBuilder	getReservationAffinityOrBuilder() Optional.
String	getServiceAccount() Optional.
ByteString	getServiceAccountBytes() Optional.
String	getServiceAccountScopes(int index) Optional.
ByteString	getServiceAccountScopesBytes(int index) Optional.
int	getServiceAccountScopesCount() Optional.
List<String>	getServiceAccountScopesList() Optional.
ShieldedInstanceConfig	getShieldedInstanceConfig() Optional.
ShieldedInstanceConfigOrBuilder	getShieldedInstanceConfigOrBuilder() Optional.
String	getSubnetworkUri() Optional.
ByteString	getSubnetworkUriBytes() Optional.
String	getTags(int index) The Compute Engine tags to add to all instances (see [Tagging instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
ByteString	getTagsBytes(int index) The Compute Engine tags to add to all instances (see [Tagging instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
int	getTagsCount() The Compute Engine tags to add to all instances (see [Tagging instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
List<String>	getTagsList() The Compute Engine tags to add to all instances (see [Tagging instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
String	getZoneUri() Optional.
ByteString	getZoneUriBytes() Optional.
boolean	hasConfidentialInstanceConfig() Optional.
boolean	hasNodeGroupAffinity() Optional.
boolean	hasReservationAffinity() Optional.
boolean	hasShieldedInstanceConfig() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getZoneUri

String getZoneUri()

 Optional. The zone where the Compute Engine cluster will be located.
 On a create request, it is required in the "global" region. If omitted
 in a non-global Dataproc region, the service will pick a zone in the
 corresponding 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]`
 * `us-central1-f`
 

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

Returns:

The zoneUri.

getZoneUriBytes

ByteString getZoneUriBytes()

 Optional. The zone where the Compute Engine cluster will be located.
 On a create request, it is required in the "global" region. If omitted
 in a non-global Dataproc region, the service will pick a zone in the
 corresponding 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]`
 * `us-central1-f`
 

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

Returns:

The bytes for zoneUri.

getNetworkUri

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](https://cloud.google.com/compute/docs/subnetworks) for
 more information).
 A full URL, partial URI, or short name are valid. Examples:
 * `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default`
 * `projects/[project_id]/regions/global/default`
 * `default`
 

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

Returns:

The networkUri.

getNetworkUriBytes

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](https://cloud.google.com/compute/docs/subnetworks) for
 more information).
 A full URL, partial URI, or short name are valid. Examples:
 * `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default`
 * `projects/[project_id]/regions/global/default`
 * `default`
 

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

Returns:

The bytes for networkUri.

getSubnetworkUri

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/us-east1/subnetworks/sub0`
 * `projects/[project_id]/regions/us-east1/subnetworks/sub0`
 * `sub0`
 

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

Returns:

The subnetworkUri.

getSubnetworkUriBytes

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/us-east1/subnetworks/sub0`
 * `projects/[project_id]/regions/us-east1/subnetworks/sub0`
 * `sub0`
 

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

Returns:

The bytes for subnetworkUri.

getInternalIpOnly

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.
 

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

Returns:

The internalIpOnly.

getPrivateIpv6GoogleAccessValue

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:

The enum numeric value on the wire for privateIpv6GoogleAccess.

getPrivateIpv6GoogleAccess

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:

The privateIpv6GoogleAccess.

getServiceAccount

String getServiceAccount()

 Optional. The [Dataproc service
 account](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc)
 (also see [VM Data Plane
 identity](https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity))
 used by Dataproc cluster VM instances to access Google Cloud Platform
 services.
 If not specified, the
 [Compute Engine default service
 account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account)
 is used.
 

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

Returns:

The serviceAccount.

getServiceAccountBytes

ByteString getServiceAccountBytes()

 Optional. The [Dataproc service
 account](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc)
 (also see [VM Data Plane
 identity](https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity))
 used by Dataproc cluster VM instances to access Google Cloud Platform
 services.
 If not specified, the
 [Compute Engine default service
 account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account)
 is used.
 

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

Returns:

The bytes for serviceAccount.

getServiceAccountScopesList

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:

A list containing the serviceAccountScopes.

getServiceAccountScopesCount

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:

The count of serviceAccountScopes.

getServiceAccountScopes

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];

Parameters:

index - The index of the element to return.

Returns:

The serviceAccountScopes at the given index.

getServiceAccountScopesBytes

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];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the serviceAccountScopes at the given index.

getTagsList

List<String> getTagsList()

 The Compute Engine tags to add to all instances (see [Tagging
 instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
 

repeated string tags = 4;

Returns:

A list containing the tags.

getTagsCount

int getTagsCount()

 The Compute Engine tags to add to all instances (see [Tagging
 instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
 

repeated string tags = 4;

Returns:

The count of tags.

getTags

String getTags(int index)

 The Compute Engine tags to add to all instances (see [Tagging
 instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
 

repeated string tags = 4;

Parameters:

index - The index of the element to return.

Returns:

The tags at the given index.

getTagsBytes

ByteString getTagsBytes(int index)

 The Compute Engine tags to add to all instances (see [Tagging
 instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
 

repeated string tags = 4;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the tags at the given index.

getMetadataCount

int getMetadataCount()

 The Compute Engine metadata entries to add to all instances (see
 [Project and instance
 metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
 

map<string, string> metadata = 5;

containsMetadata

boolean containsMetadata(String key)

 The Compute Engine metadata entries to add to all instances (see
 [Project and instance
 metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
 

map<string, string> metadata = 5;

getMetadata

@Deprecated
Map<String,String> getMetadata()

Deprecated.

Use getMetadataMap() instead.

getMetadataMap

Map<String,String> getMetadataMap()

 The Compute Engine metadata entries to add to all instances (see
 [Project and instance
 metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
 

map<string, string> metadata = 5;

getMetadataOrDefault

String getMetadataOrDefault(String key,
                            String defaultValue)

 The Compute Engine metadata entries to add to all instances (see
 [Project and instance
 metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
 

map<string, string> metadata = 5;

getMetadataOrThrow

String getMetadataOrThrow(String key)

 The Compute Engine metadata entries to add to all instances (see
 [Project and instance
 metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
 

map<string, string> metadata = 5;

hasReservationAffinity

boolean hasReservationAffinity()

 Optional. Reservation Affinity for consuming Zonal reservation.
 

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

Returns:

Whether the reservationAffinity field is set.

getReservationAffinity

ReservationAffinity getReservationAffinity()

 Optional. Reservation Affinity for consuming Zonal reservation.
 

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

Returns:

The reservationAffinity.

getReservationAffinityOrBuilder

ReservationAffinityOrBuilder getReservationAffinityOrBuilder()

 Optional. Reservation Affinity for consuming Zonal reservation.
 

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

hasNodeGroupAffinity

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:

Whether the nodeGroupAffinity field is set.

getNodeGroupAffinity

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:

The nodeGroupAffinity.

getNodeGroupAffinityOrBuilder

NodeGroupAffinityOrBuilder getNodeGroupAffinityOrBuilder()

 Optional. Node Group Affinity for sole-tenant clusters.
 

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

hasShieldedInstanceConfig

boolean hasShieldedInstanceConfig()

 Optional. Shielded Instance Config for clusters using [Compute Engine Shielded
 VMs](https://cloud.google.com/security/shielded-cloud/shielded-vm).
 

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

Returns:

Whether the shieldedInstanceConfig field is set.

getShieldedInstanceConfig

ShieldedInstanceConfig getShieldedInstanceConfig()

 Optional. Shielded Instance Config for clusters using [Compute Engine Shielded
 VMs](https://cloud.google.com/security/shielded-cloud/shielded-vm).
 

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

Returns:

The shieldedInstanceConfig.

getShieldedInstanceConfigOrBuilder

ShieldedInstanceConfigOrBuilder getShieldedInstanceConfigOrBuilder()

 Optional. Shielded Instance Config for clusters using [Compute Engine Shielded
 VMs](https://cloud.google.com/security/shielded-cloud/shielded-vm).
 

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

hasConfidentialInstanceConfig

boolean hasConfidentialInstanceConfig()

 Optional. Confidential Instance Config for clusters using [Confidential
 VMs](https://cloud.google.com/compute/confidential-vm/docs).
 

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

Returns:

Whether the confidentialInstanceConfig field is set.

getConfidentialInstanceConfig

ConfidentialInstanceConfig getConfidentialInstanceConfig()

 Optional. Confidential Instance Config for clusters using [Confidential
 VMs](https://cloud.google.com/compute/confidential-vm/docs).
 

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

Returns:

The confidentialInstanceConfig.

getConfidentialInstanceConfigOrBuilder

ConfidentialInstanceConfigOrBuilder getConfidentialInstanceConfigOrBuilder()

 Optional. Confidential Instance Config for clusters using [Confidential
 VMs](https://cloud.google.com/compute/confidential-vm/docs).
 

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