Class ClusterConfig.Builder (4.42.0) 

public static final class ClusterConfig.Builder extends GeneratedMessageV3.Builder<ClusterConfig.Builder> implements ClusterConfigOrBuilder

The cluster config.

Protobuf type google.cloud.dataproc.v1.ClusterConfig

Inheritance

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

Static Methods

getDescriptor()

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

Methods

addAllAuxiliaryNodeGroups(Iterable<? extends AuxiliaryNodeGroup> values)

public ClusterConfig.Builder addAllAuxiliaryNodeGroups(Iterable<? extends AuxiliaryNodeGroup> values)

Optional. The node group settings.

repeated .google.cloud.dataproc.v1.AuxiliaryNodeGroup auxiliary_node_groups = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.dataproc.v1.AuxiliaryNodeGroup>
Returns
Type Description
ClusterConfig.Builder

addAllInitializationActions(Iterable<? extends NodeInitializationAction> values)

public ClusterConfig.Builder addAllInitializationActions(Iterable<? extends NodeInitializationAction> values)

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.dataproc.v1.NodeInitializationAction>
Returns
Type Description
ClusterConfig.Builder

addAuxiliaryNodeGroups(AuxiliaryNodeGroup value)

public ClusterConfig.Builder addAuxiliaryNodeGroups(AuxiliaryNodeGroup value)

Optional. The node group settings.

repeated .google.cloud.dataproc.v1.AuxiliaryNodeGroup auxiliary_node_groups = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value AuxiliaryNodeGroup
Returns
Type Description
ClusterConfig.Builder

addAuxiliaryNodeGroups(AuxiliaryNodeGroup.Builder builderForValue)

public ClusterConfig.Builder addAuxiliaryNodeGroups(AuxiliaryNodeGroup.Builder builderForValue)

Optional. The node group settings.

repeated .google.cloud.dataproc.v1.AuxiliaryNodeGroup auxiliary_node_groups = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue AuxiliaryNodeGroup.Builder
Returns
Type Description
ClusterConfig.Builder

addAuxiliaryNodeGroups(int index, AuxiliaryNodeGroup value)

public ClusterConfig.Builder addAuxiliaryNodeGroups(int index, AuxiliaryNodeGroup value)

Optional. The node group settings.

repeated .google.cloud.dataproc.v1.AuxiliaryNodeGroup auxiliary_node_groups = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value AuxiliaryNodeGroup
Returns
Type Description
ClusterConfig.Builder

addAuxiliaryNodeGroups(int index, AuxiliaryNodeGroup.Builder builderForValue)

public ClusterConfig.Builder addAuxiliaryNodeGroups(int index, AuxiliaryNodeGroup.Builder builderForValue)

Optional. The node group settings.

repeated .google.cloud.dataproc.v1.AuxiliaryNodeGroup auxiliary_node_groups = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue AuxiliaryNodeGroup.Builder
Returns
Type Description
ClusterConfig.Builder

addAuxiliaryNodeGroupsBuilder()

public AuxiliaryNodeGroup.Builder addAuxiliaryNodeGroupsBuilder()

Optional. The node group settings.

repeated .google.cloud.dataproc.v1.AuxiliaryNodeGroup auxiliary_node_groups = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AuxiliaryNodeGroup.Builder

addAuxiliaryNodeGroupsBuilder(int index)

public AuxiliaryNodeGroup.Builder addAuxiliaryNodeGroupsBuilder(int index)

Optional. The node group settings.

repeated .google.cloud.dataproc.v1.AuxiliaryNodeGroup auxiliary_node_groups = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AuxiliaryNodeGroup.Builder

addInitializationActions(NodeInitializationAction value)

public ClusterConfig.Builder addInitializationActions(NodeInitializationAction value)

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

Parameter
Name Description
value NodeInitializationAction
Returns
Type Description
ClusterConfig.Builder

addInitializationActions(NodeInitializationAction.Builder builderForValue)

public ClusterConfig.Builder addInitializationActions(NodeInitializationAction.Builder builderForValue)

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

Parameter
Name Description
builderForValue NodeInitializationAction.Builder
Returns
Type Description
ClusterConfig.Builder

addInitializationActions(int index, NodeInitializationAction value)

public ClusterConfig.Builder addInitializationActions(int index, NodeInitializationAction value)

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

Parameters
Name Description
index int
value NodeInitializationAction
Returns
Type Description
ClusterConfig.Builder

addInitializationActions(int index, NodeInitializationAction.Builder builderForValue)

public ClusterConfig.Builder addInitializationActions(int index, NodeInitializationAction.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue NodeInitializationAction.Builder
Returns
Type Description
ClusterConfig.Builder

addInitializationActionsBuilder()

public NodeInitializationAction.Builder addInitializationActionsBuilder()

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

Returns
Type Description
NodeInitializationAction.Builder

addInitializationActionsBuilder(int index)

public NodeInitializationAction.Builder addInitializationActionsBuilder(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];

Parameter
Name Description
index int
Returns
Type Description
NodeInitializationAction.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ClusterConfig build()
Returns
Type Description
ClusterConfig

buildPartial()

public ClusterConfig buildPartial()
Returns
Type Description
ClusterConfig

clear()

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

clearAutoscalingConfig()

public ClusterConfig.Builder clearAutoscalingConfig()

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

Returns
Type Description
ClusterConfig.Builder

clearAuxiliaryNodeGroups()

public ClusterConfig.Builder clearAuxiliaryNodeGroups()

Optional. The node group settings.

repeated .google.cloud.dataproc.v1.AuxiliaryNodeGroup auxiliary_node_groups = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ClusterConfig.Builder

clearConfigBucket()

public ClusterConfig.Builder clearConfigBucket()

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

Returns
Type Description
ClusterConfig.Builder

This builder for chaining.

clearDataprocMetricConfig()

public ClusterConfig.Builder clearDataprocMetricConfig()

Optional. The config for Dataproc metrics.

.google.cloud.dataproc.v1.DataprocMetricConfig dataproc_metric_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ClusterConfig.Builder

clearEncryptionConfig()

public ClusterConfig.Builder clearEncryptionConfig()

Optional. Encryption settings for the cluster.

.google.cloud.dataproc.v1.EncryptionConfig encryption_config = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ClusterConfig.Builder

clearEndpointConfig()

public ClusterConfig.Builder clearEndpointConfig()

Optional. Port/endpoint configuration for this cluster

.google.cloud.dataproc.v1.EndpointConfig endpoint_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ClusterConfig.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearGceClusterConfig()

public ClusterConfig.Builder clearGceClusterConfig()

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

Returns
Type Description
ClusterConfig.Builder

clearInitializationActions()

public ClusterConfig.Builder clearInitializationActions()

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

Returns
Type Description
ClusterConfig.Builder

clearLifecycleConfig()

public ClusterConfig.Builder clearLifecycleConfig()

Optional. Lifecycle setting for the cluster.

.google.cloud.dataproc.v1.LifecycleConfig lifecycle_config = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ClusterConfig.Builder

clearMasterConfig()

public ClusterConfig.Builder clearMasterConfig()

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

Returns
Type Description
ClusterConfig.Builder

clearMetastoreConfig()

public ClusterConfig.Builder clearMetastoreConfig()

Optional. Metastore configuration.

.google.cloud.dataproc.v1.MetastoreConfig metastore_config = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ClusterConfig.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearSecondaryWorkerConfig()

public ClusterConfig.Builder clearSecondaryWorkerConfig()

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

Returns
Type Description
ClusterConfig.Builder

clearSecurityConfig()

public ClusterConfig.Builder clearSecurityConfig()

Optional. Security settings for the cluster.

.google.cloud.dataproc.v1.SecurityConfig security_config = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ClusterConfig.Builder

clearSoftwareConfig()

public ClusterConfig.Builder clearSoftwareConfig()

Optional. The config settings for cluster software.

.google.cloud.dataproc.v1.SoftwareConfig software_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ClusterConfig.Builder

clearTempBucket()

public ClusterConfig.Builder clearTempBucket()

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

Returns
Type Description
ClusterConfig.Builder

This builder for chaining.

clearWorkerConfig()

public ClusterConfig.Builder clearWorkerConfig()

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

Returns
Type Description
ClusterConfig.Builder

clone()

public ClusterConfig.Builder clone()
Returns
Type Description
ClusterConfig.Builder
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];

Returns
Type Description
AutoscalingConfig

The autoscalingConfig.

getAutoscalingConfigBuilder()

public AutoscalingConfig.Builder getAutoscalingConfigBuilder()

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

Returns
Type Description
AutoscalingConfig.Builder

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

Returns
Type Description
AutoscalingConfigOrBuilder

getAuxiliaryNodeGroups(int index)

public AuxiliaryNodeGroup getAuxiliaryNodeGroups(int index)

Optional. The node group settings.

repeated .google.cloud.dataproc.v1.AuxiliaryNodeGroup auxiliary_node_groups = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AuxiliaryNodeGroup

getAuxiliaryNodeGroupsBuilder(int index)

public AuxiliaryNodeGroup.Builder getAuxiliaryNodeGroupsBuilder(int index)

Optional. The node group settings.

repeated .google.cloud.dataproc.v1.AuxiliaryNodeGroup auxiliary_node_groups = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AuxiliaryNodeGroup.Builder

getAuxiliaryNodeGroupsBuilderList()

public List<AuxiliaryNodeGroup.Builder> getAuxiliaryNodeGroupsBuilderList()

Optional. The node group settings.

repeated .google.cloud.dataproc.v1.AuxiliaryNodeGroup auxiliary_node_groups = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getAuxiliaryNodeGroupsCount()

public int getAuxiliaryNodeGroupsCount()

Optional. The node group settings.

repeated .google.cloud.dataproc.v1.AuxiliaryNodeGroup auxiliary_node_groups = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getAuxiliaryNodeGroupsList()

public List<AuxiliaryNodeGroup> getAuxiliaryNodeGroupsList()

Optional. The node group settings.

repeated .google.cloud.dataproc.v1.AuxiliaryNodeGroup auxiliary_node_groups = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<AuxiliaryNodeGroup>

getAuxiliaryNodeGroupsOrBuilder(int index)

public AuxiliaryNodeGroupOrBuilder getAuxiliaryNodeGroupsOrBuilder(int index)

Optional. The node group settings.

repeated .google.cloud.dataproc.v1.AuxiliaryNodeGroup auxiliary_node_groups = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AuxiliaryNodeGroupOrBuilder

getAuxiliaryNodeGroupsOrBuilderList()

public List<? extends AuxiliaryNodeGroupOrBuilder> getAuxiliaryNodeGroupsOrBuilderList()

Optional. The node group settings.

repeated .google.cloud.dataproc.v1.AuxiliaryNodeGroup auxiliary_node_groups = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.dataproc.v1.AuxiliaryNodeGroupOrBuilder>

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

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

Returns
Type Description
ByteString

The bytes for configBucket.

getDataprocMetricConfig()

public DataprocMetricConfig getDataprocMetricConfig()

Optional. The config for Dataproc metrics.

.google.cloud.dataproc.v1.DataprocMetricConfig dataproc_metric_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataprocMetricConfig

The dataprocMetricConfig.

getDataprocMetricConfigBuilder()

public DataprocMetricConfig.Builder getDataprocMetricConfigBuilder()

Optional. The config for Dataproc metrics.

.google.cloud.dataproc.v1.DataprocMetricConfig dataproc_metric_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataprocMetricConfig.Builder

getDataprocMetricConfigOrBuilder()

public DataprocMetricConfigOrBuilder getDataprocMetricConfigOrBuilder()

Optional. The config for Dataproc metrics.

.google.cloud.dataproc.v1.DataprocMetricConfig dataproc_metric_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataprocMetricConfigOrBuilder

getDefaultInstanceForType()

public ClusterConfig getDefaultInstanceForType()
Returns
Type Description
ClusterConfig

getDescriptorForType()

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

getEncryptionConfig()

public EncryptionConfig getEncryptionConfig()

Optional. Encryption settings for the cluster.

.google.cloud.dataproc.v1.EncryptionConfig encryption_config = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EncryptionConfig

The encryptionConfig.

getEncryptionConfigBuilder()

public EncryptionConfig.Builder getEncryptionConfigBuilder()

Optional. Encryption settings for the cluster.

