public final class UpdateClusterRequest extends GeneratedMessageV3 implements UpdateClusterRequestOrBuilder
A request to update a cluster.Protobuf type
google.cloud.dataproc.v1.UpdateClusterRequest
Modifier and Type | Class and Description |
---|---|
static class |
UpdateClusterRequest.Builder
A request to update a cluster.
|
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter
AbstractMessageLite.InternalOneOfEnum
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 |
alwaysUseFieldBuilders, unknownFields
memoizedSize
memoizedHashCode
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
toByteArray, toByteString, writeDelimitedTo, writeTo
public static final int PROJECT_ID_FIELD_NUMBER
public static final int REGION_FIELD_NUMBER
public static final int CLUSTER_NAME_FIELD_NUMBER
public static final int CLUSTER_FIELD_NUMBER
public static final int GRACEFUL_DECOMMISSION_TIMEOUT_FIELD_NUMBER
public static final int UPDATE_MASK_FIELD_NUMBER
public static final int REQUEST_ID_FIELD_NUMBER
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance
in class GeneratedMessageV3
public final UnknownFieldSet getUnknownFields()
getUnknownFields
in interface MessageOrBuilder
getUnknownFields
in class GeneratedMessageV3
public static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class GeneratedMessageV3
public String getProjectId()
Required. The ID of the Google Cloud Platform project the cluster belongs to.
string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
getProjectId
in interface UpdateClusterRequestOrBuilder
public ByteString getProjectIdBytes()
Required. The ID of the Google Cloud Platform project the cluster belongs to.
string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
getProjectIdBytes
in interface UpdateClusterRequestOrBuilder
public String getRegion()
Required. The Dataproc region in which to handle the request.
string region = 5 [(.google.api.field_behavior) = REQUIRED];
getRegion
in interface UpdateClusterRequestOrBuilder
public ByteString getRegionBytes()
Required. The Dataproc region in which to handle the request.
string region = 5 [(.google.api.field_behavior) = REQUIRED];
getRegionBytes
in interface UpdateClusterRequestOrBuilder
public String getClusterName()
Required. The cluster name.
string cluster_name = 2 [(.google.api.field_behavior) = REQUIRED];
getClusterName
in interface UpdateClusterRequestOrBuilder
public ByteString getClusterNameBytes()
Required. The cluster name.
string cluster_name = 2 [(.google.api.field_behavior) = REQUIRED];
getClusterNameBytes
in interface UpdateClusterRequestOrBuilder
public boolean hasCluster()
Required. The changes to the cluster.
.google.cloud.dataproc.v1.Cluster cluster = 3 [(.google.api.field_behavior) = REQUIRED];
hasCluster
in interface UpdateClusterRequestOrBuilder
public Cluster getCluster()
Required. The changes to the cluster.
.google.cloud.dataproc.v1.Cluster cluster = 3 [(.google.api.field_behavior) = REQUIRED];
getCluster
in interface UpdateClusterRequestOrBuilder
public ClusterOrBuilder getClusterOrBuilder()
Required. The changes to the cluster.
.google.cloud.dataproc.v1.Cluster cluster = 3 [(.google.api.field_behavior) = REQUIRED];
getClusterOrBuilder
in interface UpdateClusterRequestOrBuilder
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. (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];
hasGracefulDecommissionTimeout
in interface UpdateClusterRequestOrBuilder
public 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. (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];
getGracefulDecommissionTimeout
in interface UpdateClusterRequestOrBuilder
public 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. (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];
getGracefulDecommissionTimeoutOrBuilder
in interface UpdateClusterRequestOrBuilder
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> <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];
hasUpdateMask
in interface UpdateClusterRequestOrBuilder
public 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];
getUpdateMask
in interface UpdateClusterRequestOrBuilder
public 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> <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];
getUpdateMaskOrBuilder
in interface UpdateClusterRequestOrBuilder
public 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];
getRequestId
in interface UpdateClusterRequestOrBuilder
public ByteString getRequestIdBytes()
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];
getRequestIdBytes
in interface UpdateClusterRequestOrBuilder
public final boolean isInitialized()
isInitialized
in interface MessageLiteOrBuilder
isInitialized
in class GeneratedMessageV3
public void writeTo(CodedOutputStream output) throws IOException
writeTo
in interface MessageLite
writeTo
in class GeneratedMessageV3
IOException
public int getSerializedSize()
getSerializedSize
in interface MessageLite
getSerializedSize
in class GeneratedMessageV3
public boolean equals(Object obj)
equals
in interface Message
equals
in class AbstractMessage
public int hashCode()
hashCode
in interface Message
hashCode
in class AbstractMessage
public static UpdateClusterRequest parseFrom(ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static UpdateClusterRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static UpdateClusterRequest parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static UpdateClusterRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static UpdateClusterRequest parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static UpdateClusterRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static UpdateClusterRequest parseFrom(InputStream input) throws IOException
IOException
public static UpdateClusterRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static UpdateClusterRequest parseDelimitedFrom(InputStream input) throws IOException
IOException
public static UpdateClusterRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static UpdateClusterRequest parseFrom(CodedInputStream input) throws IOException
IOException
public static UpdateClusterRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public UpdateClusterRequest.Builder newBuilderForType()
newBuilderForType
in interface Message
newBuilderForType
in interface MessageLite
public static UpdateClusterRequest.Builder newBuilder()
public static UpdateClusterRequest.Builder newBuilder(UpdateClusterRequest prototype)
public UpdateClusterRequest.Builder toBuilder()
toBuilder
in interface Message
toBuilder
in interface MessageLite
protected UpdateClusterRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class GeneratedMessageV3
public static UpdateClusterRequest getDefaultInstance()
public static Parser<UpdateClusterRequest> parser()
public Parser<UpdateClusterRequest> getParserForType()
getParserForType
in interface Message
getParserForType
in interface MessageLite
getParserForType
in class GeneratedMessageV3
public UpdateClusterRequest getDefaultInstanceForType()
getDefaultInstanceForType
in interface MessageLiteOrBuilder
getDefaultInstanceForType
in interface MessageOrBuilder
Copyright © 2022 Google LLC. All rights reserved.