@devvit/protos 0.11.6 → 0.11.7-next-2025-01-28-9b10510e8.0

package/schema/.snootobuf/deps/google/api/servicecontrol/v1/operation.proto

@@ -0,0 +1,123 @@
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.api.servicecontrol.v1;
+
+import "google/api/servicecontrol/v1/log_entry.proto";
+import "google/api/servicecontrol/v1/metric_value.proto";
+import "google/protobuf/any.proto";
+import "google/protobuf/timestamp.proto";
+
+option cc_enable_arenas = true;
+option csharp_namespace = "Google.Cloud.ServiceControl.V1";
+option go_package = "cloud.google.com/go/servicecontrol/apiv1/servicecontrolpb;servicecontrolpb";
+option java_multiple_files = true;
+option java_outer_classname = "OperationProto";
+option java_package = "com.google.api.servicecontrol.v1";
+option php_namespace = "Google\\Cloud\\ServiceControl\\V1";
+option ruby_package = "Google::Cloud::ServiceControl::V1";
+
+// Represents information regarding an operation.
+message Operation {
+  // Defines the importance of the data contained in the operation.
+  enum Importance {
+    // Allows data caching, batching, and aggregation. It provides
+    // higher performance with higher data loss risk.
+    LOW = 0;
+
+    // Disables data aggregation to minimize data loss. It is for operations
+    // that contains significant monetary value or audit trail. This feature
+    // only applies to the client libraries.
+    HIGH = 1;
+  }
+
+  // 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.
+  string operation_id = 1;
+
+  // Fully qualified name of the operation. Reserved for future use.
+  string operation_name = 2;
+
+  // 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.
+  string consumer_id = 3;
+
+  // Required. Start time of the operation.
+  google.protobuf.Timestamp start_time = 4;
+
+  // End time of the operation.
+  // Required when the operation is used in
+  // [ServiceController.Report][google.api.servicecontrol.v1.ServiceController.Report],
+  // but optional when the operation is used in
+  // [ServiceController.Check][google.api.servicecontrol.v1.ServiceController.Check].
+  google.protobuf.Timestamp end_time = 5;
+
+  // 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.
+  map<string, string> labels = 6;
+
+  // 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.
+  repeated MetricValueSet metric_value_sets = 7;
+
+  // Represents information to be logged.
+  repeated LogEntry log_entries = 8;
+
+  // DO NOT USE. This is an experimental field.
+  Importance importance = 11;
+
+  // Unimplemented.
+  repeated google.protobuf.Any extensions = 16;
+}

package/schema/.snootobuf/deps/google/api/servicecontrol/v1/quota_controller.proto

