Google Cloud Tasks v2 API - Class ListTasksRequest (3.1.0)

public sealed class ListTasksRequest : IMessage<ListTasksRequest>, IEquatable<ListTasksRequest>, IDeepCloneable<ListTasksRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Google Cloud Tasks v2 API class ListTasksRequest.

Request message for listing tasks using [ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks].

Inheritance

Object > ListTasksRequest

Implements

IMessage<ListTasksRequest>, IEquatable<ListTasksRequest>, IDeepCloneable<ListTasksRequest>, IBufferMessage, IMessage, IPageRequest

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Tasks.V2

Assembly

Google.Cloud.Tasks.V2.dll

Constructors

ListTasksRequest()

public ListTasksRequest()

ListTasksRequest(ListTasksRequest)

public ListTasksRequest(ListTasksRequest other)

Parameter
Name	Description
`other`	`ListTasksRequest`

Properties

PageSize

public int PageSize { get; set; }

Maximum page size.

Fewer tasks than requested might be returned, even if more tasks exist; use [next_page_token][google.cloud.tasks.v2.ListTasksResponse.next_page_token] in the response to determine if more tasks exist.

The maximum page size is 1000. If unspecified, the page size will be the maximum.

Property Value
Type	Description
`Int32`

PageToken

public string PageToken { get; set; }

A token identifying the page of results to return.

To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of [next_page_token][google.cloud.tasks.v2.ListTasksResponse.next_page_token] returned from the previous call to [ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks] method.

The page token is valid for only 2 hours.

Property Value
Type	Description
`String`

Parent

public string Parent { get; set; }

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

Property Value
Type	Description
`String`

ParentAsQueueName

public QueueName ParentAsQueueName { get; set; }

QueueName-typed view over the Parent resource name property.

Property Value
Type	Description
`QueueName`

ResponseView

public Task.Types.View ResponseView { get; set; }

The response_view specifies which subset of the [Task][google.cloud.tasks.v2.Task] will be returned.

By default response_view is [BASIC][google.cloud.tasks.v2.Task.View.BASIC]; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains.

Authorization for [FULL][google.cloud.tasks.v2.Task.View.FULL] requires cloudtasks.tasks.fullView Google IAM permission on the [Task][google.cloud.tasks.v2.Task] resource.

Property Value
Type	Description
`Task.Types.View`