.google.cloud.dataproc.v1.EncryptionConfig encryption_config = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EncryptionConfig.Builder

getEncryptionConfigOrBuilder()

public EncryptionConfigOrBuilder getEncryptionConfigOrBuilder()

Optional. Encryption settings for the cluster.

.google.cloud.dataproc.v1.EncryptionConfig encryption_config = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EncryptionConfigOrBuilder

getEndpointConfig()

public EndpointConfig getEndpointConfig()

Optional. Port/endpoint configuration for this cluster

.google.cloud.dataproc.v1.EndpointConfig endpoint_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EndpointConfig

The endpointConfig.

getEndpointConfigBuilder()

public EndpointConfig.Builder getEndpointConfigBuilder()

Optional. Port/endpoint configuration for this cluster

.google.cloud.dataproc.v1.EndpointConfig endpoint_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EndpointConfig.Builder

getEndpointConfigOrBuilder()

public EndpointConfigOrBuilder getEndpointConfigOrBuilder()

Optional. Port/endpoint configuration for this cluster

.google.cloud.dataproc.v1.EndpointConfig endpoint_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EndpointConfigOrBuilder

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

Returns
Type Description
GceClusterConfig

The gceClusterConfig.

getGceClusterConfigBuilder()

public GceClusterConfig.Builder getGceClusterConfigBuilder()

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

Returns
Type Description
GceClusterConfig.Builder

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

Returns
Type Description
GceClusterConfigOrBuilder

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

Parameter
Name Description
index int
Returns
Type Description
NodeInitializationAction

getInitializationActionsBuilder(int index)

public NodeInitializationAction.Builder getInitializationActionsBuilder(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];

Parameter
Name Description
index int
Returns
Type Description
NodeInitializationAction.Builder

getInitializationActionsBuilderList()

public List<NodeInitializationAction.Builder> getInitializationActionsBuilderList()

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

Returns
Type Description
List<Builder>

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

Returns
Type Description
int

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

Returns
Type Description
List<NodeInitializationAction>

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

Parameter
Name Description
index int
Returns
Type Description
NodeInitializationActionOrBuilder

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

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

Returns
Type Description
LifecycleConfig

The lifecycleConfig.

getLifecycleConfigBuilder()

public LifecycleConfig.Builder getLifecycleConfigBuilder()

Optional. Lifecycle setting for the cluster.

.google.cloud.dataproc.v1.LifecycleConfig lifecycle_config = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LifecycleConfig.Builder

getLifecycleConfigOrBuilder()

public LifecycleConfigOrBuilder getLifecycleConfigOrBuilder()

Optional. Lifecycle setting for the cluster.

.google.cloud.dataproc.v1.LifecycleConfig lifecycle_config = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LifecycleConfigOrBuilder

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

Returns
Type Description
InstanceGroupConfig

The masterConfig.

getMasterConfigBuilder()

public InstanceGroupConfig.Builder getMasterConfigBuilder()

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

Returns
Type Description
InstanceGroupConfig.Builder

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

Returns
Type Description
InstanceGroupConfigOrBuilder

getMetastoreConfig()

public MetastoreConfig getMetastoreConfig()

Optional. Metastore configuration.

.google.cloud.dataproc.v1.MetastoreConfig metastore_config = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetastoreConfig

The metastoreConfig.

getMetastoreConfigBuilder()

public MetastoreConfig.Builder getMetastoreConfigBuilder()

Optional. Metastore configuration.

.google.cloud.dataproc.v1.MetastoreConfig metastore_config = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetastoreConfig.Builder

getMetastoreConfigOrBuilder()

public MetastoreConfigOrBuilder getMetastoreConfigOrBuilder()

Optional. Metastore configuration.

.google.cloud.dataproc.v1.MetastoreConfig metastore_config = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetastoreConfigOrBuilder

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

Returns
Type Description
InstanceGroupConfig

The secondaryWorkerConfig.

getSecondaryWorkerConfigBuilder()

public InstanceGroupConfig.Builder getSecondaryWorkerConfigBuilder()

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

Returns
Type Description
InstanceGroupConfig.Builder

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

Returns
Type Description
InstanceGroupConfigOrBuilder

getSecurityConfig()

public SecurityConfig getSecurityConfig()

Optional. Security settings for the cluster.

.google.cloud.dataproc.v1.SecurityConfig security_config = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SecurityConfig

The securityConfig.

getSecurityConfigBuilder()

public SecurityConfig.Builder getSecurityConfigBuilder()

Optional. Security settings for the cluster.

.google.cloud.dataproc.v1.SecurityConfig security_config = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SecurityConfig.Builder

getSecurityConfigOrBuilder()

public SecurityConfigOrBuilder getSecurityConfigOrBuilder()

Optional. Security settings for the cluster.

.google.cloud.dataproc.v1.SecurityConfig security_config = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SecurityConfigOrBuilder

getSoftwareConfig()

public SoftwareConfig getSoftwareConfig()

Optional. The config settings for cluster software.

.google.cloud.dataproc.v1.SoftwareConfig software_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SoftwareConfig

The softwareConfig.

getSoftwareConfigBuilder()

public SoftwareConfig.Builder getSoftwareConfigBuilder()

Optional. The config settings for cluster software.

.google.cloud.dataproc.v1.SoftwareConfig software_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SoftwareConfig.Builder

getSoftwareConfigOrBuilder()

public SoftwareConfigOrBuilder getSoftwareConfigOrBuilder()

Optional. The config settings for cluster software.

.google.cloud.dataproc.v1.SoftwareConfig software_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SoftwareConfigOrBuilder

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

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

Returns
Type Description
ByteString

The bytes for tempBucket.

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

Returns
Type Description
InstanceGroupConfig

The workerConfig.

getWorkerConfigBuilder()

public InstanceGroupConfig.Builder getWorkerConfigBuilder()

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

Returns
Type Description
InstanceGroupConfig.Builder

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

Returns
Type Description
InstanceGroupConfigOrBuilder

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

Returns
Type Description
boolean

Whether the autoscalingConfig field is set.

hasDataprocMetricConfig()

public boolean hasDataprocMetricConfig()

Optional. The config for Dataproc metrics.

.google.cloud.dataproc.v1.DataprocMetricConfig dataproc_metric_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the dataprocMetricConfig 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];

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

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

Returns
Type Description
boolean

Whether the gceClusterConfig 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];

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

Returns
Type Description
boolean

Whether the masterConfig field is set.

hasMetastoreConfig()

public boolean hasMetastoreConfig()

Optional. Metastore configuration.

.google.cloud.dataproc.v1.MetastoreConfig metastore_config = 20 [(.google.api.field_behavior) = OPTIONAL];

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

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

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

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

Returns
Type Description
boolean

Whether the workerConfig field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAutoscalingConfig(AutoscalingConfig value)

public ClusterConfig.Builder mergeAutoscalingConfig(AutoscalingConfig value)

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

Parameter
Name Description
value AutoscalingConfig
Returns
Type Description
ClusterConfig.Builder

mergeDataprocMetricConfig(DataprocMetricConfig value)

public ClusterConfig.Builder mergeDataprocMetricConfig(DataprocMetricConfig value)

Optional. The config for Dataproc metrics.

.google.cloud.dataproc.v1.DataprocMetricConfig dataproc_metric_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DataprocMetricConfig
Returns
Type Description
ClusterConfig.Builder

mergeEncryptionConfig(EncryptionConfig value)

public ClusterConfig.Builder mergeEncryptionConfig(EncryptionConfig value)

Optional. Encryption settings for the cluster.

.google.cloud.dataproc.v1.EncryptionConfig encryption_config = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value EncryptionConfig
Returns
Type Description
ClusterConfig.Builder

mergeEndpointConfig(EndpointConfig value)

public ClusterConfig.Builder mergeEndpointConfig(EndpointConfig value)

Optional. Port/endpoint configuration for this cluster

.google.cloud.dataproc.v1.EndpointConfig endpoint_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value EndpointConfig
Returns
Type Description
ClusterConfig.Builder

mergeFrom(ClusterConfig other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeGceClusterConfig(GceClusterConfig value)

public ClusterConfig.Builder mergeGceClusterConfig(GceClusterConfig value)

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

Parameter
Name Description
value GceClusterConfig
Returns
Type Description
ClusterConfig.Builder

mergeLifecycleConfig(LifecycleConfig value)

public ClusterConfig.Builder mergeLifecycleConfig(LifecycleConfig value)

Optional. Lifecycle setting for the cluster.

.google.cloud.dataproc.v1.LifecycleConfig lifecycle_config = 17 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value LifecycleConfig
Returns
Type Description
ClusterConfig.Builder

mergeMasterConfig(InstanceGroupConfig value)

public ClusterConfig.Builder mergeMasterConfig(InstanceGroupConfig value)

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

Parameter
Name Description
value InstanceGroupConfig
Returns
Type Description
ClusterConfig.Builder

mergeMetastoreConfig(MetastoreConfig value)

public ClusterConfig.Builder mergeMetastoreConfig(MetastoreConfig value)

Optional. Metastore configuration.

.google.cloud.dataproc.v1.MetastoreConfig metastore_config = 20 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value MetastoreConfig
Returns
Type Description
ClusterConfig.Builder

mergeSecondaryWorkerConfig(InstanceGroupConfig value)

public ClusterConfig.Builder mergeSecondaryWorkerConfig(InstanceGroupConfig value)

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

Parameter
Name Description
value InstanceGroupConfig
Returns
Type Description
ClusterConfig.Builder

mergeSecurityConfig(SecurityConfig value)

public ClusterConfig.Builder mergeSecurityConfig(SecurityConfig value)

Optional. Security settings for the cluster.

.google.cloud.dataproc.v1.SecurityConfig security_config = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value SecurityConfig
Returns
Type Description
ClusterConfig.Builder

mergeSoftwareConfig(SoftwareConfig value)

public ClusterConfig.Builder mergeSoftwareConfig(SoftwareConfig value)

Optional. The config settings for cluster software.

.google.cloud.dataproc.v1.SoftwareConfig software_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value SoftwareConfig
Returns
Type Description
ClusterConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeWorkerConfig(InstanceGroupConfig value)

public ClusterConfig.Builder mergeWorkerConfig(InstanceGroupConfig value)

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

Parameter
Name Description
value InstanceGroupConfig
Returns
Type Description
ClusterConfig.Builder

removeAuxiliaryNodeGroups(int index)

public ClusterConfig.Builder removeAuxiliaryNodeGroups(int index)

Optional. The node group settings.

repeated .google.cloud.dataproc.v1.AuxiliaryNodeGroup auxiliary_node_groups = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ClusterConfig.Builder

removeInitializationActions(int index)

public ClusterConfig.Builder removeInitializationActions(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];

Parameter
Name Description
index int
Returns
Type Description
ClusterConfig.Builder

setAutoscalingConfig(AutoscalingConfig value)

public ClusterConfig.Builder setAutoscalingConfig(AutoscalingConfig value)

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

Parameter
Name Description
value AutoscalingConfig
Returns
Type Description
ClusterConfig.Builder

setAutoscalingConfig(AutoscalingConfig.Builder builderForValue)

public ClusterConfig.Builder setAutoscalingConfig(AutoscalingConfig.Builder builderForValue)

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

Parameter
Name Description
builderForValue AutoscalingConfig.Builder
Returns
Type Description
ClusterConfig.Builder

setAuxiliaryNodeGroups(int index, AuxiliaryNodeGroup value)

public ClusterConfig.Builder setAuxiliaryNodeGroups(int index, AuxiliaryNodeGroup value)

Optional. The node group settings.

repeated .google.cloud.dataproc.v1.AuxiliaryNodeGroup auxiliary_node_groups = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value AuxiliaryNodeGroup
Returns
Type Description
ClusterConfig.Builder

setAuxiliaryNodeGroups(int index, AuxiliaryNodeGroup.Builder builderForValue)

public ClusterConfig.Builder setAuxiliaryNodeGroups(int index, AuxiliaryNodeGroup.Builder builderForValue)

Optional. The node group settings.

repeated .google.cloud.dataproc.v1.AuxiliaryNodeGroup auxiliary_node_groups = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue AuxiliaryNodeGroup.Builder
Returns
Type Description
ClusterConfig.Builder

setConfigBucket(String value)

public ClusterConfig.Builder setConfigBucket(String value)

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

Parameter
Name Description
value String

The configBucket to set.
Returns
Type Description
ClusterConfig.Builder

This builder for chaining.

setConfigBucketBytes(ByteString value)

public ClusterConfig.Builder setConfigBucketBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for configBucket to set.
Returns
Type Description
ClusterConfig.Builder

This builder for chaining.

setDataprocMetricConfig(DataprocMetricConfig value)

public ClusterConfig.Builder setDataprocMetricConfig(DataprocMetricConfig value)

Optional. The config for Dataproc metrics.

.google.cloud.dataproc.v1.DataprocMetricConfig dataproc_metric_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DataprocMetricConfig
Returns
Type Description
ClusterConfig.Builder

setDataprocMetricConfig(DataprocMetricConfig.Builder builderForValue)

public ClusterConfig.Builder setDataprocMetricConfig(DataprocMetricConfig.Builder builderForValue)

Optional. The config for Dataproc metrics.

.google.cloud.dataproc.v1.DataprocMetricConfig dataproc_metric_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue DataprocMetricConfig.Builder
Returns
Type Description
ClusterConfig.Builder

setEncryptionConfig(EncryptionConfig value)

public ClusterConfig.Builder setEncryptionConfig(EncryptionConfig value)

Optional. Encryption settings for the cluster.

.google.cloud.dataproc.v1.EncryptionConfig encryption_config = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value EncryptionConfig
Returns
Type Description
ClusterConfig.Builder

setEncryptionConfig(EncryptionConfig.Builder builderForValue)

public ClusterConfig.Builder setEncryptionConfig(EncryptionConfig.Builder builderForValue)

Optional. Encryption settings for the cluster.

.google.cloud.dataproc.v1.EncryptionConfig encryption_config = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue EncryptionConfig.Builder
Returns
Type Description
ClusterConfig.Builder

setEndpointConfig(EndpointConfig value)

public ClusterConfig.Builder setEndpointConfig(EndpointConfig value)

Optional. Port/endpoint configuration for this cluster

.google.cloud.dataproc.v1.EndpointConfig endpoint_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value EndpointConfig
Returns
Type Description
ClusterConfig.Builder

setEndpointConfig(EndpointConfig.Builder builderForValue)

public ClusterConfig.Builder setEndpointConfig(EndpointConfig.Builder builderForValue)

Optional. Port/endpoint configuration for this cluster

.google.cloud.dataproc.v1.EndpointConfig endpoint_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue EndpointConfig.Builder
Returns
Type Description
ClusterConfig.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setGceClusterConfig(GceClusterConfig value)

public ClusterConfig.Builder setGceClusterConfig(GceClusterConfig value)

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

Parameter
Name Description
value GceClusterConfig
Returns
Type Description
ClusterConfig.Builder

setGceClusterConfig(GceClusterConfig.Builder builderForValue)

public ClusterConfig.Builder setGceClusterConfig(GceClusterConfig.Builder builderForValue)

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

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

setInitializationActions(int index, NodeInitializationAction value)

public ClusterConfig.Builder setInitializationActions(int index, NodeInitializationAction value)

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

Parameters
Name Description
index int
value NodeInitializationAction
Returns
Type Description
ClusterConfig.Builder

setInitializationActions(int index, NodeInitializationAction.Builder builderForValue)

public ClusterConfig.Builder setInitializationActions(int index, NodeInitializationAction.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue NodeInitializationAction.Builder
Returns
Type Description
ClusterConfig.Builder

setLifecycleConfig(LifecycleConfig value)

public ClusterConfig.Builder setLifecycleConfig(LifecycleConfig value)

Optional. Lifecycle setting for the cluster.

.google.cloud.dataproc.v1.LifecycleConfig lifecycle_config = 17 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value LifecycleConfig
Returns
Type Description
ClusterConfig.Builder

setLifecycleConfig(LifecycleConfig.Builder builderForValue)

public ClusterConfig.Builder setLifecycleConfig(LifecycleConfig.Builder builderForValue)

Optional. Lifecycle setting for the cluster.

.google.cloud.dataproc.v1.LifecycleConfig lifecycle_config = 17 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue LifecycleConfig.Builder
Returns
Type Description
ClusterConfig.Builder

setMasterConfig(InstanceGroupConfig value)

public ClusterConfig.Builder setMasterConfig(InstanceGroupConfig value)

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

Parameter
Name Description
value InstanceGroupConfig
Returns
Type Description
ClusterConfig.Builder

setMasterConfig(InstanceGroupConfig.Builder builderForValue)

public ClusterConfig.Builder setMasterConfig(InstanceGroupConfig.Builder builderForValue)

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

Parameter
Name Description
builderForValue InstanceGroupConfig.Builder
Returns
Type Description
ClusterConfig.Builder

setMetastoreConfig(MetastoreConfig value)

public ClusterConfig.Builder setMetastoreConfig(MetastoreConfig value)

Optional. Metastore configuration.

.google.cloud.dataproc.v1.MetastoreConfig metastore_config = 20 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value MetastoreConfig
Returns
Type Description
ClusterConfig.Builder

setMetastoreConfig(MetastoreConfig.Builder builderForValue)

public ClusterConfig.Builder setMetastoreConfig(MetastoreConfig.Builder builderForValue)

Optional. Metastore configuration.

.google.cloud.dataproc.v1.MetastoreConfig metastore_config = 20 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue MetastoreConfig.Builder
Returns
Type Description
ClusterConfig.Builder

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

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

setSecondaryWorkerConfig(InstanceGroupConfig value)

public ClusterConfig.Builder setSecondaryWorkerConfig(InstanceGroupConfig value)

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

Parameter
Name Description
value InstanceGroupConfig
Returns
Type Description
ClusterConfig.Builder

setSecondaryWorkerConfig(InstanceGroupConfig.Builder builderForValue)

public ClusterConfig.Builder setSecondaryWorkerConfig(InstanceGroupConfig.Builder builderForValue)

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

Parameter
Name Description
builderForValue InstanceGroupConfig.Builder
Returns
Type Description
ClusterConfig.Builder

setSecurityConfig(SecurityConfig value)

public ClusterConfig.Builder setSecurityConfig(SecurityConfig value)

Optional. Security settings for the cluster.

.google.cloud.dataproc.v1.SecurityConfig security_config = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value SecurityConfig
Returns
Type Description
ClusterConfig.Builder

setSecurityConfig(SecurityConfig.Builder builderForValue)

public ClusterConfig.Builder setSecurityConfig(SecurityConfig.Builder builderForValue)

Optional. Security settings for the cluster.

.google.cloud.dataproc.v1.SecurityConfig security_config = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue SecurityConfig.Builder
Returns
Type Description
ClusterConfig.Builder

setSoftwareConfig(SoftwareConfig value)

public ClusterConfig.Builder setSoftwareConfig(SoftwareConfig value)

Optional. The config settings for cluster software.

.google.cloud.dataproc.v1.SoftwareConfig software_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value SoftwareConfig
Returns
Type Description
ClusterConfig.Builder

setSoftwareConfig(SoftwareConfig.Builder builderForValue)

public ClusterConfig.Builder setSoftwareConfig(SoftwareConfig.Builder builderForValue)

Optional. The config settings for cluster software.

.google.cloud.dataproc.v1.SoftwareConfig software_config = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue SoftwareConfig.Builder
Returns
Type Description
ClusterConfig.Builder

setTempBucket(String value)

public ClusterConfig.Builder setTempBucket(String value)

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

Parameter
Name Description
value String

The tempBucket to set.
Returns
Type Description
ClusterConfig.Builder

This builder for chaining.

setTempBucketBytes(ByteString value)

public ClusterConfig.Builder setTempBucketBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for tempBucket to set.
Returns
Type Description
ClusterConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setWorkerConfig(InstanceGroupConfig value)

public ClusterConfig.Builder setWorkerConfig(InstanceGroupConfig value)

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

Parameter
Name Description
value InstanceGroupConfig
Returns
Type Description
ClusterConfig.Builder

setWorkerConfig(InstanceGroupConfig.Builder builderForValue)

public ClusterConfig.Builder setWorkerConfig(InstanceGroupConfig.Builder builderForValue)

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

Parameter
Name Description
builderForValue InstanceGroupConfig.Builder
Returns
Type Description
ClusterConfig.Builder