google-cloud-tasks 0.1.0

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

@@ -0,0 +1,167 @@
+# Copyright 2018 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 V2beta2
+        # A unit of scheduled work.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     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.
+        #
+        #     Optionally caller-specified in {Google::Cloud::Tasks::V2beta2::CloudTasks::CreateTask CreateTask}.
+        # @!attribute [rw] app_engine_http_request
+        #   @return [Google::Cloud::Tasks::V2beta2::AppEngineHttpRequest]
+        #     App Engine HTTP request that is sent to the task's target. Can
+        #     be set only if
+        #     {Google::Cloud::Tasks::V2beta2::Queue#app_engine_http_target app_engine_http_target} is set
+        #     on the queue.
+        #
+        #     An App Engine task is a task that has {Google::Cloud::Tasks::V2beta2::AppEngineHttpRequest AppEngineHttpRequest} set.
+        # @!attribute [rw] pull_message
+        #   @return [Google::Cloud::Tasks::V2beta2::PullMessage]
+        #     {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks} to process the task. Can be
+        #     set only if {Google::Cloud::Tasks::V2beta2::Queue#pull_target pull_target} is set on the queue.
+        #
+        #     A pull task is a task that has {Google::Cloud::Tasks::V2beta2::PullMessage PullMessage} 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.
+        #
+        #     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 {Google::Cloud::Tasks::V2beta2::LeaseTasksRequest#lease_duration lease_duration}.
+        #
+        #     +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] status
+        #   @return [Google::Cloud::Tasks::V2beta2::TaskStatus]
+        #     Output only. The task status.
+        # @!attribute [rw] view
+        #   @return [Google::Cloud::Tasks::V2beta2::Task::View]
+        #     Output only. The view specifies which subset of the {Google::Cloud::Tasks::V2beta2::Task Task} has
+        #     been returned.
+        class Task
+          # The view specifies a subset of {Google::Cloud::Tasks::V2beta2::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::V2beta2::AppEngineHttpRequest payload in AppEngineHttpRequest} and
+            # {Google::Cloud::Tasks::V2beta2::PullMessage#payload payload in PullMessage}). 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 {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
+            # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/)
+            # permission on the {Google::Cloud::Tasks::V2beta2::Queue Queue} resource.
+            FULL = 2
+          end
+        end
+
+        # Status of the task.
+        # @!attribute [rw] attempt_dispatch_count
+        #   @return [Integer]
+        #     Output only. The number of attempts dispatched.
+        #
+        #     This count includes tasks which have been dispatched but haven't
+        #     received a response.
+        # @!attribute [rw] attempt_response_count
+        #   @return [Integer]
+        #     Output only. The number of attempts which have received a response.
+        #
+        #     This field is not calculated for
+        #     [pull tasks](https://cloud.google.comgoogle.cloud.tasks.v2beta2.PullTaskTarget).
+        # @!attribute [rw] first_attempt_status
+        #   @return [Google::Cloud::Tasks::V2beta2::AttemptStatus]
+        #     Output only. The status of the task's first attempt.
+        #
+        #     Only {Google::Cloud::Tasks::V2beta2::AttemptStatus#dispatch_time dispatch_time} will be set.
+        #     The other {Google::Cloud::Tasks::V2beta2::AttemptStatus AttemptStatus} information is not retained by Cloud Tasks.
+        #
+        #     This field is not calculated for
+        #     [pull tasks](https://cloud.google.comgoogle.cloud.tasks.v2beta2.PullTaskTarget).
+        # @!attribute [rw] last_attempt_status
+        #   @return [Google::Cloud::Tasks::V2beta2::AttemptStatus]
+        #     Output only. The status of the task's last attempt.
+        #
+        #     This field is not calculated for
+        #     [pull tasks](https://cloud.google.comgoogle.cloud.tasks.v2beta2.PullTaskTarget).
+        class TaskStatus; 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 target for this attempt.
+        #
+        #     If the task has not been attempted or the task is currently running
+        #     then the response status is unset.
+        class AttemptStatus; end
+      end
+    end
+  end
+end

data/lib/google/cloud/tasks/v2beta2/doc/google/iam/v1/policy.rb

@@ -0,0 +1,127 @@
+# Copyright 2018 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
+      # Defines an Identity and Access Management (IAM) policy. It is used to
+      # specify access control policies for Cloud Platform resources.
+      #
+      #
+      # A +Policy+ consists of a list of +bindings+. A +Binding+ binds a list of
+      # +members+ to a +role+, where the members can be user accounts, Google groups,
+      # Google domains, and service accounts. A +role+ is a named list of permissions
+      # defined by IAM.
+      #
+      # **Example**
+      #
+      #     {
+      #       "bindings": [
+      #         {
+      #           "role": "roles/owner",
+      #           "members": [
+      #             "user:mike@example.com",
+      #             "group:admins@example.com",
+      #             "domain:google.com",
+      #             "serviceAccount:my-other-app@appspot.gserviceaccount.com",
+      #           ]
+      #         },
+      #         {
+      #           "role": "roles/viewer",
+      #           "members": ["user:sean@example.com"]
+      #         }
+      #       ]
+      #     }
+      #
+      # For a description of IAM and its features, see the
+      # [IAM developer's guide](https://cloud.google.com/iam).
+      # @!attribute [rw] version
+      #   @return [Integer]
+      #     Version of the +Policy+. The default version is 0.
+      # @!attribute [rw] bindings
+      #   @return [Array<Google::Iam::V1::Binding>]
+      #     Associates a list of +members+ to a +role+.
+      #     Multiple +bindings+ must not be specified for the same +role+.
+      #     +bindings+ with no members will result in an error.
+      # @!attribute [rw] etag
+      #   @return [String]
+      #     +etag+ is used for optimistic concurrency control as a way to help
+      #     prevent simultaneous updates of a policy from overwriting each other.
+      #     It is strongly suggested that systems make use of the +etag+ in the
+      #     read-modify-write cycle to perform policy updates in order to avoid race
+      #     conditions: An +etag+ is returned in the response to +getIamPolicy+, and
+      #     systems are expected to put that etag in the request to +setIamPolicy+ to
+      #     ensure that their change will be applied to the same version of the policy.
+      #
+      #     If no +etag+ is provided in the call to +setIamPolicy+, then the existing
+      #     policy is overwritten blindly.
+      class Policy; end
+
+      # Associates +members+ with a +role+.
+      # @!attribute [rw] role
+      #   @return [String]
+      #     Role that is assigned to +members+.
+      #     For example, +roles/viewer+, +roles/editor+, or +roles/owner+.
+      #     Required
+      # @!attribute [rw] members
+      #   @return [Array<String>]
+      #     Specifies the identities requesting access for a Cloud Platform resource.
+      #     +members+ can have the following values:
+      #
+      #     * +allUsers+: A special identifier that represents anyone who is
+      #       on the internet; with or without a Google account.
+      #
+      #     * +allAuthenticatedUsers+: A special identifier that represents anyone
+      #       who is authenticated with a Google account or a service account.
+      #
+      #     * +user:{emailid}+: An email address that represents a specific Google
+      #       account. For example, +alice@gmail.com+ or +joe@example.com+.
+      #
+      #
+      #     * +serviceAccount:{emailid}+: An email address that represents a service
+      #       account. For example, +my-other-app@appspot.gserviceaccount.com+.
+      #
+      #     * +group:{emailid}+: An email address that represents a Google group.
+      #       For example, +admins@example.com+.
+      #
+      #     * +domain:{domain}+: A Google Apps domain name that represents all the
+      #       users of that domain. For example, +google.com+ or +example.com+.
+      class Binding; end
+
+      # The difference delta between two policies.
+      # @!attribute [rw] binding_deltas
+      #   @return [Array<Google::Iam::V1::BindingDelta>]
+      #     The delta for Bindings between two policies.
+      class PolicyDelta; end
+
+      # One delta entry for Binding. Each individual change (only one member in each
+      # entry) to a binding will be a separate entry.
+      # @!attribute [rw] action
+      #   @return [Google::Iam::V1::BindingDelta::Action]
+      #     The action that was performed on a Binding.
+      #     Required
+      # @!attribute [rw] role
+      #   @return [String]
+      #     Role that is assigned to +members+.
+      #     For example, +roles/viewer+, +roles/editor+, or +roles/owner+.
+      #     Required
+      # @!attribute [rw] member
+      #   @return [String]
+      #     A single identity requesting access for a Cloud Platform resource.
+      #     Follows the same format of Binding.members.
+      #     Required
+      class BindingDelta; end
+    end
+  end
+end

data/lib/google/cloud/tasks/v2beta2/doc/google/protobuf/any.rb

@@ -0,0 +1,124 @@
+# Copyright 2018 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 Protobuf
+    # +Any+ contains an arbitrary serialized protocol buffer message along with a
+    # URL that describes the type of the serialized message.
+    #
+    # Protobuf library provides support to pack/unpack Any values in the form
+    # of utility functions or additional generated methods of the Any type.
+    #
+    # Example 1: Pack and unpack a message in C++.
+    #
+    #     Foo foo = ...;
+    #     Any any;
+    #     any.PackFrom(foo);
+    #     ...
+    #     if (any.UnpackTo(&foo)) {
+    #       ...
+    #     }
+    #
+    # Example 2: Pack and unpack a message in Java.
+    #
+    #     Foo foo = ...;
+    #     Any any = Any.pack(foo);
+    #     ...
+    #     if (any.is(Foo.class)) {
+    #       foo = any.unpack(Foo.class);
+    #     }
+    #
+    #  Example 3: Pack and unpack a message in Python.
+    #
+    #     foo = Foo(...)
+    #     any = Any()
+    #     any.Pack(foo)
+    #     ...
+    #     if any.Is(Foo.DESCRIPTOR):
+    #       any.Unpack(foo)
+    #       ...
+    #
+    #  Example 4: Pack and unpack a message in Go
+    #
+    #      foo := &pb.Foo{...}
+    #      any, err := ptypes.MarshalAny(foo)
+    #      ...
+    #      foo := &pb.Foo{}
+    #      if err := ptypes.UnmarshalAny(any, foo); err != nil {
+    #        ...
+    #      }
+    #
+    # The pack methods provided by protobuf library will by default use
+    # 'type.googleapis.com/full.type.name' as the type URL and the unpack
+    # methods only use the fully qualified type name after the last '/'
+    # in the type URL, for example "foo.bar.com/x/y.z" will yield type
+    # name "y.z".
+    #
+    #
+    # = JSON
+    #
+    # The JSON representation of an +Any+ value uses the regular
+    # representation of the deserialized, embedded message, with an
+    # additional field +@type+ which contains the type URL. Example:
+    #
+    #     package google.profile;
+    #     message Person {
+    #       string first_name = 1;
+    #       string last_name = 2;
+    #     }
+    #
+    #     {
+    #       "@type": "type.googleapis.com/google.profile.Person",
+    #       "firstName": <string>,
+    #       "lastName": <string>
+    #     }
+    #
+    # If the embedded message type is well-known and has a custom JSON
+    # representation, that representation will be embedded adding a field
+    # +value+ which holds the custom JSON in addition to the +@type+
+    # field. Example (for message {Google::Protobuf::Duration}):
+    #
+    #     {
+    #       "@type": "type.googleapis.com/google.protobuf.Duration",
+    #       "value": "1.212s"
+    #     }
+    # @!attribute [rw] type_url
+    #   @return [String]
+    #     A URL/resource name whose content describes the type of the
+    #     serialized protocol buffer message.
+    #
+    #     For URLs which use the scheme +http+, +https+, or no scheme, the
+    #     following restrictions and interpretations apply:
+    #
+    #     * If no scheme is provided, +https+ is assumed.
+    #     * The last segment of the URL's path must represent the fully
+    #       qualified name of the type (as in +path/google.protobuf.Duration+).
+    #       The name should be in a canonical form (e.g., leading "." is
+    #       not accepted).
+    #     * An HTTP GET on the URL must yield a {Google::Protobuf::Type}
+    #       value in binary format, or produce an error.
+    #     * Applications are allowed to cache lookup results based on the
+    #       URL, or have them precompiled into a binary to avoid any
+    #       lookup. Therefore, binary compatibility needs to be preserved
+    #       on changes to types. (Use versioned type names to manage
+    #       breaking changes.)
+    #
+    #     Schemes other than +http+, +https+ (or the empty scheme) might be
+    #     used with implementation specific semantics.
+    # @!attribute [rw] value
+    #   @return [String]
+    #     Must be a valid serialized protocol buffer of the above specified type.
+    class Any; end
+  end
+end

data/lib/google/cloud/tasks/v2beta2/doc/google/protobuf/duration.rb

@@ -0,0 +1,90 @@
+# Copyright 2018 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 Protobuf
+    # A Duration represents a signed, fixed-length span of time represented
+    # as a count of seconds and fractions of seconds at nanosecond
+    # resolution. It is independent of any calendar and concepts like "day"
+    # or "month". It is related to Timestamp in that the difference between
+    # two Timestamp values is a Duration and it can be added or subtracted
+    # from a Timestamp. Range is approximately +-10,000 years.
+    #
+    # = Examples
+    #
+    # Example 1: Compute Duration from two Timestamps in pseudo code.
+    #
+    #     Timestamp start = ...;
+    #     Timestamp end = ...;
+    #     Duration duration = ...;
+    #
+    #     duration.seconds = end.seconds - start.seconds;
+    #     duration.nanos = end.nanos - start.nanos;
+    #
+    #     if (duration.seconds < 0 && duration.nanos > 0) {
+    #       duration.seconds += 1;
+    #       duration.nanos -= 1000000000;
+    #     } else if (durations.seconds > 0 && duration.nanos < 0) {
+    #       duration.seconds -= 1;
+    #       duration.nanos += 1000000000;
+    #     }
+    #
+    # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
+    #
+    #     Timestamp start = ...;
+    #     Duration duration = ...;
+    #     Timestamp end = ...;
+    #
+    #     end.seconds = start.seconds + duration.seconds;
+    #     end.nanos = start.nanos + duration.nanos;
+    #
+    #     if (end.nanos < 0) {
+    #       end.seconds -= 1;
+    #       end.nanos += 1000000000;
+    #     } else if (end.nanos >= 1000000000) {
+    #       end.seconds += 1;
+    #       end.nanos -= 1000000000;
+    #     }
+    #
+    # Example 3: Compute Duration from datetime.timedelta in Python.
+    #
+    #     td = datetime.timedelta(days=3, minutes=10)
+    #     duration = Duration()
+    #     duration.FromTimedelta(td)
+    #
+    # = JSON Mapping
+    #
+    # In JSON format, the Duration type is encoded as a string rather than an
+    # object, where the string ends in the suffix "s" (indicating seconds) and
+    # is preceded by the number of seconds, with nanoseconds expressed as
+    # fractional seconds. For example, 3 seconds with 0 nanoseconds should be
+    # encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
+    # be expressed in JSON format as "3.000000001s", and 3 seconds and 1
+    # microsecond should be expressed in JSON format as "3.000001s".
+    # @!attribute [rw] seconds
+    #   @return [Integer]
+    #     Signed seconds of the span of time. Must be from -315,576,000,000
+    #     to +315,576,000,000 inclusive. Note: these bounds are computed from:
+    #     60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+    # @!attribute [rw] nanos
+    #   @return [Integer]
+    #     Signed fractions of a second at nanosecond resolution of the span
+    #     of time. Durations less than one second are represented with a 0
+    #     +seconds+ field and a positive or negative +nanos+ field. For durations
+    #     of one second or more, a non-zero value for the +nanos+ field must be
+    #     of the same sign as the +seconds+ field. Must be from -999,999,999
+    #     to +999,999,999 inclusive.
+    class Duration; end
+  end
+end