Google Cloud Dataproc V1 Client - Class CreateBatchRequest (3.8.1)

Version 3.8.1

• 3.14.0 (latest)
• 3.13.4
• 3.12.0
• 3.11.0
• 3.10.1
• 3.9.0
• 3.8.1
• 3.7.1
• 3.6.1
• 3.5.1
• 3.4.0
• 3.3.0
• 3.2.2
• 2.2.2
• 2.1.0
• 2.0.0

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

Namespace

Google \ Cloud \ Dataproc \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
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
Type	Description
string

setParent

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getBatch

Required. The batch to create.

Returns
Type	Description
Google\Cloud\Dataproc\V1\Batch|null

hasBatch

clearBatch

setBatch

Required. The batch to create.

Parameter
Name	Description
var	Google\Cloud\Dataproc\V1\Batch

Returns
Type	Description
$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
Type	Description
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
Name	Description
var	string

Returns
Type	Description
$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
Type	Description
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
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameters
Name	Description
parent	string Required. The parent resource where this batch will be created. Please see Google\Cloud\Dataproc\V1\BatchControllerClient::locationName() for help formatting this field.
batch	Google\Cloud\Dataproc\V1\Batch Required. The batch to create.
batchId	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]-/.

Returns
Type	Description
Google\Cloud\Dataproc\V1\CreateBatchRequest