public final class ClusterConfig extends GeneratedMessageV3 implements ClusterConfigOrBuilder
The cluster config.
Protobuf type google.cloud.dataproc.v1.ClusterConfig
Fields
AUTOSCALING_CONFIG_FIELD_NUMBER
public static final int AUTOSCALING_CONFIG_FIELD_NUMBER
Field Value
CONFIG_BUCKET_FIELD_NUMBER
public static final int CONFIG_BUCKET_FIELD_NUMBER
Field Value
ENCRYPTION_CONFIG_FIELD_NUMBER
public static final int ENCRYPTION_CONFIG_FIELD_NUMBER
Field Value
ENDPOINT_CONFIG_FIELD_NUMBER
public static final int ENDPOINT_CONFIG_FIELD_NUMBER
Field Value
GCE_CLUSTER_CONFIG_FIELD_NUMBER
public static final int GCE_CLUSTER_CONFIG_FIELD_NUMBER
Field Value
GKE_CLUSTER_CONFIG_FIELD_NUMBER
public static final int GKE_CLUSTER_CONFIG_FIELD_NUMBER
Field Value
INITIALIZATION_ACTIONS_FIELD_NUMBER
public static final int INITIALIZATION_ACTIONS_FIELD_NUMBER
Field Value
LIFECYCLE_CONFIG_FIELD_NUMBER
public static final int LIFECYCLE_CONFIG_FIELD_NUMBER
Field Value
MASTER_CONFIG_FIELD_NUMBER
public static final int MASTER_CONFIG_FIELD_NUMBER
Field Value
public static final int METASTORE_CONFIG_FIELD_NUMBER
Field Value
SECONDARY_WORKER_CONFIG_FIELD_NUMBER
public static final int SECONDARY_WORKER_CONFIG_FIELD_NUMBER
Field Value
SECURITY_CONFIG_FIELD_NUMBER
public static final int SECURITY_CONFIG_FIELD_NUMBER
Field Value
SOFTWARE_CONFIG_FIELD_NUMBER
public static final int SOFTWARE_CONFIG_FIELD_NUMBER
Field Value
TEMP_BUCKET_FIELD_NUMBER
public static final int TEMP_BUCKET_FIELD_NUMBER
Field Value
WORKER_CONFIG_FIELD_NUMBER
public static final int WORKER_CONFIG_FIELD_NUMBER
Field Value
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAutoscalingConfig()
public AutoscalingConfig getAutoscalingConfig()
Optional. Autoscaling config for the policy associated with the cluster.
Cluster does not autoscale if this field is unset.
.google.cloud.dataproc.v1.AutoscalingConfig autoscaling_config = 18 [(.google.api.field_behavior) = OPTIONAL];
getAutoscalingConfigOrBuilder()
public AutoscalingConfigOrBuilder getAutoscalingConfigOrBuilder()
Optional. Autoscaling config for the policy associated with the cluster.
Cluster does not autoscale if this field is unset.
.google.cloud.dataproc.v1.AutoscalingConfig autoscaling_config = 18 [(.google.api.field_behavior) = OPTIONAL];
getConfigBucket()
public String getConfigBucket()
Optional. A Cloud Storage bucket used to stage job
dependencies, config files, and job driver console output.
If you do not specify a staging bucket, Cloud
Dataproc will determine a Cloud Storage location (US,
ASIA, or EU) for your cluster's staging bucket according to the
Compute Engine zone where your cluster is deployed, and then create
and manage this project-level, per-location bucket (see
Dataproc staging and temp
buckets).
This field requires a Cloud Storage bucket name, not a gs://... URI to
a Cloud Storage bucket.
string config_bucket = 1 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| String | The configBucket.
|
getConfigBucketBytes()
public ByteString getConfigBucketBytes()
Optional. A Cloud Storage bucket used to stage job
dependencies, config files, and job driver console output.
If you do not specify a staging bucket, Cloud
Dataproc will determine a Cloud Storage location (US,
ASIA, or EU) for your cluster's staging bucket according to the
Compute Engine zone where your cluster is deployed, and then create
and manage this project-level, per-location bucket (see
Dataproc staging and temp
buckets).
This field requires a Cloud Storage bucket name, not a gs://... URI to
a Cloud Storage bucket.
string config_bucket = 1 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| ByteString | The bytes for configBucket.
|
getDefaultInstance()
public static ClusterConfig getDefaultInstance()
Returns
getDefaultInstanceForType()
public ClusterConfig getDefaultInstanceForType()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
getEncryptionConfig()
public EncryptionConfig getEncryptionConfig()
Optional. Encryption settings for the cluster.
.google.cloud.dataproc.v1.EncryptionConfig encryption_config = 15 [(.google.api.field_behavior) = OPTIONAL];
getEncryptionConfigOrBuilder()
public EncryptionConfigOrBuilder getEncryptionConfigOrBuilder()
Optional. Encryption settings for the cluster.
.google.cloud.dataproc.v1.EncryptionConfig encryption_config = 15 [(.google.api.field_behavior) = OPTIONAL];
getEndpointConfig()
public EndpointConfig getEndpointConfig()
Optional. Port/endpoint configuration for this cluster
.google.cloud.dataproc.v1.EndpointConfig endpoint_config = 19 [(.google.api.field_behavior) = OPTIONAL];
getEndpointConfigOrBuilder()
public EndpointConfigOrBuilder getEndpointConfigOrBuilder()
Optional. Port/endpoint configuration for this cluster
.google.cloud.dataproc.v1.EndpointConfig endpoint_config = 19 [(.google.api.field_behavior) = OPTIONAL];
getGceClusterConfig()
public GceClusterConfig getGceClusterConfig()
Optional. The shared Compute Engine config settings for
all instances in a cluster.
.google.cloud.dataproc.v1.GceClusterConfig gce_cluster_config = 8 [(.google.api.field_behavior) = OPTIONAL];
getGceClusterConfigOrBuilder()
public GceClusterConfigOrBuilder getGceClusterConfigOrBuilder()
Optional. The shared Compute Engine config settings for
all instances in a cluster.
.google.cloud.dataproc.v1.GceClusterConfig gce_cluster_config = 8 [(.google.api.field_behavior) = OPTIONAL];
getGkeClusterConfig()
public GkeClusterConfig getGkeClusterConfig()
Optional. BETA. The Kubernetes Engine config for Dataproc clusters deployed to
Kubernetes. Setting this is considered mutually exclusive with Compute
Engine-based options such as gce_cluster_config, master_config,
worker_config, secondary_worker_config, and autoscaling_config.
.google.cloud.dataproc.v1.GkeClusterConfig gke_cluster_config = 21 [(.google.api.field_behavior) = OPTIONAL];
getGkeClusterConfigOrBuilder()
public GkeClusterConfigOrBuilder getGkeClusterConfigOrBuilder()
Optional. BETA. The Kubernetes Engine config for Dataproc clusters deployed to
Kubernetes. Setting this is considered mutually exclusive with Compute
Engine-based options such as gce_cluster_config, master_config,
worker_config, secondary_worker_config, and autoscaling_config.
.google.cloud.dataproc.v1.GkeClusterConfig gke_cluster_config = 21 [(.google.api.field_behavior) = OPTIONAL];
getInitializationActions(int index)
public NodeInitializationAction getInitializationActions(int index)
Optional. Commands to execute on each node after config is
completed. By default, executables are run on master and all worker nodes.
You can test a node's role metadata to run an executable on
a master or worker node, as shown below using curl (you can also use
wget):
ROLE=$(curl -H Metadata-Flavor:Google
http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)
if [[ "${ROLE}" == 'Master' ]]; then
... master specific actions ...
else
... worker specific actions ...
fi
repeated .google.cloud.dataproc.v1.NodeInitializationAction initialization_actions = 11 [(.google.api.field_behavior) = OPTIONAL];
getInitializationActionsCount()
public int getInitializationActionsCount()
Optional. Commands to execute on each node after config is
completed. By default, executables are run on master and all worker nodes.
You can test a node's role metadata to run an executable on
a master or worker node, as shown below using curl (you can also use
wget):
ROLE=$(curl -H Metadata-Flavor:Google
http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)
if [[ "${ROLE}" == 'Master' ]]; then
... master specific actions ...
else
... worker specific actions ...
fi
repeated .google.cloud.dataproc.v1.NodeInitializationAction initialization_actions = 11 [(.google.api.field_behavior) = OPTIONAL];
getInitializationActionsList()
public List<NodeInitializationAction> getInitializationActionsList()
Optional. Commands to execute on each node after config is
completed. By default, executables are run on master and all worker nodes.
You can test a node's role metadata to run an executable on
a master or worker node, as shown below using curl (you can also use
wget):
ROLE=$(curl -H Metadata-Flavor:Google
http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)
if [[ "${ROLE}" == 'Master' ]]; then
... master specific actions ...
else
... worker specific actions ...
fi
repeated .google.cloud.dataproc.v1.NodeInitializationAction initialization_actions = 11 [(.google.api.field_behavior) = OPTIONAL];
getInitializationActionsOrBuilder(int index)
public NodeInitializationActionOrBuilder getInitializationActionsOrBuilder(int index)
Optional. Commands to execute on each node after config is
completed. By default, executables are run on master and all worker nodes.
You can test a node's role metadata to run an executable on
a master or worker node, as shown below using curl (you can also use
wget):
ROLE=$(curl -H Metadata-Flavor:Google
http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)
if [[ "${ROLE}" == 'Master' ]]; then
... master specific actions ...
else
... worker specific actions ...
fi
repeated .google.cloud.dataproc.v1.NodeInitializationAction initialization_actions = 11 [(.google.api.field_behavior) = OPTIONAL];
getInitializationActionsOrBuilderList()
public List<? extends NodeInitializationActionOrBuilder> getInitializationActionsOrBuilderList()
Optional. Commands to execute on each node after config is
completed. By default, executables are run on master and all worker nodes.
You can test a node's role metadata to run an executable on
a master or worker node, as shown below using curl (you can also use
wget):
ROLE=$(curl -H Metadata-Flavor:Google
http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)
if [[ "${ROLE}" == 'Master' ]]; then
... master specific actions ...
else
... worker specific actions ...
fi
repeated .google.cloud.dataproc.v1.NodeInitializationAction initialization_actions = 11 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| List<? extends com.google.cloud.dataproc.v1.NodeInitializationActionOrBuilder> | |
getLifecycleConfig()
public LifecycleConfig getLifecycleConfig()
Optional. Lifecycle setting for the cluster.
.google.cloud.dataproc.v1.LifecycleConfig lifecycle_config = 17 [(.google.api.field_behavior) = OPTIONAL];
getLifecycleConfigOrBuilder()
public LifecycleConfigOrBuilder getLifecycleConfigOrBuilder()
Optional. Lifecycle setting for the cluster.
.google.cloud.dataproc.v1.LifecycleConfig lifecycle_config = 17 [(.google.api.field_behavior) = OPTIONAL];
getMasterConfig()
public InstanceGroupConfig getMasterConfig()
Optional. The Compute Engine config settings for
the cluster's master instance.
.google.cloud.dataproc.v1.InstanceGroupConfig master_config = 9 [(.google.api.field_behavior) = OPTIONAL];
getMasterConfigOrBuilder()
public InstanceGroupConfigOrBuilder getMasterConfigOrBuilder()
Optional. The Compute Engine config settings for
the cluster's master instance.
.google.cloud.dataproc.v1.InstanceGroupConfig master_config = 9 [(.google.api.field_behavior) = OPTIONAL];
public MetastoreConfig getMetastoreConfig()
Optional. Metastore configuration.
.google.cloud.dataproc.v1.MetastoreConfig metastore_config = 20 [(.google.api.field_behavior) = OPTIONAL];
public MetastoreConfigOrBuilder getMetastoreConfigOrBuilder()
Optional. Metastore configuration.
.google.cloud.dataproc.v1.MetastoreConfig metastore_config = 20 [(.google.api.field_behavior) = OPTIONAL];
getParserForType()
public Parser<ClusterConfig> getParserForType()
Returns
Overrides
getSecondaryWorkerConfig()
public InstanceGroupConfig getSecondaryWorkerConfig()
Optional. The Compute Engine config settings for
a cluster's secondary worker instances
.google.cloud.dataproc.v1.InstanceGroupConfig secondary_worker_config = 12 [(.google.api.field_behavior) = OPTIONAL];
getSecondaryWorkerConfigOrBuilder()
public InstanceGroupConfigOrBuilder getSecondaryWorkerConfigOrBuilder()
Optional. The Compute Engine config settings for
a cluster's secondary worker instances
.google.cloud.dataproc.v1.InstanceGroupConfig secondary_worker_config = 12 [(.google.api.field_behavior) = OPTIONAL];
getSecurityConfig()
public SecurityConfig getSecurityConfig()
Optional. Security settings for the cluster.
.google.cloud.dataproc.v1.SecurityConfig security_config = 16 [(.google.api.field_behavior) = OPTIONAL];
getSecurityConfigOrBuilder()
public SecurityConfigOrBuilder getSecurityConfigOrBuilder()
Optional. Security settings for the cluster.
.google.cloud.dataproc.v1.SecurityConfig security_config = 16 [(.google.api.field_behavior) = OPTIONAL];
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSoftwareConfig()
public SoftwareConfig getSoftwareConfig()
Optional. The config settings for cluster software.
.google.cloud.dataproc.v1.SoftwareConfig software_config = 13 [(.google.api.field_behavior) = OPTIONAL];
getSoftwareConfigOrBuilder()
public SoftwareConfigOrBuilder getSoftwareConfigOrBuilder()
Optional. The config settings for cluster software.
.google.cloud.dataproc.v1.SoftwareConfig software_config = 13 [(.google.api.field_behavior) = OPTIONAL];
getTempBucket()
public String getTempBucket()
Optional. A Cloud Storage bucket used to store ephemeral cluster and jobs data,
such as Spark and MapReduce history files.
If you do not specify a temp bucket,
Dataproc will determine a Cloud Storage location (US,
ASIA, or EU) for your cluster's temp bucket according to the
Compute Engine zone where your cluster is deployed, and then create
and manage this project-level, per-location bucket. The default bucket has
a TTL of 90 days, but you can use any TTL (or none) if you specify a
bucket (see
Dataproc staging and temp
buckets).
This field requires a Cloud Storage bucket name, not a gs://... URI to
a Cloud Storage bucket.
string temp_bucket = 2 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| String | The tempBucket.
|
getTempBucketBytes()
public ByteString getTempBucketBytes()
Optional. A Cloud Storage bucket used to store ephemeral cluster and jobs data,
such as Spark and MapReduce history files.
If you do not specify a temp bucket,
Dataproc will determine a Cloud Storage location (US,
ASIA, or EU) for your cluster's temp bucket according to the
Compute Engine zone where your cluster is deployed, and then create
and manage this project-level, per-location bucket. The default bucket has
a TTL of 90 days, but you can use any TTL (or none) if you specify a
bucket (see
Dataproc staging and temp
buckets).
This field requires a Cloud Storage bucket name, not a gs://... URI to
a Cloud Storage bucket.
string temp_bucket = 2 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| ByteString | The bytes for tempBucket.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getWorkerConfig()
public InstanceGroupConfig getWorkerConfig()
Optional. The Compute Engine config settings for
the cluster's worker instances.
.google.cloud.dataproc.v1.InstanceGroupConfig worker_config = 10 [(.google.api.field_behavior) = OPTIONAL];
getWorkerConfigOrBuilder()
public InstanceGroupConfigOrBuilder getWorkerConfigOrBuilder()
Optional. The Compute Engine config settings for
the cluster's worker instances.
.google.cloud.dataproc.v1.InstanceGroupConfig worker_config = 10 [(.google.api.field_behavior) = OPTIONAL];
hasAutoscalingConfig()
public boolean hasAutoscalingConfig()
Optional. Autoscaling config for the policy associated with the cluster.
Cluster does not autoscale if this field is unset.
.google.cloud.dataproc.v1.AutoscalingConfig autoscaling_config = 18 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the autoscalingConfig field is set.
|
hasEncryptionConfig()
public boolean hasEncryptionConfig()
Optional. Encryption settings for the cluster.
.google.cloud.dataproc.v1.EncryptionConfig encryption_config = 15 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the encryptionConfig field is set.
|
hasEndpointConfig()
public boolean hasEndpointConfig()
Optional. Port/endpoint configuration for this cluster
.google.cloud.dataproc.v1.EndpointConfig endpoint_config = 19 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the endpointConfig field is set.
|
hasGceClusterConfig()
public boolean hasGceClusterConfig()
Optional. The shared Compute Engine config settings for
all instances in a cluster.
.google.cloud.dataproc.v1.GceClusterConfig gce_cluster_config = 8 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the gceClusterConfig field is set.
|
hasGkeClusterConfig()
public boolean hasGkeClusterConfig()
Optional. BETA. The Kubernetes Engine config for Dataproc clusters deployed to
Kubernetes. Setting this is considered mutually exclusive with Compute
Engine-based options such as gce_cluster_config, master_config,
worker_config, secondary_worker_config, and autoscaling_config.
.google.cloud.dataproc.v1.GkeClusterConfig gke_cluster_config = 21 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the gkeClusterConfig field is set.
|
hasLifecycleConfig()
public boolean hasLifecycleConfig()
Optional. Lifecycle setting for the cluster.
.google.cloud.dataproc.v1.LifecycleConfig lifecycle_config = 17 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the lifecycleConfig field is set.
|
hasMasterConfig()
public boolean hasMasterConfig()
Optional. The Compute Engine config settings for
the cluster's master instance.
.google.cloud.dataproc.v1.InstanceGroupConfig master_config = 9 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the masterConfig field is set.
|
public boolean hasMetastoreConfig()
Optional. Metastore configuration.
.google.cloud.dataproc.v1.MetastoreConfig metastore_config = 20 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the metastoreConfig field is set.
|
hasSecondaryWorkerConfig()
public boolean hasSecondaryWorkerConfig()
Optional. The Compute Engine config settings for
a cluster's secondary worker instances
.google.cloud.dataproc.v1.InstanceGroupConfig secondary_worker_config = 12 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the secondaryWorkerConfig field is set.
|
hasSecurityConfig()
public boolean hasSecurityConfig()
Optional. Security settings for the cluster.
.google.cloud.dataproc.v1.SecurityConfig security_config = 16 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the securityConfig field is set.
|
hasSoftwareConfig()
public boolean hasSoftwareConfig()
Optional. The config settings for cluster software.
.google.cloud.dataproc.v1.SoftwareConfig software_config = 13 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the softwareConfig field is set.
|
hasWorkerConfig()
public boolean hasWorkerConfig()
Optional. The Compute Engine config settings for
the cluster's worker instances.
.google.cloud.dataproc.v1.InstanceGroupConfig worker_config = 10 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the workerConfig field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static ClusterConfig.Builder newBuilder()
Returns
newBuilder(ClusterConfig prototype)
public static ClusterConfig.Builder newBuilder(ClusterConfig prototype)
Parameter
Returns
newBuilderForType()
public ClusterConfig.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ClusterConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static ClusterConfig parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ClusterConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ClusterConfig parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ClusterConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ClusterConfig parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ClusterConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ClusterConfig parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ClusterConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ClusterConfig parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ClusterConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ClusterConfig parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ClusterConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ClusterConfig> parser()
Returns
toBuilder()
public ClusterConfig.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
