com.google.cloud.dataproc.v1

Class UpdateClusterRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.dataproc.v1.UpdateClusterRequest

All Implemented Interfaces:

UpdateClusterRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class UpdateClusterRequest
extends com.google.protobuf.GeneratedMessageV3
implements UpdateClusterRequestOrBuilder

 A request to update a cluster.
 

Protobuf type google.cloud.dataproc.v1.UpdateClusterRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UpdateClusterRequest.Builder A request to update a cluster.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLUSTER_FIELD_NUMBER
static int	CLUSTER_NAME_FIELD_NUMBER
static int	GRACEFUL_DECOMMISSION_TIMEOUT_FIELD_NUMBER
static int	PROJECT_ID_FIELD_NUMBER
static int	REGION_FIELD_NUMBER
static int	REQUEST_ID_FIELD_NUMBER
static int	UPDATE_MASK_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Cluster	getCluster() Required.
String	getClusterName() Required.
com.google.protobuf.ByteString	getClusterNameBytes() Required.
ClusterOrBuilder	getClusterOrBuilder() Required.
static UpdateClusterRequest	getDefaultInstance()
UpdateClusterRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Duration	getGracefulDecommissionTimeout() Optional.
com.google.protobuf.DurationOrBuilder	getGracefulDecommissionTimeoutOrBuilder() Optional.
com.google.protobuf.Parser<UpdateClusterRequest>	getParserForType()
String	getProjectId() Required.
com.google.protobuf.ByteString	getProjectIdBytes() Required.
String	getRegion() Required.
com.google.protobuf.ByteString	getRegionBytes() Required.
String	getRequestId() Optional.
com.google.protobuf.ByteString	getRequestIdBytes() Optional.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
com.google.protobuf.FieldMask	getUpdateMask() Required.
com.google.protobuf.FieldMaskOrBuilder	getUpdateMaskOrBuilder() Required.
boolean	hasCluster() Required.
boolean	hasGracefulDecommissionTimeout() Optional.
int	hashCode()
boolean	hasUpdateMask() Required.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static UpdateClusterRequest.Builder	newBuilder()
static UpdateClusterRequest.Builder	newBuilder(UpdateClusterRequest prototype)
UpdateClusterRequest.Builder	newBuilderForType()
protected UpdateClusterRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static UpdateClusterRequest	parseDelimitedFrom(InputStream input)
static UpdateClusterRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static UpdateClusterRequest	parseFrom(byte[] data)
static UpdateClusterRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static UpdateClusterRequest	parseFrom(ByteBuffer data)
static UpdateClusterRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static UpdateClusterRequest	parseFrom(com.google.protobuf.ByteString data)
static UpdateClusterRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static UpdateClusterRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static UpdateClusterRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static UpdateClusterRequest	parseFrom(InputStream input)
static UpdateClusterRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<UpdateClusterRequest>	parser()
UpdateClusterRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newInstance, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER

See Also:

Constant Field Values

REGION_FIELD_NUMBER

public static final int REGION_FIELD_NUMBER

See Also:

Constant Field Values

CLUSTER_NAME_FIELD_NUMBER

public static final int CLUSTER_NAME_FIELD_NUMBER

See Also:

Constant Field Values

CLUSTER_FIELD_NUMBER

public static final int CLUSTER_FIELD_NUMBER

See Also:

Constant Field Values

GRACEFUL_DECOMMISSION_TIMEOUT_FIELD_NUMBER

public static final int GRACEFUL_DECOMMISSION_TIMEOUT_FIELD_NUMBER

See Also:

Constant Field Values

UPDATE_MASK_FIELD_NUMBER

public static final int UPDATE_MASK_FIELD_NUMBER

See Also:

Constant Field Values

REQUEST_ID_FIELD_NUMBER

public static final int REQUEST_ID_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getProjectId

public String getProjectId()

 Required. The ID of the Google Cloud Platform project the
 cluster belongs to.
 

string project_id = 1;

Specified by:

getProjectId in interface UpdateClusterRequestOrBuilder

getProjectIdBytes

public com.google.protobuf.ByteString getProjectIdBytes()

 Required. The ID of the Google Cloud Platform project the
 cluster belongs to.
 

string project_id = 1;

Specified by:

getProjectIdBytes in interface UpdateClusterRequestOrBuilder

getRegion

public String getRegion()

 Required. The Cloud Dataproc region in which to handle the request.
 

string region = 5;

Specified by:

getRegion in interface UpdateClusterRequestOrBuilder

getRegionBytes

public com.google.protobuf.ByteString getRegionBytes()

 Required. The Cloud Dataproc region in which to handle the request.
 

string region = 5;

Specified by:

getRegionBytes in interface UpdateClusterRequestOrBuilder

getClusterName

public String getClusterName()

 Required. The cluster name.
 

string cluster_name = 2;

Specified by:

getClusterName in interface UpdateClusterRequestOrBuilder

getClusterNameBytes

