Google Cloud Tasks V2 Client - Class BatchCreateTasksRequest (2.3.0)

Reference documentation and code samples for the Google Cloud Tasks V2 Client class BatchCreateTasksRequest.

Request message for [BatchCreateTasks].

Generated from protobuf message google.cloud.tasks.v2.BatchCreateTasksRequest

Namespace

Google \ Cloud \ Tasks \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID The queue must already exist.

↳ requests array<CreateTaskRequest>

Required. The list of requests to create tasks. The queue specified in parent field of each CreateTaskRequest will be the same. This validation happens on the client side as well as in the handler. BatchCreateTasksRequest.parent will also be the same value as the individual CreateTaskRequest.parent. The maximum number of requests is 100.

↳ request_id string

Optional. This field will be used to identify the long running operation, avoiding duplication when user retries. If not provided, then a UUID will be generated at server side.

getParent

Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID The queue must already exist.

Returns
Type Description
string

setParent

Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID The queue must already exist.

Parameter
Name Description
var string
Returns
Type Description
$this

getRequests

Required. The list of requests to create tasks.

The queue specified in parent field of each CreateTaskRequest will be the same. This validation happens on the client side as well as in the handler. BatchCreateTasksRequest.parent will also be the same value as the individual CreateTaskRequest.parent. The maximum number of requests is 100.

Returns
Type Description
Google\Protobuf\RepeatedField<CreateTaskRequest>

setRequests

Required. The list of requests to create tasks.

The queue specified in parent field of each CreateTaskRequest will be the same. This validation happens on the client side as well as in the handler. BatchCreateTasksRequest.parent will also be the same value as the individual CreateTaskRequest.parent. The maximum number of requests is 100.

Parameter
Name Description
var array<CreateTaskRequest>
Returns
Type Description
$this

getRequestId

Optional. This field will be used to identify the long running operation, avoiding duplication when user retries. If not provided, then a UUID will be generated at server side.

Returns
Type Description
string

setRequestId

Optional. This field will be used to identify the long running operation, avoiding duplication when user retries. If not provided, then a UUID will be generated at server side.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

The queue must already exist. Please see CloudTasksClient::queueName() for help formatting this field.

requests array<CreateTaskRequest>

Required. The list of requests to create tasks. The queue specified in parent field of each CreateTaskRequest will be the same. This validation happens on the client side as well as in the handler. BatchCreateTasksRequest.parent will also be the same value as the individual CreateTaskRequest.parent. The maximum number of requests is 100.

Returns
Type Description
BatchCreateTasksRequest