diff --git a/.coveragerc b/.coveragerc
index eb43c0f5..1d5bc53f 100644
--- a/.coveragerc
+++ b/.coveragerc
@@ -2,7 +2,6 @@
branch = True
[report]
-fail_under = 100
show_missing = True
omit =
google/cloud/tasks/__init__.py
diff --git a/.github/.OwlBot.lock.yaml b/.github/.OwlBot.lock.yaml
index da616c91..e2b39f94 100644
--- a/.github/.OwlBot.lock.yaml
+++ b/.github/.OwlBot.lock.yaml
@@ -1,3 +1,3 @@
docker:
image: gcr.io/repo-automation-bots/owlbot-python:latest
- digest: sha256:c66ba3c8d7bc8566f47df841f98cd0097b28fff0b1864c86f5817f4c8c3e8600
+ digest: sha256:99d90d097e4a4710cc8658ee0b5b963f4426d0e424819787c3ac1405c9a26719
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
index e903be9f..d1ef556d 100644
--- a/.github/CODEOWNERS
+++ b/.github/CODEOWNERS
@@ -5,7 +5,7 @@
# https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners#codeowners-syntax
# The @googleapis/yoshi-python is the default owner for changes in this repo
-* @googleapis/yoshi-python
+* @averikitsch @googleapis/yoshi-python
-/samples/**/*.py @averikitsch @googleapis/python-samples-owners
\ No newline at end of file
+/samples/**/*.py @averikitsch @googleapis/python-samples-owners
diff --git a/.kokoro/samples/python3.9/common.cfg b/.kokoro/samples/python3.9/common.cfg
new file mode 100644
index 00000000..34c99b09
--- /dev/null
+++ b/.kokoro/samples/python3.9/common.cfg
@@ -0,0 +1,40 @@
+# Format: //devtools/kokoro/config/proto/build.proto
+
+# Build logs will be here
+action {
+ define_artifacts {
+ regex: "**/*sponge_log.xml"
+ }
+}
+
+# Specify which tests to run
+env_vars: {
+ key: "RUN_TESTS_SESSION"
+ value: "py-3.9"
+}
+
+# Declare build specific Cloud project.
+env_vars: {
+ key: "BUILD_SPECIFIC_GCLOUD_PROJECT"
+ value: "python-docs-samples-tests-py39"
+}
+
+env_vars: {
+ key: "TRAMPOLINE_BUILD_FILE"
+ value: "github/python-tasks/.kokoro/test-samples.sh"
+}
+
+# Configure the docker image for kokoro-trampoline.
+env_vars: {
+ key: "TRAMPOLINE_IMAGE"
+ value: "gcr.io/cloud-devrel-kokoro-resources/python-samples-testing-docker"
+}
+
+# Download secrets for samples
+gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/python-docs-samples"
+
+# Download trampoline resources.
+gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline"
+
+# Use the trampoline script to run in docker.
+build_file: "python-tasks/.kokoro/trampoline.sh"
\ No newline at end of file
diff --git a/.kokoro/samples/python3.9/continuous.cfg b/.kokoro/samples/python3.9/continuous.cfg
new file mode 100644
index 00000000..a1c8d975
--- /dev/null
+++ b/.kokoro/samples/python3.9/continuous.cfg
@@ -0,0 +1,6 @@
+# Format: //devtools/kokoro/config/proto/build.proto
+
+env_vars: {
+ key: "INSTALL_LIBRARY_FROM_SOURCE"
+ value: "True"
+}
\ No newline at end of file
diff --git a/.kokoro/samples/python3.9/periodic-head.cfg b/.kokoro/samples/python3.9/periodic-head.cfg
new file mode 100644
index 00000000..f9cfcd33
--- /dev/null
+++ b/.kokoro/samples/python3.9/periodic-head.cfg
@@ -0,0 +1,11 @@
+# Format: //devtools/kokoro/config/proto/build.proto
+
+env_vars: {
+ key: "INSTALL_LIBRARY_FROM_SOURCE"
+ value: "True"
+}
+
+env_vars: {
+ key: "TRAMPOLINE_BUILD_FILE"
+ value: "github/python-pubsub/.kokoro/test-samples-against-head.sh"
+}
diff --git a/.kokoro/samples/python3.9/periodic.cfg b/.kokoro/samples/python3.9/periodic.cfg
new file mode 100644
index 00000000..50fec964
--- /dev/null
+++ b/.kokoro/samples/python3.9/periodic.cfg
@@ -0,0 +1,6 @@
+# Format: //devtools/kokoro/config/proto/build.proto
+
+env_vars: {
+ key: "INSTALL_LIBRARY_FROM_SOURCE"
+ value: "False"
+}
\ No newline at end of file
diff --git a/.kokoro/samples/python3.9/presubmit.cfg b/.kokoro/samples/python3.9/presubmit.cfg
new file mode 100644
index 00000000..a1c8d975
--- /dev/null
+++ b/.kokoro/samples/python3.9/presubmit.cfg
@@ -0,0 +1,6 @@
+# Format: //devtools/kokoro/config/proto/build.proto
+
+env_vars: {
+ key: "INSTALL_LIBRARY_FROM_SOURCE"
+ value: "True"
+}
\ No newline at end of file
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 4f00c7cf..62eb5a77 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -16,7 +16,7 @@
# See https://pre-commit.com/hooks.html for more hooks
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
- rev: v3.4.0
+ rev: v4.0.1
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 799e65a5..a63df6f6 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,24 @@
[1]: https://pypi.org/project/google-cloud-tasks/#history
+## [2.4.0](https://www.github.com/googleapis/python-tasks/compare/v2.3.0...v2.4.0) (2021-07-01)
+
+
+### Features
+
+* add always_use_jwt_access ([#122](https://www.github.com/googleapis/python-tasks/issues/122)) ([87c9ccc](https://www.github.com/googleapis/python-tasks/commit/87c9cccb42237eb421c72411652985a7fbe1c16a))
+
+
+### Bug Fixes
+
+* disable always_use_jwt_access ([#126](https://www.github.com/googleapis/python-tasks/issues/126)) ([54d2286](https://www.github.com/googleapis/python-tasks/commit/54d2286b153c36b7a50b5a936517aa59e10ad27c))
+* update sample for task name ([#120](https://www.github.com/googleapis/python-tasks/issues/120)) ([b1be2de](https://www.github.com/googleapis/python-tasks/commit/b1be2de174fc37d0eb90bbf877851c11ddb14907))
+
+
+### Documentation
+
+* omit mention of Python 2.7 in CONTRIBUTING.rst ([#116](https://www.github.com/googleapis/python-tasks/issues/116)) ([0732ab7](https://www.github.com/googleapis/python-tasks/commit/0732ab7d726fdf564897fad009f8a5da45b5c017)), closes [#1126](https://www.github.com/googleapis/python-tasks/issues/1126)
+
## [2.3.0](https://www.github.com/googleapis/python-tasks/compare/v2.2.0...v2.3.0) (2021-05-28)
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 463ae1ed..8c5a39f5 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -68,15 +68,12 @@ Using ``nox``
We use `nox `__ to instrument our tests.
- To test your changes, run unit tests with ``nox``::
+ $ nox -s unit
- $ nox -s unit-2.7
- $ nox -s unit-3.8
- $ ...
+- To run a single unit test::
-- Args to pytest can be passed through the nox command separated by a `--`. For
- example, to run a single test::
+ $ nox -s unit-3.9 -- -k
- $ nox -s unit-3.8 -- -k
.. note::
@@ -143,8 +140,7 @@ Running System Tests
- To run system tests, you can execute::
# Run all system tests
- $ nox -s system-3.8
- $ nox -s system-2.7
+ $ nox -s system
# Run a single system test
$ nox -s system-3.8 -- -k
@@ -152,9 +148,8 @@ Running System Tests
.. note::
- System tests are only configured to run under Python 2.7 and
- Python 3.8. For expediency, we do not run them in older versions
- of Python 3.
+ System tests are only configured to run under Python 3.8.
+ For expediency, we do not run them in older versions of Python 3.
This alone will not run the tests. You'll need to change some local
auth settings and change some configuration in your project to
@@ -218,8 +213,8 @@ Supported versions can be found in our ``noxfile.py`` `config`_.
.. _config: https://github.com/googleapis/python-tasks/blob/master/noxfile.py
-We also explicitly decided to support Python 3 beginning with version
-3.6. Reasons for this include:
+We also explicitly decided to support Python 3 beginning with version 3.6.
+Reasons for this include:
- Encouraging use of newest versions of Python 3
- Taking the lead of `prominent`_ open-source `projects`_
diff --git a/docs/conf.py b/docs/conf.py
index 04ba95e8..c5edc47b 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -80,9 +80,9 @@
master_doc = "index"
# General information about the project.
-project = u"google-cloud-tasks"
-copyright = u"2019, Google"
-author = u"Google APIs"
+project = "google-cloud-tasks"
+copyright = "2019, Google"
+author = "Google APIs"
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@@ -281,7 +281,7 @@
(
master_doc,
"google-cloud-tasks.tex",
- u"google-cloud-tasks Documentation",
+ "google-cloud-tasks Documentation",
author,
"manual",
)
@@ -313,13 +313,7 @@
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
- (
- master_doc,
- "google-cloud-tasks",
- u"google-cloud-tasks Documentation",
- [author],
- 1,
- )
+ (master_doc, "google-cloud-tasks", "google-cloud-tasks Documentation", [author], 1,)
]
# If true, show URL addresses after external links.
@@ -335,7 +329,7 @@
(
master_doc,
"google-cloud-tasks",
- u"google-cloud-tasks Documentation",
+ "google-cloud-tasks Documentation",
author,
"google-cloud-tasks",
"google-cloud-tasks Library",
diff --git a/google/cloud/tasks_v2/proto/cloudtasks.proto b/google/cloud/tasks_v2/proto/cloudtasks.proto
deleted file mode 100644
index d30aae51..00000000
--- a/google/cloud/tasks_v2/proto/cloudtasks.proto
+++ /dev/null
@@ -1,655 +0,0 @@
-// Copyright 2019 Google LLC.
-//
-// 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.
-//
-
-syntax = "proto3";
-
-package google.cloud.tasks.v2;
-
-import "google/api/annotations.proto";
-import "google/api/client.proto";
-import "google/api/field_behavior.proto";
-import "google/api/resource.proto";
-import "google/cloud/tasks/v2/queue.proto";
-import "google/cloud/tasks/v2/task.proto";
-import "google/iam/v1/iam_policy.proto";
-import "google/iam/v1/policy.proto";
-import "google/protobuf/empty.proto";
-import "google/protobuf/field_mask.proto";
-
-option go_package = "google.golang.org/genproto/googleapis/cloud/tasks/v2;tasks";
-option java_multiple_files = true;
-option java_outer_classname = "CloudTasksProto";
-option java_package = "com.google.cloud.tasks.v2";
-option objc_class_prefix = "TASKS";
-
-// Cloud Tasks allows developers to manage the execution of background
-// work in their applications.
-service CloudTasks {
- option (google.api.default_host) = "cloudtasks.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
-
- // Lists queues.
- //
- // Queues are returned in lexicographical order.
- rpc ListQueues(ListQueuesRequest) returns (ListQueuesResponse) {
- option (google.api.http) = {
- get: "/v2/{parent=projects/*/locations/*}/queues"
- };
- option (google.api.method_signature) = "parent";
- }
-
- // Gets a queue.
- rpc GetQueue(GetQueueRequest) returns (Queue) {
- option (google.api.http) = {
- get: "/v2/{name=projects/*/locations/*/queues/*}"
- };
- option (google.api.method_signature) = "name";
- }
-
- // 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.
- rpc CreateQueue(CreateQueueRequest) returns (Queue) {
- option (google.api.http) = {
- post: "/v2/{parent=projects/*/locations/*}/queues"
- body: "queue"
- };
- option (google.api.method_signature) = "parent,queue";
- }
-
- // 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.
- rpc UpdateQueue(UpdateQueueRequest) returns (Queue) {
- option (google.api.http) = {
- patch: "/v2/{queue.name=projects/*/locations/*/queues/*}"
- body: "queue"
- };
- option (google.api.method_signature) = "queue,update_mask";
- }
-
- // 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
- // 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.
- rpc DeleteQueue(DeleteQueueRequest) returns (google.protobuf.Empty) {
- option (google.api.http) = {
- delete: "/v2/{name=projects/*/locations/*/queues/*}"
- };
- option (google.api.method_signature) = "name";
- }
-
- // 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.
- rpc PurgeQueue(PurgeQueueRequest) returns (Queue) {
- option (google.api.http) = {
- post: "/v2/{name=projects/*/locations/*/queues/*}:purge"
- body: "*"
- };
- option (google.api.method_signature) = "name";
- }
-
- // Pauses the queue.
- //
- // If a queue is paused then the system will stop dispatching tasks
- // until the queue is resumed via
- // [ResumeQueue][google.cloud.tasks.v2.CloudTasks.ResumeQueue]. Tasks can still be added
- // when the queue is paused. A queue is paused if its
- // [state][google.cloud.tasks.v2.Queue.state] is [PAUSED][google.cloud.tasks.v2.Queue.State.PAUSED].
- rpc PauseQueue(PauseQueueRequest) returns (Queue) {
- option (google.api.http) = {
- post: "/v2/{name=projects/*/locations/*/queues/*}:pause"
- body: "*"
- };
- option (google.api.method_signature) = "name";
- }
-
- // Resume a queue.
- //
- // This method resumes a queue after it has been
- // [PAUSED][google.cloud.tasks.v2.Queue.State.PAUSED] or
- // [DISABLED][google.cloud.tasks.v2.Queue.State.DISABLED]. The state of a queue is stored
- // in the queue's [state][google.cloud.tasks.v2.Queue.state]; after calling this method it
- // will be set to [RUNNING][google.cloud.tasks.v2.Queue.State.RUNNING].
- //
- // WARNING: Resuming many high-QPS queues at the same time can
- // lead to target overloading. If you are resuming high-QPS
- // queues, follow the 500/50/5 pattern described in
- // [Managing Cloud Tasks Scaling
- // Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
- rpc ResumeQueue(ResumeQueueRequest) returns (Queue) {
- option (google.api.http) = {
- post: "/v2/{name=projects/*/locations/*/queues/*}:resume"
- body: "*"
- };
- option (google.api.method_signature) = "name";
- }
-
- // Gets the access control policy for a [Queue][google.cloud.tasks.v2.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`
- rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest) returns (google.iam.v1.Policy) {
- option (google.api.http) = {
- post: "/v2/{resource=projects/*/locations/*/queues/*}:getIamPolicy"
- body: "*"
- };
- option (google.api.method_signature) = "resource";
- }
-
- // Sets the access control policy for a [Queue][google.cloud.tasks.v2.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`
- rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest) returns (google.iam.v1.Policy) {
- option (google.api.http) = {
- post: "/v2/{resource=projects/*/locations/*/queues/*}:setIamPolicy"
- body: "*"
- };
- option (google.api.method_signature) = "resource,policy";
- }
-
- // Returns permissions that a caller has on a [Queue][google.cloud.tasks.v2.Queue].
- // If the resource does not exist, this will return an empty set of
- // permissions, not a [NOT_FOUND][google.rpc.Code.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.
- rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest) returns (google.iam.v1.TestIamPermissionsResponse) {
- option (google.api.http) = {
- post: "/v2/{resource=projects/*/locations/*/queues/*}:testIamPermissions"
- body: "*"
- };
- option (google.api.method_signature) = "resource,permissions";
- }
-
- // Lists the tasks in a queue.
- //
- // By default, only the [BASIC][google.cloud.tasks.v2.Task.View.BASIC] view is retrieved
- // due to performance considerations;
- // [response_view][google.cloud.tasks.v2.ListTasksRequest.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.
- rpc ListTasks(ListTasksRequest) returns (ListTasksResponse) {
- option (google.api.http) = {
- get: "/v2/{parent=projects/*/locations/*/queues/*}/tasks"
- };
- option (google.api.method_signature) = "parent";
- }
-
- // Gets a task.
- rpc GetTask(GetTaskRequest) returns (Task) {
- option (google.api.http) = {
- get: "/v2/{name=projects/*/locations/*/queues/*/tasks/*}"
- };
- option (google.api.method_signature) = "name";
- }
-
- // Creates a task and adds it to a queue.
- //
- // Tasks cannot be updated after creation; there is no UpdateTask command.
- //
- // * The maximum task size is 100KB.
- rpc CreateTask(CreateTaskRequest) returns (Task) {
- option (google.api.http) = {
- post: "/v2/{parent=projects/*/locations/*/queues/*}/tasks"
- body: "*"
- };
- option (google.api.method_signature) = "parent,task";
- }
-
- // Deletes a task.
- //
- // A task can be deleted if it is scheduled or dispatched. A task
- // cannot be deleted if it has executed successfully or permanently
- // failed.
- rpc DeleteTask(DeleteTaskRequest) returns (google.protobuf.Empty) {
- option (google.api.http) = {
- delete: "/v2/{name=projects/*/locations/*/queues/*/tasks/*}"
- };
- option (google.api.method_signature) = "name";
- }
-
- // 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][google.cloud.tasks.v2.RateLimits] or
- // is [PAUSED][google.cloud.tasks.v2.Queue.State.PAUSED].
- //
- // This command is meant to be used for manual debugging. For
- // example, [RunTask][google.cloud.tasks.v2.CloudTasks.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][Task.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][google.cloud.tasks.v2.Task.schedule_time] will be reset to the time that
- // [RunTask][google.cloud.tasks.v2.CloudTasks.RunTask] was called plus the retry delay specified
- // in the queue's [RetryConfig][google.cloud.tasks.v2.RetryConfig].
- //
- // [RunTask][google.cloud.tasks.v2.CloudTasks.RunTask] returns
- // [NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a
- // task that has already succeeded or permanently failed.
- rpc RunTask(RunTaskRequest) returns (Task) {
- option (google.api.http) = {
- post: "/v2/{name=projects/*/locations/*/queues/*/tasks/*}:run"
- body: "*"
- };
- option (google.api.method_signature) = "name";
- }
-}
-
-// Request message for [ListQueues][google.cloud.tasks.v2.CloudTasks.ListQueues].
-message ListQueuesRequest {
- // Required. The location name.
- // For example: `projects/PROJECT_ID/locations/LOCATION_ID`
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- child_type: "cloudtasks.googleapis.com/Queue"
- }
- ];
-
- // `filter` can be used to specify a subset of queues. Any [Queue][google.cloud.tasks.v2.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 "state: PAUSED".
- //
- // Note that using filters might cause fewer queues than the
- // requested page_size to be returned.
- string filter = 2;
-
- // 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][google.cloud.tasks.v2.ListQueuesResponse.next_page_token] in the
- // response to determine if more queues exist.
- int32 page_size = 3;
-
- // 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][google.cloud.tasks.v2.ListQueuesResponse.next_page_token] returned
- // from the previous call to [ListQueues][google.cloud.tasks.v2.CloudTasks.ListQueues]
- // method. It is an error to switch the value of the
- // [filter][google.cloud.tasks.v2.ListQueuesRequest.filter] while iterating through pages.
- string page_token = 4;
-}
-
-// Response message for [ListQueues][google.cloud.tasks.v2.CloudTasks.ListQueues].
-message ListQueuesResponse {
- // The list of queues.
- repeated Queue queues = 1;
-
- // A token to retrieve next page of results.
- //
- // To return the next page of results, call
- // [ListQueues][google.cloud.tasks.v2.CloudTasks.ListQueues] with this value as the
- // [page_token][google.cloud.tasks.v2.ListQueuesRequest.page_token].
- //
- // If the next_page_token is empty, there are no more results.
- //
- // The page token is valid for only 2 hours.
- string next_page_token = 2;
-}
-
-// Request message for [GetQueue][google.cloud.tasks.v2.CloudTasks.GetQueue].
-message GetQueueRequest {
- // Required. The resource name of the queue. For example:
- // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "cloudtasks.googleapis.com/Queue"
- }
- ];
-}
-
-// Request message for [CreateQueue][google.cloud.tasks.v2.CloudTasks.CreateQueue].
-message CreateQueueRequest {
- // 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][google.cloud.location.Locations.ListLocations].
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- child_type: "cloudtasks.googleapis.com/Queue"
- }
- ];
-
- // Required. The queue to create.
- //
- // [Queue's name][google.cloud.tasks.v2.Queue.name] cannot be the same as an existing queue.
- Queue queue = 2 [(google.api.field_behavior) = REQUIRED];
-}
-
-// Request message for [UpdateQueue][google.cloud.tasks.v2.CloudTasks.UpdateQueue].
-message UpdateQueueRequest {
- // Required. The queue to create or update.
- //
- // The queue's [name][google.cloud.tasks.v2.Queue.name] must be specified.
- //
- // Output only fields cannot be modified using UpdateQueue.
- // Any value specified for an output only field will be ignored.
- // The queue's [name][google.cloud.tasks.v2.Queue.name] cannot be changed.
- Queue queue = 1 [(google.api.field_behavior) = REQUIRED];
-
- // A mask used to specify which fields of the queue are being updated.
- //
- // If empty, then all fields will be updated.
- google.protobuf.FieldMask update_mask = 2;
-}
-
-// Request message for [DeleteQueue][google.cloud.tasks.v2.CloudTasks.DeleteQueue].
-message DeleteQueueRequest {
- // Required. The queue name. For example:
- // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "cloudtasks.googleapis.com/Queue"
- }
- ];
-}
-
-// Request message for [PurgeQueue][google.cloud.tasks.v2.CloudTasks.PurgeQueue].
-message PurgeQueueRequest {
- // Required. The queue name. For example:
- // `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "cloudtasks.googleapis.com/Queue"
- }
- ];
-}
-
-// Request message for [PauseQueue][google.cloud.tasks.v2.CloudTasks.PauseQueue].
-message PauseQueueRequest {
- // Required. The queue name. For example:
- // `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "cloudtasks.googleapis.com/Queue"
- }
- ];
-}
-
-// Request message for [ResumeQueue][google.cloud.tasks.v2.CloudTasks.ResumeQueue].
-message ResumeQueueRequest {
- // Required. The queue name. For example:
- // `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "cloudtasks.googleapis.com/Queue"
- }
- ];
-}
-
-// Request message for listing tasks using [ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks].
-message ListTasksRequest {
- // Required. The queue name. For example:
- // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- child_type: "cloudtasks.googleapis.com/Task"
- }
- ];
-
- // The response_view specifies which subset of the [Task][google.cloud.tasks.v2.Task] will be
- // returned.
- //
- // By default response_view is [BASIC][google.cloud.tasks.v2.Task.View.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][google.cloud.tasks.v2.Task.View.FULL] requires
- // `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
- // permission on the [Task][google.cloud.tasks.v2.Task] resource.
- Task.View response_view = 2;
-
- // Maximum page size.
- //
- // Fewer tasks than requested might be returned, even if more tasks exist; use
- // [next_page_token][google.cloud.tasks.v2.ListTasksResponse.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.
- int32 page_size = 3;
-
- // 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][google.cloud.tasks.v2.ListTasksResponse.next_page_token] returned
- // from the previous call to [ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks]
- // method.
- //
- // The page token is valid for only 2 hours.
- string page_token = 4;
-}
-
-// Response message for listing tasks using [ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks].
-message ListTasksResponse {
- // The list of tasks.
- repeated Task tasks = 1;
-
- // A token to retrieve next page of results.
- //
- // To return the next page of results, call
- // [ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks] with this value as the
- // [page_token][google.cloud.tasks.v2.ListTasksRequest.page_token].
- //
- // If the next_page_token is empty, there are no more results.
- string next_page_token = 2;
-}
-
-// Request message for getting a task using [GetTask][google.cloud.tasks.v2.CloudTasks.GetTask].
-message GetTaskRequest {
- // Required. The task name. For example:
- // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "cloudtasks.googleapis.com/Task"
- }
- ];
-
- // The response_view specifies which subset of the [Task][google.cloud.tasks.v2.Task] will be
- // returned.
- //
- // By default response_view is [BASIC][google.cloud.tasks.v2.Task.View.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][google.cloud.tasks.v2.Task.View.FULL] requires
- // `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
- // permission on the [Task][google.cloud.tasks.v2.Task] resource.
- Task.View response_view = 2;
-}
-
-// Request message for [CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask].
-message CreateTaskRequest {
- // Required. The queue name. For example:
- // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- //
- // The queue must already exist.
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- child_type: "cloudtasks.googleapis.com/Task"
- }
- ];
-
- // Required. The task to add.
- //
- // Task names have the following format:
- // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
- // The user can optionally specify a task [name][google.cloud.tasks.v2.Task.name]. If a
- // name is not specified then the system will generate a random
- // unique task id, which will be set in the task returned in the
- // [response][google.cloud.tasks.v2.Task.name].
- //
- // If [schedule_time][google.cloud.tasks.v2.Task.schedule_time] is not set or is in the
- // past then Cloud Tasks will set it to the current time.
- //
- // Task De-duplication:
- //
- // Explicitly specifying a task ID enables task de-duplication. If
- // a task's ID is identical to that of an existing task or a task
- // that was deleted or executed recently then the call will fail
- // with [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS].
- // If the task's queue was created using Cloud Tasks, then another task with
- // the same name can't be created for ~1hour after the original task was
- // deleted or executed. If the task's queue was created using queue.yaml or
- // queue.xml, then another task with the same name can't be created
- // for ~9days after the original task was deleted or executed.
- //
- // Because there is an extra lookup cost to identify duplicate task
- // names, these [CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask] calls have significantly
- // increased latency. Using hashed strings for the task id or for
- // the prefix of the task id is recommended. Choosing task ids that
- // are sequential or have sequential prefixes, for example using a
- // timestamp, causes an increase in latency and error rates in all
- // task commands. The infrastructure relies on an approximately
- // uniform distribution of task ids to store and serve tasks
- // efficiently.
- Task task = 2 [(google.api.field_behavior) = REQUIRED];
-
- // The response_view specifies which subset of the [Task][google.cloud.tasks.v2.Task] will be
- // returned.
- //
- // By default response_view is [BASIC][google.cloud.tasks.v2.Task.View.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][google.cloud.tasks.v2.Task.View.FULL] requires
- // `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
- // permission on the [Task][google.cloud.tasks.v2.Task] resource.
- Task.View response_view = 3;
-}
-
-// Request message for deleting a task using
-// [DeleteTask][google.cloud.tasks.v2.CloudTasks.DeleteTask].
-message DeleteTaskRequest {
- // Required. The task name. For example:
- // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "cloudtasks.googleapis.com/Task"
- }
- ];
-}
-
-// Request message for forcing a task to run now using
-// [RunTask][google.cloud.tasks.v2.CloudTasks.RunTask].
-message RunTaskRequest {
- // Required. The task name. For example:
- // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "cloudtasks.googleapis.com/Task"
- }
- ];
-
- // The response_view specifies which subset of the [Task][google.cloud.tasks.v2.Task] will be
- // returned.
- //
- // By default response_view is [BASIC][google.cloud.tasks.v2.Task.View.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][google.cloud.tasks.v2.Task.View.FULL] requires
- // `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
- // permission on the [Task][google.cloud.tasks.v2.Task] resource.
- Task.View response_view = 2;
-}
diff --git a/google/cloud/tasks_v2/proto/queue.proto b/google/cloud/tasks_v2/proto/queue.proto
deleted file mode 100644
index 483a1f61..00000000
--- a/google/cloud/tasks_v2/proto/queue.proto
+++ /dev/null
@@ -1,361 +0,0 @@
-// Copyright 2019 Google LLC.
-//
-// 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.
-//
-
-syntax = "proto3";
-
-package google.cloud.tasks.v2;
-
-import "google/api/resource.proto";
-import "google/cloud/tasks/v2/target.proto";
-import "google/protobuf/duration.proto";
-import "google/protobuf/timestamp.proto";
-import "google/api/annotations.proto";
-
-option go_package = "google.golang.org/genproto/googleapis/cloud/tasks/v2;tasks";
-option java_multiple_files = true;
-option java_outer_classname = "QueueProto";
-option java_package = "com.google.cloud.tasks.v2";
-
-// A queue is a container of related tasks. Queues are configured to manage
-// how those tasks are dispatched. Configurable properties include rate limits,
-// retry options, queue types, and others.
-message Queue {
- option (google.api.resource) = {
- type: "cloudtasks.googleapis.com/Queue"
- pattern: "projects/{project}/locations/{location}/queues/{queue}"
- };
-
- // State of the queue.
- enum State {
- // Unspecified state.
- STATE_UNSPECIFIED = 0;
-
- // The queue is running. Tasks can be dispatched.
- //
- // If the queue was created using Cloud Tasks and the queue has
- // had no activity (method calls or task dispatches) for 30 days,
- // the queue may take a few minutes to re-activate. Some method
- // calls may return [NOT_FOUND][google.rpc.Code.NOT_FOUND] and
- // tasks may not be dispatched for a few minutes until the queue
- // has been re-activated.
- RUNNING = 1;
-
- // Tasks are paused by the user. If the queue is paused then Cloud
- // Tasks will stop delivering tasks from it, but more tasks can
- // still be added to it by the user.
- PAUSED = 2;
-
- // The queue is disabled.
- //
- // A queue becomes `DISABLED` when
- // [queue.yaml](https://cloud.google.com/appengine/docs/python/config/queueref)
- // or
- // [queue.xml](https://cloud.google.com/appengine/docs/standard/java/config/queueref)
- // is uploaded which does not contain the queue. You cannot directly disable
- // a queue.
- //
- // When a queue is disabled, tasks can still be added to a queue
- // but the tasks are not dispatched.
- //
- // To permanently delete this queue and all of its tasks, call
- // [DeleteQueue][google.cloud.tasks.v2.CloudTasks.DeleteQueue].
- DISABLED = 3;
- }
-
- // Caller-specified and required in [CreateQueue][google.cloud.tasks.v2.CloudTasks.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][google.cloud.location.Locations.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.
- string name = 1;
-
- // Overrides for
- // [task-level app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
- // These settings apply only to
- // [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in this queue.
- // [Http tasks][google.cloud.tasks.v2.HttpRequest] are not affected.
- //
- // If set, `app_engine_routing_override` is used for all
- // [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in the queue, no matter what the
- // setting is for the
- // [task-level app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
- AppEngineRouting app_engine_routing_override = 2;
-
- // Rate limits for task dispatches.
- //
- // [rate_limits][google.cloud.tasks.v2.Queue.rate_limits] and [retry_config][google.cloud.tasks.v2.Queue.retry_config] are
- // related because they both control task attempts. However they control task
- // attempts in different ways:
- //
- // * [rate_limits][google.cloud.tasks.v2.Queue.rate_limits] controls the total rate of
- // dispatches from a queue (i.e. all traffic dispatched from the
- // queue, regardless of whether the dispatch is from a first
- // attempt or a retry).
- // * [retry_config][google.cloud.tasks.v2.Queue.retry_config] controls what happens to
- // particular a task after its first attempt fails. That is,
- // [retry_config][google.cloud.tasks.v2.Queue.retry_config] controls task retries (the
- // second attempt, third attempt, etc).
- //
- // The queue's actual dispatch rate is the result of:
- //
- // * Number of tasks in the queue
- // * User-specified throttling: [rate_limits][google.cloud.tasks.v2.Queue.rate_limits],
- // [retry_config][google.cloud.tasks.v2.Queue.retry_config], and the
- // [queue's state][google.cloud.tasks.v2.Queue.state].
- // * System throttling due to `429` (Too Many Requests) or `503` (Service
- // Unavailable) responses from the worker, high error rates, or to smooth
- // sudden large traffic spikes.
- RateLimits rate_limits = 3;
-
- // Settings that determine the retry behavior.
- //
- // * For tasks created using Cloud Tasks: the queue-level retry settings
- // apply to all tasks in the queue that were created using Cloud Tasks.
- // Retry settings cannot be set on individual tasks.
- // * For tasks created using the App Engine SDK: the queue-level retry
- // settings apply to all tasks in the queue which do not have retry settings
- // explicitly set on the task and were created by the App Engine SDK. See
- // [App Engine
- // documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
- RetryConfig retry_config = 4;
-
- // Output only. The state of the queue.
- //
- // `state` can only be changed by called
- // [PauseQueue][google.cloud.tasks.v2.CloudTasks.PauseQueue],
- // [ResumeQueue][google.cloud.tasks.v2.CloudTasks.ResumeQueue], or uploading
- // [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
- // [UpdateQueue][google.cloud.tasks.v2.CloudTasks.UpdateQueue] cannot be used to change `state`.
- State state = 5;
-
- // Output only. The last time this queue was purged.
- //
- // All tasks that were [created][google.cloud.tasks.v2.Task.create_time] before this time
- // were purged.
- //
- // A queue can be purged using [PurgeQueue][google.cloud.tasks.v2.CloudTasks.PurgeQueue], the
- // [App Engine Task Queue SDK, or the Cloud
- // Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
- //
- // Purge time will be truncated to the nearest microsecond. Purge
- // time will be unset if the queue has never been purged.
- google.protobuf.Timestamp purge_time = 6;
-
- // Configuration options for writing logs to
- // [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
- // field is unset, then no logs are written.
- StackdriverLoggingConfig stackdriver_logging_config = 9;
-}
-
-// Rate limits.
-//
-// This message determines the maximum rate that tasks can be dispatched by a
-// queue, regardless of whether the dispatch is a first task attempt or a retry.
-//
-// Note: The debugging command, [RunTask][google.cloud.tasks.v2.CloudTasks.RunTask], will run a task
-// even if the queue has reached its [RateLimits][google.cloud.tasks.v2.RateLimits].
-message RateLimits {
- // The maximum rate at which tasks are dispatched from this queue.
- //
- // If unspecified when the queue is created, Cloud Tasks will pick the
- // default.
- //
- // * The maximum allowed value is 500.
- //
- //
- // This field has the same meaning as
- // [rate in
- // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
- double max_dispatches_per_second = 1;
-
- // Output only. The max burst size.
- //
- // Max burst size limits how fast tasks in queue are processed when
- // many tasks are in the queue and the rate is high. This field
- // allows the queue to have a high rate so processing starts shortly
- // after a task is enqueued, but still limits resource usage when
- // many tasks are enqueued in a short period of time.
- //
- // The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
- // algorithm is used to control the rate of task dispatches. Each
- // queue has a token bucket that holds tokens, up to the maximum
- // specified by `max_burst_size`. Each time a task is dispatched, a
- // token is removed from the bucket. Tasks will be dispatched until
- // the queue's bucket runs out of tokens. The bucket will be
- // continuously refilled with new tokens based on
- // [max_dispatches_per_second][google.cloud.tasks.v2.RateLimits.max_dispatches_per_second].
- //
- // Cloud Tasks will pick the value of `max_burst_size` based on the
- // value of
- // [max_dispatches_per_second][google.cloud.tasks.v2.RateLimits.max_dispatches_per_second].
- //
- // For queues that were created or updated using
- // `queue.yaml/xml`, `max_burst_size` is equal to
- // [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
- // Since `max_burst_size` is output only, if
- // [UpdateQueue][google.cloud.tasks.v2.CloudTasks.UpdateQueue] is called on a queue
- // created by `queue.yaml/xml`, `max_burst_size` will be reset based
- // on the value of
- // [max_dispatches_per_second][google.cloud.tasks.v2.RateLimits.max_dispatches_per_second],
- // regardless of whether
- // [max_dispatches_per_second][google.cloud.tasks.v2.RateLimits.max_dispatches_per_second]
- // is updated.
- //
- int32 max_burst_size = 2;
-
- // The maximum number of concurrent tasks that Cloud Tasks allows
- // to be dispatched for this queue. After this threshold has been
- // reached, Cloud Tasks stops dispatching tasks until the number of
- // concurrent requests decreases.
- //
- // If unspecified when the queue is created, Cloud Tasks will pick the
- // default.
- //
- //
- // The maximum allowed value is 5,000.
- //
- //
- // This field has the same meaning as
- // [max_concurrent_requests in
- // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
- int32 max_concurrent_dispatches = 3;
-}
-
-// Retry config.
-//
-// These settings determine when a failed task attempt is retried.
-message RetryConfig {
- // Number of attempts per task.
- //
- // Cloud Tasks will attempt the task `max_attempts` times (that is, if the
- // first attempt fails, then there will be `max_attempts - 1` retries). Must
- // be >= -1.
- //
- // If unspecified when the queue is created, Cloud Tasks will pick the
- // default.
- //
- // -1 indicates unlimited attempts.
- //
- // This field has the same meaning as
- // [task_retry_limit in
- // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- int32 max_attempts = 1;
-
- // If positive, `max_retry_duration` specifies the time limit for
- // retrying a failed task, measured from when the task was first
- // attempted. Once `max_retry_duration` time has passed *and* the
- // task has been attempted [max_attempts][google.cloud.tasks.v2.RetryConfig.max_attempts]
- // times, no further attempts will be made and the task will be
- // deleted.
- //
- // If zero, then the task age is unlimited.
- //
- // If unspecified when the queue is created, Cloud Tasks will pick the
- // default.
- //
- //
- // `max_retry_duration` will be truncated to the nearest second.
- //
- // This field has the same meaning as
- // [task_age_limit in
- // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- google.protobuf.Duration max_retry_duration = 2;
-
- // A task will be [scheduled][google.cloud.tasks.v2.Task.schedule_time] for retry between
- // [min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff] and
- // [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] duration after it fails,
- // if the queue's [RetryConfig][google.cloud.tasks.v2.RetryConfig] specifies that the task should be
- // retried.
- //
- // If unspecified when the queue is created, Cloud Tasks will pick the
- // default.
- //
- //
- // `min_backoff` will be truncated to the nearest second.
- //
- // This field has the same meaning as
- // [min_backoff_seconds in
- // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- google.protobuf.Duration min_backoff = 3;
-
- // A task will be [scheduled][google.cloud.tasks.v2.Task.schedule_time] for retry between
- // [min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff] and
- // [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] duration after it fails,
- // if the queue's [RetryConfig][google.cloud.tasks.v2.RetryConfig] specifies that the task should be
- // retried.
- //
- // If unspecified when the queue is created, Cloud Tasks will pick the
- // default.
- //
- //
- // `max_backoff` will be truncated to the nearest second.
- //
- // This field has the same meaning as
- // [max_backoff_seconds in
- // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- google.protobuf.Duration max_backoff = 4;
-
- // The time between retries will double `max_doublings` times.
- //
- // A task's retry interval starts at
- // [min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff], then doubles
- // `max_doublings` times, then increases linearly, and finally
- // retries retries at intervals of
- // [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] up to
- // [max_attempts][google.cloud.tasks.v2.RetryConfig.max_attempts] times.
- //
- // For example, if [min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff] is 10s,
- // [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] is 300s, and
- // `max_doublings` is 3, then the a task will first be retried in
- // 10s. The retry interval will double three times, and then
- // increase linearly by 2^3 * 10s. Finally, the task will retry at
- // intervals of [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] until the
- // task has been attempted [max_attempts][google.cloud.tasks.v2.RetryConfig.max_attempts]
- // times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s,
- // 240s, 300s, 300s, ....
- //
- // If unspecified when the queue is created, Cloud Tasks will pick the
- // default.
- //
- //
- // This field has the same meaning as
- // [max_doublings in
- // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- int32 max_doublings = 5;
-}
-
-// Configuration options for writing logs to
-// [Stackdriver Logging](https://cloud.google.com/logging/docs/).
-message StackdriverLoggingConfig {
- // Specifies the fraction of operations to write to
- // [Stackdriver Logging](https://cloud.google.com/logging/docs/).
- // This field may contain any value between 0.0 and 1.0, inclusive.
- // 0.0 is the default and means that no operations are logged.
- double sampling_ratio = 1;
-}
diff --git a/google/cloud/tasks_v2/proto/target.proto b/google/cloud/tasks_v2/proto/target.proto
deleted file mode 100644
index 558ca4af..00000000
--- a/google/cloud/tasks_v2/proto/target.proto
+++ /dev/null
@@ -1,424 +0,0 @@
-// Copyright 2019 Google LLC.
-//
-// 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.
-//
-
-syntax = "proto3";
-
-package google.cloud.tasks.v2;
-
-import "google/api/field_behavior.proto";
-import "google/api/annotations.proto";
-
-option go_package = "google.golang.org/genproto/googleapis/cloud/tasks/v2;tasks";
-option java_multiple_files = true;
-option java_outer_classname = "TargetProto";
-option java_package = "com.google.cloud.tasks.v2";
-
-// HTTP request.
-//
-// The task will be pushed to the worker as an HTTP request. If the worker
-// or the redirected worker acknowledges the task by returning a successful HTTP
-// response code ([`200` - `299`]), the task will be removed from the queue. If
-// any other HTTP response code is returned or no response is received, the
-// task will be retried according to the following:
-//
-// * User-specified throttling: [retry configuration][google.cloud.tasks.v2.Queue.retry_config],
-// [rate limits][google.cloud.tasks.v2.Queue.rate_limits], and the [queue's state][google.cloud.tasks.v2.Queue.state].
-//
-// * System throttling: To prevent the worker from overloading, Cloud Tasks may
-// temporarily reduce the queue's effective rate. User-specified settings
-// will not be changed.
-//
-// System throttling happens because:
-//
-// * Cloud Tasks backs off on all errors. Normally the backoff specified in
-// [rate limits][google.cloud.tasks.v2.Queue.rate_limits] will be used. But if the worker returns
-// `429` (Too Many Requests), `503` (Service Unavailable), or the rate of
-// errors is high, Cloud Tasks will use a higher backoff rate. The retry
-// specified in the `Retry-After` HTTP response header is considered.
-//
-// * To prevent traffic spikes and to smooth sudden increases in traffic,
-// dispatches ramp up slowly when the queue is newly created or idle and
-// if large numbers of tasks suddenly become available to dispatch (due to
-// spikes in create task rates, the queue being unpaused, or many tasks
-// that are scheduled at the same time).
-message HttpRequest {
- // Required. The full url path that the request will be sent to.
- //
- // This string must begin with either "http://" or "https://". Some examples
- // are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will
- // encode some characters for safety and compatibility. The maximum allowed
- // URL length is 2083 characters after encoding.
- //
- // The `Location` header response from a redirect response [`300` - `399`]
- // may be followed. The redirect is not counted as a separate attempt.
- string url = 1 [(google.api.field_behavior) = REQUIRED];
-
- // The HTTP method to use for the request. The default is POST.
- HttpMethod http_method = 2;
-
- // HTTP request headers.
- //
- // This map contains the header field names and values.
- // Headers can be set when the
- // [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
- //
- // These headers represent a subset of the headers that will accompany the
- // task's HTTP request. Some HTTP request headers will be ignored or replaced.
- //
- // A partial list of headers that will be ignored or replaced is:
- //
- // * Host: This will be computed by Cloud Tasks and derived from
- // [HttpRequest.url][google.cloud.tasks.v2.HttpRequest.url].
- // * Content-Length: This will be computed by Cloud Tasks.
- // * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
- // * X-Google-*: Google use only.
- // * X-AppEngine-*: Google use only.
- //
- // `Content-Type` won't be set by Cloud Tasks. You can explicitly set
- // `Content-Type` to a media type when the
- // [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
- // For example, `Content-Type` can be set to `"application/octet-stream"` or
- // `"application/json"`.
- //
- // Headers which can have multiple values (according to RFC2616) can be
- // specified using comma-separated values.
- //
- // The size of the headers must be less than 80KB.
- map headers = 3;
-
- // HTTP request body.
- //
- // A request body is allowed only if the
- // [HTTP method][google.cloud.tasks.v2.HttpRequest.http_method] is POST, PUT, or PATCH. It is an
- // error to set body on a task with an incompatible [HttpMethod][google.cloud.tasks.v2.HttpMethod].
- bytes body = 4;
-
- // The mode for generating an `Authorization` header for HTTP requests.
- //
- // If specified, all `Authorization` headers in the [HttpRequest.headers][google.cloud.tasks.v2.HttpRequest.headers]
- // field will be overridden.
- oneof authorization_header {
- // If specified, an
- // [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
- // will be generated and attached as an `Authorization` header in the HTTP
- // request.
- //
- // This type of authorization should generally only be used when calling
- // Google APIs hosted on *.googleapis.com.
- OAuthToken oauth_token = 5;
-
- // If specified, an
- // [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
- // token will be generated and attached as an `Authorization` header in the
- // HTTP request.
- //
- // This type of authorization can be used for many scenarios, including
- // calling Cloud Run, or endpoints where you intend to validate the token
- // yourself.
- OidcToken oidc_token = 6;
- }
-}
-
-// App Engine HTTP request.
-//
-// The message defines the HTTP request that is sent to an App Engine app when
-// the task is dispatched.
-//
-// Using [AppEngineHttpRequest][google.cloud.tasks.v2.AppEngineHttpRequest] requires
-// [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
-// Google IAM permission for the project
-// and the following scope:
-//
-// `https://www.googleapis.com/auth/cloud-platform`
-//
-// The task will be delivered to the App Engine app which belongs to the same
-// project as the queue. For more information, see
-// [How Requests are
-// Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
-// and how routing is affected by
-// [dispatch
-// files](https://cloud.google.com/appengine/docs/python/config/dispatchref).
-// Traffic is encrypted during transport and never leaves Google datacenters.
-// Because this traffic is carried over a communication mechanism internal to
-// Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS).
-// The request to the handler, however, will appear to have used the HTTP
-// protocol.
-//
-// The [AppEngineRouting][google.cloud.tasks.v2.AppEngineRouting] used to construct the URL that the task is
-// delivered to can be set at the queue-level or task-level:
-//
-// * If [app_engine_routing_override is set on the
-// queue][Queue.app_engine_routing_override], this value is used for all
-// tasks in the queue, no matter what the setting is for the [task-level
-// app_engine_routing][AppEngineHttpRequest.app_engine_routing].
-//
-//
-// The `url` that the task will be sent to is:
-//
-// * `url =` [host][google.cloud.tasks.v2.AppEngineRouting.host] `+`
-// [relative_uri][google.cloud.tasks.v2.AppEngineHttpRequest.relative_uri]
-//
-// Tasks can be dispatched to secure app handlers, unsecure app handlers, and
-// URIs restricted with
-// [`login:
-// admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref).
-// Because tasks are not run as any user, they cannot be dispatched to URIs
-// restricted with
-// [`login:
-// required`](https://cloud.google.com/appengine/docs/standard/python/config/appref)
-// Task dispatches also do not follow redirects.
-//
-// The task attempt has succeeded if the app's request handler returns an HTTP
-// response code in the range [`200` - `299`]. The task attempt has failed if
-// the app's handler returns a non-2xx response code or Cloud Tasks does
-// not receive response before the [deadline][google.cloud.tasks.v2.Task.dispatch_deadline]. Failed
-// tasks will be retried according to the
-// [retry configuration][google.cloud.tasks.v2.Queue.retry_config]. `503` (Service Unavailable) is
-// considered an App Engine system error instead of an application error and
-// will cause Cloud Tasks' traffic congestion control to temporarily throttle
-// the queue's dispatches. Unlike other types of task targets, a `429` (Too Many
-// Requests) response from an app handler does not cause traffic congestion
-// control to throttle the queue.
-message AppEngineHttpRequest {
- // The HTTP method to use for the request. The default is POST.
- //
- // The app's request handler for the task's target URL must be able to handle
- // HTTP requests with this http_method, otherwise the task attempt will fail
- // with error code 405 (Method Not Allowed). See
- // [Writing a push task request
- // handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
- // and the documentation for the request handlers in the language your app is
- // written in e.g.
- // [Python Request
- // Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass).
- HttpMethod http_method = 1;
-
- // Task-level setting for App Engine routing.
- //
- // * If [app_engine_routing_override is set on the
- // queue][Queue.app_engine_routing_override], this value is used for all
- // tasks in the queue, no matter what the setting is for the [task-level
- // app_engine_routing][AppEngineHttpRequest.app_engine_routing].
- AppEngineRouting app_engine_routing = 2;
-
- // The relative URI.
- //
- // The relative URI must begin with "/" and must be a valid HTTP relative URI.
- // It can contain a path and query string arguments.
- // If the relative URI is empty, then the root path "/" will be used.
- // No spaces are allowed, and the maximum length allowed is 2083 characters.
- string relative_uri = 3;
-
- // HTTP request headers.
- //
- // This map contains the header field names and values.
- // Headers can be set when the
- // [task is created][google.cloud.tasks.v2.CloudTasks.CreateTask].
- // Repeated headers are not supported but a header value can contain commas.
- //
- // Cloud Tasks sets some headers to default values:
- //
- // * `User-Agent`: By default, this header is
- // `"AppEngine-Google; (+http://code.google.com/appengine)"`.
- // This header can be modified, but Cloud Tasks will append
- // `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
- // modified `User-Agent`.
- //
- // If the task has a [body][google.cloud.tasks.v2.AppEngineHttpRequest.body], Cloud
- // Tasks sets the following headers:
- //
- // * `Content-Type`: By default, the `Content-Type` header is set to
- // `"application/octet-stream"`. The default can be overridden by explicitly
- // setting `Content-Type` to a particular media type when the
- // [task is created][google.cloud.tasks.v2.CloudTasks.CreateTask].
- // For example, `Content-Type` can be set to `"application/json"`.
- // * `Content-Length`: This is computed by Cloud Tasks. This value is
- // output only. It cannot be changed.
- //
- // The headers below cannot be set or overridden:
- //
- // * `Host`
- // * `X-Google-*`
- // * `X-AppEngine-*`
- //
- // In addition, Cloud Tasks sets some headers when the task is dispatched,
- // such as headers containing information about the task; see
- // [request
- // headers](https://cloud.google.com/tasks/docs/creating-appengine-handlers#reading_request_headers).
- // These headers are set only when the task is dispatched, so they are not
- // visible when the task is returned in a Cloud Tasks response.
- //
- // Although there is no specific limit for the maximum number of headers or
- // the size, there is a limit on the maximum size of the [Task][google.cloud.tasks.v2.Task]. For more
- // information, see the [CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask] documentation.
- map headers = 4;
-
- // HTTP request body.
- //
- // A request body is allowed only if the HTTP method is POST or PUT. It is
- // an error to set a body on a task with an incompatible [HttpMethod][google.cloud.tasks.v2.HttpMethod].
- bytes body = 5;
-}
-
-// App Engine Routing.
-//
-// Defines routing characteristics specific to App Engine - service, version,
-// and instance.
-//
-// For more information about services, versions, and instances see
-// [An Overview of App
-// Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
-// [Microservices Architecture on Google App
-// Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
-// [App Engine Standard request
-// routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
-// and [App Engine Flex request
-// routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
-//
-// Using [AppEngineRouting][google.cloud.tasks.v2.AppEngineRouting] requires
-// [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
-// Google IAM permission for the project
-// and the following scope:
-//
-// `https://www.googleapis.com/auth/cloud-platform`
-message AppEngineRouting {
- // App service.
- //
- // By default, the task is sent to the service which is the default
- // service when the task is attempted.
- //
- // For some queues or tasks which were created using the App Engine
- // Task Queue API, [host][google.cloud.tasks.v2.AppEngineRouting.host] is not parsable
- // into [service][google.cloud.tasks.v2.AppEngineRouting.service],
- // [version][google.cloud.tasks.v2.AppEngineRouting.version], and
- // [instance][google.cloud.tasks.v2.AppEngineRouting.instance]. For example, some tasks
- // which were created using the App Engine SDK use a custom domain
- // name; custom domains are not parsed by Cloud Tasks. If
- // [host][google.cloud.tasks.v2.AppEngineRouting.host] is not parsable, then
- // [service][google.cloud.tasks.v2.AppEngineRouting.service],
- // [version][google.cloud.tasks.v2.AppEngineRouting.version], and
- // [instance][google.cloud.tasks.v2.AppEngineRouting.instance] are the empty string.
- string service = 1;
-
- // App version.
- //
- // By default, the task is sent to the version which is the default
- // version when the task is attempted.
- //
- // For some queues or tasks which were created using the App Engine
- // Task Queue API, [host][google.cloud.tasks.v2.AppEngineRouting.host] is not parsable
- // into [service][google.cloud.tasks.v2.AppEngineRouting.service],
- // [version][google.cloud.tasks.v2.AppEngineRouting.version], and
- // [instance][google.cloud.tasks.v2.AppEngineRouting.instance]. For example, some tasks
- // which were created using the App Engine SDK use a custom domain
- // name; custom domains are not parsed by Cloud Tasks. If
- // [host][google.cloud.tasks.v2.AppEngineRouting.host] is not parsable, then
- // [service][google.cloud.tasks.v2.AppEngineRouting.service],
- // [version][google.cloud.tasks.v2.AppEngineRouting.version], and
- // [instance][google.cloud.tasks.v2.AppEngineRouting.instance] are the empty string.
- string version = 2;
-
- // App instance.
- //
- // By default, the task is sent to an instance which is available when
- // the task is attempted.
- //
- // Requests can only be sent to a specific instance if
- // [manual scaling is used in App Engine
- // Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
- // App Engine Flex does not support instances. For more information, see
- // [App Engine Standard request
- // routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
- // and [App Engine Flex request
- // routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- string instance = 3;
-
- // Output only. The host that the task is sent to.
- //
- // The host is constructed from the domain name of the app associated with
- // the queue's project ID (for example .appspot.com), and the
- // [service][google.cloud.tasks.v2.AppEngineRouting.service], [version][google.cloud.tasks.v2.AppEngineRouting.version],
- // and [instance][google.cloud.tasks.v2.AppEngineRouting.instance]. Tasks which were created using
- // the App Engine SDK might have a custom domain name.
- //
- // For more information, see
- // [How Requests are
- // Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
- string host = 4;
-}
-
-// The HTTP method used to deliver the task.
-enum HttpMethod {
- // HTTP method unspecified
- HTTP_METHOD_UNSPECIFIED = 0;
-
- // HTTP POST
- POST = 1;
-
- // HTTP GET
- GET = 2;
-
- // HTTP HEAD
- HEAD = 3;
-
- // HTTP PUT
- PUT = 4;
-
- // HTTP DELETE
- DELETE = 5;
-
- // HTTP PATCH
- PATCH = 6;
-
- // HTTP OPTIONS
- OPTIONS = 7;
-}
-
-// Contains information needed for generating an
-// [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
-// This type of authorization should generally only be used when calling Google
-// APIs hosted on *.googleapis.com.
-message OAuthToken {
- // [Service account email](https://cloud.google.com/iam/docs/service-accounts)
- // to be used for generating OAuth token.
- // The service account must be within the same project as the queue. The
- // caller must have iam.serviceAccounts.actAs permission for the service
- // account.
- string service_account_email = 1;
-
- // OAuth scope to be used for generating OAuth access token.
- // If not specified, "https://www.googleapis.com/auth/cloud-platform"
- // will be used.
- string scope = 2;
-}
-
-// Contains information needed for generating an
-// [OpenID Connect
-// token](https://developers.google.com/identity/protocols/OpenIDConnect).
-// This type of authorization can be used for many scenarios, including
-// calling Cloud Run, or endpoints where you intend to validate the token
-// yourself.
-message OidcToken {
- // [Service account email](https://cloud.google.com/iam/docs/service-accounts)
- // to be used for generating OIDC token.
- // The service account must be within the same project as the queue. The
- // caller must have iam.serviceAccounts.actAs permission for the service
- // account.
- string service_account_email = 1;
-
- // Audience to be used when generating OIDC token. If not specified, the URI
- // specified in target will be used.
- string audience = 2;
-}
diff --git a/google/cloud/tasks_v2/proto/task.proto b/google/cloud/tasks_v2/proto/task.proto
deleted file mode 100644
index 70a2baba..00000000
--- a/google/cloud/tasks_v2/proto/task.proto
+++ /dev/null
@@ -1,191 +0,0 @@
-// Copyright 2019 Google LLC.
-//
-// 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.
-//
-
-syntax = "proto3";
-
-package google.cloud.tasks.v2;
-
-import "google/api/resource.proto";
-import "google/cloud/tasks/v2/target.proto";
-import "google/protobuf/duration.proto";
-import "google/protobuf/timestamp.proto";
-import "google/rpc/status.proto";
-import "google/api/annotations.proto";
-
-option go_package = "google.golang.org/genproto/googleapis/cloud/tasks/v2;tasks";
-option java_multiple_files = true;
-option java_outer_classname = "TaskProto";
-option java_package = "com.google.cloud.tasks.v2";
-
-// A unit of scheduled work.
-message Task {
- option (google.api.resource) = {
- type: "cloudtasks.googleapis.com/Task"
- pattern: "projects/{project}/locations/{location}/queues/{queue}/tasks/{task}"
- };
-
- // The view specifies a subset of [Task][google.cloud.tasks.v2.Task] data.
- //
- // When a task is returned in a response, 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.
- enum View {
- // Unspecified. Defaults to BASIC.
- VIEW_UNSPECIFIED = 0;
-
- // The basic view omits fields which can be large or can contain
- // sensitive data.
- //
- // This view does not include the
- // [body in AppEngineHttpRequest][google.cloud.tasks.v2.AppEngineHttpRequest.body].
- // Bodies are desirable to return only when needed, because they
- // can be large and because of the sensitivity of the data that you
- // choose to store in it.
- BASIC = 1;
-
- // All information is returned.
- //
- // Authorization for [FULL][google.cloud.tasks.v2.Task.View.FULL] requires
- // `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
- // permission on the [Queue][google.cloud.tasks.v2.Queue] resource.
- FULL = 2;
- }
-
- // Optionally caller-specified in [CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask].
- //
- // The task name.
- //
- // The task name must have the following format:
- // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_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 task's location.
- // The list of available locations can be obtained by calling
- // [ListLocations][google.cloud.location.Locations.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.
- // * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
- // hyphens (-), or underscores (_). The maximum length is 500 characters.
- string name = 1;
-
- // Required. The message to send to the worker.
- oneof message_type {
- // HTTP request that is sent to the App Engine app handler.
- //
- // An App Engine task is a task that has [AppEngineHttpRequest][google.cloud.tasks.v2.AppEngineHttpRequest] set.
- AppEngineHttpRequest app_engine_http_request = 2;
-
- // HTTP request that is sent to the worker.
- //
- // An HTTP task is a task that has [HttpRequest][google.cloud.tasks.v2.HttpRequest] set.
- HttpRequest http_request = 3;
- }
-
- // The time when the task is scheduled to be attempted or retried.
- //
- // `schedule_time` will be truncated to the nearest microsecond.
- google.protobuf.Timestamp schedule_time = 4;
-
- // Output only. The time that the task was created.
- //
- // `create_time` will be truncated to the nearest second.
- google.protobuf.Timestamp create_time = 5;
-
- // The deadline for requests sent to the worker. If the worker does not
- // respond by this deadline then the request is cancelled and the attempt
- // is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the
- // task according to the [RetryConfig][google.cloud.tasks.v2.RetryConfig].
- //
- // Note that when the request is cancelled, Cloud Tasks will stop listing for
- // the response, but whether the worker stops processing depends on the
- // worker. For example, if the worker is stuck, it may not react to cancelled
- // requests.
- //
- // The default and maximum values depend on the type of request:
- //
- // * For [HTTP tasks][google.cloud.tasks.v2.HttpRequest], the default is 10 minutes. The deadline
- // must be in the interval [15 seconds, 30 minutes].
- //
- // * For [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest], 0 indicates that the
- // request has the default deadline. The default deadline depends on the
- // [scaling
- // type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)
- // of the service: 10 minutes for standard apps with automatic scaling, 24
- // hours for standard apps with manual and basic scaling, and 60 minutes for
- // flex apps. If the request deadline is set, it must be in the interval [15
- // seconds, 24 hours 15 seconds]. Regardless of the task's
- // `dispatch_deadline`, the app handler will not run for longer than than
- // the service's timeout. We recommend setting the `dispatch_deadline` to
- // at most a few seconds more than the app handler's timeout. For more
- // information see
- // [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).
- //
- // `dispatch_deadline` will be truncated to the nearest millisecond. The
- // deadline is an approximate deadline.
- google.protobuf.Duration dispatch_deadline = 6;
-
- // Output only. The number of attempts dispatched.
- //
- // This count includes attempts which have been dispatched but haven't
- // received a response.
- int32 dispatch_count = 7;
-
- // Output only. The number of attempts which have received a response.
- int32 response_count = 8;
-
- // Output only. The status of the task's first attempt.
- //
- // Only [dispatch_time][google.cloud.tasks.v2.Attempt.dispatch_time] will be set.
- // The other [Attempt][google.cloud.tasks.v2.Attempt] information is not retained by Cloud Tasks.
- Attempt first_attempt = 9;
-
- // Output only. The status of the task's last attempt.
- Attempt last_attempt = 10;
-
- // Output only. The view specifies which subset of the [Task][google.cloud.tasks.v2.Task] has
- // been returned.
- View view = 11;
-}
-
-// The status of a task attempt.
-message Attempt {
- // Output only. The time that this attempt was scheduled.
- //
- // `schedule_time` will be truncated to the nearest microsecond.
- google.protobuf.Timestamp schedule_time = 1;
-
- // Output only. The time that this attempt was dispatched.
- //
- // `dispatch_time` will be truncated to the nearest microsecond.
- google.protobuf.Timestamp dispatch_time = 2;
-
- // Output only. The time that this attempt response was received.
- //
- // `response_time` will be truncated to the nearest microsecond.
- google.protobuf.Timestamp response_time = 3;
-
- // Output only. The response from the worker for this attempt.
- //
- // If `response_time` is unset, then the task has not been attempted or is
- // currently running and the `response_status` field is meaningless.
- google.rpc.Status response_status = 4;
-}
diff --git a/google/cloud/tasks_v2/services/cloud_tasks/transports/base.py b/google/cloud/tasks_v2/services/cloud_tasks/transports/base.py
index 402cb230..f79aae7f 100644
--- a/google/cloud/tasks_v2/services/cloud_tasks/transports/base.py
+++ b/google/cloud/tasks_v2/services/cloud_tasks/transports/base.py
@@ -24,6 +24,7 @@
from google.api_core import gapic_v1 # type: ignore
from google.api_core import retry as retries # type: ignore
from google.auth import credentials as ga_credentials # type: ignore
+from google.oauth2 import service_account # type: ignore
from google.cloud.tasks_v2.types import cloudtasks
from google.cloud.tasks_v2.types import queue
@@ -50,8 +51,6 @@
except pkg_resources.DistributionNotFound: # pragma: NO COVER
_GOOGLE_AUTH_VERSION = None
-_API_CORE_VERSION = google.api_core.__version__
-
class CloudTasksTransport(abc.ABC):
"""Abstract transport class for CloudTasks."""
@@ -69,6 +68,7 @@ def __init__(
scopes: Optional[Sequence[str]] = None,
quota_project_id: Optional[str] = None,
client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
+ always_use_jwt_access: Optional[bool] = False,
**kwargs,
) -> None:
"""Instantiate the transport.
@@ -92,6 +92,8 @@ def __init__(
API requests. If ``None``, then default info will be used.
Generally, you only need to set this if you're developing
your own client library.
+ always_use_jwt_access (Optional[bool]): Whether self signed JWT should
+ be used for service account credentials.
"""
# Save the hostname. Default to port 443 (HTTPS) if none is specified.
if ":" not in host:
@@ -101,7 +103,7 @@ def __init__(
scopes_kwargs = self._get_scopes_kwargs(self._host, scopes)
# Save the scopes.
- self._scopes = scopes or self.AUTH_SCOPES
+ self._scopes = scopes
# If no credentials are provided, then determine the appropriate
# defaults.
@@ -120,13 +122,20 @@ def __init__(
**scopes_kwargs, quota_project_id=quota_project_id
)
+ # If the credentials is service account credentials, then always try to use self signed JWT.
+ if (
+ always_use_jwt_access
+ and isinstance(credentials, service_account.Credentials)
+ and hasattr(service_account.Credentials, "with_always_use_jwt_access")
+ ):
+ credentials = credentials.with_always_use_jwt_access(True)
+
# Save the credentials.
self._credentials = credentials
- # TODO(busunkim): These two class methods are in the base transport
+ # TODO(busunkim): This method is in the base transport
# to avoid duplicating code across the transport classes. These functions
- # should be deleted once the minimum required versions of google-api-core
- # and google-auth are increased.
+ # should be deleted once the minimum required versions of google-auth is increased.
# TODO: Remove this function once google-auth >= 1.25.0 is required
@classmethod
@@ -147,27 +156,6 @@ def _get_scopes_kwargs(
return scopes_kwargs
- # TODO: Remove this function once google-api-core >= 1.26.0 is required
- @classmethod
- def _get_self_signed_jwt_kwargs(
- cls, host: str, scopes: Optional[Sequence[str]]
- ) -> Dict[str, Union[Optional[Sequence[str]], str]]:
- """Returns kwargs to pass to grpc_helpers.create_channel depending on the google-api-core version"""
-
- self_signed_jwt_kwargs: Dict[str, Union[Optional[Sequence[str]], str]] = {}
-
- if _API_CORE_VERSION and (
- packaging.version.parse(_API_CORE_VERSION)
- >= packaging.version.parse("1.26.0")
- ):
- self_signed_jwt_kwargs["default_scopes"] = cls.AUTH_SCOPES
- self_signed_jwt_kwargs["scopes"] = scopes
- self_signed_jwt_kwargs["default_host"] = cls.DEFAULT_HOST
- else:
- self_signed_jwt_kwargs["scopes"] = scopes or cls.AUTH_SCOPES
-
- return self_signed_jwt_kwargs
-
def _prep_wrapped_messages(self, client_info):
# Precompute the wrapped methods.
self._wrapped_methods = {
diff --git a/google/cloud/tasks_v2/services/cloud_tasks/transports/grpc.py b/google/cloud/tasks_v2/services/cloud_tasks/transports/grpc.py
index e7f3ceac..cfc89672 100644
--- a/google/cloud/tasks_v2/services/cloud_tasks/transports/grpc.py
+++ b/google/cloud/tasks_v2/services/cloud_tasks/transports/grpc.py
@@ -65,6 +65,7 @@ def __init__(
client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None,
quota_project_id: Optional[str] = None,
client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
+ always_use_jwt_access: Optional[bool] = False,
) -> None:
"""Instantiate the transport.
@@ -105,6 +106,8 @@ def __init__(
API requests. If ``None``, then default info will be used.
Generally, you only need to set this if you're developing
your own client library.
+ always_use_jwt_access (Optional[bool]): Whether self signed JWT should
+ be used for service account credentials.
Raises:
google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport
@@ -157,6 +160,7 @@ def __init__(
scopes=scopes,
quota_project_id=quota_project_id,
client_info=client_info,
+ always_use_jwt_access=always_use_jwt_access,
)
if not self._grpc_channel:
@@ -212,14 +216,14 @@ def create_channel(
and ``credentials_file`` are passed.
"""
- self_signed_jwt_kwargs = cls._get_self_signed_jwt_kwargs(host, scopes)
-
return grpc_helpers.create_channel(
host,
credentials=credentials,
credentials_file=credentials_file,
quota_project_id=quota_project_id,
- **self_signed_jwt_kwargs,
+ default_scopes=cls.AUTH_SCOPES,
+ scopes=scopes,
+ default_host=cls.DEFAULT_HOST,
**kwargs,
)
diff --git a/google/cloud/tasks_v2/services/cloud_tasks/transports/grpc_asyncio.py b/google/cloud/tasks_v2/services/cloud_tasks/transports/grpc_asyncio.py
index 4773ed21..1dead937 100644
--- a/google/cloud/tasks_v2/services/cloud_tasks/transports/grpc_asyncio.py
+++ b/google/cloud/tasks_v2/services/cloud_tasks/transports/grpc_asyncio.py
@@ -86,14 +86,14 @@ def create_channel(
aio.Channel: A gRPC AsyncIO channel object.
"""
- self_signed_jwt_kwargs = cls._get_self_signed_jwt_kwargs(host, scopes)
-
return grpc_helpers_async.create_channel(
host,
credentials=credentials,
credentials_file=credentials_file,
quota_project_id=quota_project_id,
- **self_signed_jwt_kwargs,
+ default_scopes=cls.AUTH_SCOPES,
+ scopes=scopes,
+ default_host=cls.DEFAULT_HOST,
**kwargs,
)
@@ -111,6 +111,7 @@ def __init__(
client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None,
quota_project_id=None,
client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
+ always_use_jwt_access: Optional[bool] = False,
) -> None:
"""Instantiate the transport.
@@ -152,6 +153,8 @@ def __init__(
API requests. If ``None``, then default info will be used.
Generally, you only need to set this if you're developing
your own client library.
+ always_use_jwt_access (Optional[bool]): Whether self signed JWT should
+ be used for service account credentials.
Raises:
google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport
@@ -203,6 +206,7 @@ def __init__(
scopes=scopes,
quota_project_id=quota_project_id,
client_info=client_info,
+ always_use_jwt_access=always_use_jwt_access,
)
if not self._grpc_channel:
diff --git a/google/cloud/tasks_v2beta2/proto/cloudtasks.proto b/google/cloud/tasks_v2beta2/proto/cloudtasks.proto
deleted file mode 100644
index 8b2fa57e..00000000
--- a/google/cloud/tasks_v2beta2/proto/cloudtasks.proto
+++ /dev/null
@@ -1,942 +0,0 @@
-// Copyright 2020 Google LLC
-//
-// 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.
-
-syntax = "proto3";
-
-package google.cloud.tasks.v2beta2;
-
-import "google/api/annotations.proto";
-import "google/api/client.proto";
-import "google/api/field_behavior.proto";
-import "google/api/resource.proto";
-import "google/cloud/tasks/v2beta2/queue.proto";
-import "google/cloud/tasks/v2beta2/task.proto";
-import "google/iam/v1/iam_policy.proto";
-import "google/iam/v1/policy.proto";
-import "google/protobuf/duration.proto";
-import "google/protobuf/empty.proto";
-import "google/protobuf/field_mask.proto";
-import "google/protobuf/timestamp.proto";
-
-option go_package = "google.golang.org/genproto/googleapis/cloud/tasks/v2beta2;tasks";
-option java_multiple_files = true;
-option java_outer_classname = "CloudTasksProto";
-option java_package = "com.google.cloud.tasks.v2beta2";
-option objc_class_prefix = "TASKS";
-
-// Cloud Tasks allows developers to manage the execution of background
-// work in their applications.
-service CloudTasks {
- option (google.api.default_host) = "cloudtasks.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
-
- // Lists queues.
- //
- // Queues are returned in lexicographical order.
- rpc ListQueues(ListQueuesRequest) returns (ListQueuesResponse) {
- option (google.api.http) = {
- get: "/v2beta2/{parent=projects/*/locations/*}/queues"
- };
- option (google.api.method_signature) = "parent";
- }
-
- // Gets a queue.
- rpc GetQueue(GetQueueRequest) returns (Queue) {
- option (google.api.http) = {
- get: "/v2beta2/{name=projects/*/locations/*/queues/*}"
- };
- option (google.api.method_signature) = "name";
- }
-
- // 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.
- rpc CreateQueue(CreateQueueRequest) returns (Queue) {
- option (google.api.http) = {
- post: "/v2beta2/{parent=projects/*/locations/*}/queues"
- body: "queue"
- };
- option (google.api.method_signature) = "parent,queue";
- }
-
- // 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.
- rpc UpdateQueue(UpdateQueueRequest) returns (Queue) {
- option (google.api.http) = {
- patch: "/v2beta2/{queue.name=projects/*/locations/*/queues/*}"
- body: "queue"
- };
- option (google.api.method_signature) = "queue,update_mask";
- }
-
- // 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
- // 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.
- rpc DeleteQueue(DeleteQueueRequest) returns (google.protobuf.Empty) {
- option (google.api.http) = {
- delete: "/v2beta2/{name=projects/*/locations/*/queues/*}"
- };
- option (google.api.method_signature) = "name";
- }
-
- // 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.
- rpc PurgeQueue(PurgeQueueRequest) returns (Queue) {
- option (google.api.http) = {
- post: "/v2beta2/{name=projects/*/locations/*/queues/*}:purge"
- body: "*"
- };
- option (google.api.method_signature) = "name";
- }
-
- // Pauses the queue.
- //
- // If a queue is paused then the system will stop dispatching tasks
- // until the queue is resumed via
- // [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue]. Tasks can still be added
- // when the queue is paused. A queue is paused if its
- // [state][google.cloud.tasks.v2beta2.Queue.state] is [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED].
- rpc PauseQueue(PauseQueueRequest) returns (Queue) {
- option (google.api.http) = {
- post: "/v2beta2/{name=projects/*/locations/*/queues/*}:pause"
- body: "*"
- };
- option (google.api.method_signature) = "name";
- }
-
- // Resume a queue.
- //
- // This method resumes a queue after it has been
- // [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED] or
- // [DISABLED][google.cloud.tasks.v2beta2.Queue.State.DISABLED]. The state of a queue is stored
- // in the queue's [state][google.cloud.tasks.v2beta2.Queue.state]; after calling this method it
- // will be set to [RUNNING][google.cloud.tasks.v2beta2.Queue.State.RUNNING].
- //
- // WARNING: Resuming many high-QPS queues at the same time can
- // lead to target overloading. If you are resuming high-QPS
- // queues, follow the 500/50/5 pattern described in
- // [Managing Cloud Tasks Scaling
- // Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
- rpc ResumeQueue(ResumeQueueRequest) returns (Queue) {
- option (google.api.http) = {
- post: "/v2beta2/{name=projects/*/locations/*/queues/*}:resume"
- body: "*"
- };
- option (google.api.method_signature) = "name";
- }
-
- // Gets the access control policy for a [Queue][google.cloud.tasks.v2beta2.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`
- rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest) returns (google.iam.v1.Policy) {
- option (google.api.http) = {
- post: "/v2beta2/{resource=projects/*/locations/*/queues/*}:getIamPolicy"
- body: "*"
- };
- option (google.api.method_signature) = "resource";
- }
-
- // Sets the access control policy for a [Queue][google.cloud.tasks.v2beta2.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`
- rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest) returns (google.iam.v1.Policy) {
- option (google.api.http) = {
- post: "/v2beta2/{resource=projects/*/locations/*/queues/*}:setIamPolicy"
- body: "*"
- };
- option (google.api.method_signature) = "resource,policy";
- }
-
- // Returns permissions that a caller has on a [Queue][google.cloud.tasks.v2beta2.Queue].
- // If the resource does not exist, this will return an empty set of
- // permissions, not a [NOT_FOUND][google.rpc.Code.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.
- rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest) returns (google.iam.v1.TestIamPermissionsResponse) {
- option (google.api.http) = {
- post: "/v2beta2/{resource=projects/*/locations/*/queues/*}:testIamPermissions"
- body: "*"
- };
- option (google.api.method_signature) = "resource,permissions";
- }
-
- // Lists the tasks in a queue.
- //
- // By default, only the [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC] view is retrieved
- // due to performance considerations;
- // [response_view][google.cloud.tasks.v2beta2.ListTasksRequest.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.
- rpc ListTasks(ListTasksRequest) returns (ListTasksResponse) {
- option (google.api.http) = {
- get: "/v2beta2/{parent=projects/*/locations/*/queues/*}/tasks"
- };
- option (google.api.method_signature) = "parent";
- }
-
- // Gets a task.
- rpc GetTask(GetTaskRequest) returns (Task) {
- option (google.api.http) = {
- get: "/v2beta2/{name=projects/*/locations/*/queues/*/tasks/*}"
- };
- option (google.api.method_signature) = "name";
- }
-
- // Creates a task and adds it to a queue.
- //
- // Tasks cannot be updated after creation; there is no UpdateTask command.
- //
- // * For [App Engine queues][google.cloud.tasks.v2beta2.AppEngineHttpTarget], the maximum task size is
- // 100KB.
- // * For [pull queues][google.cloud.tasks.v2beta2.PullTarget], the maximum task size is 1MB.
- rpc CreateTask(CreateTaskRequest) returns (Task) {
- option (google.api.http) = {
- post: "/v2beta2/{parent=projects/*/locations/*/queues/*}/tasks"
- body: "*"
- };
- option (google.api.method_signature) = "parent,task";
- }
-
- // 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.
- rpc DeleteTask(DeleteTaskRequest) returns (google.protobuf.Empty) {
- option (google.api.http) = {
- delete: "/v2beta2/{name=projects/*/locations/*/queues/*/tasks/*}"
- };
- option (google.api.method_signature) = "name";
- }
-
- // Leases tasks from a pull queue for
- // [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration].
- //
- // This method is invoked by the worker to obtain a lease. The
- // worker must acknowledge the task via
- // [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask] after they have
- // performed the work associated with the task.
- //
- // The [payload][google.cloud.tasks.v2beta2.PullMessage.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][google.cloud.tasks.v2beta2.LeaseTasksResponse], set
- // [response_view][google.cloud.tasks.v2beta2.LeaseTasksRequest.response_view] to
- // [FULL][google.cloud.tasks.v2beta2.Task.View.FULL].
- //
- // A maximum of 10 qps of [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks]
- // requests are allowed per
- // queue. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED]
- // is returned when this limit is
- // exceeded. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED]
- // is also returned when
- // [max_tasks_dispatched_per_second][google.cloud.tasks.v2beta2.RateLimits.max_tasks_dispatched_per_second]
- // is exceeded.
- rpc LeaseTasks(LeaseTasksRequest) returns (LeaseTasksResponse) {
- option (google.api.http) = {
- post: "/v2beta2/{parent=projects/*/locations/*/queues/*}/tasks:lease"
- body: "*"
- };
- option (google.api.method_signature) = "parent,lease_duration";
- }
-
- // Acknowledges a pull task.
- //
- // The worker, that is, the entity that
- // [leased][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] 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][google.cloud.tasks.v2beta2.LeaseTasksRequest.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][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks],
- // [GetTask][google.cloud.tasks.v2beta2.CloudTasks.GetTask], or
- // [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks].
- rpc AcknowledgeTask(AcknowledgeTaskRequest) returns (google.protobuf.Empty) {
- option (google.api.http) = {
- post: "/v2beta2/{name=projects/*/locations/*/queues/*/tasks/*}:acknowledge"
- body: "*"
- };
- option (google.api.method_signature) = "name,schedule_time";
- }
-
- // 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][google.cloud.tasks.v2beta2.Task.schedule_time].
- rpc RenewLease(RenewLeaseRequest) returns (Task) {
- option (google.api.http) = {
- post: "/v2beta2/{name=projects/*/locations/*/queues/*/tasks/*}:renewLease"
- body: "*"
- };
- option (google.api.method_signature) = "name,schedule_time,lease_duration";
- }
-
- // Cancel a pull task's lease.
- //
- // The worker can use this method to cancel a task's lease by
- // setting its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] to now. This will
- // make the task available to be leased to the next caller of
- // [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].
- rpc CancelLease(CancelLeaseRequest) returns (Task) {
- option (google.api.http) = {
- post: "/v2beta2/{name=projects/*/locations/*/queues/*/tasks/*}:cancelLease"
- body: "*"
- };
- option (google.api.method_signature) = "name,schedule_time";
- }
-
- // 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][google.cloud.tasks.v2beta2.RateLimits] or
- // is [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED].
- //
- // This command is meant to be used for manual debugging. For
- // example, [RunTask][google.cloud.tasks.v2beta2.CloudTasks.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][google.cloud.tasks.v2beta2.Task.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][google.cloud.tasks.v2beta2.Task.schedule_time] will be reset to the time that
- // [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] was called plus the retry delay specified
- // in the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig].
- //
- // [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] returns
- // [NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a
- // task that has already succeeded or permanently failed.
- //
- // [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] cannot be called on a
- // [pull task][google.cloud.tasks.v2beta2.PullMessage].
- rpc RunTask(RunTaskRequest) returns (Task) {
- option (google.api.http) = {
- post: "/v2beta2/{name=projects/*/locations/*/queues/*/tasks/*}:run"
- body: "*"
- };
- option (google.api.method_signature) = "name";
- }
-}
-
-// Request message for [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues].
-message ListQueuesRequest {
- // Required. The location name.
- // For example: `projects/PROJECT_ID/locations/LOCATION_ID`
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- child_type: "cloudtasks.googleapis.com/Queue"
- }
- ];
-
- // `filter` can be used to specify a subset of queues. Any [Queue][google.cloud.tasks.v2beta2.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.
- string filter = 2;
-
- // 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][google.cloud.tasks.v2beta2.ListQueuesResponse.next_page_token] in the
- // response to determine if more queues exist.
- int32 page_size = 3;
-
- // 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][google.cloud.tasks.v2beta2.ListQueuesResponse.next_page_token] returned
- // from the previous call to [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues]
- // method. It is an error to switch the value of the
- // [filter][google.cloud.tasks.v2beta2.ListQueuesRequest.filter] while iterating through pages.
- string page_token = 4;
-
- // 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]. [Queue.stats] will be returned only if it was explicitly
- // specified in the mask.
- google.protobuf.FieldMask read_mask = 5 [(google.api.field_behavior) = OPTIONAL];
-}
-
-// Response message for [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues].
-message ListQueuesResponse {
- // The list of queues.
- repeated Queue queues = 1;
-
- // A token to retrieve next page of results.
- //
- // To return the next page of results, call
- // [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues] with this value as the
- // [page_token][google.cloud.tasks.v2beta2.ListQueuesRequest.page_token].
- //
- // If the next_page_token is empty, there are no more results.
- //
- // The page token is valid for only 2 hours.
- string next_page_token = 2;
-}
-
-// Request message for [GetQueue][google.cloud.tasks.v2beta2.CloudTasks.GetQueue].
-message GetQueueRequest {
- // Required. The resource name of the queue. For example:
- // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "cloudtasks.googleapis.com/Queue"
- }
- ];
-
- // 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]. [Queue.stats] will be returned only if it was explicitly
- // specified in the mask.
- google.protobuf.FieldMask read_mask = 2 [(google.api.field_behavior) = OPTIONAL];
-}
-
-// Request message for [CreateQueue][google.cloud.tasks.v2beta2.CloudTasks.CreateQueue].
-message CreateQueueRequest {
- // 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][google.cloud.location.Locations.ListLocations].
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- child_type: "cloudtasks.googleapis.com/Queue"
- }
- ];
-
- // Required. The queue to create.
- //
- // [Queue's name][google.cloud.tasks.v2beta2.Queue.name] cannot be the same as an existing queue.
- Queue queue = 2 [(google.api.field_behavior) = REQUIRED];
-}
-
-// Request message for [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue].
-message UpdateQueueRequest {
- // Required. The queue to create or update.
- //
- // The queue's [name][google.cloud.tasks.v2beta2.Queue.name] must be specified.
- //
- // Output only fields cannot be modified using UpdateQueue.
- // Any value specified for an output only field will be ignored.
- // The queue's [name][google.cloud.tasks.v2beta2.Queue.name] cannot be changed.
- Queue queue = 1 [(google.api.field_behavior) = REQUIRED];
-
- // A mask used to specify which fields of the queue are being updated.
- //
- // If empty, then all fields will be updated.
- google.protobuf.FieldMask update_mask = 2;
-}
-
-// Request message for [DeleteQueue][google.cloud.tasks.v2beta2.CloudTasks.DeleteQueue].
-message DeleteQueueRequest {
- // Required. The queue name. For example:
- // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "cloudtasks.googleapis.com/Queue"
- }
- ];
-}
-
-// Request message for [PurgeQueue][google.cloud.tasks.v2beta2.CloudTasks.PurgeQueue].
-message PurgeQueueRequest {
- // Required. The queue name. For example:
- // `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "cloudtasks.googleapis.com/Queue"
- }
- ];
-}
-
-// Request message for [PauseQueue][google.cloud.tasks.v2beta2.CloudTasks.PauseQueue].
-message PauseQueueRequest {
- // Required. The queue name. For example:
- // `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "cloudtasks.googleapis.com/Queue"
- }
- ];
-}
-
-// Request message for [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue].
-message ResumeQueueRequest {
- // Required. The queue name. For example:
- // `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "cloudtasks.googleapis.com/Queue"
- }
- ];
-}
-
-// Request message for listing tasks using [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks].
-message ListTasksRequest {
- // Required. The queue name. For example:
- // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- child_type: "cloudtasks.googleapis.com/Task"
- }
- ];
-
- // The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be
- // returned.
- //
- // By default response_view is [BASIC][google.cloud.tasks.v2beta2.Task.View.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][google.cloud.tasks.v2beta2.Task.View.FULL] requires
- // `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
- // permission on the [Task][google.cloud.tasks.v2beta2.Task] resource.
- Task.View response_view = 2;
-
- // Maximum page size.
- //
- // Fewer tasks than requested might be returned, even if more tasks exist; use
- // [next_page_token][google.cloud.tasks.v2beta2.ListTasksResponse.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.
- int32 page_size = 4;
-
- // 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][google.cloud.tasks.v2beta2.ListTasksResponse.next_page_token] returned
- // from the previous call to [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks]
- // method.
- //
- // The page token is valid for only 2 hours.
- string page_token = 5;
-}
-
-// Response message for listing tasks using [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks].
-message ListTasksResponse {
- // The list of tasks.
- repeated Task tasks = 1;
-
- // A token to retrieve next page of results.
- //
- // To return the next page of results, call
- // [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks] with this value as the
- // [page_token][google.cloud.tasks.v2beta2.ListTasksRequest.page_token].
- //
- // If the next_page_token is empty, there are no more results.
- string next_page_token = 2;
-}
-
-// Request message for getting a task using [GetTask][google.cloud.tasks.v2beta2.CloudTasks.GetTask].
-message GetTaskRequest {
- // Required. The task name. For example:
- // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "cloudtasks.googleapis.com/Task"
- }
- ];
-
- // The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be
- // returned.
- //
- // By default response_view is [BASIC][google.cloud.tasks.v2beta2.Task.View.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][google.cloud.tasks.v2beta2.Task.View.FULL] requires
- // `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
- // permission on the [Task][google.cloud.tasks.v2beta2.Task] resource.
- Task.View response_view = 2;
-}
-
-// Request message for [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask].
-message CreateTaskRequest {
- // Required. The queue name. For example:
- // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- //
- // The queue must already exist.
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- child_type: "cloudtasks.googleapis.com/Task"
- }
- ];
-
- // Required. The task to add.
- //
- // Task names have the following format:
- // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
- // The user can optionally specify a task [name][google.cloud.tasks.v2beta2.Task.name]. If a
- // name is not specified then the system will generate a random
- // unique task id, which will be set in the task returned in the
- // [response][google.cloud.tasks.v2beta2.Task.name].
- //
- // If [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] is not set or is in the
- // past then Cloud Tasks will set it to the current time.
- //
- // Task De-duplication:
- //
- // Explicitly specifying a task ID enables task de-duplication. If
- // a task's ID is identical to that of an existing task or a task
- // that was deleted or completed recently then the call will fail
- // with [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS].
- // If the task's queue was created using Cloud Tasks, then another task with
- // the same name can't be created for ~1hour after the original task was
- // deleted or completed. If the task's queue was created using queue.yaml or
- // queue.xml, then another task with the same name can't be created
- // for ~9days after the original task was deleted or completed.
- //
- // Because there is an extra lookup cost to identify duplicate task
- // names, these [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask] calls have significantly
- // increased latency. Using hashed strings for the task id or for
- // the prefix of the task id is recommended. Choosing task ids that
- // are sequential or have sequential prefixes, for example using a
- // timestamp, causes an increase in latency and error rates in all
- // task commands. The infrastructure relies on an approximately
- // uniform distribution of task ids to store and serve tasks
- // efficiently.
- Task task = 2 [(google.api.field_behavior) = REQUIRED];
-
- // The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be
- // returned.
- //
- // By default response_view is [BASIC][google.cloud.tasks.v2beta2.Task.View.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][google.cloud.tasks.v2beta2.Task.View.FULL] requires
- // `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
- // permission on the [Task][google.cloud.tasks.v2beta2.Task] resource.
- Task.View response_view = 3;
-}
-
-// Request message for deleting a task using
-// [DeleteTask][google.cloud.tasks.v2beta2.CloudTasks.DeleteTask].
-message DeleteTaskRequest {
- // Required. The task name. For example:
- // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "cloudtasks.googleapis.com/Task"
- }
- ];
-}
-
-// Request message for leasing tasks using [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].
-message LeaseTasksRequest {
- // Required. The queue name. For example:
- // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- child_type: "cloudtasks.googleapis.com/Task"
- }
- ];
-
- // The maximum number of tasks to lease.
- //
- // The system will make a best effort to return as close to as
- // `max_tasks` as possible.
- //
- // The largest that `max_tasks` can be is 1000.
- //
- // The maximum total size of a [lease tasks response][google.cloud.tasks.v2beta2.LeaseTasksResponse] is
- // 32 MB. If the sum of all task sizes requested reaches this limit,
- // fewer tasks than requested are returned.
- int32 max_tasks = 2;
-
- // Required. The duration of the lease.
- //
- // Each task returned in the [response][google.cloud.tasks.v2beta2.LeaseTasksResponse] will
- // have its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] set to the current
- // time plus the `lease_duration`. The task is leased until its
- // [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time]; thus, the task will not be
- // returned to another [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] call
- // before its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time].
- //
- //
- // After the worker has successfully finished the work associated
- // with the task, the worker must call via
- // [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask] before the
- // [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time]. Otherwise the task will be
- // returned to a later [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] call so
- // that another worker can retry it.
- //
- // The maximum lease duration is 1 week.
- // `lease_duration` will be truncated to the nearest second.
- google.protobuf.Duration lease_duration = 3 [(google.api.field_behavior) = REQUIRED];
-
- // The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be
- // returned.
- //
- // By default response_view is [BASIC][google.cloud.tasks.v2beta2.Task.View.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][google.cloud.tasks.v2beta2.Task.View.FULL] requires
- // `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
- // permission on the [Task][google.cloud.tasks.v2beta2.Task] resource.
- Task.View response_view = 4;
-
- // `filter` can be used to specify a subset of tasks to lease.
- //
- // When `filter` is set to `tag=` then the
- // [response][google.cloud.tasks.v2beta2.LeaseTasksResponse] will contain only tasks whose
- // [tag][google.cloud.tasks.v2beta2.PullMessage.tag] is equal to ``. `` must be
- // less than 500 characters.
- //
- // When `filter` is set to `tag_function=oldest_tag()`, only tasks which have
- // the same tag as the task with the oldest
- // [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] will be returned.
- //
- // Grammar Syntax:
- //
- // * `filter = "tag=" tag | "tag_function=" function`
- //
- // * `tag = string`
- //
- // * `function = "oldest_tag()"`
- //
- // The `oldest_tag()` function returns tasks which have the same tag as the
- // oldest task (ordered by schedule time).
- //
- // SDK compatibility: Although the SDK allows tags to be either
- // string or
- // [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
- // only UTF-8 encoded tags can be used in Cloud Tasks. Tag which
- // aren't UTF-8 encoded can't be used in the
- // [filter][google.cloud.tasks.v2beta2.LeaseTasksRequest.filter] and the task's
- // [tag][google.cloud.tasks.v2beta2.PullMessage.tag] will be displayed as empty in Cloud Tasks.
- string filter = 5;
-}
-
-// Response message for leasing tasks using [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].
-message LeaseTasksResponse {
- // The leased tasks.
- repeated Task tasks = 1;
-}
-
-// Request message for acknowledging a task using
-// [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask].
-message AcknowledgeTaskRequest {
- // Required. The task name. For example:
- // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "cloudtasks.googleapis.com/Task"
- }
- ];
-
- // Required. The task's current schedule time, available in the
- // [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] returned by
- // [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] response or
- // [RenewLease][google.cloud.tasks.v2beta2.CloudTasks.RenewLease] response. This restriction is
- // to ensure that your worker currently holds the lease.
- google.protobuf.Timestamp schedule_time = 2 [(google.api.field_behavior) = REQUIRED];
-}
-
-// Request message for renewing a lease using
-// [RenewLease][google.cloud.tasks.v2beta2.CloudTasks.RenewLease].
-message RenewLeaseRequest {
- // Required. The task name. For example:
- // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "cloudtasks.googleapis.com/Task"
- }
- ];
-
- // Required. The task's current schedule time, available in the
- // [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] returned by
- // [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] response or
- // [RenewLease][google.cloud.tasks.v2beta2.CloudTasks.RenewLease] response. This restriction is
- // to ensure that your worker currently holds the lease.
- google.protobuf.Timestamp schedule_time = 2 [(google.api.field_behavior) = REQUIRED];
-
- // Required. The desired new lease duration, starting from now.
- //
- //
- // The maximum lease duration is 1 week.
- // `lease_duration` will be truncated to the nearest second.
- google.protobuf.Duration lease_duration = 3 [(google.api.field_behavior) = REQUIRED];
-
- // The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be
- // returned.
- //
- // By default response_view is [BASIC][google.cloud.tasks.v2beta2.Task.View.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][google.cloud.tasks.v2beta2.Task.View.FULL] requires
- // `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
- // permission on the [Task][google.cloud.tasks.v2beta2.Task] resource.
- Task.View response_view = 4;
-}
-
-// Request message for canceling a lease using
-// [CancelLease][google.cloud.tasks.v2beta2.CloudTasks.CancelLease].
-message CancelLeaseRequest {
- // Required. The task name. For example:
- // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "cloudtasks.googleapis.com/Task"
- }
- ];
-
- // Required. The task's current schedule time, available in the
- // [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] returned by
- // [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] response or
- // [RenewLease][google.cloud.tasks.v2beta2.CloudTasks.RenewLease] response. This restriction is
- // to ensure that your worker currently holds the lease.
- google.protobuf.Timestamp schedule_time = 2 [(google.api.field_behavior) = REQUIRED];
-
- // The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be
- // returned.
- //
- // By default response_view is [BASIC][google.cloud.tasks.v2beta2.Task.View.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][google.cloud.tasks.v2beta2.Task.View.FULL] requires
- // `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
- // permission on the [Task][google.cloud.tasks.v2beta2.Task] resource.
- Task.View response_view = 3;
-}
-
-// Request message for forcing a task to run now using
-// [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask].
-message RunTaskRequest {
- // Required. The task name. For example:
- // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "cloudtasks.googleapis.com/Task"
- }
- ];
-
- // The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be
- // returned.
- //
- // By default response_view is [BASIC][google.cloud.tasks.v2beta2.Task.View.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][google.cloud.tasks.v2beta2.Task.View.FULL] requires
- // `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
- // permission on the [Task][google.cloud.tasks.v2beta2.Task] resource.
- Task.View response_view = 2;
-}
diff --git a/google/cloud/tasks_v2beta2/proto/old_target.proto b/google/cloud/tasks_v2beta2/proto/old_target.proto
deleted file mode 100644
index 5b5c095c..00000000
--- a/google/cloud/tasks_v2beta2/proto/old_target.proto
+++ /dev/null
@@ -1,25 +0,0 @@
-// Copyright 2020 Google LLC
-//
-// 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.
-
-syntax = "proto3";
-
-package google.cloud.tasks.v2beta2;
-
-import "google/cloud/tasks/v2beta2/target.proto";
-import "google/api/annotations.proto";
-
-option go_package = "google.golang.org/genproto/googleapis/cloud/tasks/v2beta2;tasks";
-option java_multiple_files = true;
-option java_outer_classname = "OldTargetProto";
-option java_package = "com.google.cloud.tasks.v2beta2";
diff --git a/google/cloud/tasks_v2beta2/proto/queue.proto b/google/cloud/tasks_v2beta2/proto/queue.proto
deleted file mode 100644
index 1cc44651..00000000
--- a/google/cloud/tasks_v2beta2/proto/queue.proto
+++ /dev/null
@@ -1,429 +0,0 @@
-// Copyright 2020 Google LLC
-//
-// 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.
-
-syntax = "proto3";
-
-package google.cloud.tasks.v2beta2;
-
-import "google/api/field_behavior.proto";
-import "google/api/resource.proto";
-import "google/cloud/tasks/v2beta2/target.proto";
-import "google/protobuf/duration.proto";
-import "google/protobuf/timestamp.proto";
-import "google/api/annotations.proto";
-
-option go_package = "google.golang.org/genproto/googleapis/cloud/tasks/v2beta2;tasks";
-option java_multiple_files = true;
-option java_outer_classname = "QueueProto";
-option java_package = "com.google.cloud.tasks.v2beta2";
-
-// A queue is a container of related tasks. Queues are configured to manage
-// how those tasks are dispatched. Configurable properties include rate limits,
-// retry options, target types, and others.
-message Queue {
- option (google.api.resource) = {
- type: "cloudtasks.googleapis.com/Queue"
- pattern: "projects/{project}/locations/{location}/queues/{queue}"
- };
-
- // State of the queue.
- enum State {
- // Unspecified state.
- STATE_UNSPECIFIED = 0;
-
- // The queue is running. Tasks can be dispatched.
- //
- // If the queue was created using Cloud Tasks and the queue has
- // had no activity (method calls or task dispatches) for 30 days,
- // the queue may take a few minutes to re-activate. Some method
- // calls may return [NOT_FOUND][google.rpc.Code.NOT_FOUND] and
- // tasks may not be dispatched for a few minutes until the queue
- // has been re-activated.
- RUNNING = 1;
-
- // Tasks are paused by the user. If the queue is paused then Cloud
- // Tasks will stop delivering tasks from it, but more tasks can
- // still be added to it by the user. When a pull queue is paused,
- // all [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] calls will return a
- // [FAILED_PRECONDITION][google.rpc.Code.FAILED_PRECONDITION].
- PAUSED = 2;
-
- // The queue is disabled.
- //
- // A queue becomes `DISABLED` when
- // [queue.yaml](https://cloud.google.com/appengine/docs/python/config/queueref)
- // or
- // [queue.xml](https://cloud.google.com/appengine/docs/standard/java/config/queueref)
- // is uploaded which does not contain the queue. You cannot directly disable
- // a queue.
- //
- // When a queue is disabled, tasks can still be added to a queue
- // but the tasks are not dispatched and
- // [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] calls return a
- // `FAILED_PRECONDITION` error.
- //
- // To permanently delete this queue and all of its tasks, call
- // [DeleteQueue][google.cloud.tasks.v2beta2.CloudTasks.DeleteQueue].
- DISABLED = 3;
- }
-
- // Caller-specified and required in [CreateQueue][google.cloud.tasks.v2beta2.CloudTasks.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][google.cloud.location.Locations.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.
- string name = 1;
-
- // Caller-specified and required in [CreateQueue][google.cloud.tasks.v2beta2.CloudTasks.CreateQueue][],
- // after which the queue config type becomes output only, though fields within
- // the config are mutable.
- //
- // The queue's target.
- //
- // The target applies to all tasks in the queue.
- oneof target_type {
- // App Engine HTTP target.
- //
- // An App Engine queue is a queue that has an [AppEngineHttpTarget][google.cloud.tasks.v2beta2.AppEngineHttpTarget].
- AppEngineHttpTarget app_engine_http_target = 3;
-
- // Pull target.
- //
- // A pull queue is a queue that has a [PullTarget][google.cloud.tasks.v2beta2.PullTarget].
- PullTarget pull_target = 4;
- }
-
- // Rate limits for task dispatches.
- //
- // [rate_limits][google.cloud.tasks.v2beta2.Queue.rate_limits] and
- // [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] are related because they both
- // control task attempts however they control how tasks are
- // attempted in different ways:
- //
- // * [rate_limits][google.cloud.tasks.v2beta2.Queue.rate_limits] controls the total rate of
- // dispatches from a queue (i.e. all traffic dispatched from the
- // queue, regardless of whether the dispatch is from a first
- // attempt or a retry).
- // * [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] controls what happens to
- // particular a task after its first attempt fails. That is,
- // [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] controls task retries (the
- // second attempt, third attempt, etc).
- RateLimits rate_limits = 5;
-
- // Settings that determine the retry behavior.
- //
- // * For tasks created using Cloud Tasks: the queue-level retry settings
- // apply to all tasks in the queue that were created using Cloud Tasks.
- // Retry settings cannot be set on individual tasks.
- // * For tasks created using the App Engine SDK: the queue-level retry
- // settings apply to all tasks in the queue which do not have retry settings
- // explicitly set on the task and were created by the App Engine SDK. See
- // [App Engine
- // documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
- RetryConfig retry_config = 6;
-
- // Output only. The state of the queue.
- //
- // `state` can only be changed by called
- // [PauseQueue][google.cloud.tasks.v2beta2.CloudTasks.PauseQueue],
- // [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue], or uploading
- // [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
- // [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue] cannot be used to change `state`.
- State state = 7;
-
- // Output only. The last time this queue was purged.
- //
- // All tasks that were [created][google.cloud.tasks.v2beta2.Task.create_time] before this time
- // were purged.
- //
- // A queue can be purged using [PurgeQueue][google.cloud.tasks.v2beta2.CloudTasks.PurgeQueue], the
- // [App Engine Task Queue SDK, or the Cloud
- // Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
- //
- // Purge time will be truncated to the nearest microsecond. Purge
- // time will be unset if the queue has never been purged.
- google.protobuf.Timestamp purge_time = 8;
-
- // The maximum amount of time that a task will be retained in
- // this queue.
- //
- // Queues created by Cloud Tasks have a default `task_ttl` of 31 days.
- // After a task has lived for `task_ttl`, the task will be deleted
- // regardless of whether it was dispatched or not.
- //
- // The `task_ttl` for queues created via queue.yaml/xml is equal to the
- // maximum duration because there is a
- // [storage quota](https://cloud.google.com/appengine/quotas#Task_Queue) for
- // these queues. To view the maximum valid duration, see the documentation for
- // [Duration][google.protobuf.Duration].
- google.protobuf.Duration task_ttl = 9;
-
- // The task tombstone time to live (TTL).
- //
- // After a task is deleted or completed, the task's tombstone is
- // retained for the length of time specified by `tombstone_ttl`.
- // The tombstone is used by task de-duplication; another task with the same
- // name can't be created until the tombstone has expired. For more information
- // about task de-duplication, see the documentation for
- // [CreateTaskRequest][google.cloud.tasks.v2beta2.CreateTaskRequest.task].
- //
- // Queues created by Cloud Tasks have a default `tombstone_ttl` of 1 hour.
- google.protobuf.Duration tombstone_ttl = 10;
-
- // Output only. The realtime, informational statistics for a queue. In order
- // to receive the statistics the caller should include this field in the
- // FieldMask.
- QueueStats stats = 16 [(google.api.field_behavior) = OUTPUT_ONLY];
-}
-
-// Rate limits.
-//
-// This message determines the maximum rate that tasks can be dispatched by a
-// queue, regardless of whether the dispatch is a first task attempt or a retry.
-//
-// Note: The debugging command, [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask], will run a task
-// even if the queue has reached its [RateLimits][google.cloud.tasks.v2beta2.RateLimits].
-message RateLimits {
- // The maximum rate at which tasks are dispatched from this queue.
- //
- // If unspecified when the queue is created, Cloud Tasks will pick the
- // default.
- //
- // * For [App Engine queues][google.cloud.tasks.v2beta2.AppEngineHttpTarget], the maximum allowed value
- // is 500.
- // * This field is output only for [pull queues][google.cloud.tasks.v2beta2.PullTarget]. In addition to the
- // `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
- // [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] requests are allowed per pull queue.
- //
- //
- // This field has the same meaning as
- // [rate in
- // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
- double max_tasks_dispatched_per_second = 1;
-
- // The max burst size.
- //
- // Max burst size limits how fast tasks in queue are processed when
- // many tasks are in the queue and the rate is high. This field
- // allows the queue to have a high rate so processing starts shortly
- // after a task is enqueued, but still limits resource usage when
- // many tasks are enqueued in a short period of time.
- //
- // The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
- // algorithm is used to control the rate of task dispatches. Each
- // queue has a token bucket that holds tokens, up to the maximum
- // specified by `max_burst_size`. Each time a task is dispatched, a
- // token is removed from the bucket. Tasks will be dispatched until
- // the queue's bucket runs out of tokens. The bucket will be
- // continuously refilled with new tokens based on
- // [max_dispatches_per_second][RateLimits.max_dispatches_per_second].
- //
- // The default value of `max_burst_size` is picked by Cloud Tasks
- // based on the value of
- // [max_dispatches_per_second][RateLimits.max_dispatches_per_second].
- //
- // The maximum value of `max_burst_size` is 500.
- //
- // For App Engine queues that were created or updated using
- // `queue.yaml/xml`, `max_burst_size` is equal to
- // [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
- // If
- // [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue] is called on a queue without
- // explicitly setting a value for `max_burst_size`,
- // `max_burst_size` value will get updated if
- // [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue] is updating
- // [max_dispatches_per_second][RateLimits.max_dispatches_per_second].
- //
- int32 max_burst_size = 2;
-
- // The maximum number of concurrent tasks that Cloud Tasks allows
- // to be dispatched for this queue. After this threshold has been
- // reached, Cloud Tasks stops dispatching tasks until the number of
- // concurrent requests decreases.
- //
- // If unspecified when the queue is created, Cloud Tasks will pick the
- // default.
- //
- //
- // The maximum allowed value is 5,000.
- //
- // This field is output only for
- // [pull queues][google.cloud.tasks.v2beta2.PullTarget] and always -1, which indicates no limit. No other
- // queue types can have `max_concurrent_tasks` set to -1.
- //
- //
- // This field has the same meaning as
- // [max_concurrent_requests in
- // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
- int32 max_concurrent_tasks = 3;
-}
-
-// Retry config.
-//
-// These settings determine how a failed task attempt is retried.
-message RetryConfig {
- // Number of attempts per task.
- //
- // If unspecified when the queue is created, Cloud Tasks will pick the
- // default.
- //
- //
- //
- // This field has the same meaning as
- // [task_retry_limit in
- // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- oneof num_attempts {
- // The maximum number of attempts for a task.
- //
- // Cloud Tasks will attempt the task `max_attempts` times (that
- // is, if the first attempt fails, then there will be
- // `max_attempts - 1` retries). Must be > 0.
- int32 max_attempts = 1;
-
- // If true, then the number of attempts is unlimited.
- bool unlimited_attempts = 2;
- }
-
- // If positive, `max_retry_duration` specifies the time limit for
- // retrying a failed task, measured from when the task was first
- // attempted. Once `max_retry_duration` time has passed *and* the
- // task has been attempted [max_attempts][google.cloud.tasks.v2beta2.RetryConfig.max_attempts]
- // times, no further attempts will be made and the task will be
- // deleted.
- //
- // If zero, then the task age is unlimited.
- //
- // If unspecified when the queue is created, Cloud Tasks will pick the
- // default.
- //
- // This field is output only for [pull queues][google.cloud.tasks.v2beta2.PullTarget].
- //
- //
- // `max_retry_duration` will be truncated to the nearest second.
- //
- // This field has the same meaning as
- // [task_age_limit in
- // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- google.protobuf.Duration max_retry_duration = 3;
-
- // A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time] for retry between
- // [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and
- // [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration after it fails,
- // if the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig] specifies that the task should be
- // retried.
- //
- // If unspecified when the queue is created, Cloud Tasks will pick the
- // default.
- //
- // This field is output only for [pull queues][google.cloud.tasks.v2beta2.PullTarget].
- //
- //
- // `min_backoff` will be truncated to the nearest second.
- //
- // This field has the same meaning as
- // [min_backoff_seconds in
- // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- google.protobuf.Duration min_backoff = 4;
-
- // A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time] for retry between
- // [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and
- // [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration after it fails,
- // if the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig] specifies that the task should be
- // retried.
- //
- // If unspecified when the queue is created, Cloud Tasks will pick the
- // default.
- //
- // This field is output only for [pull queues][google.cloud.tasks.v2beta2.PullTarget].
- //
- //
- // `max_backoff` will be truncated to the nearest second.
- //
- // This field has the same meaning as
- // [max_backoff_seconds in
- // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- google.protobuf.Duration max_backoff = 5;
-
- // The time between retries will double `max_doublings` times.
- //
- // A task's retry interval starts at
- // [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff], then doubles
- // `max_doublings` times, then increases linearly, and finally
- // retries at intervals of
- // [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] up to
- // [max_attempts][google.cloud.tasks.v2beta2.RetryConfig.max_attempts] times.
- //
- // For example, if [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] is 10s,
- // [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] is 300s, and
- // `max_doublings` is 3, then the a task will first be retried in
- // 10s. The retry interval will double three times, and then
- // increase linearly by 2^3 * 10s. Finally, the task will retry at
- // intervals of [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] until the
- // task has been attempted [max_attempts][google.cloud.tasks.v2beta2.RetryConfig.max_attempts]
- // times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s,
- // 240s, 300s, 300s, ....
- //
- // If unspecified when the queue is created, Cloud Tasks will pick the
- // default.
- //
- // This field is output only for [pull queues][google.cloud.tasks.v2beta2.PullTarget].
- //
- //
- // This field has the same meaning as
- // [max_doublings in
- // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- int32 max_doublings = 6;
-}
-
-// Statistics for a queue.
-message QueueStats {
- // Output only. An estimation of the number of tasks in the queue, that is, the tasks in
- // the queue that haven't been executed, the tasks in the queue which the
- // queue has dispatched but has not yet received a reply for, and the failed
- // tasks that the queue is retrying.
- int64 tasks_count = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. An estimation of the nearest time in the future where a task in the queue
- // is scheduled to be executed.
- google.protobuf.Timestamp oldest_estimated_arrival_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The number of tasks that the queue has dispatched and received a reply for
- // during the last minute. This variable counts both successful and
- // non-successful executions.
- int64 executed_last_minute_count = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The number of requests that the queue has dispatched but has not received
- // a reply for yet.
- int64 concurrent_dispatches_count = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The current maximum number of tasks per second executed by the queue.
- // The maximum value of this variable is controlled by the RateLimits of the
- // Queue. However, this value could be less to avoid overloading the endpoints
- // tasks in the queue are targeting.
- double effective_execution_rate = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
-}
diff --git a/google/cloud/tasks_v2beta2/proto/target.proto b/google/cloud/tasks_v2beta2/proto/target.proto
deleted file mode 100644
index 09c8fd78..00000000
--- a/google/cloud/tasks_v2beta2/proto/target.proto
+++ /dev/null
@@ -1,378 +0,0 @@
-// Copyright 2020 Google LLC
-//
-// 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.
-
-syntax = "proto3";
-
-package google.cloud.tasks.v2beta2;
-
-import "google/api/annotations.proto";
-
-option go_package = "google.golang.org/genproto/googleapis/cloud/tasks/v2beta2;tasks";
-option java_multiple_files = true;
-option java_outer_classname = "TargetProto";
-option java_package = "com.google.cloud.tasks.v2beta2";
-
-// Pull target.
-message PullTarget {
-
-}
-
-// The pull message contains data that can be used by the caller of
-// [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process the task.
-//
-// This proto can only be used for tasks in a queue which has
-// [pull_target][google.cloud.tasks.v2beta2.Queue.pull_target] set.
-message PullMessage {
- // A data payload consumed by the worker to execute the task.
- bytes payload = 1;
-
- // The task's tag.
- //
- // Tags allow similar tasks to be processed in a batch. If you label
- // tasks with a tag, your worker can
- // [lease tasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] with the same tag using
- // [filter][google.cloud.tasks.v2beta2.LeaseTasksRequest.filter]. For example, if you want to
- // aggregate the events associated with a specific user once a day,
- // you could tag tasks with the user ID.
- //
- // The task's tag can only be set when the
- // [task is created][google.cloud.tasks.v2beta2.CloudTasks.CreateTask].
- //
- // The tag must be less than 500 characters.
- //
- // SDK compatibility: Although the SDK allows tags to be either
- // string or
- // [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
- // only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8
- // encoded, the tag will be empty when the task is returned by Cloud Tasks.
- string tag = 2;
-}
-
-// App Engine HTTP target.
-//
-// The task will be delivered to the App Engine application hostname
-// specified by its [AppEngineHttpTarget][google.cloud.tasks.v2beta2.AppEngineHttpTarget] and [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest].
-// The documentation for [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest] explains how the
-// task's host URL is constructed.
-//
-// Using [AppEngineHttpTarget][google.cloud.tasks.v2beta2.AppEngineHttpTarget] requires
-// [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
-// Google IAM permission for the project
-// and the following scope:
-//
-// `https://www.googleapis.com/auth/cloud-platform`
-message AppEngineHttpTarget {
- // Overrides for the
- // [task-level app_engine_routing][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing].
- //
- // If set, `app_engine_routing_override` is used for all tasks in
- // the queue, no matter what the setting is for the
- // [task-level app_engine_routing][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing].
- AppEngineRouting app_engine_routing_override = 1;
-}
-
-// App Engine HTTP request.
-//
-// The message defines the HTTP request that is sent to an App Engine app when
-// the task is dispatched.
-//
-// This proto can only be used for tasks in a queue which has
-// [app_engine_http_target][google.cloud.tasks.v2beta2.Queue.app_engine_http_target] set.
-//
-// Using [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest] requires
-// [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
-// Google IAM permission for the project
-// and the following scope:
-//
-// `https://www.googleapis.com/auth/cloud-platform`
-//
-// The task will be delivered to the App Engine app which belongs to the same
-// project as the queue. For more information, see
-// [How Requests are
-// Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
-// and how routing is affected by
-// [dispatch
-// files](https://cloud.google.com/appengine/docs/python/config/dispatchref).
-// Traffic is encrypted during transport and never leaves Google datacenters.
-// Because this traffic is carried over a communication mechanism internal to
-// Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS).
-// The request to the handler, however, will appear to have used the HTTP
-// protocol.
-//
-// The [AppEngineRouting][google.cloud.tasks.v2beta2.AppEngineRouting] used to construct the URL that the task is
-// delivered to can be set at the queue-level or task-level:
-//
-// * If set,
-// [app_engine_routing_override][google.cloud.tasks.v2beta2.AppEngineHttpTarget.app_engine_routing_override]
-// is used for all tasks in the queue, no matter what the setting
-// is for the
-// [task-level app_engine_routing][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing].
-//
-//
-// The `url` that the task will be sent to is:
-//
-// * `url =` [host][google.cloud.tasks.v2beta2.AppEngineRouting.host] `+`
-// [relative_url][google.cloud.tasks.v2beta2.AppEngineHttpRequest.relative_url]
-//
-// Tasks can be dispatched to secure app handlers, unsecure app handlers, and
-// URIs restricted with
-// [`login:
-// admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref).
-// Because tasks are not run as any user, they cannot be dispatched to URIs
-// restricted with
-// [`login:
-// required`](https://cloud.google.com/appengine/docs/standard/python/config/appref)
-// Task dispatches also do not follow redirects.
-//
-// The task attempt has succeeded if the app's request handler returns an HTTP
-// response code in the range [`200` - `299`]. The task attempt has failed if
-// the app's handler returns a non-2xx response code or Cloud Tasks does
-// not receive response before the [deadline][Task.dispatch_deadline]. Failed
-// tasks will be retried according to the
-// [retry configuration][google.cloud.tasks.v2beta2.Queue.retry_config]. `503` (Service Unavailable) is
-// considered an App Engine system error instead of an application error and
-// will cause Cloud Tasks' traffic congestion control to temporarily throttle
-// the queue's dispatches. Unlike other types of task targets, a `429` (Too Many
-// Requests) response from an app handler does not cause traffic congestion
-// control to throttle the queue.
-message AppEngineHttpRequest {
- // The HTTP method to use for the request. The default is POST.
- //
- // The app's request handler for the task's target URL must be able to handle
- // HTTP requests with this http_method, otherwise the task attempt fails with
- // error code 405 (Method Not Allowed). See [Writing a push task request
- // handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
- // and the App Engine documentation for your runtime on [How Requests are
- // Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
- HttpMethod http_method = 1;
-
- // Task-level setting for App Engine routing.
- //
- // If set,
- // [app_engine_routing_override][google.cloud.tasks.v2beta2.AppEngineHttpTarget.app_engine_routing_override]
- // is used for all tasks in the queue, no matter what the setting is for the
- // [task-level app_engine_routing][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing].
- AppEngineRouting app_engine_routing = 2;
-
- // The relative URL.
- //
- // The relative URL must begin with "/" and must be a valid HTTP relative URL.
- // It can contain a path and query string arguments.
- // If the relative URL is empty, then the root path "/" will be used.
- // No spaces are allowed, and the maximum length allowed is 2083 characters.
- string relative_url = 3;
-
- // HTTP request headers.
- //
- // This map contains the header field names and values.
- // Headers can be set when the
- // [task is created][google.cloud.tasks.v2beta2.CloudTasks.CreateTask].
- // Repeated headers are not supported but a header value can contain commas.
- //
- // Cloud Tasks sets some headers to default values:
- //
- // * `User-Agent`: By default, this header is
- // `"AppEngine-Google; (+http://code.google.com/appengine)"`.
- // This header can be modified, but Cloud Tasks will append
- // `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
- // modified `User-Agent`.
- //
- // If the task has a [payload][google.cloud.tasks.v2beta2.AppEngineHttpRequest.payload], Cloud
- // Tasks sets the following headers:
- //
- // * `Content-Type`: By default, the `Content-Type` header is set to
- // `"application/octet-stream"`. The default can be overridden by explicitly
- // setting `Content-Type` to a particular media type when the
- // [task is created][google.cloud.tasks.v2beta2.CloudTasks.CreateTask].
- // For example, `Content-Type` can be set to `"application/json"`.
- // * `Content-Length`: This is computed by Cloud Tasks. This value is
- // output only. It cannot be changed.
- //
- // The headers below cannot be set or overridden:
- //
- // * `Host`
- // * `X-Google-*`
- // * `X-AppEngine-*`
- //
- // In addition, Cloud Tasks sets some headers when the task is dispatched,
- // such as headers containing information about the task; see
- // [request
- // headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
- // These headers are set only when the task is dispatched, so they are not
- // visible when the task is returned in a Cloud Tasks response.
- //
- // Although there is no specific limit for the maximum number of headers or
- // the size, there is a limit on the maximum size of the [Task][google.cloud.tasks.v2beta2.Task]. For more
- // information, see the [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask] documentation.
- map headers = 4;
-
- // Payload.
- //
- // The payload will be sent as the HTTP message body. A message
- // body, and thus a payload, is allowed only if the HTTP method is
- // POST or PUT. It is an error to set a data payload on a task with
- // an incompatible [HttpMethod][google.cloud.tasks.v2beta2.HttpMethod].
- bytes payload = 5;
-}
-
-// App Engine Routing.
-//
-// Defines routing characteristics specific to App Engine - service, version,
-// and instance.
-//
-// For more information about services, versions, and instances see
-// [An Overview of App
-// Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
-// [Microservices Architecture on Google App
-// Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
-// [App Engine Standard request
-// routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
-// and [App Engine Flex request
-// routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
-message AppEngineRouting {
- // App service.
- //
- // By default, the task is sent to the service which is the default
- // service when the task is attempted.
- //
- // For some queues or tasks which were created using the App Engine
- // Task Queue API, [host][google.cloud.tasks.v2beta2.AppEngineRouting.host] is not parsable
- // into [service][google.cloud.tasks.v2beta2.AppEngineRouting.service],
- // [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], and
- // [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance]. For example, some tasks
- // which were created using the App Engine SDK use a custom domain
- // name; custom domains are not parsed by Cloud Tasks. If
- // [host][google.cloud.tasks.v2beta2.AppEngineRouting.host] is not parsable, then
- // [service][google.cloud.tasks.v2beta2.AppEngineRouting.service],
- // [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], and
- // [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] are the empty string.
- string service = 1;
-
- // App version.
- //
- // By default, the task is sent to the version which is the default
- // version when the task is attempted.
- //
- // For some queues or tasks which were created using the App Engine
- // Task Queue API, [host][google.cloud.tasks.v2beta2.AppEngineRouting.host] is not parsable
- // into [service][google.cloud.tasks.v2beta2.AppEngineRouting.service],
- // [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], and
- // [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance]. For example, some tasks
- // which were created using the App Engine SDK use a custom domain
- // name; custom domains are not parsed by Cloud Tasks. If
- // [host][google.cloud.tasks.v2beta2.AppEngineRouting.host] is not parsable, then
- // [service][google.cloud.tasks.v2beta2.AppEngineRouting.service],
- // [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], and
- // [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] are the empty string.
- string version = 2;
-
- // App instance.
- //
- // By default, the task is sent to an instance which is available when
- // the task is attempted.
- //
- // Requests can only be sent to a specific instance if
- // [manual scaling is used in App Engine
- // Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
- // App Engine Flex does not support instances. For more information, see
- // [App Engine Standard request
- // routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
- // and [App Engine Flex request
- // routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- string instance = 3;
-
- // Output only. The host that the task is sent to.
- //
- // For more information, see
- // [How Requests are
- // Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
- //
- // The host is constructed as:
- //
- //
- // * `host = [application_domain_name]`
- // `| [service] + '.' + [application_domain_name]`
- // `| [version] + '.' + [application_domain_name]`
- // `| [version_dot_service]+ '.' + [application_domain_name]`
- // `| [instance] + '.' + [application_domain_name]`
- // `| [instance_dot_service] + '.' + [application_domain_name]`
- // `| [instance_dot_version] + '.' + [application_domain_name]`
- // `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
- //
- // * `application_domain_name` = The domain name of the app, for
- // example .appspot.com, which is associated with the
- // queue's project ID. Some tasks which were created using the App Engine
- // SDK use a custom domain name.
- //
- // * `service =` [service][google.cloud.tasks.v2beta2.AppEngineRouting.service]
- //
- // * `version =` [version][google.cloud.tasks.v2beta2.AppEngineRouting.version]
- //
- // * `version_dot_service =`
- // [version][google.cloud.tasks.v2beta2.AppEngineRouting.version] `+ '.' +`
- // [service][google.cloud.tasks.v2beta2.AppEngineRouting.service]
- //
- // * `instance =` [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance]
- //
- // * `instance_dot_service =`
- // [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] `+ '.' +`
- // [service][google.cloud.tasks.v2beta2.AppEngineRouting.service]
- //
- // * `instance_dot_version =`
- // [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] `+ '.' +`
- // [version][google.cloud.tasks.v2beta2.AppEngineRouting.version]
- //
- // * `instance_dot_version_dot_service =`
- // [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] `+ '.' +`
- // [version][google.cloud.tasks.v2beta2.AppEngineRouting.version] `+ '.' +`
- // [service][google.cloud.tasks.v2beta2.AppEngineRouting.service]
- //
- // If [service][google.cloud.tasks.v2beta2.AppEngineRouting.service] is empty, then the task will be sent
- // to the service which is the default service when the task is attempted.
- //
- // If [version][google.cloud.tasks.v2beta2.AppEngineRouting.version] is empty, then the task will be sent
- // to the version which is the default version when the task is attempted.
- //
- // If [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] is empty, then the task
- // will be sent to an instance which is available when the task is
- // attempted.
- //
- // If [service][google.cloud.tasks.v2beta2.AppEngineRouting.service],
- // [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], or
- // [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] is invalid, then the task
- // will be sent to the default version of the default service when
- // the task is attempted.
- string host = 4;
-}
-
-// The HTTP method used to execute the task.
-enum HttpMethod {
- // HTTP method unspecified
- HTTP_METHOD_UNSPECIFIED = 0;
-
- // HTTP POST
- POST = 1;
-
- // HTTP GET
- GET = 2;
-
- // HTTP HEAD
- HEAD = 3;
-
- // HTTP PUT
- PUT = 4;
-
- // HTTP DELETE
- DELETE = 5;
-}
diff --git a/google/cloud/tasks_v2beta2/proto/task.proto b/google/cloud/tasks_v2beta2/proto/task.proto
deleted file mode 100644
index 873a6f93..00000000
--- a/google/cloud/tasks_v2beta2/proto/task.proto
+++ /dev/null
@@ -1,183 +0,0 @@
-// Copyright 2020 Google LLC
-//
-// 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.
-
-syntax = "proto3";
-
-package google.cloud.tasks.v2beta2;
-
-import "google/api/resource.proto";
-import "google/cloud/tasks/v2beta2/target.proto";
-import "google/protobuf/timestamp.proto";
-import "google/rpc/status.proto";
-import "google/api/annotations.proto";
-
-option go_package = "google.golang.org/genproto/googleapis/cloud/tasks/v2beta2;tasks";
-option java_multiple_files = true;
-option java_outer_classname = "TaskProto";
-option java_package = "com.google.cloud.tasks.v2beta2";
-
-// A unit of scheduled work.
-message Task {
- option (google.api.resource) = {
- type: "cloudtasks.googleapis.com/Task"
- pattern: "projects/{project}/locations/{location}/queues/{queue}/tasks/{task}"
- };
-
- // The view specifies a subset of [Task][google.cloud.tasks.v2beta2.Task] data.
- //
- // When a task is returned in a response, 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.
- enum View {
- // Unspecified. Defaults to BASIC.
- VIEW_UNSPECIFIED = 0;
-
- // The basic view omits fields which can be large or can contain
- // sensitive data.
- //
- // This view does not include the
- // ([payload in AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest] and
- // [payload in PullMessage][google.cloud.tasks.v2beta2.PullMessage.payload]). These payloads are
- // desirable to return only when needed, because they can be large
- // and because of the sensitivity of the data that you choose to
- // store in it.
- BASIC = 1;
-
- // All information is returned.
- //
- // Authorization for [FULL][google.cloud.tasks.v2beta2.Task.View.FULL] requires
- // `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
- // permission on the [Queue][google.cloud.tasks.v2beta2.Queue] resource.
- FULL = 2;
- }
-
- // Optionally caller-specified in [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask].
- //
- // The task name.
- //
- // The task name must have the following format:
- // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_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 task's location.
- // The list of available locations can be obtained by calling
- // [ListLocations][google.cloud.location.Locations.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.
- // * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
- // hyphens (-), or underscores (_). The maximum length is 500 characters.
- string name = 1;
-
- // Required.
- //
- // The task's payload is used by the task's target to process the task.
- // A payload is valid only if it is compatible with the queue's target.
- oneof payload_type {
- // App Engine HTTP request that is sent to the task's target. Can
- // be set only if
- // [app_engine_http_target][google.cloud.tasks.v2beta2.Queue.app_engine_http_target] is set
- // on the queue.
- //
- // An App Engine task is a task that has [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest] set.
- AppEngineHttpRequest app_engine_http_request = 3;
-
- // [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process the task. Can be
- // set only if [pull_target][google.cloud.tasks.v2beta2.Queue.pull_target] is set on the queue.
- //
- // A pull task is a task that has [PullMessage][google.cloud.tasks.v2beta2.PullMessage] set.
- PullMessage pull_message = 4;
- }
-
- // The time when the task is scheduled to be attempted.
- //
- // For App Engine queues, this is when the task will be attempted or retried.
- //
- // For pull queues, this is the time when the task is available to
- // be leased; if a task is currently leased, this is the time when
- // the current lease expires, that is, the time that the task was
- // leased plus the [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration].
- //
- // `schedule_time` will be truncated to the nearest microsecond.
- google.protobuf.Timestamp schedule_time = 5;
-
- // Output only. The time that the task was created.
- //
- // `create_time` will be truncated to the nearest second.
- google.protobuf.Timestamp create_time = 6;
-
- // Output only. The task status.
- TaskStatus status = 7;
-
- // Output only. The view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] has
- // been returned.
- View view = 8;
-}
-
-// Status of the task.
-message TaskStatus {
- // Output only. The number of attempts dispatched.
- //
- // This count includes attempts which have been dispatched but haven't
- // received a response.
- int32 attempt_dispatch_count = 1;
-
- // Output only. The number of attempts which have received a response.
- //
- // This field is not calculated for [pull tasks][google.cloud.tasks.v2beta2.PullMessage].
- int32 attempt_response_count = 2;
-
- // Output only. The status of the task's first attempt.
- //
- // Only [dispatch_time][google.cloud.tasks.v2beta2.AttemptStatus.dispatch_time] will be set.
- // The other [AttemptStatus][google.cloud.tasks.v2beta2.AttemptStatus] information is not retained by Cloud Tasks.
- //
- // This field is not calculated for [pull tasks][google.cloud.tasks.v2beta2.PullMessage].
- AttemptStatus first_attempt_status = 3;
-
- // Output only. The status of the task's last attempt.
- //
- // This field is not calculated for [pull tasks][google.cloud.tasks.v2beta2.PullMessage].
- AttemptStatus last_attempt_status = 4;
-}
-
-// The status of a task attempt.
-message AttemptStatus {
- // Output only. The time that this attempt was scheduled.
- //
- // `schedule_time` will be truncated to the nearest microsecond.
- google.protobuf.Timestamp schedule_time = 1;
-
- // Output only. The time that this attempt was dispatched.
- //
- // `dispatch_time` will be truncated to the nearest microsecond.
- google.protobuf.Timestamp dispatch_time = 2;
-
- // Output only. The time that this attempt response was received.
- //
- // `response_time` will be truncated to the nearest microsecond.
- google.protobuf.Timestamp response_time = 3;
-
- // Output only. The response from the target for this attempt.
- //
- // If the task has not been attempted or the task is currently running
- // then the response status is unset.
- google.rpc.Status response_status = 4;
-}
diff --git a/google/cloud/tasks_v2beta2/services/cloud_tasks/transports/base.py b/google/cloud/tasks_v2beta2/services/cloud_tasks/transports/base.py
index 3af4ea62..609a04a3 100644
--- a/google/cloud/tasks_v2beta2/services/cloud_tasks/transports/base.py
+++ b/google/cloud/tasks_v2beta2/services/cloud_tasks/transports/base.py
@@ -24,6 +24,7 @@
from google.api_core import gapic_v1 # type: ignore
from google.api_core import retry as retries # type: ignore
from google.auth import credentials as ga_credentials # type: ignore
+from google.oauth2 import service_account # type: ignore
from google.cloud.tasks_v2beta2.types import cloudtasks
from google.cloud.tasks_v2beta2.types import queue
@@ -50,8 +51,6 @@
except pkg_resources.DistributionNotFound: # pragma: NO COVER
_GOOGLE_AUTH_VERSION = None
-_API_CORE_VERSION = google.api_core.__version__
-
class CloudTasksTransport(abc.ABC):
"""Abstract transport class for CloudTasks."""
@@ -69,6 +68,7 @@ def __init__(
scopes: Optional[Sequence[str]] = None,
quota_project_id: Optional[str] = None,
client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
+ always_use_jwt_access: Optional[bool] = False,
**kwargs,
) -> None:
"""Instantiate the transport.
@@ -92,6 +92,8 @@ def __init__(
API requests. If ``None``, then default info will be used.
Generally, you only need to set this if you're developing
your own client library.
+ always_use_jwt_access (Optional[bool]): Whether self signed JWT should
+ be used for service account credentials.
"""
# Save the hostname. Default to port 443 (HTTPS) if none is specified.
if ":" not in host:
@@ -101,7 +103,7 @@ def __init__(
scopes_kwargs = self._get_scopes_kwargs(self._host, scopes)
# Save the scopes.
- self._scopes = scopes or self.AUTH_SCOPES
+ self._scopes = scopes
# If no credentials are provided, then determine the appropriate
# defaults.
@@ -120,13 +122,20 @@ def __init__(
**scopes_kwargs, quota_project_id=quota_project_id
)
+ # If the credentials is service account credentials, then always try to use self signed JWT.
+ if (
+ always_use_jwt_access
+ and isinstance(credentials, service_account.Credentials)
+ and hasattr(service_account.Credentials, "with_always_use_jwt_access")
+ ):
+ credentials = credentials.with_always_use_jwt_access(True)
+
# Save the credentials.
self._credentials = credentials
- # TODO(busunkim): These two class methods are in the base transport
+ # TODO(busunkim): This method is in the base transport
# to avoid duplicating code across the transport classes. These functions
- # should be deleted once the minimum required versions of google-api-core
- # and google-auth are increased.
+ # should be deleted once the minimum required versions of google-auth is increased.
# TODO: Remove this function once google-auth >= 1.25.0 is required
@classmethod
@@ -147,27 +156,6 @@ def _get_scopes_kwargs(
return scopes_kwargs
- # TODO: Remove this function once google-api-core >= 1.26.0 is required
- @classmethod
- def _get_self_signed_jwt_kwargs(
- cls, host: str, scopes: Optional[Sequence[str]]
- ) -> Dict[str, Union[Optional[Sequence[str]], str]]:
- """Returns kwargs to pass to grpc_helpers.create_channel depending on the google-api-core version"""
-
- self_signed_jwt_kwargs: Dict[str, Union[Optional[Sequence[str]], str]] = {}
-
- if _API_CORE_VERSION and (
- packaging.version.parse(_API_CORE_VERSION)
- >= packaging.version.parse("1.26.0")
- ):
- self_signed_jwt_kwargs["default_scopes"] = cls.AUTH_SCOPES
- self_signed_jwt_kwargs["scopes"] = scopes
- self_signed_jwt_kwargs["default_host"] = cls.DEFAULT_HOST
- else:
- self_signed_jwt_kwargs["scopes"] = scopes or cls.AUTH_SCOPES
-
- return self_signed_jwt_kwargs
-
def _prep_wrapped_messages(self, client_info):
# Precompute the wrapped methods.
self._wrapped_methods = {
diff --git a/google/cloud/tasks_v2beta2/services/cloud_tasks/transports/grpc.py b/google/cloud/tasks_v2beta2/services/cloud_tasks/transports/grpc.py
index 72838fc7..100d45b1 100644
--- a/google/cloud/tasks_v2beta2/services/cloud_tasks/transports/grpc.py
+++ b/google/cloud/tasks_v2beta2/services/cloud_tasks/transports/grpc.py
@@ -65,6 +65,7 @@ def __init__(
client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None,
quota_project_id: Optional[str] = None,
client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
+ always_use_jwt_access: Optional[bool] = False,
) -> None:
"""Instantiate the transport.
@@ -105,6 +106,8 @@ def __init__(
API requests. If ``None``, then default info will be used.
Generally, you only need to set this if you're developing
your own client library.
+ always_use_jwt_access (Optional[bool]): Whether self signed JWT should
+ be used for service account credentials.
Raises:
google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport
@@ -157,6 +160,7 @@ def __init__(
scopes=scopes,
quota_project_id=quota_project_id,
client_info=client_info,
+ always_use_jwt_access=always_use_jwt_access,
)
if not self._grpc_channel:
@@ -212,14 +216,14 @@ def create_channel(
and ``credentials_file`` are passed.
"""
- self_signed_jwt_kwargs = cls._get_self_signed_jwt_kwargs(host, scopes)
-
return grpc_helpers.create_channel(
host,
credentials=credentials,
credentials_file=credentials_file,
quota_project_id=quota_project_id,
- **self_signed_jwt_kwargs,
+ default_scopes=cls.AUTH_SCOPES,
+ scopes=scopes,
+ default_host=cls.DEFAULT_HOST,
**kwargs,
)
diff --git a/google/cloud/tasks_v2beta2/services/cloud_tasks/transports/grpc_asyncio.py b/google/cloud/tasks_v2beta2/services/cloud_tasks/transports/grpc_asyncio.py
index a5c5bea9..f371b59b 100644
--- a/google/cloud/tasks_v2beta2/services/cloud_tasks/transports/grpc_asyncio.py
+++ b/google/cloud/tasks_v2beta2/services/cloud_tasks/transports/grpc_asyncio.py
@@ -86,14 +86,14 @@ def create_channel(
aio.Channel: A gRPC AsyncIO channel object.
"""
- self_signed_jwt_kwargs = cls._get_self_signed_jwt_kwargs(host, scopes)
-
return grpc_helpers_async.create_channel(
host,
credentials=credentials,
credentials_file=credentials_file,
quota_project_id=quota_project_id,
- **self_signed_jwt_kwargs,
+ default_scopes=cls.AUTH_SCOPES,
+ scopes=scopes,
+ default_host=cls.DEFAULT_HOST,
**kwargs,
)
@@ -111,6 +111,7 @@ def __init__(
client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None,
quota_project_id=None,
client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
+ always_use_jwt_access: Optional[bool] = False,
) -> None:
"""Instantiate the transport.
@@ -152,6 +153,8 @@ def __init__(
API requests. If ``None``, then default info will be used.
Generally, you only need to set this if you're developing
your own client library.
+ always_use_jwt_access (Optional[bool]): Whether self signed JWT should
+ be used for service account credentials.
Raises:
google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport
@@ -203,6 +206,7 @@ def __init__(
scopes=scopes,
quota_project_id=quota_project_id,
client_info=client_info,
+ always_use_jwt_access=always_use_jwt_access,
)
if not self._grpc_channel:
diff --git a/google/cloud/tasks_v2beta3/proto/cloudtasks.proto b/google/cloud/tasks_v2beta3/proto/cloudtasks.proto
deleted file mode 100644
index 81e2098d..00000000
--- a/google/cloud/tasks_v2beta3/proto/cloudtasks.proto
+++ /dev/null
@@ -1,666 +0,0 @@
-// Copyright 2020 Google LLC
-//
-// 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.
-
-syntax = "proto3";
-
-package google.cloud.tasks.v2beta3;
-
-import "google/api/annotations.proto";
-import "google/api/client.proto";
-import "google/api/field_behavior.proto";
-import "google/api/resource.proto";
-import "google/cloud/tasks/v2beta3/queue.proto";
-import "google/cloud/tasks/v2beta3/task.proto";
-import "google/iam/v1/iam_policy.proto";
-import "google/iam/v1/policy.proto";
-import "google/protobuf/empty.proto";
-import "google/protobuf/field_mask.proto";
-
-option go_package = "google.golang.org/genproto/googleapis/cloud/tasks/v2beta3;tasks";
-option java_multiple_files = true;
-option java_outer_classname = "CloudTasksProto";
-option java_package = "com.google.cloud.tasks.v2beta3";
-option objc_class_prefix = "TASKS";
-
-// Cloud Tasks allows developers to manage the execution of background
-// work in their applications.
-service CloudTasks {
- option (google.api.default_host) = "cloudtasks.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
-
- // Lists queues.
- //
- // Queues are returned in lexicographical order.
- rpc ListQueues(ListQueuesRequest) returns (ListQueuesResponse) {
- option (google.api.http) = {
- get: "/v2beta3/{parent=projects/*/locations/*}/queues"
- };
- option (google.api.method_signature) = "parent";
- }
-
- // Gets a queue.
- rpc GetQueue(GetQueueRequest) returns (Queue) {
- option (google.api.http) = {
- get: "/v2beta3/{name=projects/*/locations/*/queues/*}"
- };
- option (google.api.method_signature) = "name";
- }
-
- // 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.
- rpc CreateQueue(CreateQueueRequest) returns (Queue) {
- option (google.api.http) = {
- post: "/v2beta3/{parent=projects/*/locations/*}/queues"
- body: "queue"
- };
- option (google.api.method_signature) = "parent,queue";
- }
-
- // 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.
- rpc UpdateQueue(UpdateQueueRequest) returns (Queue) {
- option (google.api.http) = {
- patch: "/v2beta3/{queue.name=projects/*/locations/*/queues/*}"
- body: "queue"
- };
- option (google.api.method_signature) = "queue,update_mask";
- }
-
- // 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
- // 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.
- rpc DeleteQueue(DeleteQueueRequest) returns (google.protobuf.Empty) {
- option (google.api.http) = {
- delete: "/v2beta3/{name=projects/*/locations/*/queues/*}"
- };
- option (google.api.method_signature) = "name";
- }
-
- // 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.
- rpc PurgeQueue(PurgeQueueRequest) returns (Queue) {
- option (google.api.http) = {
- post: "/v2beta3/{name=projects/*/locations/*/queues/*}:purge"
- body: "*"
- };
- option (google.api.method_signature) = "name";
- }
-
- // Pauses the queue.
- //
- // If a queue is paused then the system will stop dispatching tasks
- // until the queue is resumed via
- // [ResumeQueue][google.cloud.tasks.v2beta3.CloudTasks.ResumeQueue]. Tasks can still be added
- // when the queue is paused. A queue is paused if its
- // [state][google.cloud.tasks.v2beta3.Queue.state] is [PAUSED][google.cloud.tasks.v2beta3.Queue.State.PAUSED].
- rpc PauseQueue(PauseQueueRequest) returns (Queue) {
- option (google.api.http) = {
- post: "/v2beta3/{name=projects/*/locations/*/queues/*}:pause"
- body: "*"
- };
- option (google.api.method_signature) = "name";
- }
-
- // Resume a queue.
- //
- // This method resumes a queue after it has been
- // [PAUSED][google.cloud.tasks.v2beta3.Queue.State.PAUSED] or
- // [DISABLED][google.cloud.tasks.v2beta3.Queue.State.DISABLED]. The state of a queue is stored
- // in the queue's [state][google.cloud.tasks.v2beta3.Queue.state]; after calling this method it
- // will be set to [RUNNING][google.cloud.tasks.v2beta3.Queue.State.RUNNING].
- //
- // WARNING: Resuming many high-QPS queues at the same time can
- // lead to target overloading. If you are resuming high-QPS
- // queues, follow the 500/50/5 pattern described in
- // [Managing Cloud Tasks Scaling
- // Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
- rpc ResumeQueue(ResumeQueueRequest) returns (Queue) {
- option (google.api.http) = {
- post: "/v2beta3/{name=projects/*/locations/*/queues/*}:resume"
- body: "*"
- };
- option (google.api.method_signature) = "name";
- }
-
- // Gets the access control policy for a [Queue][google.cloud.tasks.v2beta3.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`
- rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest) returns (google.iam.v1.Policy) {
- option (google.api.http) = {
- post: "/v2beta3/{resource=projects/*/locations/*/queues/*}:getIamPolicy"
- body: "*"
- };
- option (google.api.method_signature) = "resource";
- }
-
- // Sets the access control policy for a [Queue][google.cloud.tasks.v2beta3.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`
- rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest) returns (google.iam.v1.Policy) {
- option (google.api.http) = {
- post: "/v2beta3/{resource=projects/*/locations/*/queues/*}:setIamPolicy"
- body: "*"
- };
- option (google.api.method_signature) = "resource,policy";
- }
-
- // Returns permissions that a caller has on a [Queue][google.cloud.tasks.v2beta3.Queue].
- // If the resource does not exist, this will return an empty set of
- // permissions, not a [NOT_FOUND][google.rpc.Code.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.
- rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest) returns (google.iam.v1.TestIamPermissionsResponse) {
- option (google.api.http) = {
- post: "/v2beta3/{resource=projects/*/locations/*/queues/*}:testIamPermissions"
- body: "*"
- };
- option (google.api.method_signature) = "resource,permissions";
- }
-
- // Lists the tasks in a queue.
- //
- // By default, only the [BASIC][google.cloud.tasks.v2beta3.Task.View.BASIC] view is retrieved
- // due to performance considerations;
- // [response_view][google.cloud.tasks.v2beta3.ListTasksRequest.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.
- rpc ListTasks(ListTasksRequest) returns (ListTasksResponse) {
- option (google.api.http) = {
- get: "/v2beta3/{parent=projects/*/locations/*/queues/*}/tasks"
- };
- option (google.api.method_signature) = "parent";
- }
-
- // Gets a task.
- rpc GetTask(GetTaskRequest) returns (Task) {
- option (google.api.http) = {
- get: "/v2beta3/{name=projects/*/locations/*/queues/*/tasks/*}"
- };
- option (google.api.method_signature) = "name";
- }
-
- // Creates a task and adds it to a queue.
- //
- // Tasks cannot be updated after creation; there is no UpdateTask command.
- //
- // * The maximum task size is 100KB.
- rpc CreateTask(CreateTaskRequest) returns (Task) {
- option (google.api.http) = {
- post: "/v2beta3/{parent=projects/*/locations/*/queues/*}/tasks"
- body: "*"
- };
- option (google.api.method_signature) = "parent,task";
- }
-
- // Deletes a task.
- //
- // A task can be deleted if it is scheduled or dispatched. A task
- // cannot be deleted if it has executed successfully or permanently
- // failed.
- rpc DeleteTask(DeleteTaskRequest) returns (google.protobuf.Empty) {
- option (google.api.http) = {
- delete: "/v2beta3/{name=projects/*/locations/*/queues/*/tasks/*}"
- };
- option (google.api.method_signature) = "name";
- }
-
- // 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][google.cloud.tasks.v2beta3.RateLimits] or
- // is [PAUSED][google.cloud.tasks.v2beta3.Queue.State.PAUSED].
- //
- // This command is meant to be used for manual debugging. For
- // example, [RunTask][google.cloud.tasks.v2beta3.CloudTasks.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][Task.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][google.cloud.tasks.v2beta3.Task.schedule_time] will be reset to the time that
- // [RunTask][google.cloud.tasks.v2beta3.CloudTasks.RunTask] was called plus the retry delay specified
- // in the queue's [RetryConfig][google.cloud.tasks.v2beta3.RetryConfig].
- //
- // [RunTask][google.cloud.tasks.v2beta3.CloudTasks.RunTask] returns
- // [NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a
- // task that has already succeeded or permanently failed.
- rpc RunTask(RunTaskRequest) returns (Task) {
- option (google.api.http) = {
- post: "/v2beta3/{name=projects/*/locations/*/queues/*/tasks/*}:run"
- body: "*"
- };
- option (google.api.method_signature) = "name";
- }
-}
-
-// Request message for [ListQueues][google.cloud.tasks.v2beta3.CloudTasks.ListQueues].
-message ListQueuesRequest {
- // Required. The location name.
- // For example: `projects/PROJECT_ID/locations/LOCATION_ID`
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- child_type: "cloudtasks.googleapis.com/Queue"
- }
- ];
-
- // `filter` can be used to specify a subset of queues. Any [Queue][google.cloud.tasks.v2beta3.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 "state: PAUSED".
- //
- // Note that using filters might cause fewer queues than the
- // requested page_size to be returned.
- string filter = 2;
-
- // 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][google.cloud.tasks.v2beta3.ListQueuesResponse.next_page_token] in the
- // response to determine if more queues exist.
- int32 page_size = 3;
-
- // 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][google.cloud.tasks.v2beta3.ListQueuesResponse.next_page_token] returned
- // from the previous call to [ListQueues][google.cloud.tasks.v2beta3.CloudTasks.ListQueues]
- // method. It is an error to switch the value of the
- // [filter][google.cloud.tasks.v2beta3.ListQueuesRequest.filter] while iterating through pages.
- string page_token = 4;
-
- // 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]. [Queue.stats] will be returned only if it was explicitly
- // specified in the mask.
- google.protobuf.FieldMask read_mask = 5 [(google.api.field_behavior) = OPTIONAL];
-}
-
-// Response message for [ListQueues][google.cloud.tasks.v2beta3.CloudTasks.ListQueues].
-message ListQueuesResponse {
- // The list of queues.
- repeated Queue queues = 1;
-
- // A token to retrieve next page of results.
- //
- // To return the next page of results, call
- // [ListQueues][google.cloud.tasks.v2beta3.CloudTasks.ListQueues] with this value as the
- // [page_token][google.cloud.tasks.v2beta3.ListQueuesRequest.page_token].
- //
- // If the next_page_token is empty, there are no more results.
- //
- // The page token is valid for only 2 hours.
- string next_page_token = 2;
-}
-
-// Request message for [GetQueue][google.cloud.tasks.v2beta3.CloudTasks.GetQueue].
-message GetQueueRequest {
- // Required. The resource name of the queue. For example:
- // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "cloudtasks.googleapis.com/Queue"
- }
- ];
-
- // 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]. [Queue.stats] will be returned only if it was explicitly
- // specified in the mask.
- google.protobuf.FieldMask read_mask = 2 [(google.api.field_behavior) = OPTIONAL];
-}
-
-// Request message for [CreateQueue][google.cloud.tasks.v2beta3.CloudTasks.CreateQueue].
-message CreateQueueRequest {
- // 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][google.cloud.location.Locations.ListLocations].
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- child_type: "cloudtasks.googleapis.com/Queue"
- }
- ];
-
- // Required. The queue to create.
- //
- // [Queue's name][google.cloud.tasks.v2beta3.Queue.name] cannot be the same as an existing queue.
- Queue queue = 2 [(google.api.field_behavior) = REQUIRED];
-}
-
-// Request message for [UpdateQueue][google.cloud.tasks.v2beta3.CloudTasks.UpdateQueue].
-message UpdateQueueRequest {
- // Required. The queue to create or update.
- //
- // The queue's [name][google.cloud.tasks.v2beta3.Queue.name] must be specified.
- //
- // Output only fields cannot be modified using UpdateQueue.
- // Any value specified for an output only field will be ignored.
- // The queue's [name][google.cloud.tasks.v2beta3.Queue.name] cannot be changed.
- Queue queue = 1 [(google.api.field_behavior) = REQUIRED];
-
- // A mask used to specify which fields of the queue are being updated.
- //
- // If empty, then all fields will be updated.
- google.protobuf.FieldMask update_mask = 2;
-}
-
-// Request message for [DeleteQueue][google.cloud.tasks.v2beta3.CloudTasks.DeleteQueue].
-message DeleteQueueRequest {
- // Required. The queue name. For example:
- // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "cloudtasks.googleapis.com/Queue"
- }
- ];
-}
-
-// Request message for [PurgeQueue][google.cloud.tasks.v2beta3.CloudTasks.PurgeQueue].
-message PurgeQueueRequest {
- // Required. The queue name. For example:
- // `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "cloudtasks.googleapis.com/Queue"
- }
- ];
-}
-
-// Request message for [PauseQueue][google.cloud.tasks.v2beta3.CloudTasks.PauseQueue].
-message PauseQueueRequest {
- // Required. The queue name. For example:
- // `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "cloudtasks.googleapis.com/Queue"
- }
- ];
-}
-
-// Request message for [ResumeQueue][google.cloud.tasks.v2beta3.CloudTasks.ResumeQueue].
-message ResumeQueueRequest {
- // Required. The queue name. For example:
- // `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "cloudtasks.googleapis.com/Queue"
- }
- ];
-}
-
-// Request message for listing tasks using [ListTasks][google.cloud.tasks.v2beta3.CloudTasks.ListTasks].
-message ListTasksRequest {
- // Required. The queue name. For example:
- // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- child_type: "cloudtasks.googleapis.com/Task"
- }
- ];
-
- // The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta3.Task] will be
- // returned.
- //
- // By default response_view is [BASIC][google.cloud.tasks.v2beta3.Task.View.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][google.cloud.tasks.v2beta3.Task.View.FULL] requires
- // `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
- // permission on the [Task][google.cloud.tasks.v2beta3.Task] resource.
- Task.View response_view = 2;
-
- // Maximum page size.
- //
- // Fewer tasks than requested might be returned, even if more tasks exist; use
- // [next_page_token][google.cloud.tasks.v2beta3.ListTasksResponse.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.
- int32 page_size = 3;
-
- // 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][google.cloud.tasks.v2beta3.ListTasksResponse.next_page_token] returned
- // from the previous call to [ListTasks][google.cloud.tasks.v2beta3.CloudTasks.ListTasks]
- // method.
- //
- // The page token is valid for only 2 hours.
- string page_token = 4;
-}
-
-// Response message for listing tasks using [ListTasks][google.cloud.tasks.v2beta3.CloudTasks.ListTasks].
-message ListTasksResponse {
- // The list of tasks.
- repeated Task tasks = 1;
-
- // A token to retrieve next page of results.
- //
- // To return the next page of results, call
- // [ListTasks][google.cloud.tasks.v2beta3.CloudTasks.ListTasks] with this value as the
- // [page_token][google.cloud.tasks.v2beta3.ListTasksRequest.page_token].
- //
- // If the next_page_token is empty, there are no more results.
- string next_page_token = 2;
-}
-
-// Request message for getting a task using [GetTask][google.cloud.tasks.v2beta3.CloudTasks.GetTask].
-message GetTaskRequest {
- // Required. The task name. For example:
- // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "cloudtasks.googleapis.com/Task"
- }
- ];
-
- // The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta3.Task] will be
- // returned.
- //
- // By default response_view is [BASIC][google.cloud.tasks.v2beta3.Task.View.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][google.cloud.tasks.v2beta3.Task.View.FULL] requires
- // `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
- // permission on the [Task][google.cloud.tasks.v2beta3.Task] resource.
- Task.View response_view = 2;
-}
-
-// Request message for [CreateTask][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
-message CreateTaskRequest {
- // Required. The queue name. For example:
- // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- //
- // The queue must already exist.
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- child_type: "cloudtasks.googleapis.com/Task"
- }
- ];
-
- // Required. The task to add.
- //
- // Task names have the following format:
- // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
- // The user can optionally specify a task [name][google.cloud.tasks.v2beta3.Task.name]. If a
- // name is not specified then the system will generate a random
- // unique task id, which will be set in the task returned in the
- // [response][google.cloud.tasks.v2beta3.Task.name].
- //
- // If [schedule_time][google.cloud.tasks.v2beta3.Task.schedule_time] is not set or is in the
- // past then Cloud Tasks will set it to the current time.
- //
- // Task De-duplication:
- //
- // Explicitly specifying a task ID enables task de-duplication. If
- // a task's ID is identical to that of an existing task or a task
- // that was deleted or executed recently then the call will fail
- // with [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS].
- // If the task's queue was created using Cloud Tasks, then another task with
- // the same name can't be created for ~1hour after the original task was
- // deleted or executed. If the task's queue was created using queue.yaml or
- // queue.xml, then another task with the same name can't be created
- // for ~9days after the original task was deleted or executed.
- //
- // Because there is an extra lookup cost to identify duplicate task
- // names, these [CreateTask][google.cloud.tasks.v2beta3.CloudTasks.CreateTask] calls have significantly
- // increased latency. Using hashed strings for the task id or for
- // the prefix of the task id is recommended. Choosing task ids that
- // are sequential or have sequential prefixes, for example using a
- // timestamp, causes an increase in latency and error rates in all
- // task commands. The infrastructure relies on an approximately
- // uniform distribution of task ids to store and serve tasks
- // efficiently.
- Task task = 2 [(google.api.field_behavior) = REQUIRED];
-
- // The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta3.Task] will be
- // returned.
- //
- // By default response_view is [BASIC][google.cloud.tasks.v2beta3.Task.View.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][google.cloud.tasks.v2beta3.Task.View.FULL] requires
- // `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
- // permission on the [Task][google.cloud.tasks.v2beta3.Task] resource.
- Task.View response_view = 3;
-}
-
-// Request message for deleting a task using
-// [DeleteTask][google.cloud.tasks.v2beta3.CloudTasks.DeleteTask].
-message DeleteTaskRequest {
- // Required. The task name. For example:
- // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "cloudtasks.googleapis.com/Task"
- }
- ];
-}
-
-// Request message for forcing a task to run now using
-// [RunTask][google.cloud.tasks.v2beta3.CloudTasks.RunTask].
-message RunTaskRequest {
- // Required. The task name. For example:
- // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "cloudtasks.googleapis.com/Task"
- }
- ];
-
- // The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta3.Task] will be
- // returned.
- //
- // By default response_view is [BASIC][google.cloud.tasks.v2beta3.Task.View.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][google.cloud.tasks.v2beta3.Task.View.FULL] requires
- // `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
- // permission on the [Task][google.cloud.tasks.v2beta3.Task] resource.
- Task.View response_view = 2;
-}
diff --git a/google/cloud/tasks_v2beta3/proto/queue.proto b/google/cloud/tasks_v2beta3/proto/queue.proto
deleted file mode 100644
index 2b042a12..00000000
--- a/google/cloud/tasks_v2beta3/proto/queue.proto
+++ /dev/null
@@ -1,435 +0,0 @@
-// Copyright 2020 Google LLC
-//
-// 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.
-
-syntax = "proto3";
-
-package google.cloud.tasks.v2beta3;
-
-import "google/api/field_behavior.proto";
-import "google/api/resource.proto";
-import "google/cloud/tasks/v2beta3/target.proto";
-import "google/protobuf/duration.proto";
-import "google/protobuf/timestamp.proto";
-import "google/api/annotations.proto";
-
-option go_package = "google.golang.org/genproto/googleapis/cloud/tasks/v2beta3;tasks";
-option java_multiple_files = true;
-option java_outer_classname = "QueueProto";
-option java_package = "com.google.cloud.tasks.v2beta3";
-
-// A queue is a container of related tasks. Queues are configured to manage
-// how those tasks are dispatched. Configurable properties include rate limits,
-// retry options, queue types, and others.
-message Queue {
- option (google.api.resource) = {
- type: "cloudtasks.googleapis.com/Queue"
- pattern: "projects/{project}/locations/{location}/queues/{queue}"
- };
-
- // State of the queue.
- enum State {
- // Unspecified state.
- STATE_UNSPECIFIED = 0;
-
- // The queue is running. Tasks can be dispatched.
- //
- // If the queue was created using Cloud Tasks and the queue has
- // had no activity (method calls or task dispatches) for 30 days,
- // the queue may take a few minutes to re-activate. Some method
- // calls may return [NOT_FOUND][google.rpc.Code.NOT_FOUND] and
- // tasks may not be dispatched for a few minutes until the queue
- // has been re-activated.
- RUNNING = 1;
-
- // Tasks are paused by the user. If the queue is paused then Cloud
- // Tasks will stop delivering tasks from it, but more tasks can
- // still be added to it by the user.
- PAUSED = 2;
-
- // The queue is disabled.
- //
- // A queue becomes `DISABLED` when
- // [queue.yaml](https://cloud.google.com/appengine/docs/python/config/queueref)
- // or
- // [queue.xml](https://cloud.google.com/appengine/docs/standard/java/config/queueref)
- // is uploaded which does not contain the queue. You cannot directly disable
- // a queue.
- //
- // When a queue is disabled, tasks can still be added to a queue
- // but the tasks are not dispatched.
- //
- // To permanently delete this queue and all of its tasks, call
- // [DeleteQueue][google.cloud.tasks.v2beta3.CloudTasks.DeleteQueue].
- DISABLED = 3;
- }
-
- // The type of the queue.
- enum Type {
- // Default value.
- TYPE_UNSPECIFIED = 0;
-
- // A pull queue.
- PULL = 1;
-
- // A push queue.
- PUSH = 2;
- }
-
- // Caller-specified and required in [CreateQueue][google.cloud.tasks.v2beta3.CloudTasks.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][google.cloud.location.Locations.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.
- string name = 1;
-
- oneof queue_type {
- // [AppEngineHttpQueue][google.cloud.tasks.v2beta3.AppEngineHttpQueue] settings apply only to
- // [App Engine tasks][google.cloud.tasks.v2beta3.AppEngineHttpRequest] in this queue.
- // [Http tasks][google.cloud.tasks.v2beta3.HttpRequest] are not affected by this proto.
- AppEngineHttpQueue app_engine_http_queue = 3;
- }
-
- // Rate limits for task dispatches.
- //
- // [rate_limits][google.cloud.tasks.v2beta3.Queue.rate_limits] and [retry_config][google.cloud.tasks.v2beta3.Queue.retry_config] are
- // related because they both control task attempts. However they control task
- // attempts in different ways:
- //
- // * [rate_limits][google.cloud.tasks.v2beta3.Queue.rate_limits] controls the total rate of
- // dispatches from a queue (i.e. all traffic dispatched from the
- // queue, regardless of whether the dispatch is from a first
- // attempt or a retry).
- // * [retry_config][google.cloud.tasks.v2beta3.Queue.retry_config] controls what happens to
- // particular a task after its first attempt fails. That is,
- // [retry_config][google.cloud.tasks.v2beta3.Queue.retry_config] controls task retries (the
- // second attempt, third attempt, etc).
- //
- // The queue's actual dispatch rate is the result of:
- //
- // * Number of tasks in the queue
- // * User-specified throttling: [rate_limits][google.cloud.tasks.v2beta3.Queue.rate_limits],
- // [retry_config][google.cloud.tasks.v2beta3.Queue.retry_config], and the
- // [queue's state][google.cloud.tasks.v2beta3.Queue.state].
- // * System throttling due to `429` (Too Many Requests) or `503` (Service
- // Unavailable) responses from the worker, high error rates, or to smooth
- // sudden large traffic spikes.
- RateLimits rate_limits = 4;
-
- // Settings that determine the retry behavior.
- //
- // * For tasks created using Cloud Tasks: the queue-level retry settings
- // apply to all tasks in the queue that were created using Cloud Tasks.
- // Retry settings cannot be set on individual tasks.
- // * For tasks created using the App Engine SDK: the queue-level retry
- // settings apply to all tasks in the queue which do not have retry settings
- // explicitly set on the task and were created by the App Engine SDK. See
- // [App Engine
- // documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
- RetryConfig retry_config = 5;
-
- // Output only. The state of the queue.
- //
- // `state` can only be changed by called
- // [PauseQueue][google.cloud.tasks.v2beta3.CloudTasks.PauseQueue],
- // [ResumeQueue][google.cloud.tasks.v2beta3.CloudTasks.ResumeQueue], or uploading
- // [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
- // [UpdateQueue][google.cloud.tasks.v2beta3.CloudTasks.UpdateQueue] cannot be used to change `state`.
- State state = 6;
-
- // Output only. The last time this queue was purged.
- //
- // All tasks that were [created][google.cloud.tasks.v2beta3.Task.create_time] before this time
- // were purged.
- //
- // A queue can be purged using [PurgeQueue][google.cloud.tasks.v2beta3.CloudTasks.PurgeQueue], the
- // [App Engine Task Queue SDK, or the Cloud
- // Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
- //
- // Purge time will be truncated to the nearest microsecond. Purge
- // time will be unset if the queue has never been purged.
- google.protobuf.Timestamp purge_time = 7;
-
- // The maximum amount of time that a task will be retained in
- // this queue.
- //
- // Queues created by Cloud Tasks have a default `task_ttl` of 31 days.
- // After a task has lived for `task_ttl`, the task will be deleted
- // regardless of whether it was dispatched or not.
- //
- // The `task_ttl` for queues created via queue.yaml/xml is equal to the
- // maximum duration because there is a
- // [storage quota](https://cloud.google.com/appengine/quotas#Task_Queue) for
- // these queues. To view the maximum valid duration, see the documentation for
- // [Duration][google.protobuf.Duration].
- google.protobuf.Duration task_ttl = 8;
-
- // The task tombstone time to live (TTL).
- //
- // After a task is deleted or executed, the task's tombstone is
- // retained for the length of time specified by `tombstone_ttl`.
- // The tombstone is used by task de-duplication; another task with the same
- // name can't be created until the tombstone has expired. For more information
- // about task de-duplication, see the documentation for
- // [CreateTaskRequest][google.cloud.tasks.v2beta3.CreateTaskRequest.task].
- //
- // Queues created by Cloud Tasks have a default `tombstone_ttl` of 1 hour.
- google.protobuf.Duration tombstone_ttl = 9;
-
- // Configuration options for writing logs to
- // [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
- // field is unset, then no logs are written.
- StackdriverLoggingConfig stackdriver_logging_config = 10;
-
- // Immutable. The type of a queue (push or pull).
- //
- // `Queue.type` is an immutable property of the queue that is set at the queue
- // creation time. When left unspecified, the default value of `PUSH` is
- // selected.
- Type type = 11 [(google.api.field_behavior) = IMMUTABLE];
-
- // Output only. The realtime, informational statistics for a queue. In order
- // to receive the statistics the caller should include this field in the
- // FieldMask.
- QueueStats stats = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
-}
-
-// Rate limits.
-//
-// This message determines the maximum rate that tasks can be dispatched by a
-// queue, regardless of whether the dispatch is a first task attempt or a retry.
-//
-// Note: The debugging command, [RunTask][google.cloud.tasks.v2beta3.CloudTasks.RunTask], will run a task
-// even if the queue has reached its [RateLimits][google.cloud.tasks.v2beta3.RateLimits].
-message RateLimits {
- // The maximum rate at which tasks are dispatched from this queue.
- //
- // If unspecified when the queue is created, Cloud Tasks will pick the
- // default.
- //
- // * For [App Engine queues][google.cloud.tasks.v2beta3.AppEngineHttpQueue], the maximum allowed value
- // is 500.
- //
- //
- // This field has the same meaning as
- // [rate in
- // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
- double max_dispatches_per_second = 1;
-
- // The max burst size.
- //
- // Max burst size limits how fast tasks in queue are processed when
- // many tasks are in the queue and the rate is high. This field
- // allows the queue to have a high rate so processing starts shortly
- // after a task is enqueued, but still limits resource usage when
- // many tasks are enqueued in a short period of time.
- //
- // The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
- // algorithm is used to control the rate of task dispatches. Each
- // queue has a token bucket that holds tokens, up to the maximum
- // specified by `max_burst_size`. Each time a task is dispatched, a
- // token is removed from the bucket. Tasks will be dispatched until
- // the queue's bucket runs out of tokens. The bucket will be
- // continuously refilled with new tokens based on
- // [max_dispatches_per_second][google.cloud.tasks.v2beta3.RateLimits.max_dispatches_per_second].
- //
- // The default value of `max_burst_size` is picked by Cloud Tasks
- // based on the value of
- // [max_dispatches_per_second][google.cloud.tasks.v2beta3.RateLimits.max_dispatches_per_second].
- //
- // The maximum value of `max_burst_size` is 500.
- //
- // For App Engine queues that were created or updated using
- // `queue.yaml/xml`, `max_burst_size` is equal to
- // [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
- // If
- // [UpdateQueue][google.cloud.tasks.v2beta3.CloudTasks.UpdateQueue] is called on a queue without
- // explicitly setting a value for `max_burst_size`,
- // `max_burst_size` value will get updated if
- // [UpdateQueue][google.cloud.tasks.v2beta3.CloudTasks.UpdateQueue] is updating
- // [max_dispatches_per_second][google.cloud.tasks.v2beta3.RateLimits.max_dispatches_per_second].
- //
- int32 max_burst_size = 2;
-
- // The maximum number of concurrent tasks that Cloud Tasks allows
- // to be dispatched for this queue. After this threshold has been
- // reached, Cloud Tasks stops dispatching tasks until the number of
- // concurrent requests decreases.
- //
- // If unspecified when the queue is created, Cloud Tasks will pick the
- // default.
- //
- //
- // The maximum allowed value is 5,000.
- //
- //
- // This field has the same meaning as
- // [max_concurrent_requests in
- // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
- int32 max_concurrent_dispatches = 3;
-}
-
-// Retry config.
-//
-// These settings determine when a failed task attempt is retried.
-message RetryConfig {
- // Number of attempts per task.
- //
- // Cloud Tasks will attempt the task `max_attempts` times (that is, if the
- // first attempt fails, then there will be `max_attempts - 1` retries). Must
- // be >= -1.
- //
- // If unspecified when the queue is created, Cloud Tasks will pick the
- // default.
- //
- // -1 indicates unlimited attempts.
- //
- // This field has the same meaning as
- // [task_retry_limit in
- // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- int32 max_attempts = 1;
-
- // If positive, `max_retry_duration` specifies the time limit for
- // retrying a failed task, measured from when the task was first
- // attempted. Once `max_retry_duration` time has passed *and* the
- // task has been attempted [max_attempts][google.cloud.tasks.v2beta3.RetryConfig.max_attempts]
- // times, no further attempts will be made and the task will be
- // deleted.
- //
- // If zero, then the task age is unlimited.
- //
- // If unspecified when the queue is created, Cloud Tasks will pick the
- // default.
- //
- //
- // `max_retry_duration` will be truncated to the nearest second.
- //
- // This field has the same meaning as
- // [task_age_limit in
- // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- google.protobuf.Duration max_retry_duration = 2;
-
- // A task will be [scheduled][google.cloud.tasks.v2beta3.Task.schedule_time] for retry between
- // [min_backoff][google.cloud.tasks.v2beta3.RetryConfig.min_backoff] and
- // [max_backoff][google.cloud.tasks.v2beta3.RetryConfig.max_backoff] duration after it fails,
- // if the queue's [RetryConfig][google.cloud.tasks.v2beta3.RetryConfig] specifies that the task should be
- // retried.
- //
- // If unspecified when the queue is created, Cloud Tasks will pick the
- // default.
- //
- //
- // `min_backoff` will be truncated to the nearest second.
- //
- // This field has the same meaning as
- // [min_backoff_seconds in
- // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- google.protobuf.Duration min_backoff = 3;
-
- // A task will be [scheduled][google.cloud.tasks.v2beta3.Task.schedule_time] for retry between
- // [min_backoff][google.cloud.tasks.v2beta3.RetryConfig.min_backoff] and
- // [max_backoff][google.cloud.tasks.v2beta3.RetryConfig.max_backoff] duration after it fails,
- // if the queue's [RetryConfig][google.cloud.tasks.v2beta3.RetryConfig] specifies that the task should be
- // retried.
- //
- // If unspecified when the queue is created, Cloud Tasks will pick the
- // default.
- //
- //
- // `max_backoff` will be truncated to the nearest second.
- //
- // This field has the same meaning as
- // [max_backoff_seconds in
- // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- google.protobuf.Duration max_backoff = 4;
-
- // The time between retries will double `max_doublings` times.
- //
- // A task's retry interval starts at
- // [min_backoff][google.cloud.tasks.v2beta3.RetryConfig.min_backoff], then doubles
- // `max_doublings` times, then increases linearly, and finally
- // retries at intervals of
- // [max_backoff][google.cloud.tasks.v2beta3.RetryConfig.max_backoff] up to
- // [max_attempts][google.cloud.tasks.v2beta3.RetryConfig.max_attempts] times.
- //
- // For example, if [min_backoff][google.cloud.tasks.v2beta3.RetryConfig.min_backoff] is 10s,
- // [max_backoff][google.cloud.tasks.v2beta3.RetryConfig.max_backoff] is 300s, and
- // `max_doublings` is 3, then the a task will first be retried in
- // 10s. The retry interval will double three times, and then
- // increase linearly by 2^3 * 10s. Finally, the task will retry at
- // intervals of [max_backoff][google.cloud.tasks.v2beta3.RetryConfig.max_backoff] until the
- // task has been attempted [max_attempts][google.cloud.tasks.v2beta3.RetryConfig.max_attempts]
- // times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s,
- // 240s, 300s, 300s, ....
- //
- // If unspecified when the queue is created, Cloud Tasks will pick the
- // default.
- //
- //
- // This field has the same meaning as
- // [max_doublings in
- // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- int32 max_doublings = 5;
-}
-
-// Configuration options for writing logs to
-// [Stackdriver Logging](https://cloud.google.com/logging/docs/).
-message StackdriverLoggingConfig {
- // Specifies the fraction of operations to write to
- // [Stackdriver Logging](https://cloud.google.com/logging/docs/).
- // This field may contain any value between 0.0 and 1.0, inclusive.
- // 0.0 is the default and means that no operations are logged.
- double sampling_ratio = 1;
-}
-
-// Statistics for a queue.
-message QueueStats {
- // Output only. An estimation of the number of tasks in the queue, that is, the tasks in
- // the queue that haven't been executed, the tasks in the queue which the
- // queue has dispatched but has not yet received a reply for, and the failed
- // tasks that the queue is retrying.
- int64 tasks_count = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. An estimation of the nearest time in the future where a task in the queue
- // is scheduled to be executed.
- google.protobuf.Timestamp oldest_estimated_arrival_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The number of tasks that the queue has dispatched and received a reply for
- // during the last minute. This variable counts both successful and
- // non-successful executions.
- int64 executed_last_minute_count = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The number of requests that the queue has dispatched but has not received
- // a reply for yet.
- int64 concurrent_dispatches_count = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // Output only. The current maximum number of tasks per second executed by the queue.
- // The maximum value of this variable is controlled by the RateLimits of the
- // Queue. However, this value could be less to avoid overloading the endpoints
- // tasks in the queue are targeting.
- double effective_execution_rate = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
-}
diff --git a/google/cloud/tasks_v2beta3/proto/target.proto b/google/cloud/tasks_v2beta3/proto/target.proto
deleted file mode 100644
index 5ef1ee08..00000000
--- a/google/cloud/tasks_v2beta3/proto/target.proto
+++ /dev/null
@@ -1,460 +0,0 @@
-// Copyright 2020 Google LLC
-//
-// 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.
-
-syntax = "proto3";
-
-package google.cloud.tasks.v2beta3;
-
-import "google/api/annotations.proto";
-
-option go_package = "google.golang.org/genproto/googleapis/cloud/tasks/v2beta3;tasks";
-option java_multiple_files = true;
-option java_outer_classname = "TargetProto";
-option java_package = "com.google.cloud.tasks.v2beta3";
-
-// Pull Message.
-//
-// This proto can only be used for tasks in a queue which has
-// [PULL][google.cloud.tasks.v2beta3.Queue.type] type. It currently exists for backwards compatibility with
-// the App Engine Task Queue SDK. This message type maybe returned with methods
-// [list][google.cloud.tasks.v2beta3.CloudTask.ListTasks] and
-// [get][google.cloud.tasks.v2beta3.CloudTask.ListTasks], when the response view
-// is [FULL][google.cloud.tasks.v2beta3.Task.View.Full].
-message PullMessage {
- // A data payload consumed by the worker to execute the task.
- bytes payload = 1;
-
- // The tasks's tag.
- //
- // The tag is less than 500 characters.
- //
- // SDK compatibility: Although the SDK allows tags to be either
- // string or
- // [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
- // only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8
- // encoded, the tag will be empty when the task is returned by Cloud Tasks.
- string tag = 2;
-}
-
-// HTTP request.
-//
-// The task will be pushed to the worker as an HTTP request. If the worker
-// or the redirected worker acknowledges the task by returning a successful HTTP
-// response code ([`200` - `299`]), the task will be removed from the queue. If
-// any other HTTP response code is returned or no response is received, the
-// task will be retried according to the following:
-//
-// * User-specified throttling: [retry configuration][google.cloud.tasks.v2beta3.Queue.retry_config],
-// [rate limits][google.cloud.tasks.v2beta3.Queue.rate_limits], and the [queue's state][google.cloud.tasks.v2beta3.Queue.state].
-//
-// * System throttling: To prevent the worker from overloading, Cloud Tasks may
-// temporarily reduce the queue's effective rate. User-specified settings
-// will not be changed.
-//
-// System throttling happens because:
-//
-// * Cloud Tasks backs off on all errors. Normally the backoff specified in
-// [rate limits][google.cloud.tasks.v2beta3.Queue.rate_limits] will be used. But if the worker returns
-// `429` (Too Many Requests), `503` (Service Unavailable), or the rate of
-// errors is high, Cloud Tasks will use a higher backoff rate. The retry
-// specified in the `Retry-After` HTTP response header is considered.
-//
-// * To prevent traffic spikes and to smooth sudden increases in traffic,
-// dispatches ramp up slowly when the queue is newly created or idle and
-// if large numbers of tasks suddenly become available to dispatch (due to
-// spikes in create task rates, the queue being unpaused, or many tasks
-// that are scheduled at the same time).
-message HttpRequest {
- // Required. The full url path that the request will be sent to.
- //
- // This string must begin with either "http://" or "https://". Some examples
- // are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will
- // encode some characters for safety and compatibility. The maximum allowed
- // URL length is 2083 characters after encoding.
- //
- // The `Location` header response from a redirect response [`300` - `399`]
- // may be followed. The redirect is not counted as a separate attempt.
- string url = 1;
-
- // The HTTP method to use for the request. The default is POST.
- HttpMethod http_method = 2;
-
- // HTTP request headers.
- //
- // This map contains the header field names and values.
- // Headers can be set when the
- // [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
- //
- // These headers represent a subset of the headers that will accompany the
- // task's HTTP request. Some HTTP request headers will be ignored or replaced.
- //
- // A partial list of headers that will be ignored or replaced is:
- //
- // * Host: This will be computed by Cloud Tasks and derived from
- // [HttpRequest.url][google.cloud.tasks.v2beta3.HttpRequest.url].
- // * Content-Length: This will be computed by Cloud Tasks.
- // * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
- // * X-Google-*: Google use only.
- // * X-AppEngine-*: Google use only.
- //
- // `Content-Type` won't be set by Cloud Tasks. You can explicitly set
- // `Content-Type` to a media type when the
- // [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
- // For example, `Content-Type` can be set to `"application/octet-stream"` or
- // `"application/json"`.
- //
- // Headers which can have multiple values (according to RFC2616) can be
- // specified using comma-separated values.
- //
- // The size of the headers must be less than 80KB.
- map headers = 3;
-
- // HTTP request body.
- //
- // A request body is allowed only if the
- // [HTTP method][google.cloud.tasks.v2beta3.HttpRequest.http_method] is POST, PUT, or PATCH. It is an
- // error to set body on a task with an incompatible [HttpMethod][google.cloud.tasks.v2beta3.HttpMethod].
- bytes body = 4;
-
- // The mode for generating an `Authorization` header for HTTP requests.
- //
- // If specified, all `Authorization` headers in the [HttpRequest.headers][google.cloud.tasks.v2beta3.HttpRequest.headers]
- // field will be overridden.
- oneof authorization_header {
- // If specified, an
- // [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
- // will be generated and attached as an `Authorization` header in the HTTP
- // request.
- //
- // This type of authorization should generally only be used when calling
- // Google APIs hosted on *.googleapis.com.
- OAuthToken oauth_token = 5;
-
- // If specified, an
- // [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
- // token will be generated and attached as an `Authorization` header in the
- // HTTP request.
- //
- // This type of authorization can be used for many scenarios, including
- // calling Cloud Run, or endpoints where you intend to validate the token
- // yourself.
- OidcToken oidc_token = 6;
- }
-}
-
-// App Engine HTTP queue.
-//
-// The task will be delivered to the App Engine application hostname
-// specified by its [AppEngineHttpQueue][google.cloud.tasks.v2beta3.AppEngineHttpQueue] and [AppEngineHttpRequest][google.cloud.tasks.v2beta3.AppEngineHttpRequest].
-// The documentation for [AppEngineHttpRequest][google.cloud.tasks.v2beta3.AppEngineHttpRequest] explains how the
-// task's host URL is constructed.
-//
-// Using [AppEngineHttpQueue][google.cloud.tasks.v2beta3.AppEngineHttpQueue] requires
-// [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
-// Google IAM permission for the project
-// and the following scope:
-//
-// `https://www.googleapis.com/auth/cloud-platform`
-message AppEngineHttpQueue {
- // Overrides for the
- // [task-level app_engine_routing][google.cloud.tasks.v2beta3.AppEngineHttpRequest.app_engine_routing].
- //
- // If set, `app_engine_routing_override` is used for all tasks in
- // the queue, no matter what the setting is for the
- // [task-level app_engine_routing][google.cloud.tasks.v2beta3.AppEngineHttpRequest.app_engine_routing].
- AppEngineRouting app_engine_routing_override = 1;
-}
-
-// App Engine HTTP request.
-//
-// The message defines the HTTP request that is sent to an App Engine app when
-// the task is dispatched.
-//
-// Using [AppEngineHttpRequest][google.cloud.tasks.v2beta3.AppEngineHttpRequest] requires
-// [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
-// Google IAM permission for the project
-// and the following scope:
-//
-// `https://www.googleapis.com/auth/cloud-platform`
-//
-// The task will be delivered to the App Engine app which belongs to the same
-// project as the queue. For more information, see
-// [How Requests are
-// Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
-// and how routing is affected by
-// [dispatch
-// files](https://cloud.google.com/appengine/docs/python/config/dispatchref).
-// Traffic is encrypted during transport and never leaves Google datacenters.
-// Because this traffic is carried over a communication mechanism internal to
-// Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS).
-// The request to the handler, however, will appear to have used the HTTP
-// protocol.
-//
-// The [AppEngineRouting][google.cloud.tasks.v2beta3.AppEngineRouting] used to construct the URL that the task is
-// delivered to can be set at the queue-level or task-level:
-//
-// * If set,
-// [app_engine_routing_override][google.cloud.tasks.v2beta3.AppEngineHttpQueue.app_engine_routing_override]
-// is used for all tasks in the queue, no matter what the setting
-// is for the
-// [task-level app_engine_routing][google.cloud.tasks.v2beta3.AppEngineHttpRequest.app_engine_routing].
-//
-//
-// The `url` that the task will be sent to is:
-//
-// * `url =` [host][google.cloud.tasks.v2beta3.AppEngineRouting.host] `+`
-// [relative_uri][google.cloud.tasks.v2beta3.AppEngineHttpRequest.relative_uri]
-//
-// Tasks can be dispatched to secure app handlers, unsecure app handlers, and
-// URIs restricted with
-// [`login:
-// admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref).
-// Because tasks are not run as any user, they cannot be dispatched to URIs
-// restricted with
-// [`login:
-// required`](https://cloud.google.com/appengine/docs/standard/python/config/appref)
-// Task dispatches also do not follow redirects.
-//
-// The task attempt has succeeded if the app's request handler returns an HTTP
-// response code in the range [`200` - `299`]. The task attempt has failed if
-// the app's handler returns a non-2xx response code or Cloud Tasks does
-// not receive response before the [deadline][google.cloud.tasks.v2beta3.Task.dispatch_deadline]. Failed
-// tasks will be retried according to the
-// [retry configuration][google.cloud.tasks.v2beta3.Queue.retry_config]. `503` (Service Unavailable) is
-// considered an App Engine system error instead of an application error and
-// will cause Cloud Tasks' traffic congestion control to temporarily throttle
-// the queue's dispatches. Unlike other types of task targets, a `429` (Too Many
-// Requests) response from an app handler does not cause traffic congestion
-// control to throttle the queue.
-message AppEngineHttpRequest {
- // The HTTP method to use for the request. The default is POST.
- //
- // The app's request handler for the task's target URL must be able to handle
- // HTTP requests with this http_method, otherwise the task attempt fails with
- // error code 405 (Method Not Allowed). See [Writing a push task request
- // handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
- // and the App Engine documentation for your runtime on [How Requests are
- // Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
- HttpMethod http_method = 1;
-
- // Task-level setting for App Engine routing.
- //
- // If set,
- // [app_engine_routing_override][google.cloud.tasks.v2beta3.AppEngineHttpQueue.app_engine_routing_override]
- // is used for all tasks in the queue, no matter what the setting is for the
- // [task-level app_engine_routing][google.cloud.tasks.v2beta3.AppEngineHttpRequest.app_engine_routing].
- AppEngineRouting app_engine_routing = 2;
-
- // The relative URI.
- //
- // The relative URI must begin with "/" and must be a valid HTTP relative URI.
- // It can contain a path and query string arguments.
- // If the relative URI is empty, then the root path "/" will be used.
- // No spaces are allowed, and the maximum length allowed is 2083 characters.
- string relative_uri = 3;
-
- // HTTP request headers.
- //
- // This map contains the header field names and values.
- // Headers can be set when the
- // [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
- // Repeated headers are not supported but a header value can contain commas.
- //
- // Cloud Tasks sets some headers to default values:
- //
- // * `User-Agent`: By default, this header is
- // `"AppEngine-Google; (+http://code.google.com/appengine)"`.
- // This header can be modified, but Cloud Tasks will append
- // `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
- // modified `User-Agent`.
- //
- // If the task has a [body][google.cloud.tasks.v2beta3.AppEngineHttpRequest.body], Cloud
- // Tasks sets the following headers:
- //
- // * `Content-Type`: By default, the `Content-Type` header is set to
- // `"application/octet-stream"`. The default can be overridden by explicitly
- // setting `Content-Type` to a particular media type when the
- // [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
- // For example, `Content-Type` can be set to `"application/json"`.
- // * `Content-Length`: This is computed by Cloud Tasks. This value is
- // output only. It cannot be changed.
- //
- // The headers below cannot be set or overridden:
- //
- // * `Host`
- // * `X-Google-*`
- // * `X-AppEngine-*`
- //
- // In addition, Cloud Tasks sets some headers when the task is dispatched,
- // such as headers containing information about the task; see
- // [request
- // headers](https://cloud.google.com/tasks/docs/creating-appengine-handlers#reading_request_headers).
- // These headers are set only when the task is dispatched, so they are not
- // visible when the task is returned in a Cloud Tasks response.
- //
- // Although there is no specific limit for the maximum number of headers or
- // the size, there is a limit on the maximum size of the [Task][google.cloud.tasks.v2beta3.Task]. For more
- // information, see the [CreateTask][google.cloud.tasks.v2beta3.CloudTasks.CreateTask] documentation.
- map headers = 4;
-
- // HTTP request body.
- //
- // A request body is allowed only if the HTTP method is POST or PUT. It is
- // an error to set a body on a task with an incompatible [HttpMethod][google.cloud.tasks.v2beta3.HttpMethod].
- bytes body = 5;
-}
-
-// App Engine Routing.
-//
-// Defines routing characteristics specific to App Engine - service, version,
-// and instance.
-//
-// For more information about services, versions, and instances see
-// [An Overview of App
-// Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
-// [Microservices Architecture on Google App
-// Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
-// [App Engine Standard request
-// routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
-// and [App Engine Flex request
-// routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
-message AppEngineRouting {
- // App service.
- //
- // By default, the task is sent to the service which is the default
- // service when the task is attempted.
- //
- // For some queues or tasks which were created using the App Engine
- // Task Queue API, [host][google.cloud.tasks.v2beta3.AppEngineRouting.host] is not parsable
- // into [service][google.cloud.tasks.v2beta3.AppEngineRouting.service],
- // [version][google.cloud.tasks.v2beta3.AppEngineRouting.version], and
- // [instance][google.cloud.tasks.v2beta3.AppEngineRouting.instance]. For example, some tasks
- // which were created using the App Engine SDK use a custom domain
- // name; custom domains are not parsed by Cloud Tasks. If
- // [host][google.cloud.tasks.v2beta3.AppEngineRouting.host] is not parsable, then
- // [service][google.cloud.tasks.v2beta3.AppEngineRouting.service],
- // [version][google.cloud.tasks.v2beta3.AppEngineRouting.version], and
- // [instance][google.cloud.tasks.v2beta3.AppEngineRouting.instance] are the empty string.
- string service = 1;
-
- // App version.
- //
- // By default, the task is sent to the version which is the default
- // version when the task is attempted.
- //
- // For some queues or tasks which were created using the App Engine
- // Task Queue API, [host][google.cloud.tasks.v2beta3.AppEngineRouting.host] is not parsable
- // into [service][google.cloud.tasks.v2beta3.AppEngineRouting.service],
- // [version][google.cloud.tasks.v2beta3.AppEngineRouting.version], and
- // [instance][google.cloud.tasks.v2beta3.AppEngineRouting.instance]. For example, some tasks
- // which were created using the App Engine SDK use a custom domain
- // name; custom domains are not parsed by Cloud Tasks. If
- // [host][google.cloud.tasks.v2beta3.AppEngineRouting.host] is not parsable, then
- // [service][google.cloud.tasks.v2beta3.AppEngineRouting.service],
- // [version][google.cloud.tasks.v2beta3.AppEngineRouting.version], and
- // [instance][google.cloud.tasks.v2beta3.AppEngineRouting.instance] are the empty string.
- string version = 2;
-
- // App instance.
- //
- // By default, the task is sent to an instance which is available when
- // the task is attempted.
- //
- // Requests can only be sent to a specific instance if
- // [manual scaling is used in App Engine
- // Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
- // App Engine Flex does not support instances. For more information, see
- // [App Engine Standard request
- // routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
- // and [App Engine Flex request
- // routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- string instance = 3;
-
- // Output only. The host that the task is sent to.
- //
- // The host is constructed from the domain name of the app associated with
- // the queue's project ID (for example .appspot.com), and the
- // [service][google.cloud.tasks.v2beta3.AppEngineRouting.service], [version][google.cloud.tasks.v2beta3.AppEngineRouting.version],
- // and [instance][google.cloud.tasks.v2beta3.AppEngineRouting.instance]. Tasks which were created using
- // the App Engine SDK might have a custom domain name.
- //
- // For more information, see
- // [How Requests are
- // Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
- string host = 4;
-}
-
-// The HTTP method used to execute the task.
-enum HttpMethod {
- // HTTP method unspecified
- HTTP_METHOD_UNSPECIFIED = 0;
-
- // HTTP POST
- POST = 1;
-
- // HTTP GET
- GET = 2;
-
- // HTTP HEAD
- HEAD = 3;
-
- // HTTP PUT
- PUT = 4;
-
- // HTTP DELETE
- DELETE = 5;
-
- // HTTP PATCH
- PATCH = 6;
-
- // HTTP OPTIONS
- OPTIONS = 7;
-}
-
-// Contains information needed for generating an
-// [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
-// This type of authorization should generally only be used when calling Google
-// APIs hosted on *.googleapis.com.
-message OAuthToken {
- // [Service account email](https://cloud.google.com/iam/docs/service-accounts)
- // to be used for generating OAuth token.
- // The service account must be within the same project as the queue. The
- // caller must have iam.serviceAccounts.actAs permission for the service
- // account.
- string service_account_email = 1;
-
- // OAuth scope to be used for generating OAuth access token.
- // If not specified, "https://www.googleapis.com/auth/cloud-platform"
- // will be used.
- string scope = 2;
-}
-
-// Contains information needed for generating an
-// [OpenID Connect
-// token](https://developers.google.com/identity/protocols/OpenIDConnect).
-// This type of authorization can be used for many scenarios, including
-// calling Cloud Run, or endpoints where you intend to validate the token
-// yourself.
-message OidcToken {
- // [Service account email](https://cloud.google.com/iam/docs/service-accounts)
- // to be used for generating OIDC token.
- // The service account must be within the same project as the queue. The
- // caller must have iam.serviceAccounts.actAs permission for the service
- // account.
- string service_account_email = 1;
-
- // Audience to be used when generating OIDC token. If not specified, the URI
- // specified in target will be used.
- string audience = 2;
-}
diff --git a/google/cloud/tasks_v2beta3/proto/task.proto b/google/cloud/tasks_v2beta3/proto/task.proto
deleted file mode 100644
index 8a652566..00000000
--- a/google/cloud/tasks_v2beta3/proto/task.proto
+++ /dev/null
@@ -1,201 +0,0 @@
-// Copyright 2020 Google LLC
-//
-// 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.
-
-syntax = "proto3";
-
-package google.cloud.tasks.v2beta3;
-
-import "google/api/resource.proto";
-import "google/cloud/tasks/v2beta3/target.proto";
-import "google/protobuf/duration.proto";
-import "google/protobuf/timestamp.proto";
-import "google/rpc/status.proto";
-import "google/api/annotations.proto";
-
-option go_package = "google.golang.org/genproto/googleapis/cloud/tasks/v2beta3;tasks";
-option java_multiple_files = true;
-option java_outer_classname = "TaskProto";
-option java_package = "com.google.cloud.tasks.v2beta3";
-
-// A unit of scheduled work.
-message Task {
- option (google.api.resource) = {
- type: "cloudtasks.googleapis.com/Task"
- pattern: "projects/{project}/locations/{location}/queues/{queue}/tasks/{task}"
- };
-
- // The view specifies a subset of [Task][google.cloud.tasks.v2beta3.Task] data.
- //
- // When a task is returned in a response, 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.
- enum View {
- // Unspecified. Defaults to BASIC.
- VIEW_UNSPECIFIED = 0;
-
- // The basic view omits fields which can be large or can contain
- // sensitive data.
- //
- // This view does not include the
- // [body in AppEngineHttpRequest][google.cloud.tasks.v2beta3.AppEngineHttpRequest.body].
- // Bodies are desirable to return only when needed, because they
- // can be large and because of the sensitivity of the data that you
- // choose to store in it.
- BASIC = 1;
-
- // All information is returned.
- //
- // Authorization for [FULL][google.cloud.tasks.v2beta3.Task.View.FULL] requires
- // `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
- // permission on the [Queue][google.cloud.tasks.v2beta3.Queue] resource.
- FULL = 2;
- }
-
- // Optionally caller-specified in [CreateTask][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
- //
- // The task name.
- //
- // The task name must have the following format:
- // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_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 task's location.
- // The list of available locations can be obtained by calling
- // [ListLocations][google.cloud.location.Locations.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.
- // * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
- // hyphens (-), or underscores (_). The maximum length is 500 characters.
- string name = 1;
-
- // Required. The message to send to the worker.
- oneof payload_type {
- // HTTP request that is sent to the App Engine app handler.
- //
- // An App Engine task is a task that has [AppEngineHttpRequest][google.cloud.tasks.v2beta3.AppEngineHttpRequest] set.
- AppEngineHttpRequest app_engine_http_request = 3;
-
- // HTTP request that is sent to the task's target.
- //
- // An HTTP task is a task that has [HttpRequest][google.cloud.tasks.v2beta3.HttpRequest] set.
- HttpRequest http_request = 11;
-
- // Pull Message contained in a task in a [PULL][google.cloud.tasks.v2beta3.Queue.type] queue type. This
- // payload type cannot be explicitly set through Cloud Tasks API. Its
- // purpose, currently is to provide backward compatibility with App Engine
- // Task Queue
- // [pull](https://cloud.google.com/appengine/docs/standard/java/taskqueue/pull/)
- // queues to provide a way to inspect contents of pull tasks through the
- // [CloudTasks.GetTask][google.cloud.tasks.v2beta3.CloudTasks.GetTask].
- PullMessage pull_message = 13;
- }
-
- // The time when the task is scheduled to be attempted.
- //
- // For App Engine queues, this is when the task will be attempted or retried.
- //
- // `schedule_time` will be truncated to the nearest microsecond.
- google.protobuf.Timestamp schedule_time = 4;
-
- // Output only. The time that the task was created.
- //
- // `create_time` will be truncated to the nearest second.
- google.protobuf.Timestamp create_time = 5;
-
- // The deadline for requests sent to the worker. If the worker does not
- // respond by this deadline then the request is cancelled and the attempt
- // is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the
- // task according to the [RetryConfig][google.cloud.tasks.v2beta3.RetryConfig].
- //
- // Note that when the request is cancelled, Cloud Tasks will stop listening
- // for the response, but whether the worker stops processing depends on the
- // worker. For example, if the worker is stuck, it may not react to cancelled
- // requests.
- //
- // The default and maximum values depend on the type of request:
- //
- // * For [HTTP tasks][google.cloud.tasks.v2beta3.HttpRequest], the default is 10 minutes. The deadline
- // must be in the interval [15 seconds, 30 minutes].
- //
- // * For [App Engine tasks][google.cloud.tasks.v2beta3.AppEngineHttpRequest], 0 indicates that the
- // request has the default deadline. The default deadline depends on the
- // [scaling
- // type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)
- // of the service: 10 minutes for standard apps with automatic scaling, 24
- // hours for standard apps with manual and basic scaling, and 60 minutes for
- // flex apps. If the request deadline is set, it must be in the interval [15
- // seconds, 24 hours 15 seconds]. Regardless of the task's
- // `dispatch_deadline`, the app handler will not run for longer than than
- // the service's timeout. We recommend setting the `dispatch_deadline` to
- // at most a few seconds more than the app handler's timeout. For more
- // information see
- // [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).
- //
- // `dispatch_deadline` will be truncated to the nearest millisecond. The
- // deadline is an approximate deadline.
- google.protobuf.Duration dispatch_deadline = 12;
-
- // Output only. The number of attempts dispatched.
- //
- // This count includes attempts which have been dispatched but haven't
- // received a response.
- int32 dispatch_count = 6;
-
- // Output only. The number of attempts which have received a response.
- int32 response_count = 7;
-
- // Output only. The status of the task's first attempt.
- //
- // Only [dispatch_time][google.cloud.tasks.v2beta3.Attempt.dispatch_time] will be set.
- // The other [Attempt][google.cloud.tasks.v2beta3.Attempt] information is not retained by Cloud Tasks.
- Attempt first_attempt = 8;
-
- // Output only. The status of the task's last attempt.
- Attempt last_attempt = 9;
-
- // Output only. The view specifies which subset of the [Task][google.cloud.tasks.v2beta3.Task] has
- // been returned.
- View view = 10;
-}
-
-// The status of a task attempt.
-message Attempt {
- // Output only. The time that this attempt was scheduled.
- //
- // `schedule_time` will be truncated to the nearest microsecond.
- google.protobuf.Timestamp schedule_time = 1;
-
- // Output only. The time that this attempt was dispatched.
- //
- // `dispatch_time` will be truncated to the nearest microsecond.
- google.protobuf.Timestamp dispatch_time = 2;
-
- // Output only. The time that this attempt response was received.
- //
- // `response_time` will be truncated to the nearest microsecond.
- google.protobuf.Timestamp response_time = 3;
-
- // Output only. The response from the worker for this attempt.
- //
- // If `response_time` is unset, then the task has not been attempted or is
- // currently running and the `response_status` field is meaningless.
- google.rpc.Status response_status = 4;
-}
diff --git a/google/cloud/tasks_v2beta3/services/cloud_tasks/transports/base.py b/google/cloud/tasks_v2beta3/services/cloud_tasks/transports/base.py
index 5c331ac6..cc7d0b7a 100644
--- a/google/cloud/tasks_v2beta3/services/cloud_tasks/transports/base.py
+++ b/google/cloud/tasks_v2beta3/services/cloud_tasks/transports/base.py
@@ -24,6 +24,7 @@
from google.api_core import gapic_v1 # type: ignore
from google.api_core import retry as retries # type: ignore
from google.auth import credentials as ga_credentials # type: ignore
+from google.oauth2 import service_account # type: ignore
from google.cloud.tasks_v2beta3.types import cloudtasks
from google.cloud.tasks_v2beta3.types import queue
@@ -50,8 +51,6 @@
except pkg_resources.DistributionNotFound: # pragma: NO COVER
_GOOGLE_AUTH_VERSION = None
-_API_CORE_VERSION = google.api_core.__version__
-
class CloudTasksTransport(abc.ABC):
"""Abstract transport class for CloudTasks."""
@@ -69,6 +68,7 @@ def __init__(
scopes: Optional[Sequence[str]] = None,
quota_project_id: Optional[str] = None,
client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
+ always_use_jwt_access: Optional[bool] = False,
**kwargs,
) -> None:
"""Instantiate the transport.
@@ -92,6 +92,8 @@ def __init__(
API requests. If ``None``, then default info will be used.
Generally, you only need to set this if you're developing
your own client library.
+ always_use_jwt_access (Optional[bool]): Whether self signed JWT should
+ be used for service account credentials.
"""
# Save the hostname. Default to port 443 (HTTPS) if none is specified.
if ":" not in host:
@@ -101,7 +103,7 @@ def __init__(
scopes_kwargs = self._get_scopes_kwargs(self._host, scopes)
# Save the scopes.
- self._scopes = scopes or self.AUTH_SCOPES
+ self._scopes = scopes
# If no credentials are provided, then determine the appropriate
# defaults.
@@ -120,13 +122,20 @@ def __init__(
**scopes_kwargs, quota_project_id=quota_project_id
)
+ # If the credentials is service account credentials, then always try to use self signed JWT.
+ if (
+ always_use_jwt_access
+ and isinstance(credentials, service_account.Credentials)
+ and hasattr(service_account.Credentials, "with_always_use_jwt_access")
+ ):
+ credentials = credentials.with_always_use_jwt_access(True)
+
# Save the credentials.
self._credentials = credentials
- # TODO(busunkim): These two class methods are in the base transport
+ # TODO(busunkim): This method is in the base transport
# to avoid duplicating code across the transport classes. These functions
- # should be deleted once the minimum required versions of google-api-core
- # and google-auth are increased.
+ # should be deleted once the minimum required versions of google-auth is increased.
# TODO: Remove this function once google-auth >= 1.25.0 is required
@classmethod
@@ -147,27 +156,6 @@ def _get_scopes_kwargs(
return scopes_kwargs
- # TODO: Remove this function once google-api-core >= 1.26.0 is required
- @classmethod
- def _get_self_signed_jwt_kwargs(
- cls, host: str, scopes: Optional[Sequence[str]]
- ) -> Dict[str, Union[Optional[Sequence[str]], str]]:
- """Returns kwargs to pass to grpc_helpers.create_channel depending on the google-api-core version"""
-
- self_signed_jwt_kwargs: Dict[str, Union[Optional[Sequence[str]], str]] = {}
-
- if _API_CORE_VERSION and (
- packaging.version.parse(_API_CORE_VERSION)
- >= packaging.version.parse("1.26.0")
- ):
- self_signed_jwt_kwargs["default_scopes"] = cls.AUTH_SCOPES
- self_signed_jwt_kwargs["scopes"] = scopes
- self_signed_jwt_kwargs["default_host"] = cls.DEFAULT_HOST
- else:
- self_signed_jwt_kwargs["scopes"] = scopes or cls.AUTH_SCOPES
-
- return self_signed_jwt_kwargs
-
def _prep_wrapped_messages(self, client_info):
# Precompute the wrapped methods.
self._wrapped_methods = {
diff --git a/google/cloud/tasks_v2beta3/services/cloud_tasks/transports/grpc.py b/google/cloud/tasks_v2beta3/services/cloud_tasks/transports/grpc.py
index 8437327f..1000b6b0 100644
--- a/google/cloud/tasks_v2beta3/services/cloud_tasks/transports/grpc.py
+++ b/google/cloud/tasks_v2beta3/services/cloud_tasks/transports/grpc.py
@@ -65,6 +65,7 @@ def __init__(
client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None,
quota_project_id: Optional[str] = None,
client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
+ always_use_jwt_access: Optional[bool] = False,
) -> None:
"""Instantiate the transport.
@@ -105,6 +106,8 @@ def __init__(
API requests. If ``None``, then default info will be used.
Generally, you only need to set this if you're developing
your own client library.
+ always_use_jwt_access (Optional[bool]): Whether self signed JWT should
+ be used for service account credentials.
Raises:
google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport
@@ -157,6 +160,7 @@ def __init__(
scopes=scopes,
quota_project_id=quota_project_id,
client_info=client_info,
+ always_use_jwt_access=always_use_jwt_access,
)
if not self._grpc_channel:
@@ -212,14 +216,14 @@ def create_channel(
and ``credentials_file`` are passed.
"""
- self_signed_jwt_kwargs = cls._get_self_signed_jwt_kwargs(host, scopes)
-
return grpc_helpers.create_channel(
host,
credentials=credentials,
credentials_file=credentials_file,
quota_project_id=quota_project_id,
- **self_signed_jwt_kwargs,
+ default_scopes=cls.AUTH_SCOPES,
+ scopes=scopes,
+ default_host=cls.DEFAULT_HOST,
**kwargs,
)
diff --git a/google/cloud/tasks_v2beta3/services/cloud_tasks/transports/grpc_asyncio.py b/google/cloud/tasks_v2beta3/services/cloud_tasks/transports/grpc_asyncio.py
index cc327a61..f10ad55a 100644
--- a/google/cloud/tasks_v2beta3/services/cloud_tasks/transports/grpc_asyncio.py
+++ b/google/cloud/tasks_v2beta3/services/cloud_tasks/transports/grpc_asyncio.py
@@ -86,14 +86,14 @@ def create_channel(
aio.Channel: A gRPC AsyncIO channel object.
"""
- self_signed_jwt_kwargs = cls._get_self_signed_jwt_kwargs(host, scopes)
-
return grpc_helpers_async.create_channel(
host,
credentials=credentials,
credentials_file=credentials_file,
quota_project_id=quota_project_id,
- **self_signed_jwt_kwargs,
+ default_scopes=cls.AUTH_SCOPES,
+ scopes=scopes,
+ default_host=cls.DEFAULT_HOST,
**kwargs,
)
@@ -111,6 +111,7 @@ def __init__(
client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None,
quota_project_id=None,
client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
+ always_use_jwt_access: Optional[bool] = False,
) -> None:
"""Instantiate the transport.
@@ -152,6 +153,8 @@ def __init__(
API requests. If ``None``, then default info will be used.
Generally, you only need to set this if you're developing
your own client library.
+ always_use_jwt_access (Optional[bool]): Whether self signed JWT should
+ be used for service account credentials.
Raises:
google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport
@@ -203,6 +206,7 @@ def __init__(
scopes=scopes,
quota_project_id=quota_project_id,
client_info=client_info,
+ always_use_jwt_access=always_use_jwt_access,
)
if not self._grpc_channel:
diff --git a/samples/snippets/create_http_task.py b/samples/snippets/create_http_task.py
index 056dde0c..e6d7435e 100644
--- a/samples/snippets/create_http_task.py
+++ b/samples/snippets/create_http_task.py
@@ -76,7 +76,7 @@ def create_http_task(
if task_name is not None:
# Add the name to tasks.
- task["name"] = task_name
+ task["name"] = client.task_path(project, location, queue, task_name)
# Use the client to build and send the task.
response = client.create_task(request={"parent": parent, "task": task})
diff --git a/samples/snippets/requirements.txt b/samples/snippets/requirements.txt
index e543c96a..c463504c 100644
--- a/samples/snippets/requirements.txt
+++ b/samples/snippets/requirements.txt
@@ -1 +1 @@
-google-cloud-tasks==2.2.0
+google-cloud-tasks==2.3.0
diff --git a/setup.py b/setup.py
index af750040..293e3fb4 100644
--- a/setup.py
+++ b/setup.py
@@ -21,10 +21,10 @@
name = "google-cloud-tasks"
description = "Cloud Tasks API API client library"
-version = "2.3.0"
+version = "2.4.0"
release_status = "Development Status :: 5 - Production/Stable"
dependencies = [
- "google-api-core[grpc] >= 1.22.2, < 2.0.0dev",
+ "google-api-core[grpc] >= 1.26.0, <2.0.0dev",
"grpc-google-iam-v1 >= 0.12.3, < 0.13dev",
"proto-plus >= 0.4.0",
"packaging >= 14.3",
diff --git a/testing/constraints-3.6.txt b/testing/constraints-3.6.txt
index ac3ae21c..c4ecfd63 100644
--- a/testing/constraints-3.6.txt
+++ b/testing/constraints-3.6.txt
@@ -5,7 +5,7 @@
#
# e.g., if setup.py has "foo >= 1.14.0, < 2.0.0dev",
# Then this file should have foo==1.14.0
-google-api-core==1.22.2
+google-api-core==1.26.0
grpc-google-iam-v1==0.12.3
proto-plus==0.4.0
libcst==0.2.5
diff --git a/tests/unit/gapic/tasks_v2/test_cloud_tasks.py b/tests/unit/gapic/tasks_v2/test_cloud_tasks.py
index f2f3cda1..10d1ab74 100644
--- a/tests/unit/gapic/tasks_v2/test_cloud_tasks.py
+++ b/tests/unit/gapic/tasks_v2/test_cloud_tasks.py
@@ -35,7 +35,6 @@
from google.cloud.tasks_v2.services.cloud_tasks import CloudTasksClient
from google.cloud.tasks_v2.services.cloud_tasks import pagers
from google.cloud.tasks_v2.services.cloud_tasks import transports
-from google.cloud.tasks_v2.services.cloud_tasks.transports.base import _API_CORE_VERSION
from google.cloud.tasks_v2.services.cloud_tasks.transports.base import (
_GOOGLE_AUTH_VERSION,
)
@@ -58,8 +57,9 @@
import google.auth
-# TODO(busunkim): Once google-api-core >= 1.26.0 is required:
-# - Delete all the api-core and auth "less than" test cases
+# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively
+# through google-api-core:
+# - Delete the auth "less than" test cases
# - Delete these pytest markers (Make the "greater than or equal to" tests the default).
requires_google_auth_lt_1_25_0 = pytest.mark.skipif(
packaging.version.parse(_GOOGLE_AUTH_VERSION) >= packaging.version.parse("1.25.0"),
@@ -70,16 +70,6 @@
reason="This test requires google-auth >= 1.25.0",
)
-requires_api_core_lt_1_26_0 = pytest.mark.skipif(
- packaging.version.parse(_API_CORE_VERSION) >= packaging.version.parse("1.26.0"),
- reason="This test requires google-api-core < 1.26.0",
-)
-
-requires_api_core_gte_1_26_0 = pytest.mark.skipif(
- packaging.version.parse(_API_CORE_VERSION) < packaging.version.parse("1.26.0"),
- reason="This test requires google-api-core >= 1.26.0",
-)
-
def client_cert_source_callback():
return b"cert bytes", b"key bytes"
@@ -137,6 +127,34 @@ def test_cloud_tasks_client_from_service_account_info(client_class):
assert client.transport._host == "cloudtasks.googleapis.com:443"
+@pytest.mark.parametrize("client_class", [CloudTasksClient, CloudTasksAsyncClient,])
+def test_cloud_tasks_client_service_account_always_use_jwt(client_class):
+ with mock.patch.object(
+ service_account.Credentials, "with_always_use_jwt_access", create=True
+ ) as use_jwt:
+ creds = service_account.Credentials(None, None, None)
+ client = client_class(credentials=creds)
+ use_jwt.assert_not_called()
+
+
+@pytest.mark.parametrize(
+ "transport_class,transport_name",
+ [
+ (transports.CloudTasksGrpcTransport, "grpc"),
+ (transports.CloudTasksGrpcAsyncIOTransport, "grpc_asyncio"),
+ ],
+)
+def test_cloud_tasks_client_service_account_always_use_jwt_true(
+ transport_class, transport_name
+):
+ with mock.patch.object(
+ service_account.Credentials, "with_always_use_jwt_access", create=True
+ ) as use_jwt:
+ creds = service_account.Credentials(None, None, None)
+ transport = transport_class(credentials=creds, always_use_jwt_access=True)
+ use_jwt.assert_called_once_with(True)
+
+
@pytest.mark.parametrize("client_class", [CloudTasksClient, CloudTasksAsyncClient,])
def test_cloud_tasks_client_from_service_account_file(client_class):
creds = ga_credentials.AnonymousCredentials()
@@ -4186,7 +4204,6 @@ def test_cloud_tasks_transport_auth_adc_old_google_auth(transport_class):
(transports.CloudTasksGrpcAsyncIOTransport, grpc_helpers_async),
],
)
-@requires_api_core_gte_1_26_0
def test_cloud_tasks_transport_create_channel(transport_class, grpc_helpers):
# If credentials and host are not provided, the transport class should use
# ADC credentials.
@@ -4215,79 +4232,6 @@ def test_cloud_tasks_transport_create_channel(transport_class, grpc_helpers):
)
-@pytest.mark.parametrize(
- "transport_class,grpc_helpers",
- [
- (transports.CloudTasksGrpcTransport, grpc_helpers),
- (transports.CloudTasksGrpcAsyncIOTransport, grpc_helpers_async),
- ],
-)
-@requires_api_core_lt_1_26_0
-def test_cloud_tasks_transport_create_channel_old_api_core(
- transport_class, grpc_helpers
-):
- # If credentials and host are not provided, the transport class should use
- # ADC credentials.
- with mock.patch.object(
- google.auth, "default", autospec=True
- ) as adc, mock.patch.object(
- grpc_helpers, "create_channel", autospec=True
- ) as create_channel:
- creds = ga_credentials.AnonymousCredentials()
- adc.return_value = (creds, None)
- transport_class(quota_project_id="octopus")
-
- create_channel.assert_called_with(
- "cloudtasks.googleapis.com:443",
- credentials=creds,
- credentials_file=None,
- quota_project_id="octopus",
- scopes=("https://www.googleapis.com/auth/cloud-platform",),
- ssl_credentials=None,
- options=[
- ("grpc.max_send_message_length", -1),
- ("grpc.max_receive_message_length", -1),
- ],
- )
-
-
-@pytest.mark.parametrize(
- "transport_class,grpc_helpers",
- [
- (transports.CloudTasksGrpcTransport, grpc_helpers),
- (transports.CloudTasksGrpcAsyncIOTransport, grpc_helpers_async),
- ],
-)
-@requires_api_core_lt_1_26_0
-def test_cloud_tasks_transport_create_channel_user_scopes(
- transport_class, grpc_helpers
-):
- # If credentials and host are not provided, the transport class should use
- # ADC credentials.
- with mock.patch.object(
- google.auth, "default", autospec=True
- ) as adc, mock.patch.object(
- grpc_helpers, "create_channel", autospec=True
- ) as create_channel:
- creds = ga_credentials.AnonymousCredentials()
- adc.return_value = (creds, None)
-
- transport_class(quota_project_id="octopus", scopes=["1", "2"])
-
- create_channel.assert_called_with(
- "cloudtasks.googleapis.com:443",
- credentials=creds,
- credentials_file=None,
- quota_project_id="octopus",
- scopes=["1", "2"],
- ssl_credentials=None,
- options=[
- ("grpc.max_send_message_length", -1),
- ("grpc.max_receive_message_length", -1),
- ],
- )
-
-
@pytest.mark.parametrize(
"transport_class",
[transports.CloudTasksGrpcTransport, transports.CloudTasksGrpcAsyncIOTransport],
@@ -4307,7 +4251,7 @@ def test_cloud_tasks_grpc_transport_client_cert_source_for_mtls(transport_class)
"squid.clam.whelk:443",
credentials=cred,
credentials_file=None,
- scopes=("https://www.googleapis.com/auth/cloud-platform",),
+ scopes=None,
ssl_credentials=mock_ssl_channel_creds,
quota_project_id=None,
options=[
@@ -4411,7 +4355,7 @@ def test_cloud_tasks_transport_channel_mtls_with_client_cert_source(transport_cl
"mtls.squid.clam.whelk:443",
credentials=cred,
credentials_file=None,
- scopes=("https://www.googleapis.com/auth/cloud-platform",),
+ scopes=None,
ssl_credentials=mock_ssl_cred,
quota_project_id=None,
options=[
@@ -4455,7 +4399,7 @@ def test_cloud_tasks_transport_channel_mtls_with_adc(transport_class):
"mtls.squid.clam.whelk:443",
credentials=mock_cred,
credentials_file=None,
- scopes=("https://www.googleapis.com/auth/cloud-platform",),
+ scopes=None,
ssl_credentials=mock_ssl_cred,
quota_project_id=None,
options=[
diff --git a/tests/unit/gapic/tasks_v2beta2/test_cloud_tasks.py b/tests/unit/gapic/tasks_v2beta2/test_cloud_tasks.py
index 8a11b7fb..b7901308 100644
--- a/tests/unit/gapic/tasks_v2beta2/test_cloud_tasks.py
+++ b/tests/unit/gapic/tasks_v2beta2/test_cloud_tasks.py
@@ -35,9 +35,6 @@
from google.cloud.tasks_v2beta2.services.cloud_tasks import CloudTasksClient
from google.cloud.tasks_v2beta2.services.cloud_tasks import pagers
from google.cloud.tasks_v2beta2.services.cloud_tasks import transports
-from google.cloud.tasks_v2beta2.services.cloud_tasks.transports.base import (
- _API_CORE_VERSION,
-)
from google.cloud.tasks_v2beta2.services.cloud_tasks.transports.base import (
_GOOGLE_AUTH_VERSION,
)
@@ -60,8 +57,9 @@
import google.auth
-# TODO(busunkim): Once google-api-core >= 1.26.0 is required:
-# - Delete all the api-core and auth "less than" test cases
+# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively
+# through google-api-core:
+# - Delete the auth "less than" test cases
# - Delete these pytest markers (Make the "greater than or equal to" tests the default).
requires_google_auth_lt_1_25_0 = pytest.mark.skipif(
packaging.version.parse(_GOOGLE_AUTH_VERSION) >= packaging.version.parse("1.25.0"),
@@ -72,16 +70,6 @@
reason="This test requires google-auth >= 1.25.0",
)
-requires_api_core_lt_1_26_0 = pytest.mark.skipif(
- packaging.version.parse(_API_CORE_VERSION) >= packaging.version.parse("1.26.0"),
- reason="This test requires google-api-core < 1.26.0",
-)
-
-requires_api_core_gte_1_26_0 = pytest.mark.skipif(
- packaging.version.parse(_API_CORE_VERSION) < packaging.version.parse("1.26.0"),
- reason="This test requires google-api-core >= 1.26.0",
-)
-
def client_cert_source_callback():
return b"cert bytes", b"key bytes"
@@ -139,6 +127,34 @@ def test_cloud_tasks_client_from_service_account_info(client_class):
assert client.transport._host == "cloudtasks.googleapis.com:443"
+@pytest.mark.parametrize("client_class", [CloudTasksClient, CloudTasksAsyncClient,])
+def test_cloud_tasks_client_service_account_always_use_jwt(client_class):
+ with mock.patch.object(
+ service_account.Credentials, "with_always_use_jwt_access", create=True
+ ) as use_jwt:
+ creds = service_account.Credentials(None, None, None)
+ client = client_class(credentials=creds)
+ use_jwt.assert_not_called()
+
+
+@pytest.mark.parametrize(
+ "transport_class,transport_name",
+ [
+ (transports.CloudTasksGrpcTransport, "grpc"),
+ (transports.CloudTasksGrpcAsyncIOTransport, "grpc_asyncio"),
+ ],
+)
+def test_cloud_tasks_client_service_account_always_use_jwt_true(
+ transport_class, transport_name
+):
+ with mock.patch.object(
+ service_account.Credentials, "with_always_use_jwt_access", create=True
+ ) as use_jwt:
+ creds = service_account.Credentials(None, None, None)
+ transport = transport_class(credentials=creds, always_use_jwt_access=True)
+ use_jwt.assert_called_once_with(True)
+
+
@pytest.mark.parametrize("client_class", [CloudTasksClient, CloudTasksAsyncClient,])
def test_cloud_tasks_client_from_service_account_file(client_class):
creds = ga_credentials.AnonymousCredentials()
@@ -3906,7 +3922,9 @@ def test_lease_tasks_flattened():
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0].parent == "parent_value"
- # assert args[0].lease_duration == duration_pb2.Duration(seconds=751)
+ assert DurationRule().to_proto(args[0].lease_duration) == duration_pb2.Duration(
+ seconds=751
+ )
def test_lease_tasks_flattened_error():
@@ -3945,7 +3963,9 @@ async def test_lease_tasks_flattened_async():
assert len(call.mock_calls)
_, args, _ = call.mock_calls[0]
assert args[0].parent == "parent_value"
- # assert args[0].lease_duration == duration_pb2.Duration(seconds=751)
+ assert DurationRule().to_proto(args[0].lease_duration) == duration_pb2.Duration(
+ seconds=751
+ )
@pytest.mark.asyncio
@@ -4106,7 +4126,9 @@ def test_acknowledge_task_flattened():
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0].name == "name_value"
- # assert args[0].schedule_time == timestamp_pb2.Timestamp(seconds=751)
+ assert TimestampRule().to_proto(
+ args[0].schedule_time
+ ) == timestamp_pb2.Timestamp(seconds=751)
def test_acknowledge_task_flattened_error():
@@ -4143,7 +4165,9 @@ async def test_acknowledge_task_flattened_async():
assert len(call.mock_calls)
_, args, _ = call.mock_calls[0]
assert args[0].name == "name_value"
- # assert args[0].schedule_time == timestamp_pb2.Timestamp(seconds=751)
+ assert TimestampRule().to_proto(
+ args[0].schedule_time
+ ) == timestamp_pb2.Timestamp(seconds=751)
@pytest.mark.asyncio
@@ -4318,8 +4342,12 @@ def test_renew_lease_flattened():
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0].name == "name_value"
- # assert args[0].schedule_time == timestamp_pb2.Timestamp(seconds=751)
- # assert args[0].lease_duration == duration_pb2.Duration(seconds=751)
+ assert TimestampRule().to_proto(
+ args[0].schedule_time
+ ) == timestamp_pb2.Timestamp(seconds=751)
+ assert DurationRule().to_proto(args[0].lease_duration) == duration_pb2.Duration(
+ seconds=751
+ )
def test_renew_lease_flattened_error():
@@ -4359,8 +4387,12 @@ async def test_renew_lease_flattened_async():
assert len(call.mock_calls)
_, args, _ = call.mock_calls[0]
assert args[0].name == "name_value"
- # assert args[0].schedule_time == timestamp_pb2.Timestamp(seconds=751)
- # assert args[0].lease_duration == duration_pb2.Duration(seconds=751)
+ assert TimestampRule().to_proto(
+ args[0].schedule_time
+ ) == timestamp_pb2.Timestamp(seconds=751)
+ assert DurationRule().to_proto(args[0].lease_duration) == duration_pb2.Duration(
+ seconds=751
+ )
@pytest.mark.asyncio
@@ -4534,7 +4566,9 @@ def test_cancel_lease_flattened():
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0].name == "name_value"
- # assert args[0].schedule_time == timestamp_pb2.Timestamp(seconds=751)
+ assert TimestampRule().to_proto(
+ args[0].schedule_time
+ ) == timestamp_pb2.Timestamp(seconds=751)
def test_cancel_lease_flattened_error():
@@ -4571,7 +4605,9 @@ async def test_cancel_lease_flattened_async():
assert len(call.mock_calls)
_, args, _ = call.mock_calls[0]
assert args[0].name == "name_value"
- # assert args[0].schedule_time == timestamp_pb2.Timestamp(seconds=751)
+ assert TimestampRule().to_proto(
+ args[0].schedule_time
+ ) == timestamp_pb2.Timestamp(seconds=751)
@pytest.mark.asyncio
@@ -5025,7 +5061,6 @@ def test_cloud_tasks_transport_auth_adc_old_google_auth(transport_class):
(transports.CloudTasksGrpcAsyncIOTransport, grpc_helpers_async),
],
)
-@requires_api_core_gte_1_26_0
def test_cloud_tasks_transport_create_channel(transport_class, grpc_helpers):
# If credentials and host are not provided, the transport class should use
# ADC credentials.
@@ -5054,79 +5089,6 @@ def test_cloud_tasks_transport_create_channel(transport_class, grpc_helpers):
)
-@pytest.mark.parametrize(
- "transport_class,grpc_helpers",
- [
- (transports.CloudTasksGrpcTransport, grpc_helpers),
- (transports.CloudTasksGrpcAsyncIOTransport, grpc_helpers_async),
- ],
-)
-@requires_api_core_lt_1_26_0
-def test_cloud_tasks_transport_create_channel_old_api_core(
- transport_class, grpc_helpers
-):
- # If credentials and host are not provided, the transport class should use
- # ADC credentials.
- with mock.patch.object(
- google.auth, "default", autospec=True
- ) as adc, mock.patch.object(
- grpc_helpers, "create_channel", autospec=True
- ) as create_channel:
- creds = ga_credentials.AnonymousCredentials()
- adc.return_value = (creds, None)
- transport_class(quota_project_id="octopus")
-
- create_channel.assert_called_with(
- "cloudtasks.googleapis.com:443",
- credentials=creds,
- credentials_file=None,
- quota_project_id="octopus",
- scopes=("https://www.googleapis.com/auth/cloud-platform",),
- ssl_credentials=None,
- options=[
- ("grpc.max_send_message_length", -1),
- ("grpc.max_receive_message_length", -1),
- ],
- )
-
-
-@pytest.mark.parametrize(
- "transport_class,grpc_helpers",
- [
- (transports.CloudTasksGrpcTransport, grpc_helpers),
- (transports.CloudTasksGrpcAsyncIOTransport, grpc_helpers_async),
- ],
-)
-@requires_api_core_lt_1_26_0
-def test_cloud_tasks_transport_create_channel_user_scopes(
- transport_class, grpc_helpers
-):
- # If credentials and host are not provided, the transport class should use
- # ADC credentials.
- with mock.patch.object(
- google.auth, "default", autospec=True
- ) as adc, mock.patch.object(
- grpc_helpers, "create_channel", autospec=True
- ) as create_channel:
- creds = ga_credentials.AnonymousCredentials()
- adc.return_value = (creds, None)
-
- transport_class(quota_project_id="octopus", scopes=["1", "2"])
-
- create_channel.assert_called_with(
- "cloudtasks.googleapis.com:443",
- credentials=creds,
- credentials_file=None,
- quota_project_id="octopus",
- scopes=["1", "2"],
- ssl_credentials=None,
- options=[
- ("grpc.max_send_message_length", -1),
- ("grpc.max_receive_message_length", -1),
- ],
- )
-
-
@pytest.mark.parametrize(
"transport_class",
[transports.CloudTasksGrpcTransport, transports.CloudTasksGrpcAsyncIOTransport],
@@ -5146,7 +5108,7 @@ def test_cloud_tasks_grpc_transport_client_cert_source_for_mtls(transport_class)
"squid.clam.whelk:443",
credentials=cred,
credentials_file=None,
- scopes=("https://www.googleapis.com/auth/cloud-platform",),
+ scopes=None,
ssl_credentials=mock_ssl_channel_creds,
quota_project_id=None,
options=[
@@ -5250,7 +5212,7 @@ def test_cloud_tasks_transport_channel_mtls_with_client_cert_source(transport_cl
"mtls.squid.clam.whelk:443",
credentials=cred,
credentials_file=None,
- scopes=("https://www.googleapis.com/auth/cloud-platform",),
+ scopes=None,
ssl_credentials=mock_ssl_cred,
quota_project_id=None,
options=[
@@ -5294,7 +5256,7 @@ def test_cloud_tasks_transport_channel_mtls_with_adc(transport_class):
"mtls.squid.clam.whelk:443",
credentials=mock_cred,
credentials_file=None,
- scopes=("https://www.googleapis.com/auth/cloud-platform",),
+ scopes=None,
ssl_credentials=mock_ssl_cred,
quota_project_id=None,
options=[
diff --git a/tests/unit/gapic/tasks_v2beta3/test_cloud_tasks.py b/tests/unit/gapic/tasks_v2beta3/test_cloud_tasks.py
index 185aa41c..a32bc30b 100644
--- a/tests/unit/gapic/tasks_v2beta3/test_cloud_tasks.py
+++ b/tests/unit/gapic/tasks_v2beta3/test_cloud_tasks.py
@@ -35,9 +35,6 @@
from google.cloud.tasks_v2beta3.services.cloud_tasks import CloudTasksClient
from google.cloud.tasks_v2beta3.services.cloud_tasks import pagers
from google.cloud.tasks_v2beta3.services.cloud_tasks import transports
-from google.cloud.tasks_v2beta3.services.cloud_tasks.transports.base import (
- _API_CORE_VERSION,
-)
from google.cloud.tasks_v2beta3.services.cloud_tasks.transports.base import (
_GOOGLE_AUTH_VERSION,
)
@@ -60,8 +57,9 @@
import google.auth
-# TODO(busunkim): Once google-api-core >= 1.26.0 is required:
-# - Delete all the api-core and auth "less than" test cases
+# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively
+# through google-api-core:
+# - Delete the auth "less than" test cases
# - Delete these pytest markers (Make the "greater than or equal to" tests the default).
requires_google_auth_lt_1_25_0 = pytest.mark.skipif(
packaging.version.parse(_GOOGLE_AUTH_VERSION) >= packaging.version.parse("1.25.0"),
@@ -72,16 +70,6 @@
reason="This test requires google-auth >= 1.25.0",
)
-requires_api_core_lt_1_26_0 = pytest.mark.skipif(
- packaging.version.parse(_API_CORE_VERSION) >= packaging.version.parse("1.26.0"),
- reason="This test requires google-api-core < 1.26.0",
-)
-
-requires_api_core_gte_1_26_0 = pytest.mark.skipif(
- packaging.version.parse(_API_CORE_VERSION) < packaging.version.parse("1.26.0"),
- reason="This test requires google-api-core >= 1.26.0",
-)
-
def client_cert_source_callback():
return b"cert bytes", b"key bytes"
@@ -139,6 +127,34 @@ def test_cloud_tasks_client_from_service_account_info(client_class):
assert client.transport._host == "cloudtasks.googleapis.com:443"
+@pytest.mark.parametrize("client_class", [CloudTasksClient, CloudTasksAsyncClient,])
+def test_cloud_tasks_client_service_account_always_use_jwt(client_class):
+ with mock.patch.object(
+ service_account.Credentials, "with_always_use_jwt_access", create=True
+ ) as use_jwt:
+ creds = service_account.Credentials(None, None, None)
+ client = client_class(credentials=creds)
+ use_jwt.assert_not_called()
+
+
+@pytest.mark.parametrize(
+ "transport_class,transport_name",
+ [
+ (transports.CloudTasksGrpcTransport, "grpc"),
+ (transports.CloudTasksGrpcAsyncIOTransport, "grpc_asyncio"),
+ ],
+)
+def test_cloud_tasks_client_service_account_always_use_jwt_true(
+ transport_class, transport_name
+):
+ with mock.patch.object(
+ service_account.Credentials, "with_always_use_jwt_access", create=True
+ ) as use_jwt:
+ creds = service_account.Credentials(None, None, None)
+ transport = transport_class(credentials=creds, always_use_jwt_access=True)
+ use_jwt.assert_called_once_with(True)
+
+
@pytest.mark.parametrize("client_class", [CloudTasksClient, CloudTasksAsyncClient,])
def test_cloud_tasks_client_from_service_account_file(client_class):
creds = ga_credentials.AnonymousCredentials()
@@ -4266,7 +4282,6 @@ def test_cloud_tasks_transport_auth_adc_old_google_auth(transport_class):
(transports.CloudTasksGrpcAsyncIOTransport, grpc_helpers_async),
],
)
-@requires_api_core_gte_1_26_0
def test_cloud_tasks_transport_create_channel(transport_class, grpc_helpers):
# If credentials and host are not provided, the transport class should use
# ADC credentials.
@@ -4295,79 +4310,6 @@ def test_cloud_tasks_transport_create_channel(transport_class, grpc_helpers):
)
-@pytest.mark.parametrize(
- "transport_class,grpc_helpers",
- [
- (transports.CloudTasksGrpcTransport, grpc_helpers),
- (transports.CloudTasksGrpcAsyncIOTransport, grpc_helpers_async),
- ],
-)
-@requires_api_core_lt_1_26_0
-def test_cloud_tasks_transport_create_channel_old_api_core(
- transport_class, grpc_helpers
-):
- # If credentials and host are not provided, the transport class should use
- # ADC credentials.
- with mock.patch.object(
- google.auth, "default", autospec=True
- ) as adc, mock.patch.object(
- grpc_helpers, "create_channel", autospec=True
- ) as create_channel:
- creds = ga_credentials.AnonymousCredentials()
- adc.return_value = (creds, None)
- transport_class(quota_project_id="octopus")
-
- create_channel.assert_called_with(
- "cloudtasks.googleapis.com:443",
- credentials=creds,
- credentials_file=None,
- quota_project_id="octopus",
- scopes=("https://www.googleapis.com/auth/cloud-platform",),
- ssl_credentials=None,
- options=[
- ("grpc.max_send_message_length", -1),
- ("grpc.max_receive_message_length", -1),
- ],
- )
-
-
-@pytest.mark.parametrize(
- "transport_class,grpc_helpers",
- [
- (transports.CloudTasksGrpcTransport, grpc_helpers),
- (transports.CloudTasksGrpcAsyncIOTransport, grpc_helpers_async),
- ],
-)
-@requires_api_core_lt_1_26_0
-def test_cloud_tasks_transport_create_channel_user_scopes(
- transport_class, grpc_helpers
-):
- # If credentials and host are not provided, the transport class should use
- # ADC credentials.
- with mock.patch.object(
- google.auth, "default", autospec=True
- ) as adc, mock.patch.object(
- grpc_helpers, "create_channel", autospec=True
- ) as create_channel:
- creds = ga_credentials.AnonymousCredentials()
- adc.return_value = (creds, None)
-
- transport_class(quota_project_id="octopus", scopes=["1", "2"])
-
- create_channel.assert_called_with(
- "cloudtasks.googleapis.com:443",
- credentials=creds,
- credentials_file=None,
- quota_project_id="octopus",
- scopes=["1", "2"],
- ssl_credentials=None,
- options=[
- ("grpc.max_send_message_length", -1),
- ("grpc.max_receive_message_length", -1),
- ],
- )
-
-
@pytest.mark.parametrize(
"transport_class",
[transports.CloudTasksGrpcTransport, transports.CloudTasksGrpcAsyncIOTransport],
@@ -4387,7 +4329,7 @@ def test_cloud_tasks_grpc_transport_client_cert_source_for_mtls(transport_class)
"squid.clam.whelk:443",
credentials=cred,
credentials_file=None,
- scopes=("https://www.googleapis.com/auth/cloud-platform",),
+ scopes=None,
ssl_credentials=mock_ssl_channel_creds,
quota_project_id=None,
options=[
@@ -4491,7 +4433,7 @@ def test_cloud_tasks_transport_channel_mtls_with_client_cert_source(transport_cl
"mtls.squid.clam.whelk:443",
credentials=cred,
credentials_file=None,
- scopes=("https://www.googleapis.com/auth/cloud-platform",),
+ scopes=None,
ssl_credentials=mock_ssl_cred,
quota_project_id=None,
options=[
@@ -4535,7 +4477,7 @@ def test_cloud_tasks_transport_channel_mtls_with_adc(transport_class):
"mtls.squid.clam.whelk:443",
credentials=mock_cred,
credentials_file=None,
- scopes=("https://www.googleapis.com/auth/cloud-platform",),
+ scopes=None,
ssl_credentials=mock_ssl_cred,
quota_project_id=None,
options=[