google-cloud-tasks 0.5.0 → 0.6.0

data/lib/google/cloud/tasks/v2/doc/google/cloud/tasks/v2/target.rb

@@ -0,0 +1,270 @@
+# 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.
+
+
+module Google
+  module Cloud
+    module Tasks
+      module V2
+        # 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
+        # {Queue#app_engine_http_queue app_engine_http_queue} set.
+        #
+        # Using {Google::Cloud::Tasks::V2::AppEngineHttpRequest 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 {Google::Cloud::Tasks::V2::AppEngineRouting AppEngineRouting} used to construct the URL that the task is
+        # delivered to can be set at the queue-level or task-level:
+        #
+        # * If set,
+        #   {Google::Cloud::Tasks::V2::AppEngineHttpQueue#app_engine_routing_override app_engine_routing_override}
+        #   is used for all tasks in the queue, no matter what the setting
+        #   is for the
+        #   {Google::Cloud::Tasks::V2::AppEngineHttpRequest#app_engine_routing task-level app_engine_routing}.
+        #
+        #
+        # The `url` that the task will be sent to is:
+        #
+        # * `url =` {Google::Cloud::Tasks::V2::AppEngineRouting#host host} `+`
+        #   {Google::Cloud::Tasks::V2::AppEngineHttpRequest#relative_uri 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`]. `503` is
+        # considered an App Engine system error instead of an application
+        # error. Requests returning error `503` will be retried regardless of
+        # retry configuration and not counted against retry counts.
+        # Any other response code or a failure to receive a response before the
+        # deadline is a failed attempt.
+        # @!attribute [rw] http_method
+        #   @return [Google::Cloud::Tasks::V2::HttpMethod]
+        #     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).
+        # @!attribute [rw] app_engine_routing
+        #   @return [Google::Cloud::Tasks::V2::AppEngineRouting]
+        #     Task-level setting for App Engine routing.
+        #
+        #     If set,
+        #     {Google::Cloud::Tasks::V2::AppEngineHttpQueue#app_engine_routing_override app_engine_routing_override}
+        #     is used for all tasks in the queue, no matter what the setting is for the
+        #     {Google::Cloud::Tasks::V2::AppEngineHttpRequest#app_engine_routing task-level app_engine_routing}.
+        # @!attribute [rw] relative_uri
+        #   @return [String]
+        #     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.
+        # @!attribute [rw] headers
+        #   @return [Hash{String => String}]
+        #     HTTP request headers.
+        #
+        #     This map contains the header field names and values.
+        #     Headers can be set when the
+        #     {Google::Cloud::Tasks::V2::CloudTasks::CreateTask task is created}.
+        #     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 {Google::Cloud::Tasks::V2::AppEngineHttpRequest#body 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
+        #       {Google::Cloud::Tasks::V2::CloudTasks::CreateTask task is created}.
+        #       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 {Google::Cloud::Tasks::V2::Task Task}. For more
+        #     information, see the {Google::Cloud::Tasks::V2::CloudTasks::CreateTask CreateTask} documentation.
+        # @!attribute [rw] body
+        #   @return [String]
+        #     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 {Google::Cloud::Tasks::V2::HttpMethod HttpMethod}.
+        class AppEngineHttpRequest; end
+
+        # 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).
+        # @!attribute [rw] service
+        #   @return [String]
+        #     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, {Google::Cloud::Tasks::V2::AppEngineRouting#host host} is not parsable
+        #     into {Google::Cloud::Tasks::V2::AppEngineRouting#service service},
+        #     {Google::Cloud::Tasks::V2::AppEngineRouting#version version}, and
+        #     {Google::Cloud::Tasks::V2::AppEngineRouting#instance 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
+        #     {Google::Cloud::Tasks::V2::AppEngineRouting#host host} is not parsable, then
+        #     {Google::Cloud::Tasks::V2::AppEngineRouting#service service},
+        #     {Google::Cloud::Tasks::V2::AppEngineRouting#version version}, and
+        #     {Google::Cloud::Tasks::V2::AppEngineRouting#instance instance} are the empty string.
+        # @!attribute [rw] version
+        #   @return [String]
+        #     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, {Google::Cloud::Tasks::V2::AppEngineRouting#host host} is not parsable
+        #     into {Google::Cloud::Tasks::V2::AppEngineRouting#service service},
+        #     {Google::Cloud::Tasks::V2::AppEngineRouting#version version}, and
+        #     {Google::Cloud::Tasks::V2::AppEngineRouting#instance 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
+        #     {Google::Cloud::Tasks::V2::AppEngineRouting#host host} is not parsable, then
+        #     {Google::Cloud::Tasks::V2::AppEngineRouting#service service},
+        #     {Google::Cloud::Tasks::V2::AppEngineRouting#version version}, and
+        #     {Google::Cloud::Tasks::V2::AppEngineRouting#instance instance} are the empty string.
+        # @!attribute [rw] instance
+        #   @return [String]
+        #     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).
+        # @!attribute [rw] host
+        #   @return [String]
+        #     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 <app-id>.appspot.com), and the
+        #     {Google::Cloud::Tasks::V2::AppEngineRouting#service service}, {Google::Cloud::Tasks::V2::AppEngineRouting#version version},
+        #     and {Google::Cloud::Tasks::V2::AppEngineRouting#instance 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).
+        class AppEngineRouting; end
+
+        # The HTTP method used to deliver the task.
+        module 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
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/tasks/v2/doc/google/cloud/tasks/v2/task.rb

@@ -0,0 +1,170 @@
+# 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.
+
+
+module Google
+  module Cloud
+    module Tasks
+      module V2
+        # A unit of scheduled work.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Optionally caller-specified in {Google::Cloud::Tasks::V2::CloudTasks::CreateTask 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
+        #       {Google::Cloud::Location::Locations::ListLocations 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.
+        # @!attribute [rw] app_engine_http_request
+        #   @return [Google::Cloud::Tasks::V2::AppEngineHttpRequest]
+        #     HTTP request that is sent to the App Engine app handler.
+        #
+        #     An App Engine task is a task that has {Google::Cloud::Tasks::V2::AppEngineHttpRequest AppEngineHttpRequest} set.
+        # @!attribute [rw] schedule_time
+        #   @return [Google::Protobuf::Timestamp]
+        #     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.
+        # @!attribute [rw] create_time
+        #   @return [Google::Protobuf::Timestamp]
+        #     Output only. The time that the task was created.
+        #
+        #     `create_time` will be truncated to the nearest second.
+        # @!attribute [rw] dispatch_deadline
+        #   @return [Google::Protobuf::Duration]
+        #     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 {Google::Cloud::Tasks::V2::RetryConfig 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 {Google::Cloud::Tasks::V2::AppEngineHttpRequest App Engine tasks}, 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.
+        # @!attribute [rw] dispatch_count
+        #   @return [Integer]
+        #     Output only. The number of attempts dispatched.
+        #
+        #     This count includes attempts which have been dispatched but haven't
+        #     received a response.
+        # @!attribute [rw] response_count
+        #   @return [Integer]
+        #     Output only. The number of attempts which have received a response.
+        # @!attribute [rw] first_attempt
+        #   @return [Google::Cloud::Tasks::V2::Attempt]
+        #     Output only. The status of the task's first attempt.
+        #
+        #     Only {Google::Cloud::Tasks::V2::Attempt#dispatch_time dispatch_time} will be set.
+        #     The other {Google::Cloud::Tasks::V2::Attempt Attempt} information is not retained by Cloud Tasks.
+        # @!attribute [rw] last_attempt
+        #   @return [Google::Cloud::Tasks::V2::Attempt]
+        #     Output only. The status of the task's last attempt.
+        # @!attribute [rw] view
+        #   @return [Google::Cloud::Tasks::V2::Task::View]
+        #     Output only. The view specifies which subset of the {Google::Cloud::Tasks::V2::Task Task} has
+        #     been returned.
+        class Task
+          # The view specifies a subset of {Google::Cloud::Tasks::V2::Task 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.
+          module 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
+            # {Google::Cloud::Tasks::V2::AppEngineHttpRequest#body body in AppEngineHttpRequest}.
+            # 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 {Google::Cloud::Tasks::V2::Task::View::FULL FULL} requires
+            # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
+            # permission on the {Google::Cloud::Tasks::V2::Queue Queue} resource.
+            FULL = 2
+          end
+        end
+
+        # The status of a task attempt.
+        # @!attribute [rw] schedule_time
+        #   @return [Google::Protobuf::Timestamp]
+        #     Output only. The time that this attempt was scheduled.
+        #
+        #     `schedule_time` will be truncated to the nearest microsecond.
+        # @!attribute [rw] dispatch_time
+        #   @return [Google::Protobuf::Timestamp]
+        #     Output only. The time that this attempt was dispatched.
+        #
+        #     `dispatch_time` will be truncated to the nearest microsecond.
+        # @!attribute [rw] response_time
+        #   @return [Google::Protobuf::Timestamp]
+        #     Output only. The time that this attempt response was received.
+        #
+        #     `response_time` will be truncated to the nearest microsecond.
+        # @!attribute [rw] response_status
+        #   @return [Google::Rpc::Status]
+        #     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.
+        class Attempt; end
+      end
+    end
+  end
+end

data/lib/google/cloud/tasks/v2/doc/google/iam/v1/iam_policy.rb

@@ -0,0 +1,63 @@
+# 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.
+
+
+module Google
+  module Iam
+    module V1
+      # Request message for `SetIamPolicy` method.
+      # @!attribute [rw] resource
+      #   @return [String]
+      #     REQUIRED: The resource for which the policy is being specified.
+      #     `resource` is usually specified as a path. For example, a Project
+      #     resource is specified as `projects/{project}`.
+      # @!attribute [rw] policy
+      #   @return [Google::Iam::V1::Policy]
+      #     REQUIRED: The complete policy to be applied to the `resource`. The size of
+      #     the policy is limited to a few 10s of KB. An empty policy is a
+      #     valid policy but certain Cloud Platform services (such as Projects)
+      #     might reject them.
+      class SetIamPolicyRequest; end
+
+      # Request message for `GetIamPolicy` method.
+      # @!attribute [rw] resource
+      #   @return [String]
+      #     REQUIRED: The resource for which the policy is being requested.
+      #     `resource` is usually specified as a path. For example, a Project
+      #     resource is specified as `projects/{project}`.
+      class GetIamPolicyRequest; end
+
+      # Request message for `TestIamPermissions` method.
+      # @!attribute [rw] resource
+      #   @return [String]
+      #     REQUIRED: The resource for which the policy detail is being requested.
+      #     `resource` is usually specified as a path. For example, a Project
+      #     resource is specified as `projects/{project}`.
+      # @!attribute [rw] permissions
+      #   @return [Array<String>]
+      #     The set of permissions to check for the `resource`. Permissions with
+      #     wildcards (such as '*' or 'storage.*') are not allowed. For more
+      #     information see
+      #     [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+      class TestIamPermissionsRequest; end
+
+      # Response message for `TestIamPermissions` method.
+      # @!attribute [rw] permissions
+      #   @return [Array<String>]
+      #     A subset of `TestPermissionsRequest.permissions` that the caller is
+      #     allowed.
+      class TestIamPermissionsResponse; end
+    end
+  end
+end