Google Cloud Dataproc V1 Client - Class CreateBatchRequest (3.5.1)

Reference documentation and code samples for the Google Cloud Dataproc V1 Client class CreateBatchRequest.

A request to create a batch workload.

Generated from protobuf message google.cloud.dataproc.v1.CreateBatchRequest

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

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

↳ batch Google\Cloud\Dataproc\V1\Batch

Required. The batch to create.

↳ batch_id string

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][0-9]-/.

↳ request_id string

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.

getParent

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

Returns
TypeDescription
string

setParent

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getBatch

Required. The batch to create.

Returns
TypeDescription
Google\Cloud\Dataproc\V1\Batch|null

hasBatch

clearBatch

setBatch

Required. The batch to create.

Parameter
NameDescription
var Google\Cloud\Dataproc\V1\Batch
Returns
TypeDescription
$this

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][0-9]-/.

Returns
TypeDescription
string

setBatchId

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][0-9]-/.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

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.

Returns
TypeDescription
string

setRequestId

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this