2017-09-14 00:36:39 +00:00
|
|
|
# Copyright 2015 Google Inc.
|
|
|
|
#
|
|
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
# you may not use this file except in compliance with the License.
|
|
|
|
# You may obtain a copy of the License at
|
|
|
|
#
|
|
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
#
|
|
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
# See the License for the specific language governing permissions and
|
|
|
|
# limitations under the License.
|
|
|
|
|
|
|
|
require 'google/apis/core/base_service'
|
|
|
|
require 'google/apis/core/json_representation'
|
|
|
|
require 'google/apis/core/hashable'
|
|
|
|
require 'google/apis/errors'
|
|
|
|
|
|
|
|
module Google
|
|
|
|
module Apis
|
|
|
|
module CloudtasksV2beta2
|
|
|
|
# Cloud Tasks API
|
|
|
|
#
|
2018-06-15 00:36:51 +00:00
|
|
|
# Manages the execution of large numbers of distributed requests.
|
2017-09-14 00:36:39 +00:00
|
|
|
#
|
|
|
|
# @example
|
|
|
|
# require 'google/apis/cloudtasks_v2beta2'
|
|
|
|
#
|
|
|
|
# Cloudtasks = Google::Apis::CloudtasksV2beta2 # Alias the module
|
|
|
|
# service = Cloudtasks::CloudTasksService.new
|
|
|
|
#
|
2018-08-22 21:14:52 +00:00
|
|
|
# @see https://cloud.google.com/tasks/
|
2017-09-14 00:36:39 +00:00
|
|
|
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
|
|
|
|
|
|
|
|
# @return [String]
|
|
|
|
# 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.
|
|
|
|
attr_accessor :quota_user
|
|
|
|
|
|
|
|
def initialize
|
|
|
|
super('https://cloudtasks.googleapis.com/', '')
|
|
|
|
@batch_path = 'batch'
|
|
|
|
end
|
|
|
|
|
2018-04-11 00:35:27 +00:00
|
|
|
# Gets information about a location.
|
2017-09-16 00:35:41 +00:00
|
|
|
# @param [String] name
|
|
|
|
# Resource name for the location.
|
|
|
|
# @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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudtasksV2beta2::Location] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudtasksV2beta2::Location]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:get, 'v2beta2/{+name}', options)
|
2017-09-16 00:35:41 +00:00
|
|
|
command.response_representation = Google::Apis::CloudtasksV2beta2::Location::Representation
|
|
|
|
command.response_class = Google::Apis::CloudtasksV2beta2::Location
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
|
|
|
# Lists information about the supported locations for this service.
|
|
|
|
# @param [String] name
|
|
|
|
# The resource that owns the locations collection, if applicable.
|
|
|
|
# @param [String] filter
|
|
|
|
# The standard list filter.
|
|
|
|
# @param [Fixnum] page_size
|
|
|
|
# The standard list page size.
|
|
|
|
# @param [String] page_token
|
|
|
|
# The standard list page token.
|
|
|
|
# @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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudtasksV2beta2::ListLocationsResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudtasksV2beta2::ListLocationsResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:get, 'v2beta2/{+name}/locations', options)
|
2017-09-16 00:35:41 +00:00
|
|
|
command.response_representation = Google::Apis::CloudtasksV2beta2::ListLocationsResponse::Representation
|
|
|
|
command.response_class = Google::Apis::CloudtasksV2beta2::ListLocationsResponse
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
command.query['filter'] = filter unless filter.nil?
|
|
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
2020-08-13 00:39:19 +00:00
|
|
|
# Creates a queue. 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. Read [Overview of Queue Management and
|
|
|
|
# queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this
|
|
|
|
# method.
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [String] parent
|
2020-08-13 00:39:19 +00:00
|
|
|
# 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 ListLocations.
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [Google::Apis::CloudtasksV2beta2::Queue] queue_object
|
|
|
|
# @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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudtasksV2beta2::Queue] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudtasksV2beta2::Queue]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def create_project_location_queue(parent, queue_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:post, 'v2beta2/{+parent}/queues', options)
|
2017-09-14 00:36:39 +00:00
|
|
|
command.request_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation
|
|
|
|
command.request_object = queue_object
|
|
|
|
command.response_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation
|
|
|
|
command.response_class = Google::Apis::CloudtasksV2beta2::Queue
|
|
|
|
command.params['parent'] = parent unless parent.nil?
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
2020-08-13 00:39:19 +00:00
|
|
|
# Deletes a queue. This command will delete the queue even if it has tasks in it.
|
|
|
|
# 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
|
2017-11-18 00:35:57 +00:00
|
|
|
# using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
|
2020-08-13 00:39:19 +00:00
|
|
|
# Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/
|
|
|
|
# tasks/docs/queue-yaml) before using this method.
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [String] name
|
2020-08-13 00:39:19 +00:00
|
|
|
# Required. The queue name. For example: `projects/PROJECT_ID/locations/
|
|
|
|
# LOCATION_ID/queues/QUEUE_ID`
|
2017-09-14 00:36:39 +00:00
|
|
|
# @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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudtasksV2beta2::Empty] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudtasksV2beta2::Empty]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def delete_project_location_queue(name, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:delete, 'v2beta2/{+name}', options)
|
2017-09-14 00:36:39 +00:00
|
|
|
command.response_representation = Google::Apis::CloudtasksV2beta2::Empty::Representation
|
|
|
|
command.response_class = Google::Apis::CloudtasksV2beta2::Empty
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
|
|
|
# Gets a queue.
|
|
|
|
# @param [String] name
|
2020-08-13 00:39:19 +00:00
|
|
|
# Required. The resource name of the queue. For example: `projects/PROJECT_ID/
|
|
|
|
# locations/LOCATION_ID/queues/QUEUE_ID`
|
2020-04-13 16:49:10 +00:00
|
|
|
# @param [String] read_mask
|
|
|
|
# Optional. Read mask is used for a more granular control over what the API
|
feat: Automated regeneration of cloudtasks v2beta2 client (#1390)
This PR was generated using Autosynth. :rainbow:
<details><summary>Log from Synthtool</summary>
```
2020-11-05 01:59:52,681 synthtool [DEBUG] > Executing /home/kbuilder/.cache/synthtool/google-api-ruby-client/synth.py.
On branch autosynth-cloudtasks-v2beta2
nothing to commit, working tree clean
2020-11-05 01:59:52,708 synthtool [DEBUG] > Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth cloudtasks v2beta2
DEBUG:synthtool:Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth cloudtasks v2beta2
bundle install
Don't run Bundler as root. Bundler can ask for sudo if it is needed, and
installing your bundle as root will break this application for all non-root
users on this machine.
The dependency jruby-openssl (>= 0) will be unused by any of the platforms Bundler is installing for. Bundler is installing for ruby but the dependency is only for java. To add those platforms to the bundle, run `bundle lock --add-platform java`.
Fetching gem metadata from https://rubygems.org/.........
Fetching gem metadata from https://rubygems.org/.
Resolving dependencies...
Fetching rake 11.3.0
Installing rake 11.3.0
Fetching concurrent-ruby 1.1.7
Installing concurrent-ruby 1.1.7
Fetching i18n 1.8.5
Installing i18n 1.8.5
Fetching minitest 5.14.2
Installing minitest 5.14.2
Fetching thread_safe 0.3.6
Installing thread_safe 0.3.6
Fetching tzinfo 1.2.7
Installing tzinfo 1.2.7
Fetching activesupport 5.0.7.2
Installing activesupport 5.0.7.2
Fetching public_suffix 4.0.6
Installing public_suffix 4.0.6
Fetching addressable 2.7.0
Installing addressable 2.7.0
Fetching ast 2.4.1
Installing ast 2.4.1
Using bundler 2.1.4
Fetching byebug 11.1.3
Installing byebug 11.1.3 with native extensions
Fetching coderay 1.1.3
Installing coderay 1.1.3
Fetching json 2.3.1
Installing json 2.3.1 with native extensions
Fetching docile 1.3.2
Installing docile 1.3.2
Fetching simplecov-html 0.10.2
Installing simplecov-html 0.10.2
Fetching simplecov 0.16.1
Installing simplecov 0.16.1
Using sync 0.5.0
Fetching tins 1.26.0
Installing tins 1.26.0
Fetching term-ansicolor 1.7.1
Installing term-ansicolor 1.7.1
Fetching thor 0.20.3
Installing thor 0.20.3
Fetching coveralls 0.8.23
Installing coveralls 0.8.23
Fetching crack 0.4.4
Installing crack 0.4.4
Fetching declarative 0.0.20
Installing declarative 0.0.20
Fetching declarative-option 0.1.0
Installing declarative-option 0.1.0
Fetching diff-lcs 1.4.4
Installing diff-lcs 1.4.4
Fetching dotenv 2.7.6
Installing dotenv 2.7.6
Fetching fakefs 0.20.1
Installing fakefs 0.20.1
Fetching multipart-post 2.1.1
Installing multipart-post 2.1.1
Fetching ruby2_keywords 0.0.2
Installing ruby2_keywords 0.0.2
Fetching faraday 1.1.0
Installing faraday 1.1.0
Fetching gems 1.2.0
Installing gems 1.2.0
Fetching github-markup 1.7.0
Installing github-markup 1.7.0
Fetching jwt 2.2.2
Installing jwt 2.2.2
Fetching memoist 0.16.2
Installing memoist 0.16.2
Fetching multi_json 1.15.0
Installing multi_json 1.15.0
Fetching os 0.9.6
Installing os 0.9.6
Fetching signet 0.14.0
Installing signet 0.14.0
Fetching googleauth 0.14.0
Installing googleauth 0.14.0
Fetching httpclient 2.8.3
Installing httpclient 2.8.3
Fetching mini_mime 1.0.2
Installing mini_mime 1.0.2
Fetching uber 0.1.0
Installing uber 0.1.0
Fetching representable 3.0.4
Installing representable 3.0.4
Fetching retriable 3.1.2
Installing retriable 3.1.2
Fetching rexml 3.2.4
Installing rexml 3.2.4
Using google-api-client 0.48.0 from source at `.`
Fetching google-id-token 1.4.2
Installing google-id-token 1.4.2
Fetching hashdiff 1.0.1
Installing hashdiff 1.0.1
Fetching mime-types-data 3.2020.1104
Installing mime-types-data 3.2020.1104
Fetching mime-types 3.3.1
Installing mime-types 3.3.1
Fetching multi_xml 0.6.0
Installing multi_xml 0.6.0
Fetching httparty 0.18.1
Installing httparty 0.18.1
Fetching rspec-support 3.10.0
Installing rspec-support 3.10.0
Fetching rspec-core 3.10.0
Installing rspec-core 3.10.0
Fetching rspec-expectations 3.10.0
Installing rspec-expectations 3.10.0
Fetching rspec-mocks 3.10.0
Installing rspec-mocks 3.10.0
Fetching rspec 3.10.0
Installing rspec 3.10.0
Fetching json_spec 1.1.5
Installing json_spec 1.1.5
Fetching launchy 2.5.0
Installing launchy 2.5.0
Fetching little-plugger 1.1.4
Installing little-plugger 1.1.4
Fetching logging 2.3.0
Installing logging 2.3.0
Fetching method_source 1.0.0
Installing method_source 1.0.0
Fetching opencensus 0.5.0
Installing opencensus 0.5.0
Fetching parallel 1.19.2
Installing parallel 1.19.2
Fetching parser 2.7.2.0
Installing parser 2.7.2.0
Fetching powerpack 0.1.2
Installing powerpack 0.1.2
Fetching pry 0.13.1
Installing pry 0.13.1
Fetching pry-byebug 3.9.0
Installing pry-byebug 3.9.0
Fetching yard 0.9.25
Installing yard 0.9.25
Fetching pry-doc 0.13.5
Installing pry-doc 0.13.5
Fetching rainbow 2.2.2
Installing rainbow 2.2.2 with native extensions
Fetching redcarpet 3.5.0
Installing redcarpet 3.5.0 with native extensions
Fetching redis 3.3.5
Installing redis 3.3.5
Fetching rmail 1.1.4
Installing rmail 1.1.4
Fetching ruby-progressbar 1.10.1
Installing ruby-progressbar 1.10.1
Fetching unicode-display_width 1.7.0
Installing unicode-display_width 1.7.0
Fetching rubocop 0.49.1
Installing rubocop 0.49.1
Fetching webmock 2.3.2
Installing webmock 2.3.2
Bundle complete! 31 Gemfile dependencies, 78 gems now installed.
Use `bundle info [gemname]` to see where a bundled gem is installed.
Post-install message from i18n:
HEADS UP! i18n 1.1 changed fallbacks to exclude default locale.
But that may break your application.
If you are upgrading your Rails application from an older version of Rails:
Please check your Rails app for 'config.i18n.fallbacks = true'.
If you're using I18n (>= 1.1.0) and Rails (< 5.2.2), this should be
'config.i18n.fallbacks = [I18n.default_locale]'.
If not, fallbacks will be broken in your app by I18n 1.1.x.
If you are starting a NEW Rails application, you can ignore this notice.
For more info see:
https://github.com/svenfuchs/i18n/releases/tag/v1.1.0
Post-install message from httparty:
When you HTTParty, you must party hard!
echo a | bundle exec bin/generate-api gen generated --api=cloudtasks.v2beta2 --names-out=/workspace/api_names_out.yaml
Loading cloudtasks, version v2beta2 from https://raw.githubusercontent.com/googleapis/discovery-artifact-manager/master/discoveries/cloudtasks.v2beta2.json
conflict google/apis/cloudtasks_v2beta2.rb
<udtasks_v2beta2.rb? (enter "h" for help) [Ynaqdhm] a
force google/apis/cloudtasks_v2beta2.rb
conflict google/apis/cloudtasks_v2beta2/service.rb
force google/apis/cloudtasks_v2beta2/service.rb
conflict google/apis/cloudtasks_v2beta2/classes.rb
force google/apis/cloudtasks_v2beta2/classes.rb
identical google/apis/cloudtasks_v2beta2/representations.rb
conflict /workspace/api_names_out.yaml
force /workspace/api_names_out.yaml
2020-11-05 02:00:17,685 synthtool [DEBUG] > Wrote metadata to generated/google/apis/cloudtasks_v2beta2/synth.metadata.
DEBUG:synthtool:Wrote metadata to generated/google/apis/cloudtasks_v2beta2/synth.metadata.
```
</details>
Full log will be available here:
https://source.cloud.google.com/results/invocations/749223e1-0b80-43a0-be68-640be14dbb8a/targets
- [ ] To automatically regenerate this PR, check this box.
2020-11-05 10:22:02 +00:00
|
|
|
# returns. If the mask is not present all fields will be returned except [Queue.
|
|
|
|
# stats], if the mask is set to "*" all fields including [Queue.stats] will be
|
|
|
|
# returned, otherwise only the fields explicitly specified in the mask will be
|
|
|
|
# returned.
|
2017-09-14 00:36:39 +00:00
|
|
|
# @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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudtasksV2beta2::Queue] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudtasksV2beta2::Queue]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2020-04-13 16:49:10 +00:00
|
|
|
def get_project_location_queue(name, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:get, 'v2beta2/{+name}', options)
|
2017-09-14 00:36:39 +00:00
|
|
|
command.response_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation
|
|
|
|
command.response_class = Google::Apis::CloudtasksV2beta2::Queue
|
|
|
|
command.params['name'] = name unless name.nil?
|
2020-04-13 16:49:10 +00:00
|
|
|
command.query['readMask'] = read_mask unless read_mask.nil?
|
2017-09-14 00:36:39 +00:00
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
2020-08-13 00:39:19 +00:00
|
|
|
# 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](https://cloud.google.com/iam) permission on the
|
|
|
|
# specified resource parent: * `cloudtasks.queues.getIamPolicy`
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [String] resource
|
2020-08-13 00:39:19 +00:00
|
|
|
# REQUIRED: The resource for which the policy is being requested. See the
|
|
|
|
# operation documentation for the appropriate value for this field.
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [Google::Apis::CloudtasksV2beta2::GetIamPolicyRequest] get_iam_policy_request_object
|
|
|
|
# @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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudtasksV2beta2::Policy] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudtasksV2beta2::Policy]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def get_queue_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:post, 'v2beta2/{+resource}:getIamPolicy', options)
|
2017-09-14 00:36:39 +00:00
|
|
|
command.request_representation = Google::Apis::CloudtasksV2beta2::GetIamPolicyRequest::Representation
|
|
|
|
command.request_object = get_iam_policy_request_object
|
|
|
|
command.response_representation = Google::Apis::CloudtasksV2beta2::Policy::Representation
|
|
|
|
command.response_class = Google::Apis::CloudtasksV2beta2::Policy
|
|
|
|
command.params['resource'] = resource unless resource.nil?
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
2020-08-13 00:39:19 +00:00
|
|
|
# Lists queues. Queues are returned in lexicographical order.
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [String] parent
|
2020-08-13 00:39:19 +00:00
|
|
|
# Required. The location name. For example: `projects/PROJECT_ID/locations/
|
|
|
|
# LOCATION_ID`
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [String] filter
|
2020-08-13 00:39:19 +00:00
|
|
|
# `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](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.
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [Fixnum] page_size
|
2020-08-13 00:39:19 +00:00
|
|
|
# Requested page size. The maximum page size is 9800. If unspecified, the page
|
|
|
|
# size will be the maximum. Fewer queues than requested might be returned, even
|
|
|
|
# if more queues exist; use the next_page_token in the response to determine if
|
|
|
|
# more queues exist.
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [String] page_token
|
2020-08-13 00:39:19 +00:00
|
|
|
# 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 ListQueues method. It is an error to switch the value of the filter
|
|
|
|
# while iterating through pages.
|
feat: Automated regeneration of cloudtasks v2beta2 client (#1390)
This PR was generated using Autosynth. :rainbow:
<details><summary>Log from Synthtool</summary>
```
2020-11-05 01:59:52,681 synthtool [DEBUG] > Executing /home/kbuilder/.cache/synthtool/google-api-ruby-client/synth.py.
On branch autosynth-cloudtasks-v2beta2
nothing to commit, working tree clean
2020-11-05 01:59:52,708 synthtool [DEBUG] > Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth cloudtasks v2beta2
DEBUG:synthtool:Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth cloudtasks v2beta2
bundle install
Don't run Bundler as root. Bundler can ask for sudo if it is needed, and
installing your bundle as root will break this application for all non-root
users on this machine.
The dependency jruby-openssl (>= 0) will be unused by any of the platforms Bundler is installing for. Bundler is installing for ruby but the dependency is only for java. To add those platforms to the bundle, run `bundle lock --add-platform java`.
Fetching gem metadata from https://rubygems.org/.........
Fetching gem metadata from https://rubygems.org/.
Resolving dependencies...
Fetching rake 11.3.0
Installing rake 11.3.0
Fetching concurrent-ruby 1.1.7
Installing concurrent-ruby 1.1.7
Fetching i18n 1.8.5
Installing i18n 1.8.5
Fetching minitest 5.14.2
Installing minitest 5.14.2
Fetching thread_safe 0.3.6
Installing thread_safe 0.3.6
Fetching tzinfo 1.2.7
Installing tzinfo 1.2.7
Fetching activesupport 5.0.7.2
Installing activesupport 5.0.7.2
Fetching public_suffix 4.0.6
Installing public_suffix 4.0.6
Fetching addressable 2.7.0
Installing addressable 2.7.0
Fetching ast 2.4.1
Installing ast 2.4.1
Using bundler 2.1.4
Fetching byebug 11.1.3
Installing byebug 11.1.3 with native extensions
Fetching coderay 1.1.3
Installing coderay 1.1.3
Fetching json 2.3.1
Installing json 2.3.1 with native extensions
Fetching docile 1.3.2
Installing docile 1.3.2
Fetching simplecov-html 0.10.2
Installing simplecov-html 0.10.2
Fetching simplecov 0.16.1
Installing simplecov 0.16.1
Using sync 0.5.0
Fetching tins 1.26.0
Installing tins 1.26.0
Fetching term-ansicolor 1.7.1
Installing term-ansicolor 1.7.1
Fetching thor 0.20.3
Installing thor 0.20.3
Fetching coveralls 0.8.23
Installing coveralls 0.8.23
Fetching crack 0.4.4
Installing crack 0.4.4
Fetching declarative 0.0.20
Installing declarative 0.0.20
Fetching declarative-option 0.1.0
Installing declarative-option 0.1.0
Fetching diff-lcs 1.4.4
Installing diff-lcs 1.4.4
Fetching dotenv 2.7.6
Installing dotenv 2.7.6
Fetching fakefs 0.20.1
Installing fakefs 0.20.1
Fetching multipart-post 2.1.1
Installing multipart-post 2.1.1
Fetching ruby2_keywords 0.0.2
Installing ruby2_keywords 0.0.2
Fetching faraday 1.1.0
Installing faraday 1.1.0
Fetching gems 1.2.0
Installing gems 1.2.0
Fetching github-markup 1.7.0
Installing github-markup 1.7.0
Fetching jwt 2.2.2
Installing jwt 2.2.2
Fetching memoist 0.16.2
Installing memoist 0.16.2
Fetching multi_json 1.15.0
Installing multi_json 1.15.0
Fetching os 0.9.6
Installing os 0.9.6
Fetching signet 0.14.0
Installing signet 0.14.0
Fetching googleauth 0.14.0
Installing googleauth 0.14.0
Fetching httpclient 2.8.3
Installing httpclient 2.8.3
Fetching mini_mime 1.0.2
Installing mini_mime 1.0.2
Fetching uber 0.1.0
Installing uber 0.1.0
Fetching representable 3.0.4
Installing representable 3.0.4
Fetching retriable 3.1.2
Installing retriable 3.1.2
Fetching rexml 3.2.4
Installing rexml 3.2.4
Using google-api-client 0.48.0 from source at `.`
Fetching google-id-token 1.4.2
Installing google-id-token 1.4.2
Fetching hashdiff 1.0.1
Installing hashdiff 1.0.1
Fetching mime-types-data 3.2020.1104
Installing mime-types-data 3.2020.1104
Fetching mime-types 3.3.1
Installing mime-types 3.3.1
Fetching multi_xml 0.6.0
Installing multi_xml 0.6.0
Fetching httparty 0.18.1
Installing httparty 0.18.1
Fetching rspec-support 3.10.0
Installing rspec-support 3.10.0
Fetching rspec-core 3.10.0
Installing rspec-core 3.10.0
Fetching rspec-expectations 3.10.0
Installing rspec-expectations 3.10.0
Fetching rspec-mocks 3.10.0
Installing rspec-mocks 3.10.0
Fetching rspec 3.10.0
Installing rspec 3.10.0
Fetching json_spec 1.1.5
Installing json_spec 1.1.5
Fetching launchy 2.5.0
Installing launchy 2.5.0
Fetching little-plugger 1.1.4
Installing little-plugger 1.1.4
Fetching logging 2.3.0
Installing logging 2.3.0
Fetching method_source 1.0.0
Installing method_source 1.0.0
Fetching opencensus 0.5.0
Installing opencensus 0.5.0
Fetching parallel 1.19.2
Installing parallel 1.19.2
Fetching parser 2.7.2.0
Installing parser 2.7.2.0
Fetching powerpack 0.1.2
Installing powerpack 0.1.2
Fetching pry 0.13.1
Installing pry 0.13.1
Fetching pry-byebug 3.9.0
Installing pry-byebug 3.9.0
Fetching yard 0.9.25
Installing yard 0.9.25
Fetching pry-doc 0.13.5
Installing pry-doc 0.13.5
Fetching rainbow 2.2.2
Installing rainbow 2.2.2 with native extensions
Fetching redcarpet 3.5.0
Installing redcarpet 3.5.0 with native extensions
Fetching redis 3.3.5
Installing redis 3.3.5
Fetching rmail 1.1.4
Installing rmail 1.1.4
Fetching ruby-progressbar 1.10.1
Installing ruby-progressbar 1.10.1
Fetching unicode-display_width 1.7.0
Installing unicode-display_width 1.7.0
Fetching rubocop 0.49.1
Installing rubocop 0.49.1
Fetching webmock 2.3.2
Installing webmock 2.3.2
Bundle complete! 31 Gemfile dependencies, 78 gems now installed.
Use `bundle info [gemname]` to see where a bundled gem is installed.
Post-install message from i18n:
HEADS UP! i18n 1.1 changed fallbacks to exclude default locale.
But that may break your application.
If you are upgrading your Rails application from an older version of Rails:
Please check your Rails app for 'config.i18n.fallbacks = true'.
If you're using I18n (>= 1.1.0) and Rails (< 5.2.2), this should be
'config.i18n.fallbacks = [I18n.default_locale]'.
If not, fallbacks will be broken in your app by I18n 1.1.x.
If you are starting a NEW Rails application, you can ignore this notice.
For more info see:
https://github.com/svenfuchs/i18n/releases/tag/v1.1.0
Post-install message from httparty:
When you HTTParty, you must party hard!
echo a | bundle exec bin/generate-api gen generated --api=cloudtasks.v2beta2 --names-out=/workspace/api_names_out.yaml
Loading cloudtasks, version v2beta2 from https://raw.githubusercontent.com/googleapis/discovery-artifact-manager/master/discoveries/cloudtasks.v2beta2.json
conflict google/apis/cloudtasks_v2beta2.rb
<udtasks_v2beta2.rb? (enter "h" for help) [Ynaqdhm] a
force google/apis/cloudtasks_v2beta2.rb
conflict google/apis/cloudtasks_v2beta2/service.rb
force google/apis/cloudtasks_v2beta2/service.rb
conflict google/apis/cloudtasks_v2beta2/classes.rb
force google/apis/cloudtasks_v2beta2/classes.rb
identical google/apis/cloudtasks_v2beta2/representations.rb
conflict /workspace/api_names_out.yaml
force /workspace/api_names_out.yaml
2020-11-05 02:00:17,685 synthtool [DEBUG] > Wrote metadata to generated/google/apis/cloudtasks_v2beta2/synth.metadata.
DEBUG:synthtool:Wrote metadata to generated/google/apis/cloudtasks_v2beta2/synth.metadata.
```
</details>
Full log will be available here:
https://source.cloud.google.com/results/invocations/749223e1-0b80-43a0-be68-640be14dbb8a/targets
- [ ] To automatically regenerate this PR, check this box.
2020-11-05 10:22:02 +00:00
|
|
|
# @param [String] read_mask
|
|
|
|
# Optional. Read mask is used for a more granular control over what the API
|
|
|
|
# returns. If the mask is not present all fields will be returned except [Queue.
|
|
|
|
# stats], if the mask is set to "*" all fields including [Queue.stats] will be
|
|
|
|
# returned, otherwise only the fields explicitly specified in the mask will be
|
|
|
|
# returned.
|
2017-09-14 00:36:39 +00:00
|
|
|
# @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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudtasksV2beta2::ListQueuesResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudtasksV2beta2::ListQueuesResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
feat: Automated regeneration of cloudtasks v2beta2 client (#1390)
This PR was generated using Autosynth. :rainbow:
<details><summary>Log from Synthtool</summary>
```
2020-11-05 01:59:52,681 synthtool [DEBUG] > Executing /home/kbuilder/.cache/synthtool/google-api-ruby-client/synth.py.
On branch autosynth-cloudtasks-v2beta2
nothing to commit, working tree clean
2020-11-05 01:59:52,708 synthtool [DEBUG] > Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth cloudtasks v2beta2
DEBUG:synthtool:Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth cloudtasks v2beta2
bundle install
Don't run Bundler as root. Bundler can ask for sudo if it is needed, and
installing your bundle as root will break this application for all non-root
users on this machine.
The dependency jruby-openssl (>= 0) will be unused by any of the platforms Bundler is installing for. Bundler is installing for ruby but the dependency is only for java. To add those platforms to the bundle, run `bundle lock --add-platform java`.
Fetching gem metadata from https://rubygems.org/.........
Fetching gem metadata from https://rubygems.org/.
Resolving dependencies...
Fetching rake 11.3.0
Installing rake 11.3.0
Fetching concurrent-ruby 1.1.7
Installing concurrent-ruby 1.1.7
Fetching i18n 1.8.5
Installing i18n 1.8.5
Fetching minitest 5.14.2
Installing minitest 5.14.2
Fetching thread_safe 0.3.6
Installing thread_safe 0.3.6
Fetching tzinfo 1.2.7
Installing tzinfo 1.2.7
Fetching activesupport 5.0.7.2
Installing activesupport 5.0.7.2
Fetching public_suffix 4.0.6
Installing public_suffix 4.0.6
Fetching addressable 2.7.0
Installing addressable 2.7.0
Fetching ast 2.4.1
Installing ast 2.4.1
Using bundler 2.1.4
Fetching byebug 11.1.3
Installing byebug 11.1.3 with native extensions
Fetching coderay 1.1.3
Installing coderay 1.1.3
Fetching json 2.3.1
Installing json 2.3.1 with native extensions
Fetching docile 1.3.2
Installing docile 1.3.2
Fetching simplecov-html 0.10.2
Installing simplecov-html 0.10.2
Fetching simplecov 0.16.1
Installing simplecov 0.16.1
Using sync 0.5.0
Fetching tins 1.26.0
Installing tins 1.26.0
Fetching term-ansicolor 1.7.1
Installing term-ansicolor 1.7.1
Fetching thor 0.20.3
Installing thor 0.20.3
Fetching coveralls 0.8.23
Installing coveralls 0.8.23
Fetching crack 0.4.4
Installing crack 0.4.4
Fetching declarative 0.0.20
Installing declarative 0.0.20
Fetching declarative-option 0.1.0
Installing declarative-option 0.1.0
Fetching diff-lcs 1.4.4
Installing diff-lcs 1.4.4
Fetching dotenv 2.7.6
Installing dotenv 2.7.6
Fetching fakefs 0.20.1
Installing fakefs 0.20.1
Fetching multipart-post 2.1.1
Installing multipart-post 2.1.1
Fetching ruby2_keywords 0.0.2
Installing ruby2_keywords 0.0.2
Fetching faraday 1.1.0
Installing faraday 1.1.0
Fetching gems 1.2.0
Installing gems 1.2.0
Fetching github-markup 1.7.0
Installing github-markup 1.7.0
Fetching jwt 2.2.2
Installing jwt 2.2.2
Fetching memoist 0.16.2
Installing memoist 0.16.2
Fetching multi_json 1.15.0
Installing multi_json 1.15.0
Fetching os 0.9.6
Installing os 0.9.6
Fetching signet 0.14.0
Installing signet 0.14.0
Fetching googleauth 0.14.0
Installing googleauth 0.14.0
Fetching httpclient 2.8.3
Installing httpclient 2.8.3
Fetching mini_mime 1.0.2
Installing mini_mime 1.0.2
Fetching uber 0.1.0
Installing uber 0.1.0
Fetching representable 3.0.4
Installing representable 3.0.4
Fetching retriable 3.1.2
Installing retriable 3.1.2
Fetching rexml 3.2.4
Installing rexml 3.2.4
Using google-api-client 0.48.0 from source at `.`
Fetching google-id-token 1.4.2
Installing google-id-token 1.4.2
Fetching hashdiff 1.0.1
Installing hashdiff 1.0.1
Fetching mime-types-data 3.2020.1104
Installing mime-types-data 3.2020.1104
Fetching mime-types 3.3.1
Installing mime-types 3.3.1
Fetching multi_xml 0.6.0
Installing multi_xml 0.6.0
Fetching httparty 0.18.1
Installing httparty 0.18.1
Fetching rspec-support 3.10.0
Installing rspec-support 3.10.0
Fetching rspec-core 3.10.0
Installing rspec-core 3.10.0
Fetching rspec-expectations 3.10.0
Installing rspec-expectations 3.10.0
Fetching rspec-mocks 3.10.0
Installing rspec-mocks 3.10.0
Fetching rspec 3.10.0
Installing rspec 3.10.0
Fetching json_spec 1.1.5
Installing json_spec 1.1.5
Fetching launchy 2.5.0
Installing launchy 2.5.0
Fetching little-plugger 1.1.4
Installing little-plugger 1.1.4
Fetching logging 2.3.0
Installing logging 2.3.0
Fetching method_source 1.0.0
Installing method_source 1.0.0
Fetching opencensus 0.5.0
Installing opencensus 0.5.0
Fetching parallel 1.19.2
Installing parallel 1.19.2
Fetching parser 2.7.2.0
Installing parser 2.7.2.0
Fetching powerpack 0.1.2
Installing powerpack 0.1.2
Fetching pry 0.13.1
Installing pry 0.13.1
Fetching pry-byebug 3.9.0
Installing pry-byebug 3.9.0
Fetching yard 0.9.25
Installing yard 0.9.25
Fetching pry-doc 0.13.5
Installing pry-doc 0.13.5
Fetching rainbow 2.2.2
Installing rainbow 2.2.2 with native extensions
Fetching redcarpet 3.5.0
Installing redcarpet 3.5.0 with native extensions
Fetching redis 3.3.5
Installing redis 3.3.5
Fetching rmail 1.1.4
Installing rmail 1.1.4
Fetching ruby-progressbar 1.10.1
Installing ruby-progressbar 1.10.1
Fetching unicode-display_width 1.7.0
Installing unicode-display_width 1.7.0
Fetching rubocop 0.49.1
Installing rubocop 0.49.1
Fetching webmock 2.3.2
Installing webmock 2.3.2
Bundle complete! 31 Gemfile dependencies, 78 gems now installed.
Use `bundle info [gemname]` to see where a bundled gem is installed.
Post-install message from i18n:
HEADS UP! i18n 1.1 changed fallbacks to exclude default locale.
But that may break your application.
If you are upgrading your Rails application from an older version of Rails:
Please check your Rails app for 'config.i18n.fallbacks = true'.
If you're using I18n (>= 1.1.0) and Rails (< 5.2.2), this should be
'config.i18n.fallbacks = [I18n.default_locale]'.
If not, fallbacks will be broken in your app by I18n 1.1.x.
If you are starting a NEW Rails application, you can ignore this notice.
For more info see:
https://github.com/svenfuchs/i18n/releases/tag/v1.1.0
Post-install message from httparty:
When you HTTParty, you must party hard!
echo a | bundle exec bin/generate-api gen generated --api=cloudtasks.v2beta2 --names-out=/workspace/api_names_out.yaml
Loading cloudtasks, version v2beta2 from https://raw.githubusercontent.com/googleapis/discovery-artifact-manager/master/discoveries/cloudtasks.v2beta2.json
conflict google/apis/cloudtasks_v2beta2.rb
<udtasks_v2beta2.rb? (enter "h" for help) [Ynaqdhm] a
force google/apis/cloudtasks_v2beta2.rb
conflict google/apis/cloudtasks_v2beta2/service.rb
force google/apis/cloudtasks_v2beta2/service.rb
conflict google/apis/cloudtasks_v2beta2/classes.rb
force google/apis/cloudtasks_v2beta2/classes.rb
identical google/apis/cloudtasks_v2beta2/representations.rb
conflict /workspace/api_names_out.yaml
force /workspace/api_names_out.yaml
2020-11-05 02:00:17,685 synthtool [DEBUG] > Wrote metadata to generated/google/apis/cloudtasks_v2beta2/synth.metadata.
DEBUG:synthtool:Wrote metadata to generated/google/apis/cloudtasks_v2beta2/synth.metadata.
```
</details>
Full log will be available here:
https://source.cloud.google.com/results/invocations/749223e1-0b80-43a0-be68-640be14dbb8a/targets
- [ ] To automatically regenerate this PR, check this box.
2020-11-05 10:22:02 +00:00
|
|
|
def list_project_location_queues(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:get, 'v2beta2/{+parent}/queues', options)
|
2017-09-14 00:36:39 +00:00
|
|
|
command.response_representation = Google::Apis::CloudtasksV2beta2::ListQueuesResponse::Representation
|
|
|
|
command.response_class = Google::Apis::CloudtasksV2beta2::ListQueuesResponse
|
|
|
|
command.params['parent'] = parent unless parent.nil?
|
|
|
|
command.query['filter'] = filter unless filter.nil?
|
|
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
feat: Automated regeneration of cloudtasks v2beta2 client (#1390)
This PR was generated using Autosynth. :rainbow:
<details><summary>Log from Synthtool</summary>
```
2020-11-05 01:59:52,681 synthtool [DEBUG] > Executing /home/kbuilder/.cache/synthtool/google-api-ruby-client/synth.py.
On branch autosynth-cloudtasks-v2beta2
nothing to commit, working tree clean
2020-11-05 01:59:52,708 synthtool [DEBUG] > Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth cloudtasks v2beta2
DEBUG:synthtool:Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth cloudtasks v2beta2
bundle install
Don't run Bundler as root. Bundler can ask for sudo if it is needed, and
installing your bundle as root will break this application for all non-root
users on this machine.
The dependency jruby-openssl (>= 0) will be unused by any of the platforms Bundler is installing for. Bundler is installing for ruby but the dependency is only for java. To add those platforms to the bundle, run `bundle lock --add-platform java`.
Fetching gem metadata from https://rubygems.org/.........
Fetching gem metadata from https://rubygems.org/.
Resolving dependencies...
Fetching rake 11.3.0
Installing rake 11.3.0
Fetching concurrent-ruby 1.1.7
Installing concurrent-ruby 1.1.7
Fetching i18n 1.8.5
Installing i18n 1.8.5
Fetching minitest 5.14.2
Installing minitest 5.14.2
Fetching thread_safe 0.3.6
Installing thread_safe 0.3.6
Fetching tzinfo 1.2.7
Installing tzinfo 1.2.7
Fetching activesupport 5.0.7.2
Installing activesupport 5.0.7.2
Fetching public_suffix 4.0.6
Installing public_suffix 4.0.6
Fetching addressable 2.7.0
Installing addressable 2.7.0
Fetching ast 2.4.1
Installing ast 2.4.1
Using bundler 2.1.4
Fetching byebug 11.1.3
Installing byebug 11.1.3 with native extensions
Fetching coderay 1.1.3
Installing coderay 1.1.3
Fetching json 2.3.1
Installing json 2.3.1 with native extensions
Fetching docile 1.3.2
Installing docile 1.3.2
Fetching simplecov-html 0.10.2
Installing simplecov-html 0.10.2
Fetching simplecov 0.16.1
Installing simplecov 0.16.1
Using sync 0.5.0
Fetching tins 1.26.0
Installing tins 1.26.0
Fetching term-ansicolor 1.7.1
Installing term-ansicolor 1.7.1
Fetching thor 0.20.3
Installing thor 0.20.3
Fetching coveralls 0.8.23
Installing coveralls 0.8.23
Fetching crack 0.4.4
Installing crack 0.4.4
Fetching declarative 0.0.20
Installing declarative 0.0.20
Fetching declarative-option 0.1.0
Installing declarative-option 0.1.0
Fetching diff-lcs 1.4.4
Installing diff-lcs 1.4.4
Fetching dotenv 2.7.6
Installing dotenv 2.7.6
Fetching fakefs 0.20.1
Installing fakefs 0.20.1
Fetching multipart-post 2.1.1
Installing multipart-post 2.1.1
Fetching ruby2_keywords 0.0.2
Installing ruby2_keywords 0.0.2
Fetching faraday 1.1.0
Installing faraday 1.1.0
Fetching gems 1.2.0
Installing gems 1.2.0
Fetching github-markup 1.7.0
Installing github-markup 1.7.0
Fetching jwt 2.2.2
Installing jwt 2.2.2
Fetching memoist 0.16.2
Installing memoist 0.16.2
Fetching multi_json 1.15.0
Installing multi_json 1.15.0
Fetching os 0.9.6
Installing os 0.9.6
Fetching signet 0.14.0
Installing signet 0.14.0
Fetching googleauth 0.14.0
Installing googleauth 0.14.0
Fetching httpclient 2.8.3
Installing httpclient 2.8.3
Fetching mini_mime 1.0.2
Installing mini_mime 1.0.2
Fetching uber 0.1.0
Installing uber 0.1.0
Fetching representable 3.0.4
Installing representable 3.0.4
Fetching retriable 3.1.2
Installing retriable 3.1.2
Fetching rexml 3.2.4
Installing rexml 3.2.4
Using google-api-client 0.48.0 from source at `.`
Fetching google-id-token 1.4.2
Installing google-id-token 1.4.2
Fetching hashdiff 1.0.1
Installing hashdiff 1.0.1
Fetching mime-types-data 3.2020.1104
Installing mime-types-data 3.2020.1104
Fetching mime-types 3.3.1
Installing mime-types 3.3.1
Fetching multi_xml 0.6.0
Installing multi_xml 0.6.0
Fetching httparty 0.18.1
Installing httparty 0.18.1
Fetching rspec-support 3.10.0
Installing rspec-support 3.10.0
Fetching rspec-core 3.10.0
Installing rspec-core 3.10.0
Fetching rspec-expectations 3.10.0
Installing rspec-expectations 3.10.0
Fetching rspec-mocks 3.10.0
Installing rspec-mocks 3.10.0
Fetching rspec 3.10.0
Installing rspec 3.10.0
Fetching json_spec 1.1.5
Installing json_spec 1.1.5
Fetching launchy 2.5.0
Installing launchy 2.5.0
Fetching little-plugger 1.1.4
Installing little-plugger 1.1.4
Fetching logging 2.3.0
Installing logging 2.3.0
Fetching method_source 1.0.0
Installing method_source 1.0.0
Fetching opencensus 0.5.0
Installing opencensus 0.5.0
Fetching parallel 1.19.2
Installing parallel 1.19.2
Fetching parser 2.7.2.0
Installing parser 2.7.2.0
Fetching powerpack 0.1.2
Installing powerpack 0.1.2
Fetching pry 0.13.1
Installing pry 0.13.1
Fetching pry-byebug 3.9.0
Installing pry-byebug 3.9.0
Fetching yard 0.9.25
Installing yard 0.9.25
Fetching pry-doc 0.13.5
Installing pry-doc 0.13.5
Fetching rainbow 2.2.2
Installing rainbow 2.2.2 with native extensions
Fetching redcarpet 3.5.0
Installing redcarpet 3.5.0 with native extensions
Fetching redis 3.3.5
Installing redis 3.3.5
Fetching rmail 1.1.4
Installing rmail 1.1.4
Fetching ruby-progressbar 1.10.1
Installing ruby-progressbar 1.10.1
Fetching unicode-display_width 1.7.0
Installing unicode-display_width 1.7.0
Fetching rubocop 0.49.1
Installing rubocop 0.49.1
Fetching webmock 2.3.2
Installing webmock 2.3.2
Bundle complete! 31 Gemfile dependencies, 78 gems now installed.
Use `bundle info [gemname]` to see where a bundled gem is installed.
Post-install message from i18n:
HEADS UP! i18n 1.1 changed fallbacks to exclude default locale.
But that may break your application.
If you are upgrading your Rails application from an older version of Rails:
Please check your Rails app for 'config.i18n.fallbacks = true'.
If you're using I18n (>= 1.1.0) and Rails (< 5.2.2), this should be
'config.i18n.fallbacks = [I18n.default_locale]'.
If not, fallbacks will be broken in your app by I18n 1.1.x.
If you are starting a NEW Rails application, you can ignore this notice.
For more info see:
https://github.com/svenfuchs/i18n/releases/tag/v1.1.0
Post-install message from httparty:
When you HTTParty, you must party hard!
echo a | bundle exec bin/generate-api gen generated --api=cloudtasks.v2beta2 --names-out=/workspace/api_names_out.yaml
Loading cloudtasks, version v2beta2 from https://raw.githubusercontent.com/googleapis/discovery-artifact-manager/master/discoveries/cloudtasks.v2beta2.json
conflict google/apis/cloudtasks_v2beta2.rb
<udtasks_v2beta2.rb? (enter "h" for help) [Ynaqdhm] a
force google/apis/cloudtasks_v2beta2.rb
conflict google/apis/cloudtasks_v2beta2/service.rb
force google/apis/cloudtasks_v2beta2/service.rb
conflict google/apis/cloudtasks_v2beta2/classes.rb
force google/apis/cloudtasks_v2beta2/classes.rb
identical google/apis/cloudtasks_v2beta2/representations.rb
conflict /workspace/api_names_out.yaml
force /workspace/api_names_out.yaml
2020-11-05 02:00:17,685 synthtool [DEBUG] > Wrote metadata to generated/google/apis/cloudtasks_v2beta2/synth.metadata.
DEBUG:synthtool:Wrote metadata to generated/google/apis/cloudtasks_v2beta2/synth.metadata.
```
</details>
Full log will be available here:
https://source.cloud.google.com/results/invocations/749223e1-0b80-43a0-be68-640be14dbb8a/targets
- [ ] To automatically regenerate this PR, check this box.
2020-11-05 10:22:02 +00:00
|
|
|
command.query['readMask'] = read_mask unless read_mask.nil?
|
2017-09-14 00:36:39 +00:00
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
2020-08-13 00:39:19 +00:00
|
|
|
# Updates a queue. This method creates the queue if it does not exist and
|
|
|
|
# updates the queue if it does exist. 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. Read [Overview of Queue
|
|
|
|
# Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)
|
|
|
|
# before using this method.
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [String] name
|
2020-08-13 00:39:19 +00:00
|
|
|
# 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](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 hyphens (-). The maximum
|
|
|
|
# length is 100 characters.
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [Google::Apis::CloudtasksV2beta2::Queue] queue_object
|
|
|
|
# @param [String] update_mask
|
2020-08-13 00:39:19 +00:00
|
|
|
# A mask used to specify which fields of the queue are being updated. If empty,
|
|
|
|
# then all fields will be updated.
|
2017-09-14 00:36:39 +00:00
|
|
|
# @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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudtasksV2beta2::Queue] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudtasksV2beta2::Queue]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def patch_project_location_queue(name, queue_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:patch, 'v2beta2/{+name}', options)
|
2017-09-14 00:36:39 +00:00
|
|
|
command.request_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation
|
|
|
|
command.request_object = queue_object
|
|
|
|
command.response_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation
|
|
|
|
command.response_class = Google::Apis::CloudtasksV2beta2::Queue
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
2020-08-13 00:39:19 +00:00
|
|
|
# Pauses the queue. If a queue is paused then the system will stop dispatching
|
|
|
|
# tasks until the queue is resumed via ResumeQueue. Tasks can still be added
|
|
|
|
# when the queue is paused. A queue is paused if its state is PAUSED.
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [String] name
|
2020-08-13 00:39:19 +00:00
|
|
|
# Required. The queue name. For example: `projects/PROJECT_ID/location/
|
|
|
|
# LOCATION_ID/queues/QUEUE_ID`
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [Google::Apis::CloudtasksV2beta2::PauseQueueRequest] pause_queue_request_object
|
|
|
|
# @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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudtasksV2beta2::Queue] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudtasksV2beta2::Queue]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def pause_queue(name, pause_queue_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:post, 'v2beta2/{+name}:pause', options)
|
2017-09-14 00:36:39 +00:00
|
|
|
command.request_representation = Google::Apis::CloudtasksV2beta2::PauseQueueRequest::Representation
|
|
|
|
command.request_object = pause_queue_request_object
|
|
|
|
command.response_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation
|
|
|
|
command.response_class = Google::Apis::CloudtasksV2beta2::Queue
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
2020-08-13 00:39:19 +00:00
|
|
|
# Purges a queue by deleting all of its tasks. All tasks created before this
|
|
|
|
# method is called are permanently deleted. Purge operations can take up to one
|
|
|
|
# minute to take effect. Tasks might be dispatched before the purge takes effect.
|
|
|
|
# A purge is irreversible.
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [String] name
|
2020-08-13 00:39:19 +00:00
|
|
|
# Required. The queue name. For example: `projects/PROJECT_ID/location/
|
|
|
|
# LOCATION_ID/queues/QUEUE_ID`
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [Google::Apis::CloudtasksV2beta2::PurgeQueueRequest] purge_queue_request_object
|
|
|
|
# @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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudtasksV2beta2::Queue] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudtasksV2beta2::Queue]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def purge_queue(name, purge_queue_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:post, 'v2beta2/{+name}:purge', options)
|
2017-09-14 00:36:39 +00:00
|
|
|
command.request_representation = Google::Apis::CloudtasksV2beta2::PurgeQueueRequest::Representation
|
|
|
|
command.request_object = purge_queue_request_object
|
|
|
|
command.response_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation
|
|
|
|
command.response_class = Google::Apis::CloudtasksV2beta2::Queue
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
2020-08-13 00:39:19 +00:00
|
|
|
# Resume a queue. This method resumes a queue after it has been PAUSED or
|
|
|
|
# DISABLED. The state of a queue is stored 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
|
2019-04-25 00:37:02 +00:00
|
|
|
# Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [String] name
|
2020-08-13 00:39:19 +00:00
|
|
|
# Required. The queue name. For example: `projects/PROJECT_ID/location/
|
|
|
|
# LOCATION_ID/queues/QUEUE_ID`
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [Google::Apis::CloudtasksV2beta2::ResumeQueueRequest] resume_queue_request_object
|
|
|
|
# @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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudtasksV2beta2::Queue] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudtasksV2beta2::Queue]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def resume_queue(name, resume_queue_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:post, 'v2beta2/{+name}:resume', options)
|
2017-09-14 00:36:39 +00:00
|
|
|
command.request_representation = Google::Apis::CloudtasksV2beta2::ResumeQueueRequest::Representation
|
|
|
|
command.request_object = resume_queue_request_object
|
|
|
|
command.response_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation
|
|
|
|
command.response_class = Google::Apis::CloudtasksV2beta2::Queue
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
2020-08-13 00:39:19 +00:00
|
|
|
# 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](https://cloud.google.com/iam) permission
|
|
|
|
# on the specified resource parent: * `cloudtasks.queues.setIamPolicy`
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [String] resource
|
2020-08-13 00:39:19 +00:00
|
|
|
# REQUIRED: The resource for which the policy is being specified. See the
|
|
|
|
# operation documentation for the appropriate value for this field.
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [Google::Apis::CloudtasksV2beta2::SetIamPolicyRequest] set_iam_policy_request_object
|
|
|
|
# @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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudtasksV2beta2::Policy] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudtasksV2beta2::Policy]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def set_queue_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:post, 'v2beta2/{+resource}:setIamPolicy', options)
|
2017-09-14 00:36:39 +00:00
|
|
|
command.request_representation = Google::Apis::CloudtasksV2beta2::SetIamPolicyRequest::Representation
|
|
|
|
command.request_object = set_iam_policy_request_object
|
|
|
|
command.response_representation = Google::Apis::CloudtasksV2beta2::Policy::Representation
|
|
|
|
command.response_class = Google::Apis::CloudtasksV2beta2::Policy
|
|
|
|
command.params['resource'] = resource unless resource.nil?
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
2020-08-13 00:39:19 +00:00
|
|
|
# Returns permissions that a caller has on a Queue. If the resource does not
|
|
|
|
# exist, this will return an empty set of permissions, not a NOT_FOUND error.
|
|
|
|
# Note: This operation is designed to be used for building permission-aware UIs
|
|
|
|
# and command-line tools, not for authorization checking. This operation may "
|
|
|
|
# fail open" without warning.
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [String] resource
|
2020-08-13 00:39:19 +00:00
|
|
|
# REQUIRED: The resource for which the policy detail is being requested. See the
|
|
|
|
# operation documentation for the appropriate value for this field.
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [Google::Apis::CloudtasksV2beta2::TestIamPermissionsRequest] test_iam_permissions_request_object
|
|
|
|
# @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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudtasksV2beta2::TestIamPermissionsResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudtasksV2beta2::TestIamPermissionsResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def test_queue_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:post, 'v2beta2/{+resource}:testIamPermissions', options)
|
2017-09-14 00:36:39 +00:00
|
|
|
command.request_representation = Google::Apis::CloudtasksV2beta2::TestIamPermissionsRequest::Representation
|
|
|
|
command.request_object = test_iam_permissions_request_object
|
|
|
|
command.response_representation = Google::Apis::CloudtasksV2beta2::TestIamPermissionsResponse::Representation
|
|
|
|
command.response_class = Google::Apis::CloudtasksV2beta2::TestIamPermissionsResponse
|
|
|
|
command.params['resource'] = resource unless resource.nil?
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
2020-08-13 00:39:19 +00:00
|
|
|
# Acknowledges a pull task. The worker, that is, the entity that leased this
|
|
|
|
# task must call this method to indicate that the work associated with the task
|
|
|
|
# has finished. The worker must acknowledge a task within the lease_duration or
|
|
|
|
# the lease will expire and the task will become available to be leased again.
|
|
|
|
# After the task is acknowledged, it will not be returned by a later LeaseTasks,
|
|
|
|
# GetTask, or ListTasks.
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [String] name
|
2020-08-13 00:39:19 +00:00
|
|
|
# Required. The task name. For example: `projects/PROJECT_ID/locations/
|
|
|
|
# LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [Google::Apis::CloudtasksV2beta2::AcknowledgeTaskRequest] acknowledge_task_request_object
|
|
|
|
# @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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudtasksV2beta2::Empty] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudtasksV2beta2::Empty]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def acknowledge_task(name, acknowledge_task_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:post, 'v2beta2/{+name}:acknowledge', options)
|
2017-09-14 00:36:39 +00:00
|
|
|
command.request_representation = Google::Apis::CloudtasksV2beta2::AcknowledgeTaskRequest::Representation
|
|
|
|
command.request_object = acknowledge_task_request_object
|
|
|
|
command.response_representation = Google::Apis::CloudtasksV2beta2::Empty::Representation
|
|
|
|
command.response_class = Google::Apis::CloudtasksV2beta2::Empty
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
2020-08-13 00:39:19 +00:00
|
|
|
# Cancel a pull task's lease. The worker can use this method to cancel a task's
|
|
|
|
# lease by setting its schedule_time to now. This will make the task available
|
|
|
|
# to be leased to the next caller of LeaseTasks.
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [String] name
|
2020-08-13 00:39:19 +00:00
|
|
|
# Required. The task name. For example: `projects/PROJECT_ID/locations/
|
|
|
|
# LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [Google::Apis::CloudtasksV2beta2::CancelLeaseRequest] cancel_lease_request_object
|
|
|
|
# @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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudtasksV2beta2::Task] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudtasksV2beta2::Task]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def cancel_task_lease(name, cancel_lease_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:post, 'v2beta2/{+name}:cancelLease', options)
|
2017-09-14 00:36:39 +00:00
|
|
|
command.request_representation = Google::Apis::CloudtasksV2beta2::CancelLeaseRequest::Representation
|
|
|
|
command.request_object = cancel_lease_request_object
|
|
|
|
command.response_representation = Google::Apis::CloudtasksV2beta2::Task::Representation
|
|
|
|
command.response_class = Google::Apis::CloudtasksV2beta2::Task
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
2020-08-13 00:39:19 +00:00
|
|
|
# Creates a task and adds it to a queue. Tasks cannot be updated after creation;
|
|
|
|
# there is no UpdateTask command. * For App Engine queues, the maximum task size
|
|
|
|
# is 100KB. * For pull queues, the maximum task size is 1MB.
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [String] parent
|
2020-08-13 00:39:19 +00:00
|
|
|
# Required. The queue name. For example: `projects/PROJECT_ID/locations/
|
|
|
|
# LOCATION_ID/queues/QUEUE_ID` The queue must already exist.
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [Google::Apis::CloudtasksV2beta2::CreateTaskRequest] create_task_request_object
|
|
|
|
# @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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudtasksV2beta2::Task] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudtasksV2beta2::Task]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def create_task(parent, create_task_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:post, 'v2beta2/{+parent}/tasks', options)
|
2017-09-14 00:36:39 +00:00
|
|
|
command.request_representation = Google::Apis::CloudtasksV2beta2::CreateTaskRequest::Representation
|
|
|
|
command.request_object = create_task_request_object
|
|
|
|
command.response_representation = Google::Apis::CloudtasksV2beta2::Task::Representation
|
|
|
|
command.response_class = Google::Apis::CloudtasksV2beta2::Task
|
|
|
|
command.params['parent'] = parent unless parent.nil?
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
2020-08-13 00:39:19 +00:00
|
|
|
# Deletes a task. A task can be deleted if it is scheduled or dispatched. A task
|
|
|
|
# cannot be deleted if it has completed successfully or permanently failed.
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [String] name
|
2020-08-13 00:39:19 +00:00
|
|
|
# Required. The task name. For example: `projects/PROJECT_ID/locations/
|
|
|
|
# LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
|
2017-09-14 00:36:39 +00:00
|
|
|
# @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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudtasksV2beta2::Empty] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudtasksV2beta2::Empty]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def delete_project_location_queue_task(name, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:delete, 'v2beta2/{+name}', options)
|
2017-09-14 00:36:39 +00:00
|
|
|
command.response_representation = Google::Apis::CloudtasksV2beta2::Empty::Representation
|
|
|
|
command.response_class = Google::Apis::CloudtasksV2beta2::Empty
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
|
|
|
# Gets a task.
|
|
|
|
# @param [String] name
|
2020-08-13 00:39:19 +00:00
|
|
|
# Required. The task name. For example: `projects/PROJECT_ID/locations/
|
|
|
|
# LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [String] response_view
|
2020-08-13 00:39:19 +00:00
|
|
|
# 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](https://cloud.google.com/iam/) permission on the Task resource.
|
2017-09-14 00:36:39 +00:00
|
|
|
# @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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudtasksV2beta2::Task] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudtasksV2beta2::Task]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def get_project_location_queue_task(name, response_view: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:get, 'v2beta2/{+name}', options)
|
2017-09-14 00:36:39 +00:00
|
|
|
command.response_representation = Google::Apis::CloudtasksV2beta2::Task::Representation
|
|
|
|
command.response_class = Google::Apis::CloudtasksV2beta2::Task
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
command.query['responseView'] = response_view unless response_view.nil?
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
2020-08-13 00:39:19 +00:00
|
|
|
# Leases tasks from a pull queue for lease_duration. This method is invoked by
|
|
|
|
# the worker to obtain a lease. The worker must acknowledge the task via
|
|
|
|
# AcknowledgeTask after they have performed the work associated with the task.
|
|
|
|
# The payload is intended to store data that the worker needs to perform the
|
|
|
|
# work associated with the task. To return the payloads in the response, set
|
|
|
|
# response_view to FULL. A maximum of 10 qps of LeaseTasks requests are allowed
|
|
|
|
# per queue. RESOURCE_EXHAUSTED is returned when this limit is exceeded.
|
|
|
|
# RESOURCE_EXHAUSTED is also returned when max_tasks_dispatched_per_second is
|
|
|
|
# exceeded.
|
2017-12-16 00:35:40 +00:00
|
|
|
# @param [String] parent
|
2020-08-13 00:39:19 +00:00
|
|
|
# Required. The queue name. For example: `projects/PROJECT_ID/locations/
|
|
|
|
# LOCATION_ID/queues/QUEUE_ID`
|
2017-12-16 00:35:40 +00:00
|
|
|
# @param [Google::Apis::CloudtasksV2beta2::LeaseTasksRequest] lease_tasks_request_object
|
|
|
|
# @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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudtasksV2beta2::LeaseTasksResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudtasksV2beta2::LeaseTasksResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def lease_tasks(parent, lease_tasks_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:post, 'v2beta2/{+parent}/tasks:lease', options)
|
2017-12-16 00:35:40 +00:00
|
|
|
command.request_representation = Google::Apis::CloudtasksV2beta2::LeaseTasksRequest::Representation
|
|
|
|
command.request_object = lease_tasks_request_object
|
|
|
|
command.response_representation = Google::Apis::CloudtasksV2beta2::LeaseTasksResponse::Representation
|
|
|
|
command.response_class = Google::Apis::CloudtasksV2beta2::LeaseTasksResponse
|
|
|
|
command.params['parent'] = parent unless parent.nil?
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
2020-08-13 00:39:19 +00:00
|
|
|
# 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.
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [String] parent
|
2020-08-13 00:39:19 +00:00
|
|
|
# Required. The queue name. For example: `projects/PROJECT_ID/locations/
|
|
|
|
# LOCATION_ID/queues/QUEUE_ID`
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [Fixnum] page_size
|
2020-08-13 00:39:19 +00:00
|
|
|
# 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.
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [String] page_token
|
2020-08-13 00:39:19 +00:00
|
|
|
# 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.
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [String] response_view
|
2020-08-13 00:39:19 +00:00
|
|
|
# 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](https://cloud.google.com/iam/) permission on the Task resource.
|
2017-09-14 00:36:39 +00:00
|
|
|
# @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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudtasksV2beta2::ListTasksResponse] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudtasksV2beta2::ListTasksResponse]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2018-06-23 00:36:32 +00:00
|
|
|
def list_project_location_queue_tasks(parent, page_size: nil, page_token: nil, response_view: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:get, 'v2beta2/{+parent}/tasks', options)
|
2017-09-14 00:36:39 +00:00
|
|
|
command.response_representation = Google::Apis::CloudtasksV2beta2::ListTasksResponse::Representation
|
|
|
|
command.response_class = Google::Apis::CloudtasksV2beta2::ListTasksResponse
|
|
|
|
command.params['parent'] = parent unless parent.nil?
|
|
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
|
|
command.query['responseView'] = response_view unless response_view.nil?
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
2020-08-13 00:39:19 +00:00
|
|
|
# Renew the current lease of a pull task. The worker can use this method to
|
|
|
|
# extend the lease by a new duration, starting from now. The new task lease will
|
|
|
|
# be returned in the task's schedule_time.
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [String] name
|
2020-08-13 00:39:19 +00:00
|
|
|
# Required. The task name. For example: `projects/PROJECT_ID/locations/
|
|
|
|
# LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [Google::Apis::CloudtasksV2beta2::RenewLeaseRequest] renew_lease_request_object
|
|
|
|
# @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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudtasksV2beta2::Task] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudtasksV2beta2::Task]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def renew_task_lease(name, renew_lease_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:post, 'v2beta2/{+name}:renewLease', options)
|
2017-09-14 00:36:39 +00:00
|
|
|
command.request_representation = Google::Apis::CloudtasksV2beta2::RenewLeaseRequest::Representation
|
|
|
|
command.request_object = renew_lease_request_object
|
|
|
|
command.response_representation = Google::Apis::CloudtasksV2beta2::Task::Representation
|
|
|
|
command.response_class = Google::Apis::CloudtasksV2beta2::Task
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
2020-08-13 00:39:19 +00:00
|
|
|
# Forces a task to run now. When this method is called, Cloud Tasks will
|
|
|
|
# dispatch the task, even if the task is already running, the queue has reached
|
|
|
|
# its RateLimits or is PAUSED. This command is meant to be used for manual
|
|
|
|
# debugging. For example, RunTask can be used to retry a failed task after a fix
|
|
|
|
# has been made or to manually force a task to be dispatched now. The dispatched
|
|
|
|
# task is returned. That is, the task that is returned contains the status after
|
|
|
|
# the task is dispatched but before the task is received by its target. If Cloud
|
|
|
|
# Tasks receives a successful response from the task's target, then the task
|
|
|
|
# will be deleted; otherwise the task's schedule_time will be reset to the time
|
|
|
|
# that RunTask was called plus the retry delay specified in the queue's
|
|
|
|
# RetryConfig. RunTask returns NOT_FOUND when it is called on a task that has
|
|
|
|
# already succeeded or permanently failed. RunTask cannot be called on a pull
|
|
|
|
# task.
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [String] name
|
2020-08-13 00:39:19 +00:00
|
|
|
# Required. The task name. For example: `projects/PROJECT_ID/locations/
|
|
|
|
# LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
|
2017-09-14 00:36:39 +00:00
|
|
|
# @param [Google::Apis::CloudtasksV2beta2::RunTaskRequest] run_task_request_object
|
|
|
|
# @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.
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
# Request-specific options
|
|
|
|
#
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
# @yieldparam result [Google::Apis::CloudtasksV2beta2::Task] parsed result object
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
#
|
|
|
|
# @return [Google::Apis::CloudtasksV2beta2::Task]
|
|
|
|
#
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
def run_task(name, run_task_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:post, 'v2beta2/{+name}:run', options)
|
2017-09-14 00:36:39 +00:00
|
|
|
command.request_representation = Google::Apis::CloudtasksV2beta2::RunTaskRequest::Representation
|
|
|
|
command.request_object = run_task_request_object
|
|
|
|
command.response_representation = Google::Apis::CloudtasksV2beta2::Task::Representation
|
|
|
|
command.response_class = Google::Apis::CloudtasksV2beta2::Task
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
end
|
|
|
|
|
|
|
|
protected
|
|
|
|
|
|
|
|
def apply_command_defaults(command)
|
|
|
|
command.query['key'] = key unless key.nil?
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|