@@ -0,0 +1,245 @@
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.api.servicecontrol.v1;
+
+import "google/api/annotations.proto";
+import "google/api/servicecontrol/v1/metric_value.proto";
+import "google/rpc/status.proto";
+import "google/api/client.proto";
+
+option cc_enable_arenas = true;
+option csharp_namespace = "Google.Cloud.ServiceControl.V1";
+option go_package = "cloud.google.com/go/servicecontrol/apiv1/servicecontrolpb;servicecontrolpb";
+option java_multiple_files = true;
+option java_outer_classname = "QuotaControllerProto";
+option java_package = "com.google.api.servicecontrol.v1";
+option php_namespace = "Google\\Cloud\\ServiceControl\\V1";
+option ruby_package = "Google::Cloud::ServiceControl::V1";
+
+// [Google Quota Control API](/service-control/overview)
+//
+// Allows clients to allocate and release quota against a [managed
+// service](https://cloud.google.com/service-management/reference/rpc/google.api/servicemanagement.v1#google.api.servicemanagement.v1.ManagedService).
+service QuotaController {
+  option (google.api.default_host) = "servicecontrol.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/cloud-platform,"
+      "https://www.googleapis.com/auth/servicecontrol";
+
+  // Attempts to allocate quota for the specified consumer. It should be called
+  // before the operation is executed.
+  //
+  // This method requires the `servicemanagement.services.quota`
+  // permission on the specified service. For more information, see
+  // [Cloud IAM](https://cloud.google.com/iam).
+  //
+  // **NOTE:** The client **must** fail-open on server errors `INTERNAL`,
+  // `UNKNOWN`, `DEADLINE_EXCEEDED`, and `UNAVAILABLE`. To ensure system
+  // reliability, the server may inject these errors to prohibit any hard
+  // dependency on the quota functionality.
+  rpc AllocateQuota(AllocateQuotaRequest) returns (AllocateQuotaResponse) {
+    option (google.api.http) = {
+      post: "/v1/services/{service_name}:allocateQuota"
+      body: "*"
+    };
+  }
+}
+
+// Request message for the AllocateQuota method.
+message AllocateQuotaRequest {
+  // 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.
+  string service_name = 1;
+
+  // Operation that describes the quota allocation.
+  QuotaOperation allocate_operation = 2;
+
+  // 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.
+  string service_config_id = 4;
+}
+
+// Represents information regarding a quota operation.
+message QuotaOperation {
+  // Supported quota modes.
+  enum 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 allowlisted
+    // 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;
+  }
+
+  // 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
+  string operation_id = 1;
+
+  // 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
+  string method_name = 2;
+
+  // 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>.
+  string consumer_id = 3;
+
+  // Labels describing the operation.
+  map<string, string> labels = 4;
+
+  // 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.
+  repeated MetricValueSet quota_metrics = 5;
+
+  // Quota mode for this operation.
+  QuotaMode quota_mode = 6;
+}
+
+// Response message for the AllocateQuota method.
+message AllocateQuotaResponse {
+  // The same operation_id value used in the AllocateQuotaRequest. Used for
+  // logging and diagnostics purposes.
+  string operation_id = 1;
+
+  // Indicates the decision of the allocate.
+  repeated QuotaError allocate_errors = 2;
+
+  // 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"
+  repeated MetricValueSet quota_metrics = 3;
+
+  // ID of the actual config used to process the request.
+  string service_config_id = 4;
+}
+
+// Represents error information for [QuotaOperation][google.api.servicecontrol.v1.QuotaOperation].
+message QuotaError {
+  // 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.
+  enum 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;
+  }
+
+  // Error code.
+  Code code = 1;
+
+  // 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>".
+  string subject = 2;
+
+  // Free-form text that provides details on the cause of the error.
+  string description = 3;
+
+  // Contains additional information about the quota error.
+  // If available, `status.code` will be non zero.
+  google.rpc.Status status = 4;
+}

package/schema/.snootobuf/deps/google/api/servicecontrol/v1/service_controller.proto

