lib/google/cloud/tasks/v2beta3/cloud_tasks_client.rb in google-cloud-tasks-1.1.0 vs lib/google/cloud/tasks/v2beta3/cloud_tasks_client.rb in google-cloud-tasks-1.1.1
- old
+ new
@@ -389,13 +389,11 @@
# Lists queues.
#
# Queues are returned in lexicographical order.
#
# @param parent [String]
- # Required.
- #
- # The location name.
+ # Required. The location name.
# 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::V2beta3::Queue Queue}
# field can be used as a filter and several operators as supported.
# For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as
@@ -460,13 +458,11 @@
end
# Gets a queue.
#
# @param name [String]
- # Required.
- #
- # The resource name of the queue. For example:
+ # Required. The resource name of the queue. For example:
# `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
@@ -504,23 +500,19 @@
# [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.
+ # Required. The location name in which the queue will be created.
# 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::V2beta3::Queue | Hash]
- # Required.
+ # Required. The queue to create.
#
- # The queue to create.
- #
# {Google::Cloud::Tasks::V2beta3::Queue#name Queue's name} cannot be the same as an existing queue.
# A hash of the same form as `Google::Cloud::Tasks::V2beta3::Queue`
# can also be provided.
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
@@ -568,14 +560,12 @@
# [Overview of Queue Management and
# queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
# this method.
#
# @param queue [Google::Cloud::Tasks::V2beta3::Queue | Hash]
- # Required.
+ # Required. The queue to create or update.
#
- # The queue to create or update.
- #
# The queue's {Google::Cloud::Tasks::V2beta3::Queue#name name} must be specified.
#
# Output only fields cannot be modified using UpdateQueue.
# Any value specified for an output only field will be ignored.
# The queue's {Google::Cloud::Tasks::V2beta3::Queue#name name} cannot be changed.
@@ -630,13 +620,11 @@
# [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:
+ # Required. The queue name. For example:
# `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
@@ -668,13 +656,11 @@
#
# Purge operations can take up to one minute to take effect. Tasks
# might be dispatched before the purge takes effect. A purge is irreversible.
#
# @param name [String]
- # Required.
- #
- # The queue name. For example:
+ # Required. The queue name. For example:
# `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
@@ -707,13 +693,11 @@
# {Google::Cloud::Tasks::V2beta3::CloudTasks::ResumeQueue ResumeQueue}. Tasks can still be added
# when the queue is paused. A queue is paused if its
# {Google::Cloud::Tasks::V2beta3::Queue#state state} is {Google::Cloud::Tasks::V2beta3::Queue::State::PAUSED PAUSED}.
#
# @param name [String]
- # Required.
- #
- # The queue name. For example:
+ # Required. The queue name. For example:
# `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
@@ -752,13 +736,11 @@
# queues, follow the 500/50/5 pattern described in
# [Managing Cloud Tasks Scaling
# Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
#
# @param name [String]
- # Required.
- #
- # The queue name. For example:
+ # Required. The queue name. For example:
# `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
@@ -939,13 +921,11 @@
#
# The tasks may be returned in any order. The ordering may change at any
# time.
#
# @param parent [String]
- # Required.
- #
- # The queue name. For example:
+ # Required. The queue name. For example:
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
# @param response_view [Google::Cloud::Tasks::V2beta3::Task::View]
# The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta3::Task Task} will be
# returned.
#
@@ -1011,13 +991,11 @@
end
# Gets a task.
#
# @param name [String]
- # Required.
- #
- # The task name. For example:
+ # Required. The task name. For example:
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
# @param response_view [Google::Cloud::Tasks::V2beta3::Task::View]
# The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta3::Task Task} will be
# returned.
#
@@ -1063,21 +1041,17 @@
# Tasks cannot be updated after creation; there is no UpdateTask command.
#
# * The maximum task size is 100KB.
#
# @param parent [String]
- # Required.
- #
- # The queue name. For example:
+ # Required. The queue name. For example:
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
#
# The queue must already exist.
# @param task [Google::Cloud::Tasks::V2beta3::Task | Hash]
- # Required.
+ # Required. The task to add.
#
- # The task to add.
- #
# Task names have the following format:
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
# The user can optionally specify a task {Google::Cloud::Tasks::V2beta3::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
@@ -1160,13 +1134,11 @@
# A task can be deleted if it is scheduled or dispatched. A task
# cannot be deleted if it has executed successfully or permanently
# failed.
#
# @param name [String]
- # Required.
- #
- # The task name. For example:
+ # Required. The task name. For example:
# `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
@@ -1216,12 +1188,10 @@
# {Google::Cloud::Tasks::V2beta3::CloudTasks::RunTask RunTask} returns
# {Google::Rpc::Code::NOT_FOUND NOT_FOUND} when it is called on a
# task that has already succeeded or permanently failed.
#
# @param name [String]
- # Required.
- #
- # The task name. For example:
+ # Required. The task name. For example:
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
# @param response_view [Google::Cloud::Tasks::V2beta3::Task::View]
# The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta3::Task Task} will be
# returned.
#