Google Cloud Tasks V2beta3 Client - Class GetQueueRequest (1.11.11)

Reference documentation and code samples for the Google Cloud Tasks V2beta3 Client class GetQueueRequest.

Request message for GetQueue.

Generated from protobuf message google.cloud.tasks.v2beta3.GetQueueRequest

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

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

↳ read_mask Google\Protobuf\FieldMask

Optional. Read mask is used for a more granular control over what the API returns. If the mask is not present all fields will be returned except [Queue.stats]. [Queue.stats] will be returned only if it was explicitly specified in the mask.

getName

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

Returns
TypeDescription
string

setName

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getReadMask

Optional. Read mask is used for a more granular control over what the API returns.

If the mask is not present all fields will be returned except [Queue.stats]. [Queue.stats] will be returned only if it was explicitly specified in the mask.

Returns
TypeDescription
Google\Protobuf\FieldMask|null

hasReadMask

clearReadMask

setReadMask

Optional. Read mask is used for a more granular control over what the API returns.

If the mask is not present all fields will be returned except [Queue.stats]. [Queue.stats] will be returned only if it was explicitly specified in the mask.

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