Interface ClusterConfigOrBuilder (4.5.0)

Version 4.5.0

• 4.52.0 (latest)
• 4.51.0
• 4.50.0
• 4.49.0
• 4.48.0
• 4.46.0
• 4.45.0
• 4.44.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.34.0
• 4.33.0
• 4.32.0
• 4.31.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.16.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.0
• 4.8.0
• 4.6.0
• 4.5.0
• 4.4.0
• 4.3.0
• 4.2.0
• 4.1.0
• 4.0.8
• 3.1.2
• 3.0.3
• 2.3.1

public interface ClusterConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAutoscalingConfig()

public abstract 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.

getAutoscalingConfigOrBuilder()

public abstract 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 abstract 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

getAuxiliaryNodeGroupsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getDataprocMetricConfigOrBuilder()

public abstract 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

getEncryptionConfig()

public abstract 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.

getEncryptionConfigOrBuilder()

public abstract 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 abstract 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.

getEndpointConfigOrBuilder()

public abstract 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 abstract 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.

getGceClusterConfigOrBuilder()

public abstract 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 abstract 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

getInitializationActionsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getLifecycleConfigOrBuilder()

public abstract 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 abstract 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.

getMasterConfigOrBuilder()

public abstract 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 abstract MetastoreConfig getMetastoreConfig()

Optional. Metastore configuration.

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

Returns

Type	Description
MetastoreConfig	The metastoreConfig.

getMetastoreConfigOrBuilder()

public abstract MetastoreConfigOrBuilder getMetastoreConfigOrBuilder()

Optional. Metastore configuration.

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

Returns

Type	Description
MetastoreConfigOrBuilder

getSecondaryWorkerConfig()

public abstract 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.

getSecondaryWorkerConfigOrBuilder()

public abstract 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 abstract 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.

getSecurityConfigOrBuilder()

public abstract 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 abstract 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.

getSoftwareConfigOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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.

getWorkerConfigOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.