Class: Google::Cloud::Tasks::V2beta2::ListTasksRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/cloudtasks.rb

Overview

Request message for listing tasks using ListTasks.

Instance Attribute Summary collapse

Instance Attribute Details

#order_by ⇒ String

Sort order used for the query. The only fields supported for sorting are +schedule_time+ and +pull_message.tag+. All results will be returned in approximately ascending order. The default ordering is by +schedule_time+.

Returns:

  • (String) —

    Sort order used for the query. The only fields supported for sorting are +schedule_time+ and +pull_message.tag+. All results will be returned in approximately ascending order. The default ordering is by +schedule_time+.



218
 
# File 'lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/cloudtasks.rb', line 218

class ListTasksRequest; end

#page_size ⇒ Integer

Returns Requested page size. Fewer tasks than requested might be returned.

The maximum page size is 1000. If unspecified, the page size will be the maximum. Fewer tasks than requested might be returned, even if more tasks exist; use next_page_token in the response to determine if more tasks exist.

Returns:

  • (Integer) —

    Requested page size. Fewer tasks than requested might be returned.

    The maximum page size is 1000. If unspecified, the page size will be the maximum. Fewer tasks than requested might be returned, even if more tasks exist; use next_page_token in the response to determine if more tasks exist.



218
 
# File 'lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/cloudtasks.rb', line 218

class ListTasksRequest; end

#page_token ⇒ String

Returns 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 returned from the previous call to ListTasks method.

The page token is valid for only 2 hours.

Returns:

  • (String) —

    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 returned from the previous call to ListTasks method.

    The page token is valid for only 2 hours.



218
 
# File 'lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/cloudtasks.rb', line 218

class ListTasksRequest; end

#parent ⇒ String

Returns Required.

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

Returns:

  • (String) —

    Required.

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



218
 
# File 'lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/cloudtasks.rb', line 218

class ListTasksRequest; end

#response_view ⇒ Google::Cloud::Tasks::V2beta2::Task::View

The response_view specifies which subset of the Task will be returned.

By default response_view is 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 requires +cloudtasks.tasks.fullView+ Google IAM permission on the Task resource.

Returns:

  • (Google::Cloud::Tasks::V2beta2::Task::View) —

    The response_view specifies which subset of the Task will be returned.

    By default response_view is 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 requires +cloudtasks.tasks.fullView+ Google IAM permission on the Task resource.



218
 
# File 'lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/cloudtasks.rb', line 218

class ListTasksRequest; end