Class CreateBatchRequest (4.49.0)

public final class CreateBatchRequest extends GeneratedMessageV3 implements CreateBatchRequestOrBuilder

A request to create a batch workload.

Protobuf type google.cloud.dataproc.v1.CreateBatchRequest

Static Fields

BATCH_FIELD_NUMBER

public static final int BATCH_FIELD_NUMBER
Field Value
Type Description
int

BATCH_ID_FIELD_NUMBER

public static final int BATCH_ID_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_ID_FIELD_NUMBER

public static final int REQUEST_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreateBatchRequest getDefaultInstance()
Returns
Type Description
CreateBatchRequest

getDescriptor()

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

newBuilder()

public static CreateBatchRequest.Builder newBuilder()
Returns
Type Description
CreateBatchRequest.Builder

newBuilder(CreateBatchRequest prototype)

public static CreateBatchRequest.Builder newBuilder(CreateBatchRequest prototype)
Parameter
Name Description
prototype CreateBatchRequest
Returns
Type Description
CreateBatchRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateBatchRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateBatchRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateBatchRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateBatchRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CreateBatchRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CreateBatchRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateBatchRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateBatchRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateBatchRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CreateBatchRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateBatchRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateBatchRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateBatchRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CreateBatchRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateBatchRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateBatchRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CreateBatchRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateBatchRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateBatchRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateBatchRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CreateBatchRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CreateBatchRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateBatchRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateBatchRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CreateBatchRequest> parser()
Returns
Type Description
Parser<CreateBatchRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

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

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.

getParserForType()

public Parser<CreateBatchRequest> getParserForType()
Returns
Type Description
Parser<CreateBatchRequest>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CreateBatchRequest.Builder newBuilderForType()
Returns
Type Description
CreateBatchRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateBatchRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CreateBatchRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CreateBatchRequest.Builder toBuilder()
Returns
Type Description
CreateBatchRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException