/*
* 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 UpdateClusterRequestOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dataproc.v1.UpdateClusterRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Required. The ID of the Google Cloud Platform project the
* cluster belongs to.
*
*
* string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
*
* @return The projectId.
*/
java.lang.String getProjectId();
/**
*
*
*
* Required. The ID of the Google Cloud Platform project the
* cluster belongs to.
*
*
* string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for projectId.
*/
com.google.protobuf.ByteString getProjectIdBytes();
/**
*
*
*
* Required. The Dataproc region in which to handle the request.
*
*
* string region = 5 [(.google.api.field_behavior) = REQUIRED];
*
* @return The region.
*/
java.lang.String getRegion();
/**
*
*
*
* Required. The Dataproc region in which to handle the request.
*
*
* string region = 5 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for region.
*/
com.google.protobuf.ByteString getRegionBytes();
/**
*
*
*
* Required. The cluster name.
*
*
* string cluster_name = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @return The clusterName.
*/
java.lang.String getClusterName();
/**
*
*
*
* Required. The cluster name.
*
*
* string cluster_name = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for clusterName.
*/
com.google.protobuf.ByteString getClusterNameBytes();
/**
*
*
*
* Required. The changes to the cluster.
*
*
* .google.cloud.dataproc.v1.Cluster cluster = 3 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return Whether the cluster field is set.
*/
boolean hasCluster();
/**
*
*
*
* Required. The changes to the cluster.
*
*
* .google.cloud.dataproc.v1.Cluster cluster = 3 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return The cluster.
*/
com.google.cloud.dataproc.v1.Cluster getCluster();
/**
*
*
*
* Required. The changes to the cluster.
*
*
* .google.cloud.dataproc.v1.Cluster cluster = 3 [(.google.api.field_behavior) = REQUIRED];
*
*/
com.google.cloud.dataproc.v1.ClusterOrBuilder getClusterOrBuilder();
/**
*
*
*
* Optional. Timeout for graceful YARN decommissioning. Graceful
* decommissioning allows removing nodes from the cluster without
* interrupting jobs in progress. Timeout specifies how long to wait for jobs
* in progress to finish before forcefully removing nodes (and potentially
* interrupting jobs). Default timeout is 0 (for forceful decommission), and
* the maximum allowed timeout is 1 day. (see JSON representation of
* [Duration](https://developers.google.com/protocol-buffers/docs/proto3#json)).
* Only supported on Dataproc image versions 1.2 and higher.
*
*
*
* .google.protobuf.Duration graceful_decommission_timeout = 6 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the gracefulDecommissionTimeout field is set.
*/
boolean hasGracefulDecommissionTimeout();
/**
*
*
*
* Optional. Timeout for graceful YARN decommissioning. Graceful
* decommissioning allows removing nodes from the cluster without
* interrupting jobs in progress. Timeout specifies how long to wait for jobs
* in progress to finish before forcefully removing nodes (and potentially
* interrupting jobs). Default timeout is 0 (for forceful decommission), and
* the maximum allowed timeout is 1 day. (see JSON representation of
* [Duration](https://developers.google.com/protocol-buffers/docs/proto3#json)).
* Only supported on Dataproc image versions 1.2 and higher.
*
*
*
* .google.protobuf.Duration graceful_decommission_timeout = 6 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The gracefulDecommissionTimeout.
*/
com.google.protobuf.Duration getGracefulDecommissionTimeout();
/**
*
*
*
* Optional. Timeout for graceful YARN decommissioning. Graceful
* decommissioning allows removing nodes from the cluster without
* interrupting jobs in progress. Timeout specifies how long to wait for jobs
* in progress to finish before forcefully removing nodes (and potentially
* interrupting jobs). Default timeout is 0 (for forceful decommission), and
* the maximum allowed timeout is 1 day. (see JSON representation of
* [Duration](https://developers.google.com/protocol-buffers/docs/proto3#json)).
* Only supported on Dataproc image versions 1.2 and higher.
*
*
*
* .google.protobuf.Duration graceful_decommission_timeout = 6 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.protobuf.DurationOrBuilder getGracefulDecommissionTimeoutOrBuilder();
/**
*
*
*
* Required. Specifies the path, relative to `Cluster`, of
* the field to update. For example, to change the number of workers
* in a cluster to 5, the `update_mask` parameter would be
* specified as `config.worker_config.num_instances`,
* and the `PATCH` request body would specify the new value, as follows:
* {
* "config":{
* "workerConfig":{
* "numInstances":"5"
* }
* }
* }
* Similarly, to change the number of preemptible workers in a cluster to 5,
* the `update_mask` parameter would be
* `config.secondary_worker_config.num_instances`, and the `PATCH` request
* body would be set as follows:
* {
* "config":{
* "secondaryWorkerConfig":{
* "numInstances":"5"
* }
* }
* }
* <strong>Note:</strong> Currently, only the following fields can be updated:
* <table>
* <tbody>
* <tr>
* <td><strong>Mask</strong></td>
* <td><strong>Purpose</strong></td>
* </tr>
* <tr>
* <td><strong><em>labels</em></strong></td>
* <td>Update labels</td>
* </tr>
* <tr>
* <td><strong><em>config.worker_config.num_instances</em></strong></td>
* <td>Resize primary worker group</td>
* </tr>
* <tr>
* <td><strong><em>config.secondary_worker_config.num_instances</em></strong></td>
* <td>Resize secondary worker group</td>
* </tr>
* <tr>
* <td>config.autoscaling_config.policy_uri</td><td>Use, stop using, or
* change autoscaling policies</td>
* </tr>
* </tbody>
* </table>
*
*
* .google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return Whether the updateMask field is set.
*/
boolean hasUpdateMask();
/**
*
*
*
* Required. Specifies the path, relative to `Cluster`, of
* the field to update. For example, to change the number of workers
* in a cluster to 5, the `update_mask` parameter would be
* specified as `config.worker_config.num_instances`,
* and the `PATCH` request body would specify the new value, as follows:
* {
* "config":{
* "workerConfig":{
* "numInstances":"5"
* }
* }
* }
* Similarly, to change the number of preemptible workers in a cluster to 5,
* the `update_mask` parameter would be
* `config.secondary_worker_config.num_instances`, and the `PATCH` request
* body would be set as follows:
* {
* "config":{
* "secondaryWorkerConfig":{
* "numInstances":"5"
* }
* }
* }
* <strong>Note:</strong> Currently, only the following fields can be updated:
* <table>
* <tbody>
* <tr>
* <td><strong>Mask</strong></td>
* <td><strong>Purpose</strong></td>
* </tr>
* <tr>
* <td><strong><em>labels</em></strong></td>
* <td>Update labels</td>
* </tr>
* <tr>
* <td><strong><em>config.worker_config.num_instances</em></strong></td>
* <td>Resize primary worker group</td>
* </tr>
* <tr>
* <td><strong><em>config.secondary_worker_config.num_instances</em></strong></td>
* <td>Resize secondary worker group</td>
* </tr>
* <tr>
* <td>config.autoscaling_config.policy_uri</td><td>Use, stop using, or
* change autoscaling policies</td>
* </tr>
* </tbody>
* </table>
*
*
* .google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return The updateMask.
*/
com.google.protobuf.FieldMask getUpdateMask();
/**
*
*
*
* Required. Specifies the path, relative to `Cluster`, of
* the field to update. For example, to change the number of workers
* in a cluster to 5, the `update_mask` parameter would be
* specified as `config.worker_config.num_instances`,
* and the `PATCH` request body would specify the new value, as follows:
* {
* "config":{
* "workerConfig":{
* "numInstances":"5"
* }
* }
* }
* Similarly, to change the number of preemptible workers in a cluster to 5,
* the `update_mask` parameter would be
* `config.secondary_worker_config.num_instances`, and the `PATCH` request
* body would be set as follows:
* {
* "config":{
* "secondaryWorkerConfig":{
* "numInstances":"5"
* }
* }
* }
* <strong>Note:</strong> Currently, only the following fields can be updated:
* <table>
* <tbody>
* <tr>
* <td><strong>Mask</strong></td>
* <td><strong>Purpose</strong></td>
* </tr>
* <tr>
* <td><strong><em>labels</em></strong></td>
* <td>Update labels</td>
* </tr>
* <tr>
* <td><strong><em>config.worker_config.num_instances</em></strong></td>
* <td>Resize primary worker group</td>
* </tr>
* <tr>
* <td><strong><em>config.secondary_worker_config.num_instances</em></strong></td>
* <td>Resize secondary worker group</td>
* </tr>
* <tr>
* <td>config.autoscaling_config.policy_uri</td><td>Use, stop using, or
* change autoscaling policies</td>
* </tr>
* </tbody>
* </table>
*
*
* .google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = REQUIRED];
*
*/
com.google.protobuf.FieldMaskOrBuilder getUpdateMaskOrBuilder();
/**
*
*
*
* Optional. A unique ID used to identify the request. If the server
* receives two
* [UpdateClusterRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.UpdateClusterRequest)s
* with the same id, then the second request will be ignored and the
* first [google.longrunning.Operation][google.longrunning.Operation] created
* and stored in the backend is returned.
* It is recommended to always set this value to a
* [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).
* The ID must contain only letters (a-z, A-Z), numbers (0-9),
* underscores (_), and hyphens (-). The maximum length is 40 characters.
*
*
* string request_id = 7 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The requestId.
*/
java.lang.String getRequestId();
/**
*
*
*
* Optional. A unique ID used to identify the request. If the server
* receives two
* [UpdateClusterRequest](https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.UpdateClusterRequest)s
* with the same id, then the second request will be ignored and the
* first [google.longrunning.Operation][google.longrunning.Operation] created
* and stored in the backend is returned.
* It is recommended to always set this value to a
* [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).
* The ID must contain only letters (a-z, A-Z), numbers (0-9),
* underscores (_), and hyphens (-). The maximum length is 40 characters.
*
*
* string request_id = 7 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for requestId.
*/
com.google.protobuf.ByteString getRequestIdBytes();
}