@@ -0,0 +1,260 @@
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.api.servicecontrol.v1;
+
+import "google/api/annotations.proto";
+import "google/api/client.proto";
+import "google/api/servicecontrol/v1/check_error.proto";
+import "google/api/servicecontrol/v1/operation.proto";
+import "google/rpc/status.proto";
+
+option cc_enable_arenas = true;
+option csharp_namespace = "Google.Cloud.ServiceControl.V1";
+option go_package = "cloud.google.com/go/servicecontrol/apiv1/servicecontrolpb;servicecontrolpb";
+option java_multiple_files = true;
+option java_outer_classname = "ServiceControllerProto";
+option java_package = "com.google.api.servicecontrol.v1";
+option objc_class_prefix = "GASC";
+option php_namespace = "Google\\Cloud\\ServiceControl\\V1";
+option ruby_package = "Google::Cloud::ServiceControl::V1";
+
+// [Google Service Control API](/service-control/overview)
+//
+// Lets clients check and report operations against a [managed
+// service](https://cloud.google.com/service-management/reference/rpc/google.api/servicemanagement.v1#google.api.servicemanagement.v1.ManagedService).
+service ServiceController {
+  option (google.api.default_host) = "servicecontrol.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/cloud-platform,"
+      "https://www.googleapis.com/auth/servicecontrol";
+
+  // Checks whether an operation on a service should be allowed to proceed
+  // based on the configuration of the service and related policies. It must be
+  // called before the operation is executed.
+  //
+  // If feasible, the client should cache the check results and reuse them for
+  // 60 seconds. In case of any server errors, the client should rely on the
+  // cached results for much longer time to avoid outage.
+  // WARNING: There is general 60s delay for the configuration and policy
+  // propagation, therefore callers MUST NOT depend on the `Check` method having
+  // the latest policy information.
+  //
+  // NOTE: the [CheckRequest][google.api.servicecontrol.v1.CheckRequest] has
+  // the size limit (wire-format byte size) of 1MB.
+  //
+  // This method requires the `servicemanagement.services.check` permission
+  // on the specified service. For more information, see
+  // [Cloud IAM](https://cloud.google.com/iam).
+  rpc Check(CheckRequest) returns (CheckResponse) {
+    option (google.api.http) = {
+      post: "/v1/services/{service_name}:check"
+      body: "*"
+    };
+  }
+
+  // Reports operation results to Google Service Control, such as logs and
+  // metrics. It should be called after an operation is completed.
+  //
+  // If feasible, the client should aggregate reporting data for up to 5
+  // seconds to reduce API traffic. Limiting aggregation to 5 seconds is to
+  // reduce data loss during client crashes. Clients should carefully choose
+  // the aggregation time window to avoid data loss risk more than 0.01%
+  // for business and compliance reasons.
+  //
+  // NOTE: the [ReportRequest][google.api.servicecontrol.v1.ReportRequest] has
+  // the size limit (wire-format byte size) of 1MB.
+  //
+  // This method requires the `servicemanagement.services.report` permission
+  // on the specified service. For more information, see
+  // [Google Cloud IAM](https://cloud.google.com/iam).
+  rpc Report(ReportRequest) returns (ReportResponse) {
+    option (google.api.http) = {
+      post: "/v1/services/{service_name}:report"
+      body: "*"
+    };
+  }
+}
+
+// Request message for the Check method.
+message CheckRequest {
+  // 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.
+  string service_name = 1;
+
+  // The operation to be checked.
+  Operation operation = 2;
+
+  // 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.
+  string service_config_id = 4;
+}
+
+// Response message for the Check method.
+message CheckResponse {
+  // Contains additional information about the check operation.
+  message CheckInfo {
+    // 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.
+    repeated string unused_arguments = 1;
+
+    // Consumer info of this check.
+    ConsumerInfo consumer_info = 2;
+
+    // The unique id of the api key in the format of "apikey:<UID>".
+    // This field will be populated when the consumer passed to Service Control
+    // is an API key and all the API key related validations are successful.
+    string api_key_uid = 5;
+  }
+
+  // `ConsumerInfo` provides information about the consumer.
+  message ConsumerInfo {
+    // The type of the consumer as defined in
+    // [Google Resource Manager](https://cloud.google.com/resource-manager/).
+    enum 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;
+    }
+
+    // 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.
+    int64 project_number = 1;
+
+    // The type of the consumer which should have been defined in
+    // [Google Resource Manager](https://cloud.google.com/resource-manager/).
+    ConsumerType type = 2;
+
+    // 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.
+    int64 consumer_number = 3;
+  }
+
+  // The same operation_id value used in the
+  // [CheckRequest][google.api.servicecontrol.v1.CheckRequest]. Used for logging
+  // and diagnostics purposes.
+  string operation_id = 1;
+
+  // 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.
+  repeated CheckError check_errors = 2;
+
+  // The actual config id used to process the request.
+  string service_config_id = 5;
+
+  // The current service rollout id used to process the request.
+  string service_rollout_id = 11;
+
+  // Feedback data returned from the server during processing a Check request.
+  CheckInfo check_info = 6;
+}
+
+// Request message for the Report method.
+message ReportRequest {
+  // 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.
+  string service_name = 1;
+
+  // 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
+  // [ReportResponse.report_errors][google.api.servicecontrol.v1.ReportResponse.report_errors]
+  // for partial failure behavior.
+  repeated Operation operations = 2;
+
+  // 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.
+  string service_config_id = 3;
+}
+
+// Response message for the Report method.
+message ReportResponse {
+  // Represents the processing error of one
+  // [Operation][google.api.servicecontrol.v1.Operation] in the request.
+  message ReportError {
+    // The
+    // [Operation.operation_id][google.api.servicecontrol.v1.Operation.operation_id]
+    // value from the request.
+    string operation_id = 1;
+
+    // Details of the error when processing the
+    // [Operation][google.api.servicecontrol.v1.Operation].
+    google.rpc.Status status = 2;
+  }
+
+  // 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.
+  repeated ReportError report_errors = 1;
+
+  // The actual config id used to process the request.
+  string service_config_id = 2;
+
+  // The current service rollout id used to process the request.
+  string service_rollout_id = 4;
+}