Class StopClusterRequest.Builder (4.32.0)

public static final class StopClusterRequest.Builder extends GeneratedMessageV3.Builder<StopClusterRequest.Builder> implements StopClusterRequestOrBuilder

A request to stop a cluster.

Protobuf type google.cloud.dataproc.v1.StopClusterRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public StopClusterRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
StopClusterRequest.Builder
Overrides

build()

public StopClusterRequest build()
Returns
TypeDescription
StopClusterRequest

buildPartial()

public StopClusterRequest buildPartial()
Returns
TypeDescription
StopClusterRequest

clear()

public StopClusterRequest.Builder clear()
Returns
TypeDescription
StopClusterRequest.Builder
Overrides

clearClusterName()

public StopClusterRequest.Builder clearClusterName()

Required. The cluster name.

string cluster_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
StopClusterRequest.Builder

This builder for chaining.

clearClusterUuid()

public StopClusterRequest.Builder clearClusterUuid()

Optional. Specifying the cluster_uuid means the RPC will fail (with error NOT_FOUND) if a cluster with the specified UUID does not exist.

string cluster_uuid = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
StopClusterRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public StopClusterRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
StopClusterRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public StopClusterRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
StopClusterRequest.Builder
Overrides

clearProjectId()

public StopClusterRequest.Builder clearProjectId()

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

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
StopClusterRequest.Builder

This builder for chaining.

clearRegion()

public StopClusterRequest.Builder clearRegion()

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

string region = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
StopClusterRequest.Builder

This builder for chaining.

clearRequestId()

public StopClusterRequest.Builder clearRequestId()

Optional. A unique ID used to identify the request. If the server receives two StopClusterRequests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.

Recommendation: Set this value to a UUID.

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 = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
StopClusterRequest.Builder

This builder for chaining.

clone()

public StopClusterRequest.Builder clone()
Returns
TypeDescription
StopClusterRequest.Builder
Overrides

getClusterName()

public String getClusterName()

Required. The cluster name.

string cluster_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The clusterName.

getClusterNameBytes()

public ByteString getClusterNameBytes()

Required. The cluster name.

string cluster_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for clusterName.

getClusterUuid()

public String getClusterUuid()

Optional. Specifying the cluster_uuid means the RPC will fail (with error NOT_FOUND) if a cluster with the specified UUID does not exist.

string cluster_uuid = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The clusterUuid.

getClusterUuidBytes()

public ByteString getClusterUuidBytes()

Optional. Specifying the cluster_uuid means the RPC will fail (with error NOT_FOUND) if a cluster with the specified UUID does not exist.

string cluster_uuid = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for clusterUuid.

getDefaultInstanceForType()

public StopClusterRequest getDefaultInstanceForType()
Returns
TypeDescription
StopClusterRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getProjectId()

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

Returns
TypeDescription
String

The projectId.

getProjectIdBytes()

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

Returns
TypeDescription
ByteString

The bytes for projectId.

getRegion()

public String getRegion()

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

string region = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The region.

getRegionBytes()

public ByteString getRegionBytes()

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

string region = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for region.

getRequestId()

public String getRequestId()

Optional. A unique ID used to identify the request. If the server receives two StopClusterRequests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.

Recommendation: Set this value to a UUID.

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 = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The requestId.

getRequestIdBytes()

public ByteString getRequestIdBytes()

Optional. A unique ID used to identify the request. If the server receives two StopClusterRequests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.

Recommendation: Set this value to a UUID.

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 = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for requestId.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(StopClusterRequest other)

public StopClusterRequest.Builder mergeFrom(StopClusterRequest other)
Parameter
NameDescription
otherStopClusterRequest
Returns
TypeDescription
StopClusterRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StopClusterRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StopClusterRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public StopClusterRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
StopClusterRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StopClusterRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
StopClusterRequest.Builder
Overrides

setClusterName(String value)

public StopClusterRequest.Builder setClusterName(String value)

Required. The cluster name.

string cluster_name = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueString

The clusterName to set.

Returns
TypeDescription
StopClusterRequest.Builder

This builder for chaining.

setClusterNameBytes(ByteString value)

public StopClusterRequest.Builder setClusterNameBytes(ByteString value)

Required. The cluster name.

string cluster_name = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueByteString

The bytes for clusterName to set.

Returns
TypeDescription
StopClusterRequest.Builder

This builder for chaining.

setClusterUuid(String value)

public StopClusterRequest.Builder setClusterUuid(String value)

Optional. Specifying the cluster_uuid means the RPC will fail (with error NOT_FOUND) if a cluster with the specified UUID does not exist.

string cluster_uuid = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueString

The clusterUuid to set.

Returns
TypeDescription
StopClusterRequest.Builder

This builder for chaining.

setClusterUuidBytes(ByteString value)

public StopClusterRequest.Builder setClusterUuidBytes(ByteString value)

Optional. Specifying the cluster_uuid means the RPC will fail (with error NOT_FOUND) if a cluster with the specified UUID does not exist.

string cluster_uuid = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueByteString

The bytes for clusterUuid to set.

Returns
TypeDescription
StopClusterRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public StopClusterRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
StopClusterRequest.Builder
Overrides

setProjectId(String value)

public StopClusterRequest.Builder setProjectId(String value)

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

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueString

The projectId to set.

Returns
TypeDescription
StopClusterRequest.Builder

This builder for chaining.

setProjectIdBytes(ByteString value)

public StopClusterRequest.Builder setProjectIdBytes(ByteString value)

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

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueByteString

The bytes for projectId to set.

Returns
TypeDescription
StopClusterRequest.Builder

This builder for chaining.

setRegion(String value)

public StopClusterRequest.Builder setRegion(String value)

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

string region = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueString

The region to set.

Returns
TypeDescription
StopClusterRequest.Builder

This builder for chaining.

setRegionBytes(ByteString value)

public StopClusterRequest.Builder setRegionBytes(ByteString value)

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

string region = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueByteString

The bytes for region to set.

Returns
TypeDescription
StopClusterRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public StopClusterRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
StopClusterRequest.Builder
Overrides

setRequestId(String value)

public StopClusterRequest.Builder setRequestId(String value)

Optional. A unique ID used to identify the request. If the server receives two StopClusterRequests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.

Recommendation: Set this value to a UUID.

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 = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueString

The requestId to set.

Returns
TypeDescription
StopClusterRequest.Builder

This builder for chaining.

setRequestIdBytes(ByteString value)

public StopClusterRequest.Builder setRequestIdBytes(ByteString value)

Optional. A unique ID used to identify the request. If the server receives two StopClusterRequests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.

Recommendation: Set this value to a UUID.

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 = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueByteString

The bytes for requestId to set.

Returns
TypeDescription
StopClusterRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final StopClusterRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
StopClusterRequest.Builder
Overrides