Class Google::Cloud::Tasks::V2::ListTasksRequest (v0.4.6)

Request message for listing tasks using ListTasks.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — Maximum page size.

    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.

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

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — Maximum page size.

    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.

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

Returns
  • (::Integer) — Maximum page size.

    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.

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

#page_token

def page_token() -> ::String
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.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::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.

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.

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — 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

#response_view

def response_view() -> ::Google::Cloud::Tasks::V2::Task::View
Returns
  • (::Google::Cloud::Tasks::V2::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.

#response_view=

def response_view=(value) -> ::Google::Cloud::Tasks::V2::Task::View
Parameter
  • value (::Google::Cloud::Tasks::V2::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::V2::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.