public com.google.protobuf.ByteString getClusterNameBytes()

 Required. The cluster name.
 

string cluster_name = 2;

Specified by:

getClusterNameBytes in interface UpdateClusterRequestOrBuilder

hasCluster

public boolean hasCluster()

 Required. The changes to the cluster.
 

.google.cloud.dataproc.v1.Cluster cluster = 3;

Specified by:

hasCluster in interface UpdateClusterRequestOrBuilder

getCluster

public Cluster getCluster()

 Required. The changes to the cluster.
 

.google.cloud.dataproc.v1.Cluster cluster = 3;

Specified by:

getCluster in interface UpdateClusterRequestOrBuilder

getClusterOrBuilder

public ClusterOrBuilder getClusterOrBuilder()

 Required. The changes to the cluster.
 

.google.cloud.dataproc.v1.Cluster cluster = 3;

Specified by:

getClusterOrBuilder in interface UpdateClusterRequestOrBuilder

hasGracefulDecommissionTimeout

public boolean hasGracefulDecommissionTimeout()

 Optional. Timeout for graceful YARN decomissioning. 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.
 Only supported on Dataproc image versions 1.2 and higher.
 

.google.protobuf.Duration graceful_decommission_timeout = 6;

Specified by:

hasGracefulDecommissionTimeout in interface UpdateClusterRequestOrBuilder

getGracefulDecommissionTimeout

public com.google.protobuf.Duration getGracefulDecommissionTimeout()

 Optional. Timeout for graceful YARN decomissioning. 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.
 Only supported on Dataproc image versions 1.2 and higher.
 

.google.protobuf.Duration graceful_decommission_timeout = 6;

Specified by:

getGracefulDecommissionTimeout in interface UpdateClusterRequestOrBuilder

getGracefulDecommissionTimeoutOrBuilder

public com.google.protobuf.DurationOrBuilder getGracefulDecommissionTimeoutOrBuilder()

 Optional. Timeout for graceful YARN decomissioning. 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.
 Only supported on Dataproc image versions 1.2 and higher.
 

.google.protobuf.Duration graceful_decommission_timeout = 6;

Specified by:

getGracefulDecommissionTimeoutOrBuilder in interface UpdateClusterRequestOrBuilder

hasUpdateMask

public 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>
  </tbody>
  </table>
 

.google.protobuf.FieldMask update_mask = 4;

Specified by:

hasUpdateMask in interface UpdateClusterRequestOrBuilder

getUpdateMask

public 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>
  </tbody>
  </table>
 

.google.protobuf.FieldMask update_mask = 4;

Specified by:

getUpdateMask in interface UpdateClusterRequestOrBuilder

getUpdateMaskOrBuilder

public com.google.protobuf.FieldMaskOrBuilder getUpdateMaskOrBuilder()

 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>
  </tbody>
  </table>
 

.google.protobuf.FieldMask update_mask = 4;

Specified by:

getUpdateMaskOrBuilder in interface UpdateClusterRequestOrBuilder

getRequestId

public String getRequestId()

 Optional. A unique id used to identify the request. If the server
 receives two [UpdateClusterRequest][google.cloud.dataproc.v1.UpdateClusterRequest] requests  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;

Specified by:

getRequestId in interface UpdateClusterRequestOrBuilder

getRequestIdBytes

public com.google.protobuf.ByteString getRequestIdBytes()

 Optional. A unique id used to identify the request. If the server
 receives two [UpdateClusterRequest][google.cloud.dataproc.v1.UpdateClusterRequest] requests  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;

Specified by:

getRequestIdBytes in interface UpdateClusterRequestOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static UpdateClusterRequest parseFrom(ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static UpdateClusterRequest parseFrom(ByteBuffer data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static UpdateClusterRequest parseFrom(com.google.protobuf.ByteString data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static UpdateClusterRequest parseFrom(com.google.protobuf.ByteString data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static UpdateClusterRequest parseFrom(byte[] data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static UpdateClusterRequest parseFrom(byte[] data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static UpdateClusterRequest parseFrom(InputStream input)
                                      throws IOException

Throws:

IOException

parseFrom

public static UpdateClusterRequest parseFrom(InputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static UpdateClusterRequest parseDelimitedFrom(InputStream input)
                                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static UpdateClusterRequest parseDelimitedFrom(InputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Throws:

IOException

parseFrom

public static UpdateClusterRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                      throws IOException

Throws:

IOException

parseFrom

public static UpdateClusterRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Throws:

IOException

newBuilderForType

public UpdateClusterRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static UpdateClusterRequest.Builder newBuilder()

newBuilder

public static UpdateClusterRequest.Builder newBuilder(UpdateClusterRequest prototype)

toBuilder

public UpdateClusterRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected UpdateClusterRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static UpdateClusterRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<UpdateClusterRequest> parser()

getParserForType

public com.google.protobuf.Parser<UpdateClusterRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public UpdateClusterRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder