generated/google/apis/cloudtasks_v2beta2/service.rb in google-api-client-0.23.4 vs generated/google/apis/cloudtasks_v2beta2/service.rb in google-api-client-0.23.5
- old
+ new
@@ -28,11 +28,11 @@
# require 'google/apis/cloudtasks_v2beta2'
#
# Cloudtasks = Google::Apis::CloudtasksV2beta2 # Alias the module
# service = Cloudtasks::CloudTasksService.new
#
- # @see https://cloud.google.com/cloud-tasks/
+ # @see https://cloud.google.com/tasks/
class CloudTasksService < Google::Apis::Core::BaseService
# @return [String]
# API key. Your API key identifies your project and provides you with API access,
# quota, and reports. Required unless you provide an OAuth 2.0 token.
attr_accessor :key
@@ -122,11 +122,12 @@
# 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.
# Read
- # [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)
+ # [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/
+ # docs/queue-yaml)
# before using this method.
# @param [String] parent
# Required.
# The location name in which the queue will be created.
# For example: `projects/PROJECT_ID/locations/LOCATION_ID`
@@ -168,11 +169,12 @@
# 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.
# Read
- # [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)
+ # [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/
+ # docs/queue-yaml)
# before using this method.
# @param [String] name
# Required.
# The queue name. For example:
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
@@ -236,12 +238,13 @@
end
# Gets the access control policy for a Queue.
# Returns an empty policy if the resource exists and does not have a policy
# set.
- # Authorization requires the following [Google IAM](/iam) permission on the
- # specified resource parent:
+ # Authorization requires the following
+ # [Google IAM](https://cloud.google.com/iam) permission on the specified
+ # resource parent:
# * `cloudtasks.queues.getIamPolicy`
# @param [String] resource
# REQUIRED: The resource for which the policy is being requested.
# See the operation documentation for the appropriate value for this field.
# @param [Google::Apis::CloudtasksV2beta2::GetIamPolicyRequest] get_iam_policy_request_object
@@ -283,11 +286,12 @@
# @param [String] filter
# `filter` can be used to specify a subset of queues. Any Queue
# field can be used as a filter and several operators as supported.
# For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as
# described in
- # [Stackdriver's Advanced Logs Filters](/logging/docs/view/advanced_filters).
+ # [Stackdriver's Advanced Logs Filters](https://cloud.google.com/logging/docs/
+ # view/advanced_filters).
# Sample filter "app_engine_http_target: *".
# Note that using filters might cause fewer queues than the
# requested_page size to be returned.
# @param [Fixnum] page_size
# Requested page size.
@@ -342,23 +346,24 @@
# 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.
# Read
- # [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)
+ # [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/
+ # docs/queue-yaml)
# before using this method.
# @param [String] name
# Caller-specified and required in CreateQueue,
# after which it becomes output only.
# The queue name.
# The queue name must have the following format:
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
# * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
# hyphens (-), colons (:), or periods (.).
# For more information, see
- # [Identifying projects](/resource-manager/docs/creating-managing-projects#
- # identifying_projects)
+ # [Identifying projects](https://cloud.google.com/resource-manager/docs/
+ # creating-managing-projects#identifying_projects)
# * `LOCATION_ID` is the canonical ID for the queue's location.
# The list of available locations can be obtained by calling
# ListLocations.
# For more information, see https://cloud.google.com/about/locations/.
# * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
@@ -482,12 +487,12 @@
# in the queue's state; after calling this method it
# will be set to RUNNING.
# WARNING: Resuming many high-QPS queues at the same time can
# lead to target overloading. If you are resuming high-QPS
# queues, follow the 500/50/5 pattern described in
- # [Managing Cloud Tasks Scaling Risks](/cloud-tasks/pdfs/managing-cloud-tasks-
- # scaling-risks-2017-06-05.pdf).
+ # [Managing Cloud Tasks Scaling Risks](https://cloud.google.com/tasks/docs/
+ # manage-cloud-task-scaling).
# @param [String] name
# Required.
# The queue name. For example:
# `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
# @param [Google::Apis::CloudtasksV2beta2::ResumeQueueRequest] resume_queue_request_object
@@ -522,12 +527,13 @@
# Sets the access control policy for a Queue. Replaces any existing
# policy.
# Note: The Cloud Console does not check queue-level IAM permissions yet.
# Project-level permissions are required to use the Cloud Console.
- # Authorization requires the following [Google IAM](/iam) permission on the
- # specified resource parent:
+ # Authorization requires the following
+ # [Google IAM](https://cloud.google.com/iam) permission on the specified
+ # resource parent:
# * `cloudtasks.queues.setIamPolicy`
# @param [String] resource
# REQUIRED: The resource for which the policy is being specified.
# See the operation documentation for the appropriate value for this field.
# @param [Google::Apis::CloudtasksV2beta2::SetIamPolicyRequest] set_iam_policy_request_object
@@ -683,14 +689,13 @@
execute_or_queue_command(command, &block)
end
# Creates a task and adds it to a queue.
# Tasks cannot be updated after creation; there is no UpdateTask command.
- # * For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),
- # the maximum task size is 100KB.
- # * For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this
- # the maximum task size is 1MB.
+ # * For App Engine queues, the maximum task size is
+ # 100KB.
+ # * For pull queues, the maximum task size is 1MB.
# @param [String] parent
# Required.
# The queue name. For example:
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
# The queue must already exist.
@@ -771,12 +776,12 @@
# 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](/iam/) permission on the
- # Task resource.
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
+ # permission on the Task resource.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -859,10 +864,12 @@
# Lists the tasks in a queue.
# By default, only the BASIC view is retrieved
# due to performance considerations;
# response_view controls the
# subset of information which is returned.
+ # The tasks may be returned in any order. The ordering may change at any
+ # time.
# @param [String] parent
# Required.
# The queue name. For example:
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
# @param [Fixnum] page_size
@@ -887,11 +894,11 @@
# 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](/iam/) permission on the
- # Task resource.
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
+ # permission on the Task resource.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.