Class GceClusterConfig

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

Static Fields

CONFIDENTIAL_INSTANCE_CONFIG_FIELD_NUMBER

public static final int CONFIDENTIAL_INSTANCE_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

INTERNAL_IP_ONLY_FIELD_NUMBER

public static final int INTERNAL_IP_ONLY_FIELD_NUMBER
Field Value
TypeDescription
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

NETWORK_URI_FIELD_NUMBER

public static final int NETWORK_URI_FIELD_NUMBER
Field Value
TypeDescription
int

NODE_GROUP_AFFINITY_FIELD_NUMBER

public static final int NODE_GROUP_AFFINITY_FIELD_NUMBER
Field Value
TypeDescription
int

PRIVATE_IPV6_GOOGLE_ACCESS_FIELD_NUMBER

public static final int PRIVATE_IPV6_GOOGLE_ACCESS_FIELD_NUMBER
Field Value
TypeDescription
int

RESERVATION_AFFINITY_FIELD_NUMBER

public static final int RESERVATION_AFFINITY_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICE_ACCOUNT_SCOPES_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_SCOPES_FIELD_NUMBER
Field Value
TypeDescription
int

SHIELDED_INSTANCE_CONFIG_FIELD_NUMBER

public static final int SHIELDED_INSTANCE_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

SUBNETWORK_URI_FIELD_NUMBER

public static final int SUBNETWORK_URI_FIELD_NUMBER
Field Value
TypeDescription
int

TAGS_FIELD_NUMBER

public static final int TAGS_FIELD_NUMBER
Field Value
TypeDescription
int

ZONE_URI_FIELD_NUMBER

public static final int ZONE_URI_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static GceClusterConfig getDefaultInstance()
Returns
TypeDescription
GceClusterConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static GceClusterConfig.Builder newBuilder()
Returns
TypeDescription
GceClusterConfig.Builder

newBuilder(GceClusterConfig prototype)

public static GceClusterConfig.Builder newBuilder(GceClusterConfig prototype)
Parameter
NameDescription
prototypeGceClusterConfig
Returns
TypeDescription
GceClusterConfig.Builder

parseDelimitedFrom(InputStream input)

public static GceClusterConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
GceClusterConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GceClusterConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GceClusterConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static GceClusterConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
GceClusterConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GceClusterConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GceClusterConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GceClusterConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
GceClusterConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GceClusterConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GceClusterConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GceClusterConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
GceClusterConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GceClusterConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GceClusterConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static GceClusterConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
GceClusterConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GceClusterConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GceClusterConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static GceClusterConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
GceClusterConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GceClusterConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GceClusterConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<GceClusterConfig> parser()
Returns
TypeDescription
Parser<GceClusterConfig>

Methods

containsMetadata(String key)

public 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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ConfidentialInstanceConfigOrBuilder

getDefaultInstanceForType()

public GceClusterConfig getDefaultInstanceForType()
Returns
TypeDescription
GceClusterConfig

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.

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

Returns
TypeDescription
boolean

The internalIpOnly.

getMetadata()

public Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
TypeDescription
Map<String,String>

getMetadataCount()

public int getMetadataCount()

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

map<string, string> metadata = 5;

Returns
TypeDescription
int

getMetadataMap()

public 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
TypeDescription
Map<String,String>

getMetadataOrDefault(String key, String defaultValue)

public 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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getMetadataOrThrow(String key)

public 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
NameDescription
keyString
Returns
TypeDescription
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]/regions/global/default
  • projects/[project_id]/regions/global/default
  • default

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

Returns
TypeDescription
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]/regions/global/default
  • projects/[project_id]/regions/global/default
  • default

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
NodeGroupAffinityOrBuilder

getParserForType()

public Parser<GceClusterConfig> getParserForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ReservationAffinityOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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/us-east1/subnetworks/sub0
  • projects/[project_id]/regions/us-east1/subnetworks/sub0
  • sub0

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

Returns
TypeDescription
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/us-east1/subnetworks/sub0
  • projects/[project_id]/regions/us-east1/subnetworks/sub0
  • sub0

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

Returns
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ProtocolStringList

A list containing the tags.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getZoneUri()

public 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
TypeDescription
String

The zoneUri.

getZoneUriBytes()

public 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
TypeDescription
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
TypeDescription
boolean

Whether the confidentialInstanceConfig 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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the shieldedInstanceConfig field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public GceClusterConfig.Builder newBuilderForType()
Returns
TypeDescription
GceClusterConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GceClusterConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
GceClusterConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public GceClusterConfig.Builder toBuilder()
Returns
TypeDescription
GceClusterConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException