ClusterConfig (Cloud Dataproc API v1beta2-rev20210825-1.32.1)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.dataproc.v1beta2.model.ClusterConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class ClusterConfig
extends GenericJson
```
The cluster config.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Dataproc API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

ClusterConfig()

Constructors
Constructor and Description
`ClusterConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ClusterConfig`	`clone()`
`AutoscalingConfig`	`getAutoscalingConfig()` Optional.
`String`	`getConfigBucket()` Optional.
`EncryptionConfig`	`getEncryptionConfig()` Optional.
`EndpointConfig`	`getEndpointConfig()` Optional.
`GceClusterConfig`	`getGceClusterConfig()` Optional.
`GkeClusterConfig`	`getGkeClusterConfig()` Optional.
`List<NodeInitializationAction>`	`getInitializationActions()` Optional.
`LifecycleConfig`	`getLifecycleConfig()` Optional.
`InstanceGroupConfig`	`getMasterConfig()` Optional.
`MetastoreConfig`	`getMetastoreConfig()` Optional.
`InstanceGroupConfig`	`getSecondaryWorkerConfig()` Optional.
`SecurityConfig`	`getSecurityConfig()` Optional.
`SoftwareConfig`	`getSoftwareConfig()` Optional.
`String`	`getTempBucket()` Optional.
`InstanceGroupConfig`	`getWorkerConfig()` Optional.
`ClusterConfig`	`set(String fieldName, Object value)`
`ClusterConfig`	`setAutoscalingConfig(AutoscalingConfig autoscalingConfig)` Optional.
`ClusterConfig`	`setConfigBucket(String configBucket)` Optional.
`ClusterConfig`	`setEncryptionConfig(EncryptionConfig encryptionConfig)` Optional.
`ClusterConfig`	`setEndpointConfig(EndpointConfig endpointConfig)` Optional.
`ClusterConfig`	`setGceClusterConfig(GceClusterConfig gceClusterConfig)` Optional.
`ClusterConfig`	`setGkeClusterConfig(GkeClusterConfig gkeClusterConfig)` Optional.
`ClusterConfig`	`setInitializationActions(List<NodeInitializationAction> initializationActions)` Optional.
`ClusterConfig`	`setLifecycleConfig(LifecycleConfig lifecycleConfig)` Optional.
`ClusterConfig`	`setMasterConfig(InstanceGroupConfig masterConfig)` Optional.
`ClusterConfig`	`setMetastoreConfig(MetastoreConfig metastoreConfig)` Optional.
`ClusterConfig`	`setSecondaryWorkerConfig(InstanceGroupConfig secondaryWorkerConfig)` Optional.
`ClusterConfig`	`setSecurityConfig(SecurityConfig securityConfig)` Optional.
`ClusterConfig`	`setSoftwareConfig(SoftwareConfig softwareConfig)` Optional.
`ClusterConfig`	`setTempBucket(String tempBucket)` Optional.
`ClusterConfig`	`setWorkerConfig(InstanceGroupConfig workerConfig)` Optional.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - ClusterConfig
```
public ClusterConfig()
```
- Method Detail
  - getAutoscalingConfig
```
public AutoscalingConfig getAutoscalingConfig()
```
    Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset.
    
    Returns:
    
    value or null for none
  - setAutoscalingConfig
```
public ClusterConfig setAutoscalingConfig(AutoscalingConfig autoscalingConfig)
```
    Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset.
    
    Parameters:
    
    autoscalingConfig - autoscalingConfig or null for none
  - 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 bucket (https://cloud.google.com/dataproc/docs/concepts /configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a URI to a Cloud Storage bucket.
    
    Returns:
    
    value or null for none
  - setConfigBucket
```
public ClusterConfig setConfigBucket(String configBucket)
```
    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 bucket (https://cloud.google.com/dataproc/docs/concepts /configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a URI to a Cloud Storage bucket.
    
    Parameters:
    
    configBucket - configBucket or null for none
  - getEncryptionConfig
```
public EncryptionConfig getEncryptionConfig()
```
    Optional. Encryption settings for the cluster.
    
    Returns:
    
    value or null for none
  - setEncryptionConfig
```
public ClusterConfig setEncryptionConfig(EncryptionConfig encryptionConfig)
```
    Optional. Encryption settings for the cluster.
    
    Parameters:
    
    encryptionConfig - encryptionConfig or null for none
  - getEndpointConfig
```
public EndpointConfig getEndpointConfig()
```
    Optional. Port/endpoint configuration for this cluster
    
    Returns:
    
    value or null for none
  - setEndpointConfig
```
public ClusterConfig setEndpointConfig(EndpointConfig endpointConfig)
```
    Optional. Port/endpoint configuration for this cluster
    
    Parameters:
    
    endpointConfig - endpointConfig or null for none
  - getGceClusterConfig
```
public GceClusterConfig getGceClusterConfig()
```
    Optional. The shared Compute Engine config settings for all instances in a cluster.
    
    Returns:
    
    value or null for none
  - setGceClusterConfig
```
public ClusterConfig setGceClusterConfig(GceClusterConfig gceClusterConfig)
```
    Optional. The shared Compute Engine config settings for all instances in a cluster.
    
    Parameters:
    
    gceClusterConfig - gceClusterConfig or null for none
  - getGkeClusterConfig
```
public GkeClusterConfig getGkeClusterConfig()
```
    Optional. 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.
    
    Returns:
    
    value or null for none
  - setGkeClusterConfig
```
public ClusterConfig setGkeClusterConfig(GkeClusterConfig gkeClusterConfig)
```
    Optional. 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.
    
    Parameters:
    
    gkeClusterConfig - gkeClusterConfig or null for none
  - getInitializationActions
```
public List<NodeInitializationAction> getInitializationActions()
```
    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/v1beta2/instance/attributes/dataproc-role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
    
    Returns:
    
    value or null for none
  - setInitializationActions
```
public ClusterConfig setInitializationActions(List<NodeInitializationAction> initializationActions)
```
    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/v1beta2/instance/attributes/dataproc-role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
    
    Parameters:
    
    initializationActions - initializationActions or null for none
  - getLifecycleConfig
```
public LifecycleConfig getLifecycleConfig()
```
    Optional. The config setting for auto delete cluster schedule.
    
    Returns:
    
    value or null for none
  - setLifecycleConfig
```
public ClusterConfig setLifecycleConfig(LifecycleConfig lifecycleConfig)
```
    Optional. The config setting for auto delete cluster schedule.
    
    Parameters:
    
    lifecycleConfig - lifecycleConfig or null for none
  - getMasterConfig
```
public InstanceGroupConfig getMasterConfig()
```
    Optional. The Compute Engine config settings for the master instance in a cluster.
    
    Returns:
    
    value or null for none
  - setMasterConfig
```
public ClusterConfig setMasterConfig(InstanceGroupConfig masterConfig)
```
    Optional. The Compute Engine config settings for the master instance in a cluster.
    
    Parameters:
    
    masterConfig - masterConfig or null for none
  - getMetastoreConfig
```
public MetastoreConfig getMetastoreConfig()
```
    Optional. Metastore configuration.
    
    Returns:
    
    value or null for none
  - setMetastoreConfig
```
public ClusterConfig setMetastoreConfig(MetastoreConfig metastoreConfig)
```
    Optional. Metastore configuration.
    
    Parameters:
    
    metastoreConfig - metastoreConfig or null for none
  - getSecondaryWorkerConfig
```
public InstanceGroupConfig getSecondaryWorkerConfig()
```
    Optional. The Compute Engine config settings for additional worker instances in a cluster.
    
    Returns:
    
    value or null for none
  - setSecondaryWorkerConfig
```
public ClusterConfig setSecondaryWorkerConfig(InstanceGroupConfig secondaryWorkerConfig)
```
    Optional. The Compute Engine config settings for additional worker instances in a cluster.
    
    Parameters:
    
    secondaryWorkerConfig - secondaryWorkerConfig or null for none
  - getSecurityConfig
```
public SecurityConfig getSecurityConfig()
```
    Optional. Security related configuration.
    
    Returns:
    
    value or null for none
  - setSecurityConfig
```
public ClusterConfig setSecurityConfig(SecurityConfig securityConfig)
```
    Optional. Security related configuration.
    
    Parameters:
    
    securityConfig - securityConfig or null for none
  - getSoftwareConfig
```
public SoftwareConfig getSoftwareConfig()
```
    Optional. The config settings for software inside the cluster.
    
    Returns:
    
    value or null for none
  - setSoftwareConfig
```
public ClusterConfig setSoftwareConfig(SoftwareConfig softwareConfig)
```
    Optional. The config settings for software inside the cluster.
    
    Parameters:
    
    softwareConfig - softwareConfig or null for none
  - 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. This field requires a Cloud Storage bucket name, not a URI to a Cloud Storage bucket.
    
    Returns:
    
    value or null for none
  - setTempBucket
```
public ClusterConfig setTempBucket(String tempBucket)
```
    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. This field requires a Cloud Storage bucket name, not a URI to a Cloud Storage bucket.
    
    Parameters:
    
    tempBucket - tempBucket or null for none
  - getWorkerConfig
```
public InstanceGroupConfig getWorkerConfig()
```
    Optional. The Compute Engine config settings for worker instances in a cluster.
    
    Returns:
    
    value or null for none
  - setWorkerConfig
```
public ClusterConfig setWorkerConfig(InstanceGroupConfig workerConfig)
```
    Optional. The Compute Engine config settings for worker instances in a cluster.
    
    Parameters:
    
    workerConfig - workerConfig or null for none
  - set
```
public ClusterConfig set(String fieldName,
                         Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public ClusterConfig clone()
```
    Overrides:
    
    clone in class GenericJson

Class ClusterConfig

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

ClusterConfig

Method Detail

getAutoscalingConfig

setAutoscalingConfig

getConfigBucket

setConfigBucket

getEncryptionConfig

setEncryptionConfig

getEndpointConfig

setEndpointConfig

getGceClusterConfig

setGceClusterConfig

getGkeClusterConfig

setGkeClusterConfig

getInitializationActions

setInitializationActions

getLifecycleConfig

setLifecycleConfig

getMasterConfig

setMasterConfig

getMetastoreConfig

setMetastoreConfig

getSecondaryWorkerConfig

setSecondaryWorkerConfig

getSecurityConfig

setSecurityConfig

getSoftwareConfig

setSoftwareConfig

getTempBucket

setTempBucket

getWorkerConfig

setWorkerConfig

set

clone