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
INTERNAL_IP_ONLY_FIELD_NUMBER
public static final int INTERNAL_IP_ONLY_FIELD_NUMBER
Field Value
public static final int METADATA_FIELD_NUMBER
Field Value
NETWORK_URI_FIELD_NUMBER
public static final int NETWORK_URI_FIELD_NUMBER
Field Value
NODE_GROUP_AFFINITY_FIELD_NUMBER
public static final int NODE_GROUP_AFFINITY_FIELD_NUMBER
Field Value
PRIVATE_IPV6_GOOGLE_ACCESS_FIELD_NUMBER
public static final int PRIVATE_IPV6_GOOGLE_ACCESS_FIELD_NUMBER
Field Value
RESERVATION_AFFINITY_FIELD_NUMBER
public static final int RESERVATION_AFFINITY_FIELD_NUMBER
Field Value
SERVICE_ACCOUNT_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
SERVICE_ACCOUNT_SCOPES_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_SCOPES_FIELD_NUMBER
Field Value
SHIELDED_INSTANCE_CONFIG_FIELD_NUMBER
public static final int SHIELDED_INSTANCE_CONFIG_FIELD_NUMBER
Field Value
SUBNETWORK_URI_FIELD_NUMBER
public static final int SUBNETWORK_URI_FIELD_NUMBER
Field Value
public static final int TAGS_FIELD_NUMBER
Field Value
ZONE_URI_FIELD_NUMBER
public static final int ZONE_URI_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static GceClusterConfig getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static GceClusterConfig.Builder newBuilder()
Returns
newBuilder(GceClusterConfig prototype)
public static GceClusterConfig.Builder newBuilder(GceClusterConfig prototype)
Parameter
Returns
public static GceClusterConfig parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static GceClusterConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static GceClusterConfig parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static GceClusterConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static GceClusterConfig parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GceClusterConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static GceClusterConfig parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static GceClusterConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static GceClusterConfig parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static GceClusterConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static GceClusterConfig parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static GceClusterConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<GceClusterConfig> parser()
Returns
Methods
public boolean containsMetadata(String key)
Parameter
Returns
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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
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
getDefaultInstanceForType()
public GceClusterConfig getDefaultInstanceForType()
Returns
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
Type | Description |
boolean | The internalIpOnly.
|
public Map<String,String> getMetadata()
Returns
public int getMetadataCount()
Returns
public Map<String,String> getMetadataMap()
Returns
public String getMetadataOrDefault(String key, String defaultValue)
Parameters
Returns
public String getMetadataOrThrow(String key)
Parameter
Returns
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
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]/regions/global/default
projects/[project_id]/regions/global/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
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
getParserForType()
public Parser<GceClusterConfig> getParserForType()
Returns
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
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
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
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getServiceAccount()
public String getServiceAccount()
Returns
Type | Description |
String | The serviceAccount.
|
getServiceAccountBytes()
public ByteString getServiceAccountBytes()
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
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
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
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
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/us-east1/subnetworks/sub0
projects/[project_id]/regions/us-east1/subnetworks/sub0
sub0
string subnetwork_uri = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type | Description |
ByteString | The bytes for subnetworkUri.
|
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.
|
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.
|
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.
|
public ProtocolStringList getTagsList()
The Compute Engine tags to add to all instances (see Tagging
instances).
repeated string tags = 4;
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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
Type | Description |
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
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.
|
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()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public GceClusterConfig.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected GceClusterConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public GceClusterConfig.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions