lib/google/cloud/tasks/v2beta2/cloud_tasks_client.rb in google-cloud-tasks-0.2.3 vs lib/google/cloud/tasks/v2beta2/cloud_tasks_client.rb in google-cloud-tasks-0.2.4
- old
+ new
@@ -417,15 +417,15 @@
#
# @param parent [String]
# Required.
#
# The location name.
- # For example: +projects/PROJECT_ID/locations/LOCATION_ID+
+ # For example: `projects/PROJECT_ID/locations/LOCATION_ID`
# @param filter [String]
- # +filter+ can be used to specify a subset of queues. Any {Google::Cloud::Tasks::V2beta2::Queue Queue}
+ # `filter` can be used to specify a subset of queues. Any {Google::Cloud::Tasks::V2beta2::Queue Queue}
# field can be used as a filter and several operators as supported.
- # For example: +<=, <, >=, >, !=, =, :+. The filter syntax is the same as
+ # For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as
# described in
# [Stackdriver's Advanced Logs Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
#
# Sample filter "app_engine_http_target: *".
#
@@ -487,11 +487,11 @@
#
# @param name [String]
# Required.
#
# The resource name of the queue. For example:
- # +projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID+
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
# retries, etc.
# @yield [result, operation] Access the result along with the RPC operation
# @yieldparam result [Google::Cloud::Tasks::V2beta2::Queue]
@@ -521,20 +521,20 @@
# Queues created with this method allow tasks to live for a maximum of 31
# days. After a task is 31 days old, the task will be deleted regardless of whether
# it was dispatched or not.
#
# WARNING: Using this method may have unintended side effects if you are
- # using an App Engine +queue.yaml+ or +queue.xml+ file to manage your queues.
+ # using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
# Read
# [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)
# before using this method.
#
# @param parent [String]
# Required.
#
# The location name in which the queue will be created.
- # For example: +projects/PROJECT_ID/locations/LOCATION_ID+
+ # For example: `projects/PROJECT_ID/locations/LOCATION_ID`
#
# The list of allowed locations can be obtained by calling Cloud
# Tasks' implementation of
# {Google::Cloud::Location::Locations::ListLocations ListLocations}.
# @param queue [Google::Cloud::Tasks::V2beta2::Queue | Hash]
@@ -557,11 +557,11 @@
# require "google/cloud/tasks"
#
# cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
# formatted_parent = Google::Cloud::Tasks::V2beta2::CloudTasksClient.location_path("[PROJECT]", "[LOCATION]")
#
- # # TODO: Initialize +queue+:
+ # # TODO: Initialize `queue`:
# queue = {}
# response = cloud_tasks_client.create_queue(formatted_parent, queue)
def create_queue \
parent,
@@ -584,11 +584,11 @@
# Queues created with this method allow tasks to live for a maximum of 31
# days. After a task is 31 days old, the task will be deleted regardless of whether
# it was dispatched or not.
#
# WARNING: Using this method may have unintended side effects if you are
- # using an App Engine +queue.yaml+ or +queue.xml+ file to manage your queues.
+ # using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
# Read
# [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)
# before using this method.
#
# @param queue [Google::Cloud::Tasks::V2beta2::Queue | Hash]
@@ -620,11 +620,11 @@
# @example
# require "google/cloud/tasks"
#
# cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
#
- # # TODO: Initialize +queue+:
+ # # TODO: Initialize `queue`:
# queue = {}
# response = cloud_tasks_client.update_queue(queue)
def update_queue \
queue,
@@ -645,20 +645,20 @@
#
# Note: If you delete a queue, a queue with the same name can't be created
# for 7 days.
#
# WARNING: Using this method may have unintended side effects if you are
- # using an App Engine +queue.yaml+ or +queue.xml+ file to manage your queues.
+ # using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
# Read
# [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)
# before using this method.
#
# @param name [String]
# Required.
#
# The queue name. For example:
- # +projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID+
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
# retries, etc.
# @yield [result, operation] Access the result along with the RPC operation
# @yieldparam result []
@@ -692,11 +692,11 @@
#
# @param name [String]
# Required.
#
# The queue name. For example:
- # +projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID+
+ # `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
# retries, etc.
# @yield [result, operation] Access the result along with the RPC operation
# @yieldparam result [Google::Cloud::Tasks::V2beta2::Queue]
@@ -731,11 +731,11 @@
#
# @param name [String]
# Required.
#
# The queue name. For example:
- # +projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID+
+ # `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
# retries, etc.
# @yield [result, operation] Access the result along with the RPC operation
# @yieldparam result [Google::Cloud::Tasks::V2beta2::Queue]
@@ -775,11 +775,11 @@
#
# @param name [String]
# Required.
#
# The queue name. For example:
- # +projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID+
+ # `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
# retries, etc.
# @yield [result, operation] Access the result along with the RPC operation
# @yieldparam result [Google::Cloud::Tasks::V2beta2::Queue]
@@ -810,16 +810,16 @@
#
# Authorization requires the following
# [Google IAM](https://cloud.google.com/iam) permission on the specified
# resource parent:
#
- # * +cloudtasks.queues.getIamPolicy+
+ # * `cloudtasks.queues.getIamPolicy`
#
# @param resource [String]
# REQUIRED: The resource for which the policy is being requested.
- # +resource+ is usually specified as a path. For example, a Project
- # resource is specified as +projects/\\{project}+.
+ # `resource` is usually specified as a path. For example, a Project
+ # resource is specified as `projects/{project}`.
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
# retries, etc.
# @yield [result, operation] Access the result along with the RPC operation
# @yieldparam result [Google::Iam::V1::Policy]
@@ -852,18 +852,18 @@
#
# Authorization requires the following
# [Google IAM](https://cloud.google.com/iam) permission on the specified
# resource parent:
#
- # * +cloudtasks.queues.setIamPolicy+
+ # * `cloudtasks.queues.setIamPolicy`
#
# @param resource [String]
# REQUIRED: The resource for which the policy is being specified.
- # +resource+ is usually specified as a path. For example, a Project
- # resource is specified as +projects/\\{project}+.
+ # `resource` is usually specified as a path. For example, a Project
+ # resource is specified as `projects/{project}`.
# @param policy [Google::Iam::V1::Policy | Hash]
- # REQUIRED: The complete policy to be applied to the +resource+. The size of
+ # REQUIRED: The complete policy to be applied to the `resource`. The size of
# the policy is limited to a few 10s of KB. An empty policy is a
# valid policy but certain Cloud Platform services (such as Projects)
# might reject them.
# A hash of the same form as `Google::Iam::V1::Policy`
# can also be provided.
@@ -879,11 +879,11 @@
# require "google/cloud/tasks"
#
# cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
# formatted_resource = Google::Cloud::Tasks::V2beta2::CloudTasksClient.queue_path("[PROJECT]", "[LOCATION]", "[QUEUE]")
#
- # # TODO: Initialize +policy+:
+ # # TODO: Initialize `policy`:
# policy = {}
# response = cloud_tasks_client.set_iam_policy(formatted_resource, policy)
def set_iam_policy \
resource,
@@ -906,14 +906,14 @@
# UIs and command-line tools, not for authorization checking. This operation
# may "fail open" without warning.
#
# @param resource [String]
# REQUIRED: The resource for which the policy detail is being requested.
- # +resource+ is usually specified as a path. For example, a Project
- # resource is specified as +projects/\\{project}+.
+ # `resource` is usually specified as a path. For example, a Project
+ # resource is specified as `projects/{project}`.
# @param permissions [Array<String>]
- # The set of permissions to check for the +resource+. Permissions with
+ # The set of permissions to check for the `resource`. Permissions with
# wildcards (such as '*' or 'storage.*') are not allowed. For more
# information see
# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
@@ -927,11 +927,11 @@
# require "google/cloud/tasks"
#
# cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
# formatted_resource = Google::Cloud::Tasks::V2beta2::CloudTasksClient.queue_path("[PROJECT]", "[LOCATION]", "[QUEUE]")
#
- # # TODO: Initialize +permissions+:
+ # # TODO: Initialize `permissions`:
# permissions = []
# response = cloud_tasks_client.test_iam_permissions(formatted_resource, permissions)
def test_iam_permissions \
resource,
@@ -958,11 +958,11 @@
#
# @param parent [String]
# Required.
#
# The queue name. For example:
- # +projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID+
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
# @param response_view [Google::Cloud::Tasks::V2beta2::Task::View]
# The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta2::Task Task} will be
# returned.
#
# By default response_view is {Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
@@ -970,11 +970,11 @@
# 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 {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
- # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/)
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
# permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
# @param page_size [Integer]
# The maximum number of resources contained in the underlying API
# response. If page streaming is performed per-resource, this
# parameter does not affect the return value. If page streaming is
@@ -1030,11 +1030,11 @@
#
# @param name [String]
# Required.
#
# The task name. For example:
- # +projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID+
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
# @param response_view [Google::Cloud::Tasks::V2beta2::Task::View]
# The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta2::Task Task} will be
# returned.
#
# By default response_view is {Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
@@ -1042,11 +1042,11 @@
# 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 {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
- # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/)
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
# permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
# retries, etc.
# @yield [result, operation] Access the result along with the RPC operation
@@ -1084,20 +1084,20 @@
#
# @param parent [String]
# Required.
#
# The queue name. For example:
- # +projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID+
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
#
# The queue must already exist.
# @param task [Google::Cloud::Tasks::V2beta2::Task | Hash]
# Required.
#
# The task to add.
#
# Task names have the following format:
- # +projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID+.
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
# The user can optionally specify a task {Google::Cloud::Tasks::V2beta2::Task#name name}. If a
# name is not specified then the system will generate a random
# unique task id, which will be set in the task returned in the
# {Google::Cloud::Tasks::V2beta2::Task#name response}.
#
@@ -1136,11 +1136,11 @@
# 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 {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
- # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/)
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
# permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
# retries, etc.
# @yield [result, operation] Access the result along with the RPC operation
@@ -1152,11 +1152,11 @@
# require "google/cloud/tasks"
#
# cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
# formatted_parent = Google::Cloud::Tasks::V2beta2::CloudTasksClient.queue_path("[PROJECT]", "[LOCATION]", "[QUEUE]")
#
- # # TODO: Initialize +task+:
+ # # TODO: Initialize `task`:
# task = {}
# response = cloud_tasks_client.create_task(formatted_parent, task)
def create_task \
parent,
@@ -1181,11 +1181,11 @@
#
# @param name [String]
# Required.
#
# The task name. For example:
- # +projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID+
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
# retries, etc.
# @yield [result, operation] Access the result along with the RPC operation
# @yieldparam result []
@@ -1235,30 +1235,30 @@
#
# @param parent [String]
# Required.
#
# The queue name. For example:
- # +projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID+
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
# @param lease_duration [Google::Protobuf::Duration | Hash]
# After the worker has successfully finished the work associated
# with the task, the worker must call via
# {Google::Cloud::Tasks::V2beta2::CloudTasks::AcknowledgeTask AcknowledgeTask} before the
# {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time}. Otherwise the task will be
# returned to a later {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks} call so
# that another worker can retry it.
#
# The maximum lease duration is 1 week.
- # +lease_duration+ will be truncated to the nearest second.
+ # `lease_duration` will be truncated to the nearest second.
# A hash of the same form as `Google::Protobuf::Duration`
# can also be provided.
# @param max_tasks [Integer]
# The maximum number of tasks to lease.
#
# The system will make a best effort to return as close to as
- # +max_tasks+ as possible.
+ # `max_tasks` as possible.
#
- # The largest that +max_tasks+ can be is 1000.
+ # The largest that `max_tasks` can be is 1000.
# @param response_view [Google::Cloud::Tasks::V2beta2::Task::View]
# The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta2::Task Task} will be
# returned.
#
# By default response_view is {Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
@@ -1266,33 +1266,33 @@
# 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 {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
- # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/)
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
# permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
# @param filter [String]
- # +filter+ can be used to specify a subset of tasks to lease.
+ # `filter` can be used to specify a subset of tasks to lease.
#
- # When +filter+ is set to +tag=<my-tag>+ then the
+ # When `filter` is set to `tag=<my-tag>` then the
# {Google::Cloud::Tasks::V2beta2::LeaseTasksResponse response} will contain only tasks whose
- # {Google::Cloud::Tasks::V2beta2::PullMessage#tag tag} is equal to +<my-tag>+. +<my-tag>+ must be
+ # {Google::Cloud::Tasks::V2beta2::PullMessage#tag tag} is equal to `<my-tag>`. `<my-tag>` must be
# less than 500 characters.
#
- # When +filter+ is set to +tag_function=oldest_tag()+, only tasks which have
+ # When `filter` is set to `tag_function=oldest_tag()`, only tasks which have
# the same tag as the task with the oldest
# {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} will be returned.
#
# Grammar Syntax:
#
- # * +filter = "tag=" tag | "tag_function=" function+
+ # * `filter = "tag=" tag | "tag_function=" function`
#
- # * +tag = string+
+ # * `tag = string`
#
- # * +function = "oldest_tag()"+
+ # * `function = "oldest_tag()"`
#
- # The +oldest_tag()+ function returns tasks which have the same tag as the
+ # The `oldest_tag()` function returns tasks which have the same tag as the
# oldest task (ordered by schedule time).
#
# SDK compatibility: Although the SDK allows tags to be either
# string or
# [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
@@ -1312,11 +1312,11 @@
# require "google/cloud/tasks"
#
# cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
# formatted_parent = Google::Cloud::Tasks::V2beta2::CloudTasksClient.queue_path("[PROJECT]", "[LOCATION]", "[QUEUE]")
#
- # # TODO: Initialize +lease_duration+:
+ # # TODO: Initialize `lease_duration`:
# lease_duration = {}
# response = cloud_tasks_client.lease_tasks(formatted_parent, lease_duration)
def lease_tasks \
parent,
@@ -1353,11 +1353,11 @@
#
# @param name [String]
# Required.
#
# The task name. For example:
- # +projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID+
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
# @param schedule_time [Google::Protobuf::Timestamp | Hash]
# Required.
#
# The task's current schedule time, available in the
# {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} returned by
@@ -1377,11 +1377,11 @@
# require "google/cloud/tasks"
#
# cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
# formatted_name = Google::Cloud::Tasks::V2beta2::CloudTasksClient.task_path("[PROJECT]", "[LOCATION]", "[QUEUE]", "[TASK]")
#
- # # TODO: Initialize +schedule_time+:
+ # # TODO: Initialize `schedule_time`:
# schedule_time = {}
# cloud_tasks_client.acknowledge_task(formatted_name, schedule_time)
def acknowledge_task \
name,
@@ -1405,11 +1405,11 @@
#
# @param name [String]
# Required.
#
# The task name. For example:
- # +projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID+
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
# @param schedule_time [Google::Protobuf::Timestamp | Hash]
# Required.
#
# The task's current schedule time, available in the
# {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} returned by
@@ -1423,11 +1423,11 @@
#
# The desired new lease duration, starting from now.
#
#
# The maximum lease duration is 1 week.
- # +lease_duration+ will be truncated to the nearest second.
+ # `lease_duration` will be truncated to the nearest second.
# A hash of the same form as `Google::Protobuf::Duration`
# can also be provided.
# @param response_view [Google::Cloud::Tasks::V2beta2::Task::View]
# The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta2::Task Task} will be
# returned.
@@ -1437,11 +1437,11 @@
# 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 {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
- # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/)
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
# permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
# retries, etc.
# @yield [result, operation] Access the result along with the RPC operation
@@ -1453,14 +1453,14 @@
# require "google/cloud/tasks"
#
# cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
# formatted_name = Google::Cloud::Tasks::V2beta2::CloudTasksClient.task_path("[PROJECT]", "[LOCATION]", "[QUEUE]", "[TASK]")
#
- # # TODO: Initialize +schedule_time+:
+ # # TODO: Initialize `schedule_time`:
# schedule_time = {}
#
- # # TODO: Initialize +lease_duration+:
+ # # TODO: Initialize `lease_duration`:
# lease_duration = {}
# response = cloud_tasks_client.renew_lease(formatted_name, schedule_time, lease_duration)
def renew_lease \
name,
@@ -1488,11 +1488,11 @@
#
# @param name [String]
# Required.
#
# The task name. For example:
- # +projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID+
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
# @param schedule_time [Google::Protobuf::Timestamp | Hash]
# Required.
#
# The task's current schedule time, available in the
# {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} returned by
@@ -1510,11 +1510,11 @@
# 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 {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
- # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/)
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
# permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
# retries, etc.
# @yield [result, operation] Access the result along with the RPC operation
@@ -1526,11 +1526,11 @@
# require "google/cloud/tasks"
#
# cloud_tasks_client = Google::Cloud::Tasks.new(version: :v2beta2)
# formatted_name = Google::Cloud::Tasks::V2beta2::CloudTasksClient.task_path("[PROJECT]", "[LOCATION]", "[QUEUE]", "[TASK]")
#
- # # TODO: Initialize +schedule_time+:
+ # # TODO: Initialize `schedule_time`:
# schedule_time = {}
# response = cloud_tasks_client.cancel_lease(formatted_name, schedule_time)
def cancel_lease \
name,
@@ -1577,11 +1577,11 @@
#
# @param name [String]
# Required.
#
# The task name. For example:
- # +projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID+
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
# @param response_view [Google::Cloud::Tasks::V2beta2::Task::View]
# The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta2::Task Task} will be
# returned.
#
# By default response_view is {Google::Cloud::Tasks::V2beta2::Task::View::BASIC BASIC}; not all
@@ -1589,10 +1589,10 @@
# 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 {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
- # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/)
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
# permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
# retries, etc.
# @yield [result, operation] Access the result along with the RPC operation