/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/dataproc/v1/clusters.proto
package com.google.cloud.dataproc.v1;
public interface ClusterConfigOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dataproc.v1.ClusterConfig)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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];
*
* @return The configBucket.
*/
java.lang.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];
*
* @return The bytes for configBucket.
*/
com.google.protobuf.ByteString getConfigBucketBytes();
/**
*
*
*
* 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];
*
* @return The tempBucket.
*/
java.lang.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];
*
* @return The bytes for tempBucket.
*/
com.google.protobuf.ByteString getTempBucketBytes();
/**
*
*
*
* 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];
*
*
* @return Whether the gceClusterConfig field is set.
*/
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];
*
*
* @return The gceClusterConfig.
*/
com.google.cloud.dataproc.v1.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];
*
*/
com.google.cloud.dataproc.v1.GceClusterConfigOrBuilder getGceClusterConfigOrBuilder();
/**
*
*
*
* 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];
*
*
* @return Whether the masterConfig field is set.
*/
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];
*
*
* @return The masterConfig.
*/
com.google.cloud.dataproc.v1.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];
*
*/
com.google.cloud.dataproc.v1.InstanceGroupConfigOrBuilder getMasterConfigOrBuilder();
/**
*
*
*
* 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];
*
*
* @return Whether the workerConfig field is set.
*/
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];
*
*
* @return The workerConfig.
*/
com.google.cloud.dataproc.v1.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];
*
*/
com.google.cloud.dataproc.v1.InstanceGroupConfigOrBuilder getWorkerConfigOrBuilder();
/**
*
*
*
* 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];
*
*
* @return Whether the secondaryWorkerConfig field is set.
*/
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];
*
*
* @return The secondaryWorkerConfig.
*/
com.google.cloud.dataproc.v1.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];
*
*/
com.google.cloud.dataproc.v1.InstanceGroupConfigOrBuilder getSecondaryWorkerConfigOrBuilder();
/**
*
*
*
* Optional. The config settings for cluster software.
*
*
*
* .google.cloud.dataproc.v1.SoftwareConfig software_config = 13 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the softwareConfig field is set.
*/
boolean hasSoftwareConfig();
/**
*
*
*
* Optional. The config settings for cluster software.
*
*
*
* .google.cloud.dataproc.v1.SoftwareConfig software_config = 13 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The softwareConfig.
*/
com.google.cloud.dataproc.v1.SoftwareConfig getSoftwareConfig();
/**
*
*
*
* Optional. The config settings for cluster software.
*
*
*
* .google.cloud.dataproc.v1.SoftwareConfig software_config = 13 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.SoftwareConfigOrBuilder getSoftwareConfigOrBuilder();
/**
*
*
*
* 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];
*
*/
java.util.List
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];
*
*/
com.google.cloud.dataproc.v1.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];
*
*/
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];
*
*/
java.util.List
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];
*
*/
com.google.cloud.dataproc.v1.NodeInitializationActionOrBuilder getInitializationActionsOrBuilder(
int index);
/**
*
*
*
* Optional. Encryption settings for the cluster.
*
*
*
* .google.cloud.dataproc.v1.EncryptionConfig encryption_config = 15 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the encryptionConfig field is set.
*/
boolean hasEncryptionConfig();
/**
*
*
*
* Optional. Encryption settings for the cluster.
*
*
*
* .google.cloud.dataproc.v1.EncryptionConfig encryption_config = 15 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The encryptionConfig.
*/
com.google.cloud.dataproc.v1.EncryptionConfig getEncryptionConfig();
/**
*
*
*
* Optional. Encryption settings for the cluster.
*
*
*
* .google.cloud.dataproc.v1.EncryptionConfig encryption_config = 15 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.EncryptionConfigOrBuilder getEncryptionConfigOrBuilder();
/**
*
*
*
* 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];
*
*
* @return Whether the autoscalingConfig field is set.
*/
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];
*
*
* @return The autoscalingConfig.
*/
com.google.cloud.dataproc.v1.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];
*
*/
com.google.cloud.dataproc.v1.AutoscalingConfigOrBuilder getAutoscalingConfigOrBuilder();
/**
*
*
*
* Optional. Security settings for the cluster.
*
*
*
* .google.cloud.dataproc.v1.SecurityConfig security_config = 16 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the securityConfig field is set.
*/
boolean hasSecurityConfig();
/**
*
*
*
* Optional. Security settings for the cluster.
*
*
*
* .google.cloud.dataproc.v1.SecurityConfig security_config = 16 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The securityConfig.
*/
com.google.cloud.dataproc.v1.SecurityConfig getSecurityConfig();
/**
*
*
*
* Optional. Security settings for the cluster.
*
*
*
* .google.cloud.dataproc.v1.SecurityConfig security_config = 16 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.SecurityConfigOrBuilder getSecurityConfigOrBuilder();
/**
*
*
*
* Optional. Lifecycle setting for the cluster.
*
*
*
* .google.cloud.dataproc.v1.LifecycleConfig lifecycle_config = 17 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the lifecycleConfig field is set.
*/
boolean hasLifecycleConfig();
/**
*
*
*
* Optional. Lifecycle setting for the cluster.
*
*
*
* .google.cloud.dataproc.v1.LifecycleConfig lifecycle_config = 17 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The lifecycleConfig.
*/
com.google.cloud.dataproc.v1.LifecycleConfig getLifecycleConfig();
/**
*
*
*
* Optional. Lifecycle setting for the cluster.
*
*
*
* .google.cloud.dataproc.v1.LifecycleConfig lifecycle_config = 17 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.LifecycleConfigOrBuilder getLifecycleConfigOrBuilder();
/**
*
*
*
* Optional. Port/endpoint configuration for this cluster
*
*
*
* .google.cloud.dataproc.v1.EndpointConfig endpoint_config = 19 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the endpointConfig field is set.
*/
boolean hasEndpointConfig();
/**
*
*
*
* Optional. Port/endpoint configuration for this cluster
*
*
*
* .google.cloud.dataproc.v1.EndpointConfig endpoint_config = 19 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The endpointConfig.
*/
com.google.cloud.dataproc.v1.EndpointConfig getEndpointConfig();
/**
*
*
*
* Optional. Port/endpoint configuration for this cluster
*
*
*
* .google.cloud.dataproc.v1.EndpointConfig endpoint_config = 19 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.EndpointConfigOrBuilder getEndpointConfigOrBuilder();
/**
*
*
*
* Optional. Metastore configuration.
*
*
*
* .google.cloud.dataproc.v1.MetastoreConfig metastore_config = 20 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the metastoreConfig field is set.
*/
boolean hasMetastoreConfig();
/**
*
*
*
* Optional. Metastore configuration.
*
*
*
* .google.cloud.dataproc.v1.MetastoreConfig metastore_config = 20 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The metastoreConfig.
*/
com.google.cloud.dataproc.v1.MetastoreConfig getMetastoreConfig();
/**
*
*
*
* Optional. Metastore configuration.
*
*
*
* .google.cloud.dataproc.v1.MetastoreConfig metastore_config = 20 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.MetastoreConfigOrBuilder getMetastoreConfigOrBuilder();
/**
*
*
*
* Optional. The config for Dataproc metrics.
*
*
*
* .google.cloud.dataproc.v1.DataprocMetricConfig dataproc_metric_config = 23 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the dataprocMetricConfig field is set.
*/
boolean hasDataprocMetricConfig();
/**
*
*
*
* Optional. The config for Dataproc metrics.
*
*
*
* .google.cloud.dataproc.v1.DataprocMetricConfig dataproc_metric_config = 23 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The dataprocMetricConfig.
*/
com.google.cloud.dataproc.v1.DataprocMetricConfig getDataprocMetricConfig();
/**
*
*
*
* Optional. The config for Dataproc metrics.
*
*
*
* .google.cloud.dataproc.v1.DataprocMetricConfig dataproc_metric_config = 23 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.DataprocMetricConfigOrBuilder getDataprocMetricConfigOrBuilder();
/**
*
*
*
* Optional. The node group settings.
*
*
*
* repeated .google.cloud.dataproc.v1.AuxiliaryNodeGroup auxiliary_node_groups = 25 [(.google.api.field_behavior) = OPTIONAL];
*
*/
java.util.List getAuxiliaryNodeGroupsList();
/**
*
*
*
* Optional. The node group settings.
*
*
*
* repeated .google.cloud.dataproc.v1.AuxiliaryNodeGroup auxiliary_node_groups = 25 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.AuxiliaryNodeGroup getAuxiliaryNodeGroups(int index);
/**
*
*
*
* Optional. The node group settings.
*
*
*
* repeated .google.cloud.dataproc.v1.AuxiliaryNodeGroup auxiliary_node_groups = 25 [(.google.api.field_behavior) = OPTIONAL];
*
*/
int getAuxiliaryNodeGroupsCount();
/**
*
*
*
* Optional. The node group settings.
*
*
*
* repeated .google.cloud.dataproc.v1.AuxiliaryNodeGroup auxiliary_node_groups = 25 [(.google.api.field_behavior) = OPTIONAL];
*
*/
java.util.List
getAuxiliaryNodeGroupsOrBuilderList();
/**
*
*
*
* Optional. The node group settings.
*
*
*
* repeated .google.cloud.dataproc.v1.AuxiliaryNodeGroup auxiliary_node_groups = 25 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.AuxiliaryNodeGroupOrBuilder getAuxiliaryNodeGroupsOrBuilder(
int index);
}