Reference documentation and code samples for the Google Cloud Tasks V2 Client class BatchDeleteTasksRequest.
Request message for deleting a batch of tasks using BatchDeleteTasks.
Generated from protobuf message google.cloud.tasks.v2.BatchDeleteTasksRequest
Namespace
Google \ Cloud \ Tasks \ V2Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The queue name. For example: Format: |
↳ names |
string[]
Required. The names of the tasks to delete. A maximum of 1000 tasks can be deleted in a batch. For example: Format: |
↳ 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:
Format: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The queue name. For example:
Format: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNames
Required. The names of the tasks to delete.
A maximum of 1000 tasks can be deleted in a batch.
For example:
Format:
projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setNames
Required. The names of the tasks to delete.
A maximum of 1000 tasks can be deleted in a batch.
For example:
Format:
projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| 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:
Format: |
names |
string[]
Required. The names of the tasks to delete.
A maximum of 1000 tasks can be deleted in a batch.
For example:
Format:
|
| Returns | |
|---|---|
| Type | Description |
BatchDeleteTasksRequest |
|