google-cloud-service_control-v1 0.1.0

data/proto_docs/google/api/servicecontrol/v1/operation.rb

@@ -0,0 +1,128 @@
+# 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 ServiceControl
+      module V1
+        # Represents information regarding an operation.
+        # @!attribute [rw] operation_id
+        #   @return [::String]
+        #     Identity of the operation. This must be unique within the scope of the
+        #     service that generated the operation. If the service calls
+        #     Check() and Report() on the same operation, the two calls should carry
+        #     the same id.
+        #
+        #     UUID version 4 is recommended, though not required.
+        #     In scenarios where an operation is computed from existing information
+        #     and an idempotent id is desirable for deduplication purpose, UUID version 5
+        #     is recommended. See RFC 4122 for details.
+        # @!attribute [rw] operation_name
+        #   @return [::String]
+        #     Fully qualified name of the operation. Reserved for future use.
+        # @!attribute [rw] consumer_id
+        #   @return [::String]
+        #     Identity of the consumer who is using the service.
+        #     This field should be filled in for the operations initiated by a
+        #     consumer, but not for service-initiated operations that are
+        #     not related to a specific consumer.
+        #
+        #     - This can be in one of the following formats:
+        #         - project:PROJECT_ID,
+        #         - project`_`number:PROJECT_NUMBER,
+        #         - projects/PROJECT_ID or PROJECT_NUMBER,
+        #         - folders/FOLDER_NUMBER,
+        #         - organizations/ORGANIZATION_NUMBER,
+        #         - api`_`key:API_KEY.
+        # @!attribute [rw] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Required. Start time of the operation.
+        # @!attribute [rw] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     End time of the operation.
+        #     Required when the operation is used in {::Google::Cloud::ServiceControl::V1::ServiceController::Client#report ServiceController.Report},
+        #     but optional when the operation is used in {::Google::Cloud::ServiceControl::V1::ServiceController::Client#check ServiceController.Check}.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Labels describing the operation. Only the following labels are allowed:
+        #
+        #     - Labels describing monitored resources as defined in
+        #       the service configuration.
+        #     - Default labels of metric values. When specified, labels defined in the
+        #       metric value override these default.
+        #     - The following labels defined by Google Cloud Platform:
+        #         - `cloud.googleapis.com/location` describing the location where the
+        #            operation happened,
+        #         - `servicecontrol.googleapis.com/user_agent` describing the user agent
+        #            of the API request,
+        #         - `servicecontrol.googleapis.com/service_agent` describing the service
+        #            used to handle the API request (e.g. ESP),
+        #         - `servicecontrol.googleapis.com/platform` describing the platform
+        #            where the API is served, such as App Engine, Compute Engine, or
+        #            Kubernetes Engine.
+        # @!attribute [rw] metric_value_sets
+        #   @return [::Array<::Google::Cloud::ServiceControl::V1::MetricValueSet>]
+        #     Represents information about this operation. Each MetricValueSet
+        #     corresponds to a metric defined in the service configuration.
+        #     The data type used in the MetricValueSet must agree with
+        #     the data type specified in the metric definition.
+        #
+        #     Within a single operation, it is not allowed to have more than one
+        #     MetricValue instances that have the same metric names and identical
+        #     label value combinations. If a request has such duplicated MetricValue
+        #     instances, the entire request is rejected with
+        #     an invalid argument error.
+        # @!attribute [rw] log_entries
+        #   @return [::Array<::Google::Cloud::ServiceControl::V1::LogEntry>]
+        #     Represents information to be logged.
+        # @!attribute [rw] importance
+        #   @return [::Google::Cloud::ServiceControl::V1::Operation::Importance]
+        #     DO NOT USE. This is an experimental field.
+        # @!attribute [rw] extensions
+        #   @return [::Array<::Google::Protobuf::Any>]
+        #     Unimplemented.
+        class Operation
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Defines the importance of the data contained in the operation.
+          module Importance
+            # The API implementation may cache and aggregate the data.
+            # The data may be lost when rare and unexpected system failures occur.
+            LOW = 0
+
+            # The API implementation doesn't cache and aggregate the data.
+            # If the method returns successfully, it's guaranteed that the data has
+            # been persisted in durable storage.
+            HIGH = 1
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/api/servicecontrol/v1/quota_controller.rb

@@ -0,0 +1,227 @@
+# 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 ServiceControl
+      module V1
+        # Request message for the AllocateQuota method.
+        # @!attribute [rw] service_name
+        #   @return [::String]
+        #     Name of the service as specified in the service configuration. For example,
+        #     `"pubsub.googleapis.com"`.
+        #
+        #     See [google.api.Service][google.api.Service] for the definition of a service name.
+        # @!attribute [rw] allocate_operation
+        #   @return [::Google::Cloud::ServiceControl::V1::QuotaOperation]
+        #     Operation that describes the quota allocation.
+        # @!attribute [rw] service_config_id
+        #   @return [::String]
+        #     Specifies which version of service configuration should be used to process
+        #     the request. If unspecified or no matching version can be found, the latest
+        #     one will be used.
+        class AllocateQuotaRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Represents information regarding a quota operation.
+        # @!attribute [rw] operation_id
+        #   @return [::String]
+        #     Identity of the operation. This is expected to be unique within the scope
+        #     of the service that generated the operation, and guarantees idempotency in
+        #     case of retries.
+        #
+        #     In order to ensure best performance and latency in the Quota backends,
+        #     operation_ids are optimally associated with time, so that related
+        #     operations can be accessed fast in storage. For this reason, the
+        #     recommended token for services that intend to operate at a high QPS is
+        #     Unix time in nanos + UUID
+        # @!attribute [rw] method_name
+        #   @return [::String]
+        #     Fully qualified name of the API method for which this quota operation is
+        #     requested. This name is used for matching quota rules or metric rules and
+        #     billing status rules defined in service configuration.
+        #
+        #     This field should not be set if any of the following is true:
+        #     (1) the quota operation is performed on non-API resources.
+        #     (2) quota_metrics is set because the caller is doing quota override.
+        #
+        #     Example of an RPC method name:
+        #         google.example.library.v1.LibraryService.CreateShelf
+        # @!attribute [rw] consumer_id
+        #   @return [::String]
+        #     Identity of the consumer for whom this quota operation is being performed.
+        #
+        #     This can be in one of the following formats:
+        #       project:<project_id>,
+        #       project_number:<project_number>,
+        #       api_key:<api_key>.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Labels describing the operation.
+        # @!attribute [rw] quota_metrics
+        #   @return [::Array<::Google::Cloud::ServiceControl::V1::MetricValueSet>]
+        #     Represents information about this operation. Each MetricValueSet
+        #     corresponds to a metric defined in the service configuration.
+        #     The data type used in the MetricValueSet must agree with
+        #     the data type specified in the metric definition.
+        #
+        #     Within a single operation, it is not allowed to have more than one
+        #     MetricValue instances that have the same metric names and identical
+        #     label value combinations. If a request has such duplicated MetricValue
+        #     instances, the entire request is rejected with
+        #     an invalid argument error.
+        #
+        #     This field is mutually exclusive with method_name.
+        # @!attribute [rw] quota_mode
+        #   @return [::Google::Cloud::ServiceControl::V1::QuotaOperation::QuotaMode]
+        #     Quota mode for this operation.
+        class QuotaOperation
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Supported quota modes.
+          module QuotaMode
+            # Guard against implicit default. Must not be used.
+            UNSPECIFIED = 0
+
+            # For AllocateQuota request, allocates quota for the amount specified in
+            # the service configuration or specified using the quota metrics. If the
+            # amount is higher than the available quota, allocation error will be
+            # returned and no quota will be allocated.
+            # If multiple quotas are part of the request, and one fails, none of the
+            # quotas are allocated or released.
+            NORMAL = 1
+
+            # The operation allocates quota for the amount specified in the service
+            # configuration or specified using the quota metrics. If the amount is
+            # higher than the available quota, request does not fail but all available
+            # quota will be allocated.
+            # For rate quota, BEST_EFFORT will continue to deduct from other groups
+            # even if one does not have enough quota. For allocation, it will find the
+            # minimum available amount across all groups and deduct that amount from
+            # all the affected groups.
+            BEST_EFFORT = 2
+
+            # For AllocateQuota request, only checks if there is enough quota
+            # available and does not change the available quota. No lock is placed on
+            # the available quota either.
+            CHECK_ONLY = 3
+
+            # Unimplemented. When used in AllocateQuotaRequest, this returns the
+            # effective quota limit(s) in the response, and no quota check will be
+            # performed. Not supported for other requests, and even for
+            # AllocateQuotaRequest, this is currently supported only for whitelisted
+            # services.
+            QUERY_ONLY = 4
+
+            # The operation allocates quota for the amount specified in the service
+            # configuration or specified using the quota metrics. If the requested
+            # amount is higher than the available quota, request does not fail and
+            # remaining quota would become negative (going over the limit)
+            # Not supported for Rate Quota.
+            ADJUST_ONLY = 5
+          end
+        end
+
+        # Response message for the AllocateQuota method.
+        # @!attribute [rw] operation_id
+        #   @return [::String]
+        #     The same operation_id value used in the AllocateQuotaRequest. Used for
+        #     logging and diagnostics purposes.
+        # @!attribute [rw] allocate_errors
+        #   @return [::Array<::Google::Cloud::ServiceControl::V1::QuotaError>]
+        #     Indicates the decision of the allocate.
+        # @!attribute [rw] quota_metrics
+        #   @return [::Array<::Google::Cloud::ServiceControl::V1::MetricValueSet>]
+        #     Quota metrics to indicate the result of allocation. Depending on the
+        #     request, one or more of the following metrics will be included:
+        #
+        #     1. Per quota group or per quota metric incremental usage will be specified
+        #     using the following delta metric :
+        #       "serviceruntime.googleapis.com/api/consumer/quota_used_count"
+        #
+        #     2. The quota limit reached condition will be specified using the following
+        #     boolean metric :
+        #       "serviceruntime.googleapis.com/quota/exceeded"
+        # @!attribute [rw] service_config_id
+        #   @return [::String]
+        #     ID of the actual config used to process the request.
+        class AllocateQuotaResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Represents error information for {::Google::Cloud::ServiceControl::V1::QuotaOperation QuotaOperation}.
+        # @!attribute [rw] code
+        #   @return [::Google::Cloud::ServiceControl::V1::QuotaError::Code]
+        #     Error code.
+        # @!attribute [rw] subject
+        #   @return [::String]
+        #     Subject to whom this error applies. See the specific enum for more details
+        #     on this field. For example, "clientip:<ip address of client>" or
+        #     "project:<Google developer project id>".
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Free-form text that provides details on the cause of the error.
+        class QuotaError
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Error codes related to project config validations are deprecated since the
+          # quota controller methods do not perform these validations. Instead services
+          # have to call the Check method, without quota_properties field, to perform
+          # these validations before calling the quota controller methods. These
+          # methods check only for project deletion to be wipe out compliant.
+          module Code
+            # This is never used.
+            UNSPECIFIED = 0
+
+            # Quota allocation failed.
+            # Same as [google.rpc.Code.RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED].
+            RESOURCE_EXHAUSTED = 8
+
+            # Consumer cannot access the service because the service requires active
+            # billing.
+            BILLING_NOT_ACTIVE = 107
+
+            # Consumer's project has been marked as deleted (soft deletion).
+            PROJECT_DELETED = 108
+
+            # Specified API key is invalid.
+            API_KEY_INVALID = 105
+
+            # Specified API Key has expired.
+            API_KEY_EXPIRED = 112
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/api/servicecontrol/v1/service_controller.rb

@@ -0,0 +1,206 @@
+# 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 ServiceControl
+      module V1
+        # Request message for the Check method.
+        # @!attribute [rw] service_name
+        #   @return [::String]
+        #     The service name as specified in its service configuration. For example,
+        #     `"pubsub.googleapis.com"`.
+        #
+        #     See
+        #     [google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service)
+        #     for the definition of a service name.
+        # @!attribute [rw] operation
+        #   @return [::Google::Cloud::ServiceControl::V1::Operation]
+        #     The operation to be checked.
+        # @!attribute [rw] service_config_id
+        #   @return [::String]
+        #     Specifies which version of service configuration should be used to process
+        #     the request.
+        #
+        #     If unspecified or no matching version can be found, the
+        #     latest one will be used.
+        class CheckRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for the Check method.
+        # @!attribute [rw] operation_id
+        #   @return [::String]
+        #     The same operation_id value used in the {::Google::Cloud::ServiceControl::V1::CheckRequest CheckRequest}.
+        #     Used for logging and diagnostics purposes.
+        # @!attribute [rw] check_errors
+        #   @return [::Array<::Google::Cloud::ServiceControl::V1::CheckError>]
+        #     Indicate the decision of the check.
+        #
+        #     If no check errors are present, the service should process the operation.
+        #     Otherwise the service should use the list of errors to determine the
+        #     appropriate action.
+        # @!attribute [rw] service_config_id
+        #   @return [::String]
+        #     The actual config id used to process the request.
+        # @!attribute [rw] service_rollout_id
+        #   @return [::String]
+        #     The current service rollout id used to process the request.
+        # @!attribute [rw] check_info
+        #   @return [::Google::Cloud::ServiceControl::V1::CheckResponse::CheckInfo]
+        #     Feedback data returned from the server during processing a Check request.
+        class CheckResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Contains additional information about the check operation.
+          # @!attribute [rw] unused_arguments
+          #   @return [::Array<::String>]
+          #     A list of fields and label keys that are ignored by the server.
+          #     The client doesn't need to send them for following requests to improve
+          #     performance and allow better aggregation.
+          # @!attribute [rw] consumer_info
+          #   @return [::Google::Cloud::ServiceControl::V1::CheckResponse::ConsumerInfo]
+          #     Consumer info of this check.
+          class CheckInfo
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # `ConsumerInfo` provides information about the consumer.
+          # @!attribute [rw] project_number
+          #   @return [::Integer]
+          #     The Google cloud project number, e.g. 1234567890. A value of 0 indicates
+          #     no project number is found.
+          #
+          #     NOTE: This field is deprecated after we support flexible consumer
+          #     id. New code should not depend on this field anymore.
+          # @!attribute [rw] type
+          #   @return [::Google::Cloud::ServiceControl::V1::CheckResponse::ConsumerInfo::ConsumerType]
+          #     The type of the consumer which should have been defined in
+          #     [Google Resource Manager](https://cloud.google.com/resource-manager/).
+          # @!attribute [rw] consumer_number
+          #   @return [::Integer]
+          #     The consumer identity number, can be Google cloud project number, folder
+          #     number or organization number e.g. 1234567890. A value of 0 indicates no
+          #     consumer number is found.
+          class ConsumerInfo
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The type of the consumer as defined in
+            # [Google Resource Manager](https://cloud.google.com/resource-manager/).
+            module ConsumerType
+              # This is never used.
+              CONSUMER_TYPE_UNSPECIFIED = 0
+
+              # The consumer is a Google Cloud Project.
+              PROJECT = 1
+
+              # The consumer is a Google Cloud Folder.
+              FOLDER = 2
+
+              # The consumer is a Google Cloud Organization.
+              ORGANIZATION = 3
+
+              # Service-specific resource container which is defined by the service
+              # producer to offer their users the ability to manage service control
+              # functionalities at a finer level of granularity than the PROJECT.
+              SERVICE_SPECIFIC = 4
+            end
+          end
+        end
+
+        # Request message for the Report method.
+        # @!attribute [rw] service_name
+        #   @return [::String]
+        #     The service name as specified in its service configuration. For example,
+        #     `"pubsub.googleapis.com"`.
+        #
+        #     See
+        #     [google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service)
+        #     for the definition of a service name.
+        # @!attribute [rw] operations
+        #   @return [::Array<::Google::Cloud::ServiceControl::V1::Operation>]
+        #     Operations to be reported.
+        #
+        #     Typically the service should report one operation per request.
+        #     Putting multiple operations into a single request is allowed, but should
+        #     be used only when multiple operations are natually available at the time
+        #     of the report.
+        #
+        #     There is no limit on the number of operations in the same ReportRequest,
+        #     however the ReportRequest size should be no larger than 1MB. See
+        #     {::Google::Cloud::ServiceControl::V1::ReportResponse#report_errors ReportResponse.report_errors} for partial failure behavior.
+        # @!attribute [rw] service_config_id
+        #   @return [::String]
+        #     Specifies which version of service config should be used to process the
+        #     request.
+        #
+        #     If unspecified or no matching version can be found, the
+        #     latest one will be used.
+        class ReportRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for the Report method.
+        # @!attribute [rw] report_errors
+        #   @return [::Array<::Google::Cloud::ServiceControl::V1::ReportResponse::ReportError>]
+        #     Partial failures, one for each `Operation` in the request that failed
+        #     processing. There are three possible combinations of the RPC status:
+        #
+        #     1. The combination of a successful RPC status and an empty `report_errors`
+        #        list indicates a complete success where all `Operations` in the
+        #        request are processed successfully.
+        #     2. The combination of a successful RPC status and a non-empty
+        #        `report_errors` list indicates a partial success where some
+        #        `Operations` in the request succeeded. Each
+        #        `Operation` that failed processing has a corresponding item
+        #        in this list.
+        #     3. A failed RPC status indicates a general non-deterministic failure.
+        #        When this happens, it's impossible to know which of the
+        #        'Operations' in the request succeeded or failed.
+        # @!attribute [rw] service_config_id
+        #   @return [::String]
+        #     The actual config id used to process the request.
+        # @!attribute [rw] service_rollout_id
+        #   @return [::String]
+        #     The current service rollout id used to process the request.
+        class ReportResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Represents the processing error of one {::Google::Cloud::ServiceControl::V1::Operation Operation} in the request.
+          # @!attribute [rw] operation_id
+          #   @return [::String]
+          #     The {::Google::Cloud::ServiceControl::V1::Operation#operation_id Operation.operation_id} value from the request.
+          # @!attribute [rw] status
+          #   @return [::Google::Rpc::Status]
+          #     Details of the error when processing the {::Google::Cloud::ServiceControl::V1::Operation Operation}.
+          class ReportError
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end