Cloud Tasks V2 API - Class Google::Cloud::Tasks::V2::GetTaskRequest (v0.8.0)

Reference documentation and code samples for the Cloud Tasks V2 API class Google::Cloud::Tasks::V2::GetTaskRequest.

Request message for getting a task using GetTask.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#name

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

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID
Returns
  • (::String) — Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_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.