google-cloud-tasks-v2beta3 0.1.0

data/proto_docs/google/cloud/tasks/v2beta3/task.rb

@@ -0,0 +1,187 @@
+# frozen_string_literal: true
+
+# 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
+#
+#     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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Tasks
+      module V2beta3
+        # A unit of scheduled work.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Optionally caller-specified in {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#create_task 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.
+        # @!attribute [rw] app_engine_http_request
+        #   @return [::Google::Cloud::Tasks::V2beta3::AppEngineHttpRequest]
+        #     HTTP request that is sent to the App Engine app handler.
+        #
+        #     An App Engine task is a task that has {::Google::Cloud::Tasks::V2beta3::AppEngineHttpRequest AppEngineHttpRequest} set.
+        # @!attribute [rw] http_request
+        #   @return [::Google::Cloud::Tasks::V2beta3::HttpRequest]
+        #     HTTP request that is sent to the task's target.
+        #
+        #     An HTTP task is a task that has {::Google::Cloud::Tasks::V2beta3::HttpRequest HttpRequest} 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::V2beta3::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::V2beta3::HttpRequest HTTP tasks}, the default is 10 minutes. The deadline
+        #       must be in the interval [15 seconds, 30 minutes].
+        #
+        #     * For {::Google::Cloud::Tasks::V2beta3::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::V2beta3::Attempt]
+        #     Output only. The status of the task's first attempt.
+        #
+        #     Only {::Google::Cloud::Tasks::V2beta3::Attempt#dispatch_time dispatch_time} will be set.
+        #     The other {::Google::Cloud::Tasks::V2beta3::Attempt Attempt} information is not retained by Cloud Tasks.
+        # @!attribute [rw] last_attempt
+        #   @return [::Google::Cloud::Tasks::V2beta3::Attempt]
+        #     Output only. The status of the task's last attempt.
+        # @!attribute [rw] view
+        #   @return [::Google::Cloud::Tasks::V2beta3::Task::View]
+        #     Output only. The view specifies which subset of the {::Google::Cloud::Tasks::V2beta3::Task Task} has
+        #     been returned.
+        class Task
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The view specifies a subset of {::Google::Cloud::Tasks::V2beta3::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::V2beta3::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::V2beta3::Task::View::FULL FULL} requires
+            # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
+            # permission on the {::Google::Cloud::Tasks::V2beta3::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
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/iam/v1/iam_policy.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+# 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
+#
+#     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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+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.
+      #     See the operation documentation for the appropriate value for this field.
+      # @!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
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+
+      # Request message for `GetIamPolicy` method.
+      # @!attribute [rw] resource
+      #   @return [::String]
+      #     REQUIRED: The resource for which the policy is being requested.
+      #     See the operation documentation for the appropriate value for this field.
+      # @!attribute [rw] options
+      #   @return [::Google::Iam::V1::GetPolicyOptions]
+      #     OPTIONAL: A `GetPolicyOptions` object for specifying options to
+      #     `GetIamPolicy`. This field is only used by Cloud IAM.
+      class GetIamPolicyRequest
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+
+      # Request message for `TestIamPermissions` method.
+      # @!attribute [rw] resource
+      #   @return [::String]
+      #     REQUIRED: The resource for which the policy detail is being requested.
+      #     See the operation documentation for the appropriate value for this field.
+      # @!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
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+
+      # Response message for `TestIamPermissions` method.
+      # @!attribute [rw] permissions
+      #   @return [::Array<::String>]
+      #     A subset of `TestPermissionsRequest.permissions` that the caller is
+      #     allowed.
+      class TestIamPermissionsResponse
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+    end
+  end
+end

data/proto_docs/google/iam/v1/options.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# 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
+#
+#     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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Iam
+    module V1
+      # Encapsulates settings provided to GetIamPolicy.
+      # @!attribute [rw] requested_policy_version
+      #   @return [::Integer]
+      #     Optional. The policy format version to be returned.
+      #
+      #     Valid values are 0, 1, and 3. Requests specifying an invalid value will be
+      #     rejected.
+      #
+      #     Requests for policies with any conditional bindings must specify version 3.
+      #     Policies without any conditional bindings may specify any valid value or
+      #     leave the field unset.
+      class GetPolicyOptions
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+    end
+  end
+end

data/proto_docs/google/iam/v1/policy.rb

@@ -0,0 +1,248 @@
+# frozen_string_literal: true
+
+# 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
+#
+#     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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+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` is a collection of `bindings`. A `binding` binds one or more
+      # `members` to a single `role`. Members can be user accounts, service accounts,
+      # Google groups, and domains (such as G Suite). A `role` is a named list of
+      # permissions (defined by IAM or configured by users). A `binding` can
+      # optionally specify a `condition`, which is a logic expression that further
+      # constrains the role binding based on attributes about the request and/or
+      # target resource.
+      #
+      # **JSON Example**
+      #
+      #     {
+      #       "bindings": [
+      #         {
+      #           "role": "roles/resourcemanager.organizationAdmin",
+      #           "members": [
+      #             "user:mike@example.com",
+      #             "group:admins@example.com",
+      #             "domain:google.com",
+      #             "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+      #           ]
+      #         },
+      #         {
+      #           "role": "roles/resourcemanager.organizationViewer",
+      #           "members": ["user:eve@example.com"],
+      #           "condition": {
+      #             "title": "expirable access",
+      #             "description": "Does not grant access after Sep 2020",
+      #             "expression": "request.time <
+      #             timestamp('2020-10-01T00:00:00.000Z')",
+      #           }
+      #         }
+      #       ]
+      #     }
+      #
+      # **YAML Example**
+      #
+      #     bindings:
+      #     - members:
+      #       - user:mike@example.com
+      #       - group:admins@example.com
+      #       - domain:google.com
+      #       - serviceAccount:my-project-id@appspot.gserviceaccount.com
+      #       role: roles/resourcemanager.organizationAdmin
+      #     - members:
+      #       - user:eve@example.com
+      #       role: roles/resourcemanager.organizationViewer
+      #       condition:
+      #         title: expirable access
+      #         description: Does not grant access after Sep 2020
+      #         expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+      #
+      # For a description of IAM and its features, see the
+      # [IAM developer's guide](https://cloud.google.com/iam/docs).
+      # @!attribute [rw] version
+      #   @return [::Integer]
+      #     Specifies the format of the policy.
+      #
+      #     Valid values are 0, 1, and 3. Requests specifying an invalid value will be
+      #     rejected.
+      #
+      #     Operations affecting conditional bindings must specify version 3. This can
+      #     be either setting a conditional policy, modifying a conditional binding,
+      #     or removing a binding (conditional or unconditional) from the stored
+      #     conditional policy.
+      #     Operations on non-conditional policies may specify any valid value or
+      #     leave the field unset.
+      #
+      #     If no etag is provided in the call to `setIamPolicy`, version compliance
+      #     checks against the stored policy is skipped.
+      # @!attribute [rw] bindings
+      #   @return [::Array<::Google::Iam::V1::Binding>]
+      #     Associates a list of `members` to a `role`. Optionally may specify a
+      #     `condition` that determines when binding is in effect.
+      #     `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. Due to blind-set semantics of an etag-less policy,
+      #     'setIamPolicy' will not fail even if the incoming policy version does not
+      #     meet the requirements for modifying the stored policy.
+      class Policy
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      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`.
+      # @!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@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}`: The G Suite domain (primary) that represents all the
+      #        users of that domain. For example, `google.com` or `example.com`.
+      # @!attribute [rw] condition
+      #   @return [::Google::Type::Expr]
+      #     The condition that is associated with this binding.
+      #     NOTE: An unsatisfied condition will not allow user access via current
+      #     binding. Different bindings, including their conditions, are examined
+      #     independently.
+      class Binding
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+
+      # The difference delta between two policies.
+      # @!attribute [rw] binding_deltas
+      #   @return [::Array<::Google::Iam::V1::BindingDelta>]
+      #     The delta for Bindings between two policies.
+      # @!attribute [rw] audit_config_deltas
+      #   @return [::Array<::Google::Iam::V1::AuditConfigDelta>]
+      #     The delta for AuditConfigs between two policies.
+      class PolicyDelta
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      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
+      # @!attribute [rw] condition
+      #   @return [::Google::Type::Expr]
+      #     The condition that is associated with this binding.
+      class BindingDelta
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+
+        # The type of action performed on a Binding in a policy.
+        module Action
+          # Unspecified.
+          ACTION_UNSPECIFIED = 0
+
+          # Addition of a Binding.
+          ADD = 1
+
+          # Removal of a Binding.
+          REMOVE = 2
+        end
+      end
+
+      # One delta entry for AuditConfig. Each individual change (only one
+      # exempted_member in each entry) to a AuditConfig will be a separate entry.
+      # @!attribute [rw] action
+      #   @return [::Google::Iam::V1::AuditConfigDelta::Action]
+      #     The action that was performed on an audit configuration in a policy.
+      #     Required
+      # @!attribute [rw] service
+      #   @return [::String]
+      #     Specifies a service that was configured for Cloud Audit Logging.
+      #     For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+      #     `allServices` is a special value that covers all services.
+      #     Required
+      # @!attribute [rw] exempted_member
+      #   @return [::String]
+      #     A single identity that is exempted from "data access" audit
+      #     logging for the `service` specified above.
+      #     Follows the same format of Binding.members.
+      # @!attribute [rw] log_type
+      #   @return [::String]
+      #     Specifies the log_type that was be enabled. ADMIN_ACTIVITY is always
+      #     enabled, and cannot be configured.
+      #     Required
+      class AuditConfigDelta
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+
+        # The type of action performed on an audit configuration in a policy.
+        module Action
+          # Unspecified.
+          ACTION_UNSPECIFIED = 0
+
+          # Addition of an audit configuration.
+          ADD = 1
+
+          # Removal of an audit configuration.
+          REMOVE = 2
+        end
+      end
+    end
+  end
+end