Class GceClusterConfig (4.50.0) 

public final class GceClusterConfig extends GeneratedMessageV3 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<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > GceClusterConfig

Static Fields

CONFIDENTIAL_INSTANCE_CONFIG_FIELD_NUMBER

public static final int CONFIDENTIAL_INSTANCE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

INTERNAL_IP_ONLY_FIELD_NUMBER

public static final int INTERNAL_IP_ONLY_FIELD_NUMBER
Field Value
Type Description
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
Type Description
int

NETWORK_URI_FIELD_NUMBER

public static final int NETWORK_URI_FIELD_NUMBER
Field Value
Type Description
int

NODE_GROUP_AFFINITY_FIELD_NUMBER

public static final int NODE_GROUP_AFFINITY_FIELD_NUMBER
Field Value
Type Description
int

PRIVATE_IPV6_GOOGLE_ACCESS_FIELD_NUMBER

public static final int PRIVATE_IPV6_GOOGLE_ACCESS_FIELD_NUMBER
Field Value
Type Description
int

RESERVATION_AFFINITY_FIELD_NUMBER

public static final int RESERVATION_AFFINITY_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ACCOUNT_SCOPES_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_SCOPES_FIELD_NUMBER
Field Value
Type Description
int

SHIELDED_INSTANCE_CONFIG_FIELD_NUMBER

public static final int SHIELDED_INSTANCE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

SUBNETWORK_URI_FIELD_NUMBER

public static final int SUBNETWORK_URI_FIELD_NUMBER
Field Value
Type Description
int

TAGS_FIELD_NUMBER

public static final int TAGS_FIELD_NUMBER
Field Value
Type Description
int

ZONE_URI_FIELD_NUMBER

public static final int ZONE_URI_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GceClusterConfig getDefaultInstance()
Returns
Type Description
GceClusterConfig

getDescriptor()

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

newBuilder()

public static GceClusterConfig.Builder newBuilder()
Returns
Type Description
GceClusterConfig.Builder

newBuilder(GceClusterConfig prototype)

public static GceClusterConfig.Builder newBuilder(GceClusterConfig prototype)
Parameter
Name Description
prototype GceClusterConfig
Returns
Type Description
GceClusterConfig.Builder

parseDelimitedFrom(InputStream input)

public static GceClusterConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GceClusterConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GceClusterConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GceClusterConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static GceClusterConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
GceClusterConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GceClusterConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GceClusterConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GceClusterConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
GceClusterConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GceClusterConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GceClusterConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GceClusterConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
GceClusterConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GceClusterConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GceClusterConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static GceClusterConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GceClusterConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GceClusterConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GceClusterConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static GceClusterConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
GceClusterConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GceClusterConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GceClusterConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<GceClusterConfig> parser()
Returns
Type Description
Parser<GceClusterConfig>

Methods

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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.

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

getInternalIpOnly()

public boolean getInternalIpOnly()

Optional. This setting applies to subnetwork-enabled networks. It is set to true by default in clusters created with image versions 2.2.x.

When set to true:

  • All cluster VMs have internal IP addresses.
  • Google Private Access must be enabled to access Dataproc and other Google Cloud APIs.

  • Off-cluster dependencies must be configured to be accessible without external IP addresses.

    When set to false:

  • Cluster VMs are not restricted to internal IP addresses.

  • Ephemeral external IP addresses are assigned to each cluster VM.

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

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.

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

getParserForType()

public Parser<GceClusterConfig> getParserForType()
Returns
Type Description
Parser<GceClusterConfig>
Overrides

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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 network 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 network 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 network 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 network 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. This setting applies to subnetwork-enabled networks. It is set to true by default in clusters created with image versions 2.2.x.

When set to true:

  • All cluster VMs have internal IP addresses.
  • Google Private Access must be enabled to access Dataproc and other Google Cloud APIs.

  • Off-cluster dependencies must be configured to be accessible without external IP addresses.

    When set to false:

  • Cluster VMs are not restricted to internal IP addresses.

  • Ephemeral external IP addresses are assigned to each cluster VM.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

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.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GceClusterConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
GceClusterConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException