Package com.google.cloud.dataproc.v1

Interface ClusterConfigOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ClusterConfig, ClusterConfig.Builder
    public interface ClusterConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getConfigBucket

        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](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)).
 **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:
        The configBucket.

      • getConfigBucketBytes

        com.google.protobuf.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](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)).
 **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:
        The bytes for configBucket.

      • getTempBucket

        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](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)).
 **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:
        The tempBucket.

      • getTempBucketBytes

        com.google.protobuf.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](https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)).
 **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:
        The bytes for tempBucket.

      • hasGceClusterConfig

        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:
        Whether the gceClusterConfig field is set.

      • getGceClusterConfig

        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:
        The gceClusterConfig.

      • getGceClusterConfigOrBuilder

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

      • hasMasterConfig

        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:
        Whether the masterConfig field is set.

      • getMasterConfig

        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:
        The masterConfig.

      • getMasterConfigOrBuilder

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

      • hasWorkerConfig

        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:
        Whether the workerConfig field is set.

      • getWorkerConfig

        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:
        The workerConfig.

      • getWorkerConfigOrBuilder

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

      • hasSecondaryWorkerConfig

        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:
        Whether the secondaryWorkerConfig field is set.

      • getSecondaryWorkerConfig

        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:
        The secondaryWorkerConfig.

      • getSecondaryWorkerConfigOrBuilder

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

      • hasSoftwareConfig

        boolean hasSoftwareConfig()
         Optional. The config settings for cluster software.
        .google.cloud.dataproc.v1.SoftwareConfig software_config = 13 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the softwareConfig field is set.

      • getSoftwareConfig

        SoftwareConfig getSoftwareConfig()
         Optional. The config settings for cluster software.
        .google.cloud.dataproc.v1.SoftwareConfig software_config = 13 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The softwareConfig.

      • getSoftwareConfigOrBuilder

        SoftwareConfigOrBuilder getSoftwareConfigOrBuilder()
         Optional. The config settings for cluster software.
        .google.cloud.dataproc.v1.SoftwareConfig software_config = 13 [(.google.api.field_behavior) = OPTIONAL];

      • getInitializationActionsList

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

      • getInitializationActions

        NodeInitializationAction getInitializationActions​(int index)
         Optional. Commands to execute on each node after config is
 completed. By default, executables are run on master and all worker nodes.
 You can test a node's `role` metadata to run an executable on
 a master or worker node, as shown below using `curl` (you can also use
 `wget`):

     ROLE=$(curl -H Metadata-Flavor:Google
     http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)
     if [[ "${ROLE}" == 'Master' ]]; then
       ... master specific actions ...
     else
       ... worker specific actions ...
     fi
        repeated .google.cloud.dataproc.v1.NodeInitializationAction initialization_actions = 11 [(.google.api.field_behavior) = OPTIONAL];

      • getInitializationActionsCount

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

      • getInitializationActionsOrBuilderList

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

      • getInitializationActionsOrBuilder

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

      • hasEncryptionConfig

        boolean hasEncryptionConfig()
         Optional. Encryption settings for the cluster.
        .google.cloud.dataproc.v1.EncryptionConfig encryption_config = 15 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the encryptionConfig field is set.

      • getEncryptionConfig

        EncryptionConfig getEncryptionConfig()
         Optional. Encryption settings for the cluster.
        .google.cloud.dataproc.v1.EncryptionConfig encryption_config = 15 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The encryptionConfig.

      • getEncryptionConfigOrBuilder

        EncryptionConfigOrBuilder getEncryptionConfigOrBuilder()
         Optional. Encryption settings for the cluster.
        .google.cloud.dataproc.v1.EncryptionConfig encryption_config = 15 [(.google.api.field_behavior) = OPTIONAL];

      • hasAutoscalingConfig

        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:
        Whether the autoscalingConfig field is set.

      • getAutoscalingConfig

        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:
        The autoscalingConfig.

      • getAutoscalingConfigOrBuilder

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

      • hasSecurityConfig

        boolean hasSecurityConfig()
         Optional. Security settings for the cluster.
        .google.cloud.dataproc.v1.SecurityConfig security_config = 16 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the securityConfig field is set.

      • getSecurityConfig

        SecurityConfig getSecurityConfig()
         Optional. Security settings for the cluster.
        .google.cloud.dataproc.v1.SecurityConfig security_config = 16 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The securityConfig.

      • getSecurityConfigOrBuilder

        SecurityConfigOrBuilder getSecurityConfigOrBuilder()
         Optional. Security settings for the cluster.
        .google.cloud.dataproc.v1.SecurityConfig security_config = 16 [(.google.api.field_behavior) = OPTIONAL];

      • hasLifecycleConfig

        boolean hasLifecycleConfig()
         Optional. Lifecycle setting for the cluster.
        .google.cloud.dataproc.v1.LifecycleConfig lifecycle_config = 17 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the lifecycleConfig field is set.

      • getLifecycleConfig

        LifecycleConfig getLifecycleConfig()
         Optional. Lifecycle setting for the cluster.
        .google.cloud.dataproc.v1.LifecycleConfig lifecycle_config = 17 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The lifecycleConfig.

      • getLifecycleConfigOrBuilder

        LifecycleConfigOrBuilder getLifecycleConfigOrBuilder()
         Optional. Lifecycle setting for the cluster.
        .google.cloud.dataproc.v1.LifecycleConfig lifecycle_config = 17 [(.google.api.field_behavior) = OPTIONAL];

      • hasEndpointConfig

        boolean hasEndpointConfig()
         Optional. Port/endpoint configuration for this cluster
        .google.cloud.dataproc.v1.EndpointConfig endpoint_config = 19 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the endpointConfig field is set.

      • getEndpointConfig

        EndpointConfig getEndpointConfig()
         Optional. Port/endpoint configuration for this cluster
        .google.cloud.dataproc.v1.EndpointConfig endpoint_config = 19 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The endpointConfig.

      • getEndpointConfigOrBuilder

        EndpointConfigOrBuilder getEndpointConfigOrBuilder()
         Optional. Port/endpoint configuration for this cluster
        .google.cloud.dataproc.v1.EndpointConfig endpoint_config = 19 [(.google.api.field_behavior) = OPTIONAL];

      • hasMetastoreConfig

        boolean hasMetastoreConfig()
         Optional. Metastore configuration.
        .google.cloud.dataproc.v1.MetastoreConfig metastore_config = 20 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the metastoreConfig field is set.

      • getMetastoreConfig

        MetastoreConfig getMetastoreConfig()
         Optional. Metastore configuration.
        .google.cloud.dataproc.v1.MetastoreConfig metastore_config = 20 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The metastoreConfig.

      • getMetastoreConfigOrBuilder

        MetastoreConfigOrBuilder getMetastoreConfigOrBuilder()
         Optional. Metastore configuration.
        .google.cloud.dataproc.v1.MetastoreConfig metastore_config = 20 [(.google.api.field_behavior) = OPTIONAL];

      • hasDataprocMetricConfig

        boolean hasDataprocMetricConfig()
         Optional. The config for Dataproc metrics.
        .google.cloud.dataproc.v1.DataprocMetricConfig dataproc_metric_config = 23 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the dataprocMetricConfig field is set.

      • getDataprocMetricConfig

        DataprocMetricConfig getDataprocMetricConfig()
         Optional. The config for Dataproc metrics.
        .google.cloud.dataproc.v1.DataprocMetricConfig dataproc_metric_config = 23 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The dataprocMetricConfig.

      • getDataprocMetricConfigOrBuilder

        DataprocMetricConfigOrBuilder getDataprocMetricConfigOrBuilder()
         Optional. The config for Dataproc metrics.
        .google.cloud.dataproc.v1.DataprocMetricConfig dataproc_metric_config = 23 [(.google.api.field_behavior) = OPTIONAL];

      • getAuxiliaryNodeGroupsList

        List<AuxiliaryNodeGroup> getAuxiliaryNodeGroupsList()
         Optional. The node group settings.
        repeated .google.cloud.dataproc.v1.AuxiliaryNodeGroup auxiliary_node_groups = 25 [(.google.api.field_behavior) = OPTIONAL];

      • getAuxiliaryNodeGroups

        AuxiliaryNodeGroup getAuxiliaryNodeGroups​(int index)
         Optional. The node group settings.
        repeated .google.cloud.dataproc.v1.AuxiliaryNodeGroup auxiliary_node_groups = 25 [(.google.api.field_behavior) = OPTIONAL];

      • getAuxiliaryNodeGroupsCount

        int getAuxiliaryNodeGroupsCount()
         Optional. The node group settings.
        repeated .google.cloud.dataproc.v1.AuxiliaryNodeGroup auxiliary_node_groups = 25 [(.google.api.field_behavior) = OPTIONAL];

      • getAuxiliaryNodeGroupsOrBuilderList

        List<? extends AuxiliaryNodeGroupOrBuilder> getAuxiliaryNodeGroupsOrBuilderList()
         Optional. The node group settings.
        repeated .google.cloud.dataproc.v1.AuxiliaryNodeGroup auxiliary_node_groups = 25 [(.google.api.field_behavior) = OPTIONAL];

      • getAuxiliaryNodeGroupsOrBuilder

        AuxiliaryNodeGroupOrBuilder getAuxiliaryNodeGroupsOrBuilder​(int index)
         Optional. The node group settings.
        repeated .google.cloud.dataproc.v1.AuxiliaryNodeGroup auxiliary_node_groups = 25 [(.google.api.field_behavior) = OPTIONAL];