Class GceClusterConfig.Builder (4.44.0) 

public static final class GceClusterConfig.Builder extends GeneratedMessageV3.Builder<GceClusterConfig.Builder> implements GceClusterConfigOrBuilder

Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster.

Protobuf type google.cloud.dataproc.v1.GceClusterConfig

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > GceClusterConfig.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllServiceAccountScopes(Iterable<String> values)

public GceClusterConfig.Builder addAllServiceAccountScopes(Iterable<String> values)

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

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

Parameter
Name Description
values Iterable<String>

The serviceAccountScopes to add.
Returns
Type Description
GceClusterConfig.Builder

This builder for chaining.

addAllTags(Iterable<String> values)

public GceClusterConfig.Builder addAllTags(Iterable<String> values)

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

repeated string tags = 4;

Parameter
Name Description
values Iterable<String>

The tags to add.
Returns
Type Description
GceClusterConfig.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public GceClusterConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GceClusterConfig.Builder
Overrides

addServiceAccountScopes(String value)

public GceClusterConfig.Builder addServiceAccountScopes(String value)

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

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

Parameter
Name Description
value String

The serviceAccountScopes to add.
Returns
Type Description
GceClusterConfig.Builder

This builder for chaining.

addServiceAccountScopesBytes(ByteString value)

public GceClusterConfig.Builder addServiceAccountScopesBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes of the serviceAccountScopes to add.
Returns
Type Description
GceClusterConfig.Builder

This builder for chaining.

addTags(String value)

public GceClusterConfig.Builder addTags(String value)

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

repeated string tags = 4;

Parameter
Name Description
value String

The tags to add.
Returns
Type Description
GceClusterConfig.Builder

This builder for chaining.

addTagsBytes(ByteString value)

public GceClusterConfig.Builder addTagsBytes(ByteString value)

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

repeated string tags = 4;

Parameter
Name Description
value ByteString

The bytes of the tags to add.
Returns
Type Description
GceClusterConfig.Builder

This builder for chaining.

build()

public GceClusterConfig build()
Returns
Type Description
GceClusterConfig

buildPartial()

public GceClusterConfig buildPartial()
Returns
Type Description
GceClusterConfig

clear()

public GceClusterConfig.Builder clear()
Returns
Type Description
GceClusterConfig.Builder
Overrides

clearConfidentialInstanceConfig()

public GceClusterConfig.Builder clearConfidentialInstanceConfig()

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
GceClusterConfig.Builder

clearField(Descriptors.FieldDescriptor field)

public GceClusterConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
GceClusterConfig.Builder
Overrides

clearInternalIpOnly()

public GceClusterConfig.Builder clearInternalIpOnly()

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
GceClusterConfig.Builder

This builder for chaining.

clearMetadata()

public GceClusterConfig.Builder clearMetadata()
Returns
Type Description
GceClusterConfig.Builder

clearNetworkUri()

public GceClusterConfig.Builder clearNetworkUri()

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
GceClusterConfig.Builder

This builder for chaining.

clearNodeGroupAffinity()

public GceClusterConfig.Builder clearNodeGroupAffinity()

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
GceClusterConfig.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public GceClusterConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
GceClusterConfig.Builder
Overrides

clearPrivateIpv6GoogleAccess()

public GceClusterConfig.Builder clearPrivateIpv6GoogleAccess()

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

This builder for chaining.

clearReservationAffinity()

public GceClusterConfig.Builder clearReservationAffinity()

Optional. Reservation Affinity for consuming Zonal reservation.

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

Returns
Type Description
GceClusterConfig.Builder

clearServiceAccount()

public GceClusterConfig.Builder clearServiceAccount()

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
GceClusterConfig.Builder

This builder for chaining.

clearServiceAccountScopes()

public GceClusterConfig.Builder clearServiceAccountScopes()

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

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

Returns
Type Description
GceClusterConfig.Builder

This builder for chaining.

clearShieldedInstanceConfig()

public GceClusterConfig.Builder clearShieldedInstanceConfig()

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
GceClusterConfig.Builder

clearSubnetworkUri()

public GceClusterConfig.Builder clearSubnetworkUri()

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
GceClusterConfig.Builder

This builder for chaining.

clearTags()

public GceClusterConfig.Builder clearTags()

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

repeated string tags = 4;

Returns
Type Description
GceClusterConfig.Builder

This builder for chaining.

clearZoneUri()

public GceClusterConfig.Builder clearZoneUri()

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
GceClusterConfig.Builder

This builder for chaining.

clone()

public GceClusterConfig.Builder clone()
Returns
Type Description
GceClusterConfig.Builder
Overrides

containsMetadata(String key)

public boolean containsMetadata(String key)

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

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

Parameter
Name Description
key String
Returns
Type Description
boolean

getConfidentialInstanceConfig()

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

getConfidentialInstanceConfigBuilder()

public ConfidentialInstanceConfig.Builder getConfidentialInstanceConfigBuilder()

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

getConfidentialInstanceConfigOrBuilder()

public 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

getDefaultInstanceForType()

public GceClusterConfig getDefaultInstanceForType()
Returns
Type Description
GceClusterConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getInternalIpOnly()

public 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() (deprecated)

public Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
Type Description
Map<String,String>

getMetadataCount()

public int getMetadataCount()

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

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

Returns
Type Description
int

getMetadataMap()

public Map<String,String> getMetadataMap()

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

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

Returns
Type Description
Map<String,String>

getMetadataOrDefault(String key, String defaultValue)

public String getMetadataOrDefault(String key, String defaultValue)

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

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

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getMetadataOrThrow(String key)

public String getMetadataOrThrow(String key)

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

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

Parameter
Name Description
key String
Returns
Type Description
String

getMutableMetadata() (deprecated)

public Map<String,String> getMutableMetadata()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getNetworkUri()

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

getNodeGroupAffinityBuilder()

public NodeGroupAffinity.Builder getNodeGroupAffinityBuilder()

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

getNodeGroupAffinityOrBuilder()

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

getReservationAffinityBuilder()

public ReservationAffinity.Builder getReservationAffinityBuilder()

Optional. Reservation Affinity for consuming Zonal reservation.

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

Returns
Type Description
ReservationAffinity.Builder

getReservationAffinityOrBuilder()

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

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 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:

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 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:

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

Returns
Type Description
int

The count of serviceAccountScopes.

getServiceAccountScopesList()

public ProtocolStringList getServiceAccountScopesList()

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

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

Returns
Type Description
ProtocolStringList

A list containing the serviceAccountScopes.

getShieldedInstanceConfig()

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

getShieldedInstanceConfigBuilder()

public ShieldedInstanceConfig.Builder getShieldedInstanceConfigBuilder()

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

getShieldedInstanceConfigOrBuilder()

public 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 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 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 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 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 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 ProtocolStringList getTagsList()

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

repeated string tags = 4;

Returns
Type Description
ProtocolStringList

A list containing the tags.

getZoneUri()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeConfidentialInstanceConfig(ConfidentialInstanceConfig value)

public GceClusterConfig.Builder mergeConfidentialInstanceConfig(ConfidentialInstanceConfig value)

Optional. Confidential Instance Config for clusters using Confidential VMs.

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

Parameter
Name Description
value ConfidentialInstanceConfig
Returns
Type Description
GceClusterConfig.Builder

mergeFrom(GceClusterConfig other)

public GceClusterConfig.Builder mergeFrom(GceClusterConfig other)
Parameter
Name Description
other GceClusterConfig
Returns
Type Description
GceClusterConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GceClusterConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GceClusterConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public GceClusterConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
GceClusterConfig.Builder
Overrides

mergeNodeGroupAffinity(NodeGroupAffinity value)

public GceClusterConfig.Builder mergeNodeGroupAffinity(NodeGroupAffinity value)

Optional. Node Group Affinity for sole-tenant clusters.

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

Parameter
Name Description
value NodeGroupAffinity
Returns
Type Description
GceClusterConfig.Builder

mergeReservationAffinity(ReservationAffinity value)

public GceClusterConfig.Builder mergeReservationAffinity(ReservationAffinity value)

Optional. Reservation Affinity for consuming Zonal reservation.

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

Parameter
Name Description
value ReservationAffinity
Returns
Type Description
GceClusterConfig.Builder

mergeShieldedInstanceConfig(ShieldedInstanceConfig value)

public GceClusterConfig.Builder mergeShieldedInstanceConfig(ShieldedInstanceConfig value)

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

Parameter
Name Description
value ShieldedInstanceConfig
Returns
Type Description
GceClusterConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GceClusterConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GceClusterConfig.Builder
Overrides

putAllMetadata(Map<String,String> values)

public GceClusterConfig.Builder putAllMetadata(Map<String,String> values)

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

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

Parameter
Name Description
values Map<String,String>
Returns
Type Description
GceClusterConfig.Builder

putMetadata(String key, String value)

public GceClusterConfig.Builder putMetadata(String key, String value)

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

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

Parameters
Name Description
key String
value String
Returns
Type Description
GceClusterConfig.Builder

removeMetadata(String key)

public GceClusterConfig.Builder removeMetadata(String key)

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

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

Parameter
Name Description
key String
Returns
Type Description
GceClusterConfig.Builder

setConfidentialInstanceConfig(ConfidentialInstanceConfig value)

public GceClusterConfig.Builder setConfidentialInstanceConfig(ConfidentialInstanceConfig value)

Optional. Confidential Instance Config for clusters using Confidential VMs.

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

Parameter
Name Description
value ConfidentialInstanceConfig
Returns
Type Description
GceClusterConfig.Builder

setConfidentialInstanceConfig(ConfidentialInstanceConfig.Builder builderForValue)

public GceClusterConfig.Builder setConfidentialInstanceConfig(ConfidentialInstanceConfig.Builder builderForValue)

Optional. Confidential Instance Config for clusters using Confidential VMs.

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

Parameter
Name Description
builderForValue ConfidentialInstanceConfig.Builder
Returns
Type Description
GceClusterConfig.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public GceClusterConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GceClusterConfig.Builder
Overrides

setInternalIpOnly(boolean value)

public GceClusterConfig.Builder setInternalIpOnly(boolean value)

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

Parameter
Name Description
value boolean

The internalIpOnly to set.
Returns
Type Description
GceClusterConfig.Builder

This builder for chaining.

setNetworkUri(String value)

public GceClusterConfig.Builder setNetworkUri(String value)

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

Parameter
Name Description
value String

The networkUri to set.
Returns
Type Description
GceClusterConfig.Builder

This builder for chaining.

setNetworkUriBytes(ByteString value)

public GceClusterConfig.Builder setNetworkUriBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for networkUri to set.
Returns
Type Description
GceClusterConfig.Builder

This builder for chaining.

setNodeGroupAffinity(NodeGroupAffinity value)

public GceClusterConfig.Builder setNodeGroupAffinity(NodeGroupAffinity value)

Optional. Node Group Affinity for sole-tenant clusters.

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

Parameter
Name Description
value NodeGroupAffinity
Returns
Type Description
GceClusterConfig.Builder

setNodeGroupAffinity(NodeGroupAffinity.Builder builderForValue)

public GceClusterConfig.Builder setNodeGroupAffinity(NodeGroupAffinity.Builder builderForValue)

Optional. Node Group Affinity for sole-tenant clusters.

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

Parameter
Name Description
builderForValue NodeGroupAffinity.Builder
Returns
Type Description
GceClusterConfig.Builder

setPrivateIpv6GoogleAccess(GceClusterConfig.PrivateIpv6GoogleAccess value)

