Class CreateBatchRequest.Builder (4.43.0)

public static final class CreateBatchRequest.Builder extends GeneratedMessageV3.Builder<CreateBatchRequest.Builder> implements CreateBatchRequestOrBuilder

A request to create a batch workload.

Protobuf type google.cloud.dataproc.v1.CreateBatchRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CreateBatchRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CreateBatchRequest.Builder
Overrides

build()

public CreateBatchRequest build()
Returns
Type Description
CreateBatchRequest

buildPartial()

public CreateBatchRequest buildPartial()
Returns
Type Description
CreateBatchRequest

clear()

public CreateBatchRequest.Builder clear()
Returns
Type Description
CreateBatchRequest.Builder
Overrides

clearBatch()

public CreateBatchRequest.Builder clearBatch()

Required. The batch to create.

.google.cloud.dataproc.v1.Batch batch = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CreateBatchRequest.Builder

clearBatchId()

public CreateBatchRequest.Builder clearBatchId()

Optional. The ID to use for the batch, which will become the final component of the batch's resource name.

This value must be 4-63 characters. Valid characters are /a-z-/.

string batch_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CreateBatchRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CreateBatchRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
CreateBatchRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public CreateBatchRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CreateBatchRequest.Builder
Overrides

clearParent()

public CreateBatchRequest.Builder clearParent()

Required. The parent resource where this batch will be created.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
CreateBatchRequest.Builder

This builder for chaining.

clearRequestId()

public CreateBatchRequest.Builder clearRequestId()

Optional. A unique ID used to identify the request. If the service receives two CreateBatchRequests with the same request_id, the second request is ignored and the Operation that corresponds to the first Batch created and stored in the backend is returned.

Recommendation: Set this value to a UUID.

The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

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

Returns
Type Description
CreateBatchRequest.Builder

This builder for chaining.

clone()

public CreateBatchRequest.Builder clone()
Returns
Type Description
CreateBatchRequest.Builder
Overrides

getBatch()

public Batch getBatch()

Required. The batch to create.

.google.cloud.dataproc.v1.Batch batch = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Batch

The batch.

getBatchBuilder()

public Batch.Builder getBatchBuilder()

Required. The batch to create.

.google.cloud.dataproc.v1.Batch batch = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Batch.Builder

getBatchId()

public String getBatchId()

Optional. The ID to use for the batch, which will become the final component of the batch's resource name.

This value must be 4-63 characters. Valid characters are /a-z-/.

string batch_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The batchId.

getBatchIdBytes()

public ByteString getBatchIdBytes()

Optional. The ID to use for the batch, which will become the final component of the batch's resource name.

This value must be 4-63 characters. Valid characters are /a-z-/.

string batch_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for batchId.

getBatchOrBuilder()

public BatchOrBuilder getBatchOrBuilder()

Required. The batch to create.

.google.cloud.dataproc.v1.Batch batch = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BatchOrBuilder

getDefaultInstanceForType()

public CreateBatchRequest getDefaultInstanceForType()
Returns
Type Description
CreateBatchRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getParent()

public String getParent()

Required. The parent resource where this batch will be created.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent resource where this batch will be created.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getRequestId()

public String getRequestId()

Optional. A unique ID used to identify the request. If the service receives two CreateBatchRequests with the same request_id, the second request is ignored and the Operation that corresponds to the first Batch created and stored in the backend is returned.

Recommendation: Set this value to a UUID.

The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

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

Returns
Type Description
String

The requestId.

getRequestIdBytes()

public ByteString getRequestIdBytes()

Optional. A unique ID used to identify the request. If the service receives two CreateBatchRequests with the same request_id, the second request is ignored and the Operation that corresponds to the first Batch created and stored in the backend is returned.

Recommendation: Set this value to a UUID.

The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

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

Returns
Type Description
ByteString

The bytes for requestId.

hasBatch()

public boolean hasBatch()

Required. The batch to create.

.google.cloud.dataproc.v1.Batch batch = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the batch field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBatch(Batch value)

public CreateBatchRequest.Builder mergeBatch(Batch value)

Required. The batch to create.

.google.cloud.dataproc.v1.Batch batch = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Batch
Returns
Type Description
CreateBatchRequest.Builder

mergeFrom(CreateBatchRequest other)

public CreateBatchRequest.Builder mergeFrom(CreateBatchRequest other)
Parameter
Name Description
other CreateBatchRequest
Returns
Type Description
CreateBatchRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CreateBatchRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateBatchRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public CreateBatchRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CreateBatchRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CreateBatchRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CreateBatchRequest.Builder
Overrides

setBatch(Batch value)

public CreateBatchRequest.Builder setBatch(Batch value)

Required. The batch to create.

.google.cloud.dataproc.v1.Batch batch = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Batch
Returns
Type Description
CreateBatchRequest.Builder

setBatch(Batch.Builder builderForValue)

public CreateBatchRequest.Builder setBatch(Batch.Builder builderForValue)

Required. The batch to create.

.google.cloud.dataproc.v1.Batch batch = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Batch.Builder
Returns
Type Description
CreateBatchRequest.Builder

setBatchId(String value)

public CreateBatchRequest.Builder setBatchId(String value)

Optional. The ID to use for the batch, which will become the final component of the batch's resource name.

This value must be 4-63 characters. Valid characters are /a-z-/.

string batch_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The batchId to set.

Returns
Type Description
CreateBatchRequest.Builder

This builder for chaining.

setBatchIdBytes(ByteString value)

public CreateBatchRequest.Builder setBatchIdBytes(ByteString value)

Optional. The ID to use for the batch, which will become the final component of the batch's resource name.

This value must be 4-63 characters. Valid characters are /a-z-/.

string batch_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for batchId to set.

Returns
Type Description
CreateBatchRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CreateBatchRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CreateBatchRequest.Builder
Overrides

setParent(String value)

public CreateBatchRequest.Builder setParent(String value)

Required. The parent resource where this batch will be created.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
CreateBatchRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public CreateBatchRequest.Builder setParentBytes(ByteString value)

Required. The parent resource where this batch will be created.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
CreateBatchRequest.Builder

This builder for chaining.

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

public CreateBatchRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
CreateBatchRequest.Builder
Overrides

setRequestId(String value)

public CreateBatchRequest.Builder setRequestId(String value)

Optional. A unique ID used to identify the request. If the service receives two CreateBatchRequests with the same request_id, the second request is ignored and the Operation that corresponds to the first Batch created and stored in the backend is returned.

Recommendation: Set this value to a UUID.

The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

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

Parameter
Name Description
value String

The requestId to set.

Returns
Type Description
CreateBatchRequest.Builder

This builder for chaining.

setRequestIdBytes(ByteString value)

public CreateBatchRequest.Builder setRequestIdBytes(ByteString value)

Optional. A unique ID used to identify the request. If the service receives two CreateBatchRequests with the same request_id, the second request is ignored and the Operation that corresponds to the first Batch created and stored in the backend is returned.

Recommendation: Set this value to a UUID.

The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

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

Parameter
Name Description
value ByteString

The bytes for requestId to set.

Returns
Type Description
CreateBatchRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CreateBatchRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CreateBatchRequest.Builder
Overrides