Google Cloud Tasks V2 Client - Class UpdateQueueRequest (1.12.2)

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

Request message for UpdateQueue.

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

Namespace

Google \ Cloud \ Tasks \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ queue Google\Cloud\Tasks\V2\Queue

Required. The queue to create or update. The queue's name must be specified. Output only fields cannot be modified using UpdateQueue. Any value specified for an output only field will be ignored. The queue's name cannot be changed.

↳ update_mask Google\Protobuf\FieldMask

A mask used to specify which fields of the queue are being updated. If empty, then all fields will be updated.

getQueue

Required. The queue to create or update.

The queue's name must be specified. Output only fields cannot be modified using UpdateQueue. Any value specified for an output only field will be ignored. The queue's name cannot be changed.

Returns
TypeDescription
Google\Cloud\Tasks\V2\Queue|null

hasQueue

clearQueue

setQueue

Required. The queue to create or update.

The queue's name must be specified. Output only fields cannot be modified using UpdateQueue. Any value specified for an output only field will be ignored. The queue's name cannot be changed.

Parameter
NameDescription
var Google\Cloud\Tasks\V2\Queue
Returns
TypeDescription
$this

getUpdateMask

A mask used to specify which fields of the queue are being updated.

If empty, then all fields will be updated.

Returns
TypeDescription
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

A mask used to specify which fields of the queue are being updated.

If empty, then all fields will be updated.

Parameter
NameDescription
var Google\Protobuf\FieldMask
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
queue Google\Cloud\Tasks\V2\Queue

Required. The queue to create or update.

The queue's name must be specified.

Output only fields cannot be modified using UpdateQueue. Any value specified for an output only field will be ignored. The queue's name cannot be changed.

updateMask Google\Protobuf\FieldMask

A mask used to specify which fields of the queue are being updated.

If empty, then all fields will be updated.

Returns
TypeDescription
Google\Cloud\Tasks\V2\UpdateQueueRequest