public GceClusterConfig.Builder setPrivateIpv6GoogleAccess(GceClusterConfig.PrivateIpv6GoogleAccess value)

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

Parameter
Name Description
value GceClusterConfig.PrivateIpv6GoogleAccess

The privateIpv6GoogleAccess to set.
Returns
Type Description
GceClusterConfig.Builder

This builder for chaining.

setPrivateIpv6GoogleAccessValue(int value)

public GceClusterConfig.Builder setPrivateIpv6GoogleAccessValue(int value)

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

Parameter
Name Description
value int

The enum numeric value on the wire for privateIpv6GoogleAccess to set.
Returns
Type Description
GceClusterConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public GceClusterConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
GceClusterConfig.Builder
Overrides

setReservationAffinity(ReservationAffinity value)

public GceClusterConfig.Builder setReservationAffinity(ReservationAffinity value)

Optional. Reservation Affinity for consuming Zonal reservation.

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

Parameter
Name Description
value ReservationAffinity
Returns
Type Description
GceClusterConfig.Builder

setReservationAffinity(ReservationAffinity.Builder builderForValue)

public GceClusterConfig.Builder setReservationAffinity(ReservationAffinity.Builder builderForValue)

Optional. Reservation Affinity for consuming Zonal reservation.

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

Parameter
Name Description
builderForValue ReservationAffinity.Builder
Returns
Type Description
GceClusterConfig.Builder

setServiceAccount(String value)

public GceClusterConfig.Builder setServiceAccount(String value)

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

Parameter
Name Description
value String

The serviceAccount to set.
Returns
Type Description
GceClusterConfig.Builder

This builder for chaining.

setServiceAccountBytes(ByteString value)

public GceClusterConfig.Builder setServiceAccountBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for serviceAccount to set.
Returns
Type Description
GceClusterConfig.Builder

This builder for chaining.

setServiceAccountScopes(int index, String value)

public GceClusterConfig.Builder setServiceAccountScopes(int index, String value)

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

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

Parameters
Name Description
index int

The index to set the value at.
value String

The serviceAccountScopes to set.
Returns
Type Description
GceClusterConfig.Builder

This builder for chaining.

setShieldedInstanceConfig(ShieldedInstanceConfig value)

public GceClusterConfig.Builder setShieldedInstanceConfig(ShieldedInstanceConfig value)

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

Parameter
Name Description
value ShieldedInstanceConfig
Returns
Type Description
GceClusterConfig.Builder

setShieldedInstanceConfig(ShieldedInstanceConfig.Builder builderForValue)

public GceClusterConfig.Builder setShieldedInstanceConfig(ShieldedInstanceConfig.Builder builderForValue)

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

Parameter
Name Description
builderForValue ShieldedInstanceConfig.Builder
Returns
Type Description
GceClusterConfig.Builder

setSubnetworkUri(String value)

public GceClusterConfig.Builder setSubnetworkUri(String value)

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

Parameter
Name Description
value String

The subnetworkUri to set.
Returns
Type Description
GceClusterConfig.Builder

This builder for chaining.

setSubnetworkUriBytes(ByteString value)

public GceClusterConfig.Builder setSubnetworkUriBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for subnetworkUri to set.
Returns
Type Description
GceClusterConfig.Builder

This builder for chaining.

setTags(int index, String value)

public GceClusterConfig.Builder setTags(int index, String value)

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

repeated string tags = 4;

Parameters
Name Description
index int

The index to set the value at.
value String

The tags to set.
Returns
Type Description
GceClusterConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final GceClusterConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GceClusterConfig.Builder
Overrides

setZoneUri(String value)

public GceClusterConfig.Builder setZoneUri(String value)

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

Parameter
Name Description
value String

The zoneUri to set.
Returns
Type Description
GceClusterConfig.Builder

This builder for chaining.

setZoneUriBytes(ByteString value)

public GceClusterConfig.Builder setZoneUriBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for zoneUri to set.
Returns
Type Description
GceClusterConfig.Builder

This builder for chaining.