google-cloud-tasks 0.5.0 → 0.6.0

data/lib/google/cloud/tasks/v2/cloud_tasks_client_config.json

@@ -0,0 +1,106 @@
+{
+  "interfaces": {
+    "google.cloud.tasks.v2.CloudTasks": {
+      "retry_codes": {
+        "idempotent": [
+          "DEADLINE_EXCEEDED",
+          "UNAVAILABLE"
+        ],
+        "non_idempotent": []
+      },
+      "retry_params": {
+        "default": {
+          "initial_retry_delay_millis": 100,
+          "retry_delay_multiplier": 1.3,
+          "max_retry_delay_millis": 60000,
+          "initial_rpc_timeout_millis": 20000,
+          "rpc_timeout_multiplier": 1.0,
+          "max_rpc_timeout_millis": 20000,
+          "total_timeout_millis": 600000
+        }
+      },
+      "methods": {
+        "ListQueues": {
+          "timeout_millis": 15000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "GetQueue": {
+          "timeout_millis": 10000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "CreateQueue": {
+          "timeout_millis": 10000,
+          "retry_codes_name": "non_idempotent",
+          "retry_params_name": "default"
+        },
+        "UpdateQueue": {
+          "timeout_millis": 10000,
+          "retry_codes_name": "non_idempotent",
+          "retry_params_name": "default"
+        },
+        "DeleteQueue": {
+          "timeout_millis": 10000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "PurgeQueue": {
+          "timeout_millis": 10000,
+          "retry_codes_name": "non_idempotent",
+          "retry_params_name": "default"
+        },
+        "PauseQueue": {
+          "timeout_millis": 10000,
+          "retry_codes_name": "non_idempotent",
+          "retry_params_name": "default"
+        },
+        "ResumeQueue": {
+          "timeout_millis": 10000,
+          "retry_codes_name": "non_idempotent",
+          "retry_params_name": "default"
+        },
+        "GetIamPolicy": {
+          "timeout_millis": 10000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "SetIamPolicy": {
+          "timeout_millis": 10000,
+          "retry_codes_name": "non_idempotent",
+          "retry_params_name": "default"
+        },
+        "TestIamPermissions": {
+          "timeout_millis": 10000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "ListTasks": {
+          "timeout_millis": 10000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "GetTask": {
+          "timeout_millis": 10000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "CreateTask": {
+          "timeout_millis": 10000,
+          "retry_codes_name": "non_idempotent",
+          "retry_params_name": "default"
+        },
+        "DeleteTask": {
+          "timeout_millis": 10000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "RunTask": {
+          "timeout_millis": 10000,
+          "retry_codes_name": "non_idempotent",
+          "retry_params_name": "default"
+        }
+      }
+    }
+  }
+}

data/lib/google/cloud/tasks/v2/cloudtasks_pb.rb

@@ -0,0 +1,99 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/tasks/v2/cloudtasks.proto
+
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/protobuf/empty_pb'
+require 'google/protobuf/field_mask_pb'
+require 'google/cloud/tasks/v2/task_pb'
+require 'google/cloud/tasks/v2/queue_pb'
+require 'google/iam/v1/iam_policy_pb'
+require 'google/iam/v1/policy_pb'
+require 'google/rpc/code_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "google.cloud.tasks.v2.ListQueuesRequest" do
+    optional :parent, :string, 1
+    optional :filter, :string, 2
+    optional :page_size, :int32, 3
+    optional :page_token, :string, 4
+  end
+  add_message "google.cloud.tasks.v2.ListQueuesResponse" do
+    repeated :queues, :message, 1, "google.cloud.tasks.v2.Queue"
+    optional :next_page_token, :string, 2
+  end
+  add_message "google.cloud.tasks.v2.GetQueueRequest" do
+    optional :name, :string, 1
+  end
+  add_message "google.cloud.tasks.v2.CreateQueueRequest" do
+    optional :parent, :string, 1
+    optional :queue, :message, 2, "google.cloud.tasks.v2.Queue"
+  end
+  add_message "google.cloud.tasks.v2.UpdateQueueRequest" do
+    optional :queue, :message, 1, "google.cloud.tasks.v2.Queue"
+    optional :update_mask, :message, 2, "google.protobuf.FieldMask"
+  end
+  add_message "google.cloud.tasks.v2.DeleteQueueRequest" do
+    optional :name, :string, 1
+  end
+  add_message "google.cloud.tasks.v2.PurgeQueueRequest" do
+    optional :name, :string, 1
+  end
+  add_message "google.cloud.tasks.v2.PauseQueueRequest" do
+    optional :name, :string, 1
+  end
+  add_message "google.cloud.tasks.v2.ResumeQueueRequest" do
+    optional :name, :string, 1
+  end
+  add_message "google.cloud.tasks.v2.ListTasksRequest" do
+    optional :parent, :string, 1
+    optional :response_view, :enum, 2, "google.cloud.tasks.v2.Task.View"
+    optional :page_size, :int32, 3
+    optional :page_token, :string, 4
+  end
+  add_message "google.cloud.tasks.v2.ListTasksResponse" do
+    repeated :tasks, :message, 1, "google.cloud.tasks.v2.Task"
+    optional :next_page_token, :string, 2
+  end
+  add_message "google.cloud.tasks.v2.GetTaskRequest" do
+    optional :name, :string, 1
+    optional :response_view, :enum, 2, "google.cloud.tasks.v2.Task.View"
+  end
+  add_message "google.cloud.tasks.v2.CreateTaskRequest" do
+    optional :parent, :string, 1
+    optional :task, :message, 2, "google.cloud.tasks.v2.Task"
+    optional :response_view, :enum, 3, "google.cloud.tasks.v2.Task.View"
+  end
+  add_message "google.cloud.tasks.v2.DeleteTaskRequest" do
+    optional :name, :string, 1
+  end
+  add_message "google.cloud.tasks.v2.RunTaskRequest" do
+    optional :name, :string, 1
+    optional :response_view, :enum, 2, "google.cloud.tasks.v2.Task.View"
+  end
+end
+
+module Google
+  module Cloud
+    module Tasks
+      module V2
+        ListQueuesRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2.ListQueuesRequest").msgclass
+        ListQueuesResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2.ListQueuesResponse").msgclass
+        GetQueueRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2.GetQueueRequest").msgclass
+        CreateQueueRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2.CreateQueueRequest").msgclass
+        UpdateQueueRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2.UpdateQueueRequest").msgclass
+        DeleteQueueRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2.DeleteQueueRequest").msgclass
+        PurgeQueueRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2.PurgeQueueRequest").msgclass
+        PauseQueueRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2.PauseQueueRequest").msgclass
+        ResumeQueueRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2.ResumeQueueRequest").msgclass
+        ListTasksRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2.ListTasksRequest").msgclass
+        ListTasksResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2.ListTasksResponse").msgclass
+        GetTaskRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2.GetTaskRequest").msgclass
+        CreateTaskRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2.CreateTaskRequest").msgclass
+        DeleteTaskRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2.DeleteTaskRequest").msgclass
+        RunTaskRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2.RunTaskRequest").msgclass
+      end
+    end
+  end
+end

data/lib/google/cloud/tasks/v2/cloudtasks_services_pb.rb

@@ -0,0 +1,200 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/cloud/tasks/v2/cloudtasks.proto for package 'google.cloud.tasks.v2'
+# Original file comments:
+# 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.
+#
+#
+
+
+require 'grpc'
+require 'google/cloud/tasks/v2/cloudtasks_pb'
+
+module Google
+  module Cloud
+    module Tasks
+      module V2
+        module CloudTasks
+          # Cloud Tasks allows developers to manage the execution of background
+          # work in their applications.
+          class Service
+
+            include GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.cloud.tasks.v2.CloudTasks'
+
+            # Lists queues.
+            #
+            # Queues are returned in lexicographical order.
+            rpc :ListQueues, ListQueuesRequest, ListQueuesResponse
+            # Gets a queue.
+            rpc :GetQueue, GetQueueRequest, Queue
+            # 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, 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, Queue
+            # 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, Google::Protobuf::Empty
+            # 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, Queue
+            # 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, Queue
+            # 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, Queue
+            # 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, Google::Iam::V1::Policy
+            # 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, Google::Iam::V1::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, Google::Iam::V1::TestIamPermissionsResponse
+            # 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, ListTasksResponse
+            # Gets a task.
+            rpc :GetTask, GetTaskRequest, Task
+            # 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.v2.AppEngineHttpQueue], the maximum task size is
+            #   100KB.
+            rpc :CreateTask, CreateTaskRequest, 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, Google::Protobuf::Empty
+            # 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, Task
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/tasks/v2/credentials.rb

@@ -0,0 +1,41 @@
+# 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
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require "googleauth"
+
+module Google
+  module Cloud
+    module Tasks
+      module V2
+        class Credentials < Google::Auth::Credentials
+          SCOPE = [
+            "https://www.googleapis.com/auth/cloud-platform"
+          ].freeze
+          PATH_ENV_VARS = %w(TASKS_CREDENTIALS
+                             TASKS_KEYFILE
+                             GOOGLE_CLOUD_CREDENTIALS
+                             GOOGLE_CLOUD_KEYFILE
+                             GCLOUD_KEYFILE)
+          JSON_ENV_VARS = %w(TASKS_CREDENTIALS_JSON
+                             TASKS_KEYFILE_JSON
+                             GOOGLE_CLOUD_CREDENTIALS_JSON
+                             GOOGLE_CLOUD_KEYFILE_JSON
+                             GCLOUD_KEYFILE_JSON)
+          DEFAULT_PATHS = ["~/.config/gcloud/application_default_credentials.json"]
+        end
+      end
+    end
+  end
+end