chore: 添加虚拟环境到仓库
- 添加 backend_service/venv 虚拟环境 - 包含所有Python依赖包 - 注意:虚拟环境约393MB,包含12655个文件
This commit is contained in:
Binary file not shown.
@@ -0,0 +1,186 @@
|
||||
// Copyright 2025 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.rpc;
|
||||
|
||||
option go_package = "google.golang.org/genproto/googleapis/rpc/code;code";
|
||||
option java_multiple_files = true;
|
||||
option java_outer_classname = "CodeProto";
|
||||
option java_package = "com.google.rpc";
|
||||
option objc_class_prefix = "RPC";
|
||||
|
||||
// The canonical error codes for gRPC APIs.
|
||||
//
|
||||
//
|
||||
// Sometimes multiple error codes may apply. Services should return
|
||||
// the most specific error code that applies. For example, prefer
|
||||
// `OUT_OF_RANGE` over `FAILED_PRECONDITION` if both codes apply.
|
||||
// Similarly prefer `NOT_FOUND` or `ALREADY_EXISTS` over `FAILED_PRECONDITION`.
|
||||
enum Code {
|
||||
// Not an error; returned on success.
|
||||
//
|
||||
// HTTP Mapping: 200 OK
|
||||
OK = 0;
|
||||
|
||||
// The operation was cancelled, typically by the caller.
|
||||
//
|
||||
// HTTP Mapping: 499 Client Closed Request
|
||||
CANCELLED = 1;
|
||||
|
||||
// Unknown error. For example, this error may be returned when
|
||||
// a `Status` value received from another address space belongs to
|
||||
// an error space that is not known in this address space. Also
|
||||
// errors raised by APIs that do not return enough error information
|
||||
// may be converted to this error.
|
||||
//
|
||||
// HTTP Mapping: 500 Internal Server Error
|
||||
UNKNOWN = 2;
|
||||
|
||||
// The client specified an invalid argument. Note that this differs
|
||||
// from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments
|
||||
// that are problematic regardless of the state of the system
|
||||
// (e.g., a malformed file name).
|
||||
//
|
||||
// HTTP Mapping: 400 Bad Request
|
||||
INVALID_ARGUMENT = 3;
|
||||
|
||||
// The deadline expired before the operation could complete. For operations
|
||||
// that change the state of the system, this error may be returned
|
||||
// even if the operation has completed successfully. For example, a
|
||||
// successful response from a server could have been delayed long
|
||||
// enough for the deadline to expire.
|
||||
//
|
||||
// HTTP Mapping: 504 Gateway Timeout
|
||||
DEADLINE_EXCEEDED = 4;
|
||||
|
||||
// Some requested entity (e.g., file or directory) was not found.
|
||||
//
|
||||
// Note to server developers: if a request is denied for an entire class
|
||||
// of users, such as gradual feature rollout or undocumented allowlist,
|
||||
// `NOT_FOUND` may be used. If a request is denied for some users within
|
||||
// a class of users, such as user-based access control, `PERMISSION_DENIED`
|
||||
// must be used.
|
||||
//
|
||||
// HTTP Mapping: 404 Not Found
|
||||
NOT_FOUND = 5;
|
||||
|
||||
// The entity that a client attempted to create (e.g., file or directory)
|
||||
// already exists.
|
||||
//
|
||||
// HTTP Mapping: 409 Conflict
|
||||
ALREADY_EXISTS = 6;
|
||||
|
||||
// The caller does not have permission to execute the specified
|
||||
// operation. `PERMISSION_DENIED` must not be used for rejections
|
||||
// caused by exhausting some resource (use `RESOURCE_EXHAUSTED`
|
||||
// instead for those errors). `PERMISSION_DENIED` must not be
|
||||
// used if the caller can not be identified (use `UNAUTHENTICATED`
|
||||
// instead for those errors). This error code does not imply the
|
||||
// request is valid or the requested entity exists or satisfies
|
||||
// other pre-conditions.
|
||||
//
|
||||
// HTTP Mapping: 403 Forbidden
|
||||
PERMISSION_DENIED = 7;
|
||||
|
||||
// The request does not have valid authentication credentials for the
|
||||
// operation.
|
||||
//
|
||||
// HTTP Mapping: 401 Unauthorized
|
||||
UNAUTHENTICATED = 16;
|
||||
|
||||
// Some resource has been exhausted, perhaps a per-user quota, or
|
||||
// perhaps the entire file system is out of space.
|
||||
//
|
||||
// HTTP Mapping: 429 Too Many Requests
|
||||
RESOURCE_EXHAUSTED = 8;
|
||||
|
||||
// The operation was rejected because the system is not in a state
|
||||
// required for the operation's execution. For example, the directory
|
||||
// to be deleted is non-empty, an rmdir operation is applied to
|
||||
// a non-directory, etc.
|
||||
//
|
||||
// Service implementors can use the following guidelines to decide
|
||||
// between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`:
|
||||
// (a) Use `UNAVAILABLE` if the client can retry just the failing call.
|
||||
// (b) Use `ABORTED` if the client should retry at a higher level. For
|
||||
// example, when a client-specified test-and-set fails, indicating the
|
||||
// client should restart a read-modify-write sequence.
|
||||
// (c) Use `FAILED_PRECONDITION` if the client should not retry until
|
||||
// the system state has been explicitly fixed. For example, if an "rmdir"
|
||||
// fails because the directory is non-empty, `FAILED_PRECONDITION`
|
||||
// should be returned since the client should not retry unless
|
||||
// the files are deleted from the directory.
|
||||
//
|
||||
// HTTP Mapping: 400 Bad Request
|
||||
FAILED_PRECONDITION = 9;
|
||||
|
||||
// The operation was aborted, typically due to a concurrency issue such as
|
||||
// a sequencer check failure or transaction abort.
|
||||
//
|
||||
// See the guidelines above for deciding between `FAILED_PRECONDITION`,
|
||||
// `ABORTED`, and `UNAVAILABLE`.
|
||||
//
|
||||
// HTTP Mapping: 409 Conflict
|
||||
ABORTED = 10;
|
||||
|
||||
// The operation was attempted past the valid range. E.g., seeking or
|
||||
// reading past end-of-file.
|
||||
//
|
||||
// Unlike `INVALID_ARGUMENT`, this error indicates a problem that may
|
||||
// be fixed if the system state changes. For example, a 32-bit file
|
||||
// system will generate `INVALID_ARGUMENT` if asked to read at an
|
||||
// offset that is not in the range [0,2^32-1], but it will generate
|
||||
// `OUT_OF_RANGE` if asked to read from an offset past the current
|
||||
// file size.
|
||||
//
|
||||
// There is a fair bit of overlap between `FAILED_PRECONDITION` and
|
||||
// `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific
|
||||
// error) when it applies so that callers who are iterating through
|
||||
// a space can easily look for an `OUT_OF_RANGE` error to detect when
|
||||
// they are done.
|
||||
//
|
||||
// HTTP Mapping: 400 Bad Request
|
||||
OUT_OF_RANGE = 11;
|
||||
|
||||
// The operation is not implemented or is not supported/enabled in this
|
||||
// service.
|
||||
//
|
||||
// HTTP Mapping: 501 Not Implemented
|
||||
UNIMPLEMENTED = 12;
|
||||
|
||||
// Internal errors. This means that some invariants expected by the
|
||||
// underlying system have been broken. This error code is reserved
|
||||
// for serious errors.
|
||||
//
|
||||
// HTTP Mapping: 500 Internal Server Error
|
||||
INTERNAL = 13;
|
||||
|
||||
// The service is currently unavailable. This is most likely a
|
||||
// transient condition, which can be corrected by retrying with
|
||||
// a backoff. Note that it is not always safe to retry
|
||||
// non-idempotent operations.
|
||||
//
|
||||
// See the guidelines above for deciding between `FAILED_PRECONDITION`,
|
||||
// `ABORTED`, and `UNAVAILABLE`.
|
||||
//
|
||||
// HTTP Mapping: 503 Service Unavailable
|
||||
UNAVAILABLE = 14;
|
||||
|
||||
// Unrecoverable data loss or corruption.
|
||||
//
|
||||
// HTTP Mapping: 500 Internal Server Error
|
||||
DATA_LOSS = 15;
|
||||
}
|
||||
@@ -0,0 +1,45 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Copyright 2025 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.
|
||||
|
||||
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
||||
# source: google/rpc/code.proto
|
||||
# Protobuf Python Version: 4.25.3
|
||||
"""Generated protocol buffer code."""
|
||||
from google.protobuf import descriptor as _descriptor
|
||||
from google.protobuf import descriptor_pool as _descriptor_pool
|
||||
from google.protobuf import symbol_database as _symbol_database
|
||||
from google.protobuf.internal import builder as _builder
|
||||
|
||||
# @@protoc_insertion_point(imports)
|
||||
|
||||
_sym_db = _symbol_database.Default()
|
||||
|
||||
|
||||
DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(
|
||||
b"\n\x15google/rpc/code.proto\x12\ngoogle.rpc*\xb7\x02\n\x04\x43ode\x12\x06\n\x02OK\x10\x00\x12\r\n\tCANCELLED\x10\x01\x12\x0b\n\x07UNKNOWN\x10\x02\x12\x14\n\x10INVALID_ARGUMENT\x10\x03\x12\x15\n\x11\x44\x45\x41\x44LINE_EXCEEDED\x10\x04\x12\r\n\tNOT_FOUND\x10\x05\x12\x12\n\x0e\x41LREADY_EXISTS\x10\x06\x12\x15\n\x11PERMISSION_DENIED\x10\x07\x12\x13\n\x0fUNAUTHENTICATED\x10\x10\x12\x16\n\x12RESOURCE_EXHAUSTED\x10\x08\x12\x17\n\x13\x46\x41ILED_PRECONDITION\x10\t\x12\x0b\n\x07\x41\x42ORTED\x10\n\x12\x10\n\x0cOUT_OF_RANGE\x10\x0b\x12\x11\n\rUNIMPLEMENTED\x10\x0c\x12\x0c\n\x08INTERNAL\x10\r\x12\x0f\n\x0bUNAVAILABLE\x10\x0e\x12\r\n\tDATA_LOSS\x10\x0f\x42X\n\x0e\x63om.google.rpcB\tCodeProtoP\x01Z3google.golang.org/genproto/googleapis/rpc/code;code\xa2\x02\x03RPCb\x06proto3"
|
||||
)
|
||||
|
||||
_globals = globals()
|
||||
_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
|
||||
_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, "google.rpc.code_pb2", _globals)
|
||||
if _descriptor._USE_C_DESCRIPTORS == False:
|
||||
_globals["DESCRIPTOR"]._options = None
|
||||
_globals[
|
||||
"DESCRIPTOR"
|
||||
]._serialized_options = b"\n\016com.google.rpcB\tCodeProtoP\001Z3google.golang.org/genproto/googleapis/rpc/code;code\242\002\003RPC"
|
||||
_globals["_CODE"]._serialized_start = 38
|
||||
_globals["_CODE"]._serialized_end = 349
|
||||
# @@protoc_insertion_point(module_scope)
|
||||
@@ -0,0 +1,58 @@
|
||||
# Copyright 2025 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.
|
||||
|
||||
from typing import ClassVar as _ClassVar
|
||||
|
||||
from google.protobuf import descriptor as _descriptor
|
||||
from google.protobuf.internal import enum_type_wrapper as _enum_type_wrapper
|
||||
|
||||
DESCRIPTOR: _descriptor.FileDescriptor
|
||||
|
||||
class Code(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
|
||||
__slots__ = ()
|
||||
OK: _ClassVar[Code]
|
||||
CANCELLED: _ClassVar[Code]
|
||||
UNKNOWN: _ClassVar[Code]
|
||||
INVALID_ARGUMENT: _ClassVar[Code]
|
||||
DEADLINE_EXCEEDED: _ClassVar[Code]
|
||||
NOT_FOUND: _ClassVar[Code]
|
||||
ALREADY_EXISTS: _ClassVar[Code]
|
||||
PERMISSION_DENIED: _ClassVar[Code]
|
||||
UNAUTHENTICATED: _ClassVar[Code]
|
||||
RESOURCE_EXHAUSTED: _ClassVar[Code]
|
||||
FAILED_PRECONDITION: _ClassVar[Code]
|
||||
ABORTED: _ClassVar[Code]
|
||||
OUT_OF_RANGE: _ClassVar[Code]
|
||||
UNIMPLEMENTED: _ClassVar[Code]
|
||||
INTERNAL: _ClassVar[Code]
|
||||
UNAVAILABLE: _ClassVar[Code]
|
||||
DATA_LOSS: _ClassVar[Code]
|
||||
|
||||
OK: Code
|
||||
CANCELLED: Code
|
||||
UNKNOWN: Code
|
||||
INVALID_ARGUMENT: Code
|
||||
DEADLINE_EXCEEDED: Code
|
||||
NOT_FOUND: Code
|
||||
ALREADY_EXISTS: Code
|
||||
PERMISSION_DENIED: Code
|
||||
UNAUTHENTICATED: Code
|
||||
RESOURCE_EXHAUSTED: Code
|
||||
FAILED_PRECONDITION: Code
|
||||
ABORTED: Code
|
||||
OUT_OF_RANGE: Code
|
||||
UNIMPLEMENTED: Code
|
||||
INTERNAL: Code
|
||||
UNAVAILABLE: Code
|
||||
DATA_LOSS: Code
|
||||
@@ -0,0 +1,345 @@
|
||||
// Copyright 2025 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.rpc.context;
|
||||
|
||||
import "google/protobuf/any.proto";
|
||||
import "google/protobuf/duration.proto";
|
||||
import "google/protobuf/struct.proto";
|
||||
import "google/protobuf/timestamp.proto";
|
||||
|
||||
option cc_enable_arenas = true;
|
||||
option go_package = "google.golang.org/genproto/googleapis/rpc/context/attribute_context;attribute_context";
|
||||
option java_multiple_files = true;
|
||||
option java_outer_classname = "AttributeContextProto";
|
||||
option java_package = "com.google.rpc.context";
|
||||
|
||||
// This message defines the standard attribute vocabulary for Google APIs.
|
||||
//
|
||||
// An attribute is a piece of metadata that describes an activity on a network
|
||||
// service. For example, the size of an HTTP request, or the status code of
|
||||
// an HTTP response.
|
||||
//
|
||||
// Each attribute has a type and a name, which is logically defined as
|
||||
// a proto message field in `AttributeContext`. The field type becomes the
|
||||
// attribute type, and the field path becomes the attribute name. For example,
|
||||
// the attribute `source.ip` maps to field `AttributeContext.source.ip`.
|
||||
//
|
||||
// This message definition is guaranteed not to have any wire breaking change.
|
||||
// So you can use it directly for passing attributes across different systems.
|
||||
//
|
||||
// NOTE: Different system may generate different subset of attributes. Please
|
||||
// verify the system specification before relying on an attribute generated
|
||||
// a system.
|
||||
message AttributeContext {
|
||||
// This message defines attributes for a node that handles a network request.
|
||||
// The node can be either a service or an application that sends, forwards,
|
||||
// or receives the request. Service peers should fill in
|
||||
// `principal` and `labels` as appropriate.
|
||||
message Peer {
|
||||
// The IP address of the peer.
|
||||
string ip = 1;
|
||||
|
||||
// The network port of the peer.
|
||||
int64 port = 2;
|
||||
|
||||
// The labels associated with the peer.
|
||||
map<string, string> labels = 6;
|
||||
|
||||
// The identity of this peer. Similar to `Request.auth.principal`, but
|
||||
// relative to the peer instead of the request. For example, the
|
||||
// identity associated with a load balancer that forwarded the request.
|
||||
string principal = 7;
|
||||
|
||||
// The CLDR country/region code associated with the above IP address.
|
||||
// If the IP address is private, the `region_code` should reflect the
|
||||
// physical location where this peer is running.
|
||||
string region_code = 8;
|
||||
}
|
||||
|
||||
// This message defines attributes associated with API operations, such as
|
||||
// a network API request. The terminology is based on the conventions used
|
||||
// by Google APIs, Istio, and OpenAPI.
|
||||
message Api {
|
||||
// The API service name. It is a logical identifier for a networked API,
|
||||
// such as "pubsub.googleapis.com". The naming syntax depends on the
|
||||
// API management system being used for handling the request.
|
||||
string service = 1;
|
||||
|
||||
// The API operation name. For gRPC requests, it is the fully qualified API
|
||||
// method name, such as "google.pubsub.v1.Publisher.Publish". For OpenAPI
|
||||
// requests, it is the `operationId`, such as "getPet".
|
||||
string operation = 2;
|
||||
|
||||
// The API protocol used for sending the request, such as "http", "https",
|
||||
// "grpc", or "internal".
|
||||
string protocol = 3;
|
||||
|
||||
// The API version associated with the API operation above, such as "v1" or
|
||||
// "v1alpha1".
|
||||
string version = 4;
|
||||
}
|
||||
|
||||
// This message defines request authentication attributes. Terminology is
|
||||
// based on the JSON Web Token (JWT) standard, but the terms also
|
||||
// correlate to concepts in other standards.
|
||||
message Auth {
|
||||
// The authenticated principal. Reflects the issuer (`iss`) and subject
|
||||
// (`sub`) claims within a JWT. The issuer and subject should be `/`
|
||||
// delimited, with `/` percent-encoded within the subject fragment. For
|
||||
// Google accounts, the principal format is:
|
||||
// "https://accounts.google.com/{id}"
|
||||
string principal = 1;
|
||||
|
||||
// The intended audience(s) for this authentication information. Reflects
|
||||
// the audience (`aud`) claim within a JWT. The audience
|
||||
// value(s) depends on the `issuer`, but typically include one or more of
|
||||
// the following pieces of information:
|
||||
//
|
||||
// * The services intended to receive the credential. For example,
|
||||
// ["https://pubsub.googleapis.com/", "https://storage.googleapis.com/"].
|
||||
// * A set of service-based scopes. For example,
|
||||
// ["https://www.googleapis.com/auth/cloud-platform"].
|
||||
// * The client id of an app, such as the Firebase project id for JWTs
|
||||
// from Firebase Auth.
|
||||
//
|
||||
// Consult the documentation for the credential issuer to determine the
|
||||
// information provided.
|
||||
repeated string audiences = 2;
|
||||
|
||||
// The authorized presenter of the credential. Reflects the optional
|
||||
// Authorized Presenter (`azp`) claim within a JWT or the
|
||||
// OAuth client id. For example, a Google Cloud Platform client id looks
|
||||
// as follows: "123456789012.apps.googleusercontent.com".
|
||||
string presenter = 3;
|
||||
|
||||
// Structured claims presented with the credential. JWTs include
|
||||
// `{key: value}` pairs for standard and private claims. The following
|
||||
// is a subset of the standard required and optional claims that would
|
||||
// typically be presented for a Google-based JWT:
|
||||
//
|
||||
// {'iss': 'accounts.google.com',
|
||||
// 'sub': '113289723416554971153',
|
||||
// 'aud': ['123456789012', 'pubsub.googleapis.com'],
|
||||
// 'azp': '123456789012.apps.googleusercontent.com',
|
||||
// 'email': 'jsmith@example.com',
|
||||
// 'iat': 1353601026,
|
||||
// 'exp': 1353604926}
|
||||
//
|
||||
// SAML assertions are similarly specified, but with an identity provider
|
||||
// dependent structure.
|
||||
google.protobuf.Struct claims = 4;
|
||||
|
||||
// A list of access level resource names that allow resources to be
|
||||
// accessed by authenticated requester. It is part of Secure GCP processing
|
||||
// for the incoming request. An access level string has the format:
|
||||
// "//{api_service_name}/accessPolicies/{policy_id}/accessLevels/{short_name}"
|
||||
//
|
||||
// Example:
|
||||
// "//accesscontextmanager.googleapis.com/accessPolicies/MY_POLICY_ID/accessLevels/MY_LEVEL"
|
||||
repeated string access_levels = 5;
|
||||
}
|
||||
|
||||
// This message defines attributes for an HTTP request. If the actual
|
||||
// request is not an HTTP request, the runtime system should try to map
|
||||
// the actual request to an equivalent HTTP request.
|
||||
message Request {
|
||||
// The unique ID for a request, which can be propagated to downstream
|
||||
// systems. The ID should have low probability of collision
|
||||
// within a single day for a specific service.
|
||||
string id = 1;
|
||||
|
||||
// The HTTP request method, such as `GET`, `POST`.
|
||||
string method = 2;
|
||||
|
||||
// The HTTP request headers. If multiple headers share the same key, they
|
||||
// must be merged according to the HTTP spec. All header keys must be
|
||||
// lowercased, because HTTP header keys are case-insensitive.
|
||||
map<string, string> headers = 3;
|
||||
|
||||
// The HTTP URL path, excluding the query parameters.
|
||||
string path = 4;
|
||||
|
||||
// The HTTP request `Host` header value.
|
||||
string host = 5;
|
||||
|
||||
// The HTTP URL scheme, such as `http` and `https`.
|
||||
string scheme = 6;
|
||||
|
||||
// The HTTP URL query in the format of `name1=value1&name2=value2`, as it
|
||||
// appears in the first line of the HTTP request. No decoding is performed.
|
||||
string query = 7;
|
||||
|
||||
// The timestamp when the `destination` service receives the last byte of
|
||||
// the request.
|
||||
google.protobuf.Timestamp time = 9;
|
||||
|
||||
// The HTTP request size in bytes. If unknown, it must be -1.
|
||||
int64 size = 10;
|
||||
|
||||
// The network protocol used with the request, such as "http/1.1",
|
||||
// "spdy/3", "h2", "h2c", "webrtc", "tcp", "udp", "quic". See
|
||||
// https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids
|
||||
// for details.
|
||||
string protocol = 11;
|
||||
|
||||
// A special parameter for request reason. It is used by security systems
|
||||
// to associate auditing information with a request.
|
||||
string reason = 12;
|
||||
|
||||
// The request authentication. May be absent for unauthenticated requests.
|
||||
// Derived from the HTTP request `Authorization` header or equivalent.
|
||||
Auth auth = 13;
|
||||
}
|
||||
|
||||
// This message defines attributes for a typical network response. It
|
||||
// generally models semantics of an HTTP response.
|
||||
message Response {
|
||||
// The HTTP response status code, such as `200` and `404`.
|
||||
int64 code = 1;
|
||||
|
||||
// The HTTP response size in bytes. If unknown, it must be -1.
|
||||
int64 size = 2;
|
||||
|
||||
// The HTTP response headers. If multiple headers share the same key, they
|
||||
// must be merged according to HTTP spec. All header keys must be
|
||||
// lowercased, because HTTP header keys are case-insensitive.
|
||||
map<string, string> headers = 3;
|
||||
|
||||
// The timestamp when the `destination` service sends the last byte of
|
||||
// the response.
|
||||
google.protobuf.Timestamp time = 4;
|
||||
|
||||
// The amount of time it takes the backend service to fully respond to a
|
||||
// request. Measured from when the destination service starts to send the
|
||||
// request to the backend until when the destination service receives the
|
||||
// complete response from the backend.
|
||||
google.protobuf.Duration backend_latency = 5;
|
||||
}
|
||||
|
||||
// This message defines core attributes for a resource. A resource is an
|
||||
// addressable (named) entity provided by the destination service. For
|
||||
// example, a file stored on a network storage service.
|
||||
message Resource {
|
||||
// The name of the service that this resource belongs to, such as
|
||||
// `pubsub.googleapis.com`. The service may be different from the DNS
|
||||
// hostname that actually serves the request.
|
||||
string service = 1;
|
||||
|
||||
// The stable identifier (name) of a resource on the `service`. A resource
|
||||
// can be logically identified as "//{resource.service}/{resource.name}".
|
||||
// The differences between a resource name and a URI are:
|
||||
//
|
||||
// * Resource name is a logical identifier, independent of network
|
||||
// protocol and API version. For example,
|
||||
// `//pubsub.googleapis.com/projects/123/topics/news-feed`.
|
||||
// * URI often includes protocol and version information, so it can
|
||||
// be used directly by applications. For example,
|
||||
// `https://pubsub.googleapis.com/v1/projects/123/topics/news-feed`.
|
||||
//
|
||||
// See https://cloud.google.com/apis/design/resource_names for details.
|
||||
string name = 2;
|
||||
|
||||
// The type of the resource. The syntax is platform-specific because
|
||||
// different platforms define their resources differently.
|
||||
//
|
||||
// For Google APIs, the type format must be "{service}/{kind}", such as
|
||||
// "pubsub.googleapis.com/Topic".
|
||||
string type = 3;
|
||||
|
||||
// The labels or tags on the resource, such as AWS resource tags and
|
||||
// Kubernetes resource labels.
|
||||
map<string, string> labels = 4;
|
||||
|
||||
// The unique identifier of the resource. UID is unique in the time
|
||||
// and space for this resource within the scope of the service. It is
|
||||
// typically generated by the server on successful creation of a resource
|
||||
// and must not be changed. UID is used to uniquely identify resources
|
||||
// with resource name reuses. This should be a UUID4.
|
||||
string uid = 5;
|
||||
|
||||
// Annotations is an unstructured key-value map stored with a resource that
|
||||
// may be set by external tools to store and retrieve arbitrary metadata.
|
||||
// They are not queryable and should be preserved when modifying objects.
|
||||
//
|
||||
// More info:
|
||||
// https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
|
||||
map<string, string> annotations = 6;
|
||||
|
||||
// Mutable. The display name set by clients. Must be <= 63 characters.
|
||||
string display_name = 7;
|
||||
|
||||
// Output only. The timestamp when the resource was created. This may
|
||||
// be either the time creation was initiated or when it was completed.
|
||||
google.protobuf.Timestamp create_time = 8;
|
||||
|
||||
// Output only. The timestamp when the resource was last updated. Any
|
||||
// change to the resource made by users must refresh this value.
|
||||
// Changes to a resource made by the service should refresh this value.
|
||||
google.protobuf.Timestamp update_time = 9;
|
||||
|
||||
// Output only. The timestamp when the resource was deleted.
|
||||
// If the resource is not deleted, this must be empty.
|
||||
google.protobuf.Timestamp delete_time = 10;
|
||||
|
||||
// Output only. An opaque value that uniquely identifies a version or
|
||||
// generation of a resource. It can be used to confirm that the client
|
||||
// and server agree on the ordering of a resource being written.
|
||||
string etag = 11;
|
||||
|
||||
// Immutable. The location of the resource. The location encoding is
|
||||
// specific to the service provider, and new encoding may be introduced
|
||||
// as the service evolves.
|
||||
//
|
||||
// For Google Cloud products, the encoding is what is used by Google Cloud
|
||||
// APIs, such as `us-east1`, `aws-us-east-1`, and `azure-eastus2`. The
|
||||
// semantics of `location` is identical to the
|
||||
// `cloud.googleapis.com/location` label used by some Google Cloud APIs.
|
||||
string location = 12;
|
||||
}
|
||||
|
||||
// The origin of a network activity. In a multi hop network activity,
|
||||
// the origin represents the sender of the first hop. For the first hop,
|
||||
// the `source` and the `origin` must have the same content.
|
||||
Peer origin = 7;
|
||||
|
||||
// The source of a network activity, such as starting a TCP connection.
|
||||
// In a multi hop network activity, the source represents the sender of the
|
||||
// last hop.
|
||||
Peer source = 1;
|
||||
|
||||
// The destination of a network activity, such as accepting a TCP connection.
|
||||
// In a multi hop network activity, the destination represents the receiver of
|
||||
// the last hop.
|
||||
Peer destination = 2;
|
||||
|
||||
// Represents a network request, such as an HTTP request.
|
||||
Request request = 3;
|
||||
|
||||
// Represents a network response, such as an HTTP response.
|
||||
Response response = 4;
|
||||
|
||||
// Represents a target resource that is involved with a network activity.
|
||||
// If multiple resources are involved with an activity, this must be the
|
||||
// primary one.
|
||||
Resource resource = 5;
|
||||
|
||||
// Represents an API operation that is involved to a network activity.
|
||||
Api api = 6;
|
||||
|
||||
// Supports extensions for advanced use cases, such as logs and metrics.
|
||||
repeated google.protobuf.Any extensions = 8;
|
||||
}
|
||||
@@ -0,0 +1,86 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Copyright 2025 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.
|
||||
|
||||
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
||||
# source: google/rpc/context/attribute_context.proto
|
||||
# Protobuf Python Version: 4.25.3
|
||||
"""Generated protocol buffer code."""
|
||||
from google.protobuf import descriptor as _descriptor
|
||||
from google.protobuf import descriptor_pool as _descriptor_pool
|
||||
from google.protobuf import symbol_database as _symbol_database
|
||||
from google.protobuf.internal import builder as _builder
|
||||
|
||||
# @@protoc_insertion_point(imports)
|
||||
|
||||
_sym_db = _symbol_database.Default()
|
||||
|
||||
|
||||
from google.protobuf import any_pb2 as google_dot_protobuf_dot_any__pb2
|
||||
from google.protobuf import duration_pb2 as google_dot_protobuf_dot_duration__pb2
|
||||
from google.protobuf import struct_pb2 as google_dot_protobuf_dot_struct__pb2
|
||||
from google.protobuf import timestamp_pb2 as google_dot_protobuf_dot_timestamp__pb2
|
||||
|
||||
DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(
|
||||
b"\n*google/rpc/context/attribute_context.proto\x12\x12google.rpc.context\x1a\x19google/protobuf/any.proto\x1a\x1egoogle/protobuf/duration.proto\x1a\x1cgoogle/protobuf/struct.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\x83\x10\n\x10\x41ttributeContext\x12\x39\n\x06origin\x18\x07 \x01(\x0b\x32).google.rpc.context.AttributeContext.Peer\x12\x39\n\x06source\x18\x01 \x01(\x0b\x32).google.rpc.context.AttributeContext.Peer\x12>\n\x0b\x64\x65stination\x18\x02 \x01(\x0b\x32).google.rpc.context.AttributeContext.Peer\x12=\n\x07request\x18\x03 \x01(\x0b\x32,.google.rpc.context.AttributeContext.Request\x12?\n\x08response\x18\x04 \x01(\x0b\x32-.google.rpc.context.AttributeContext.Response\x12?\n\x08resource\x18\x05 \x01(\x0b\x32-.google.rpc.context.AttributeContext.Resource\x12\x35\n\x03\x61pi\x18\x06 \x01(\x0b\x32(.google.rpc.context.AttributeContext.Api\x12(\n\nextensions\x18\x08 \x03(\x0b\x32\x14.google.protobuf.Any\x1a\xbe\x01\n\x04Peer\x12\n\n\x02ip\x18\x01 \x01(\t\x12\x0c\n\x04port\x18\x02 \x01(\x03\x12\x45\n\x06labels\x18\x06 \x03(\x0b\x32\x35.google.rpc.context.AttributeContext.Peer.LabelsEntry\x12\x11\n\tprincipal\x18\x07 \x01(\t\x12\x13\n\x0bregion_code\x18\x08 \x01(\t\x1a-\n\x0bLabelsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\x1aL\n\x03\x41pi\x12\x0f\n\x07service\x18\x01 \x01(\t\x12\x11\n\toperation\x18\x02 \x01(\t\x12\x10\n\x08protocol\x18\x03 \x01(\t\x12\x0f\n\x07version\x18\x04 \x01(\t\x1a\x7f\n\x04\x41uth\x12\x11\n\tprincipal\x18\x01 \x01(\t\x12\x11\n\taudiences\x18\x02 \x03(\t\x12\x11\n\tpresenter\x18\x03 \x01(\t\x12'\n\x06\x63laims\x18\x04 \x01(\x0b\x32\x17.google.protobuf.Struct\x12\x15\n\raccess_levels\x18\x05 \x03(\t\x1a\xef\x02\n\x07Request\x12\n\n\x02id\x18\x01 \x01(\t\x12\x0e\n\x06method\x18\x02 \x01(\t\x12J\n\x07headers\x18\x03 \x03(\x0b\x32\x39.google.rpc.context.AttributeContext.Request.HeadersEntry\x12\x0c\n\x04path\x18\x04 \x01(\t\x12\x0c\n\x04host\x18\x05 \x01(\t\x12\x0e\n\x06scheme\x18\x06 \x01(\t\x12\r\n\x05query\x18\x07 \x01(\t\x12(\n\x04time\x18\t \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12\x0c\n\x04size\x18\n \x01(\x03\x12\x10\n\x08protocol\x18\x0b \x01(\t\x12\x0e\n\x06reason\x18\x0c \x01(\t\x12\x37\n\x04\x61uth\x18\r \x01(\x0b\x32).google.rpc.context.AttributeContext.Auth\x1a.\n\x0cHeadersEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\x1a\x81\x02\n\x08Response\x12\x0c\n\x04\x63ode\x18\x01 \x01(\x03\x12\x0c\n\x04size\x18\x02 \x01(\x03\x12K\n\x07headers\x18\x03 \x03(\x0b\x32:.google.rpc.context.AttributeContext.Response.HeadersEntry\x12(\n\x04time\x18\x04 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12\x32\n\x0f\x62\x61\x63kend_latency\x18\x05 \x01(\x0b\x32\x19.google.protobuf.Duration\x1a.\n\x0cHeadersEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\x1a\x90\x04\n\x08Resource\x12\x0f\n\x07service\x18\x01 \x01(\t\x12\x0c\n\x04name\x18\x02 \x01(\t\x12\x0c\n\x04type\x18\x03 \x01(\t\x12I\n\x06labels\x18\x04 \x03(\x0b\x32\x39.google.rpc.context.AttributeContext.Resource.LabelsEntry\x12\x0b\n\x03uid\x18\x05 \x01(\t\x12S\n\x0b\x61nnotations\x18\x06 \x03(\x0b\x32>.google.rpc.context.AttributeContext.Resource.AnnotationsEntry\x12\x14\n\x0c\x64isplay_name\x18\x07 \x01(\t\x12/\n\x0b\x63reate_time\x18\x08 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12/\n\x0bupdate_time\x18\t \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12/\n\x0b\x64\x65lete_time\x18\n \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12\x0c\n\x04\x65tag\x18\x0b \x01(\t\x12\x10\n\x08location\x18\x0c \x01(\t\x1a-\n\x0bLabelsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\x1a\x32\n\x10\x41nnotationsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\x42\x8b\x01\n\x16\x63om.google.rpc.contextB\x15\x41ttributeContextProtoP\x01ZUgoogle.golang.org/genproto/googleapis/rpc/context/attribute_context;attribute_context\xf8\x01\x01\x62\x06proto3"
|
||||
)
|
||||
|
||||
_globals = globals()
|
||||
_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
|
||||
_builder.BuildTopDescriptorsAndMessages(
|
||||
DESCRIPTOR, "google.rpc.context.attribute_context_pb2", _globals
|
||||
)
|
||||
if _descriptor._USE_C_DESCRIPTORS == False:
|
||||
_globals["DESCRIPTOR"]._options = None
|
||||
_globals[
|
||||
"DESCRIPTOR"
|
||||
]._serialized_options = b"\n\026com.google.rpc.contextB\025AttributeContextProtoP\001ZUgoogle.golang.org/genproto/googleapis/rpc/context/attribute_context;attribute_context\370\001\001"
|
||||
_globals["_ATTRIBUTECONTEXT_PEER_LABELSENTRY"]._options = None
|
||||
_globals["_ATTRIBUTECONTEXT_PEER_LABELSENTRY"]._serialized_options = b"8\001"
|
||||
_globals["_ATTRIBUTECONTEXT_REQUEST_HEADERSENTRY"]._options = None
|
||||
_globals["_ATTRIBUTECONTEXT_REQUEST_HEADERSENTRY"]._serialized_options = b"8\001"
|
||||
_globals["_ATTRIBUTECONTEXT_RESPONSE_HEADERSENTRY"]._options = None
|
||||
_globals["_ATTRIBUTECONTEXT_RESPONSE_HEADERSENTRY"]._serialized_options = b"8\001"
|
||||
_globals["_ATTRIBUTECONTEXT_RESOURCE_LABELSENTRY"]._options = None
|
||||
_globals["_ATTRIBUTECONTEXT_RESOURCE_LABELSENTRY"]._serialized_options = b"8\001"
|
||||
_globals["_ATTRIBUTECONTEXT_RESOURCE_ANNOTATIONSENTRY"]._options = None
|
||||
_globals[
|
||||
"_ATTRIBUTECONTEXT_RESOURCE_ANNOTATIONSENTRY"
|
||||
]._serialized_options = b"8\001"
|
||||
_globals["_ATTRIBUTECONTEXT"]._serialized_start = 189
|
||||
_globals["_ATTRIBUTECONTEXT"]._serialized_end = 2240
|
||||
_globals["_ATTRIBUTECONTEXT_PEER"]._serialized_start = 682
|
||||
_globals["_ATTRIBUTECONTEXT_PEER"]._serialized_end = 872
|
||||
_globals["_ATTRIBUTECONTEXT_PEER_LABELSENTRY"]._serialized_start = 827
|
||||
_globals["_ATTRIBUTECONTEXT_PEER_LABELSENTRY"]._serialized_end = 872
|
||||
_globals["_ATTRIBUTECONTEXT_API"]._serialized_start = 874
|
||||
_globals["_ATTRIBUTECONTEXT_API"]._serialized_end = 950
|
||||
_globals["_ATTRIBUTECONTEXT_AUTH"]._serialized_start = 952
|
||||
_globals["_ATTRIBUTECONTEXT_AUTH"]._serialized_end = 1079
|
||||
_globals["_ATTRIBUTECONTEXT_REQUEST"]._serialized_start = 1082
|
||||
_globals["_ATTRIBUTECONTEXT_REQUEST"]._serialized_end = 1449
|
||||
_globals["_ATTRIBUTECONTEXT_REQUEST_HEADERSENTRY"]._serialized_start = 1403
|
||||
_globals["_ATTRIBUTECONTEXT_REQUEST_HEADERSENTRY"]._serialized_end = 1449
|
||||
_globals["_ATTRIBUTECONTEXT_RESPONSE"]._serialized_start = 1452
|
||||
_globals["_ATTRIBUTECONTEXT_RESPONSE"]._serialized_end = 1709
|
||||
_globals["_ATTRIBUTECONTEXT_RESPONSE_HEADERSENTRY"]._serialized_start = 1403
|
||||
_globals["_ATTRIBUTECONTEXT_RESPONSE_HEADERSENTRY"]._serialized_end = 1449
|
||||
_globals["_ATTRIBUTECONTEXT_RESOURCE"]._serialized_start = 1712
|
||||
_globals["_ATTRIBUTECONTEXT_RESOURCE"]._serialized_end = 2240
|
||||
_globals["_ATTRIBUTECONTEXT_RESOURCE_LABELSENTRY"]._serialized_start = 827
|
||||
_globals["_ATTRIBUTECONTEXT_RESOURCE_LABELSENTRY"]._serialized_end = 872
|
||||
_globals["_ATTRIBUTECONTEXT_RESOURCE_ANNOTATIONSENTRY"]._serialized_start = 2190
|
||||
_globals["_ATTRIBUTECONTEXT_RESOURCE_ANNOTATIONSENTRY"]._serialized_end = 2240
|
||||
# @@protoc_insertion_point(module_scope)
|
||||
@@ -0,0 +1,309 @@
|
||||
# Copyright 2025 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.
|
||||
|
||||
from typing import ClassVar as _ClassVar
|
||||
from typing import Iterable as _Iterable
|
||||
from typing import Mapping as _Mapping
|
||||
from typing import Optional as _Optional
|
||||
from typing import Union as _Union
|
||||
|
||||
from google.protobuf import any_pb2 as _any_pb2
|
||||
from google.protobuf import descriptor as _descriptor
|
||||
from google.protobuf import duration_pb2 as _duration_pb2
|
||||
from google.protobuf import message as _message
|
||||
from google.protobuf import struct_pb2 as _struct_pb2
|
||||
from google.protobuf import timestamp_pb2 as _timestamp_pb2
|
||||
from google.protobuf.internal import containers as _containers
|
||||
|
||||
DESCRIPTOR: _descriptor.FileDescriptor
|
||||
|
||||
class AttributeContext(_message.Message):
|
||||
__slots__ = (
|
||||
"origin",
|
||||
"source",
|
||||
"destination",
|
||||
"request",
|
||||
"response",
|
||||
"resource",
|
||||
"api",
|
||||
"extensions",
|
||||
)
|
||||
|
||||
class Peer(_message.Message):
|
||||
__slots__ = ("ip", "port", "labels", "principal", "region_code")
|
||||
|
||||
class LabelsEntry(_message.Message):
|
||||
__slots__ = ("key", "value")
|
||||
KEY_FIELD_NUMBER: _ClassVar[int]
|
||||
VALUE_FIELD_NUMBER: _ClassVar[int]
|
||||
key: str
|
||||
value: str
|
||||
def __init__(
|
||||
self, key: _Optional[str] = ..., value: _Optional[str] = ...
|
||||
) -> None: ...
|
||||
IP_FIELD_NUMBER: _ClassVar[int]
|
||||
PORT_FIELD_NUMBER: _ClassVar[int]
|
||||
LABELS_FIELD_NUMBER: _ClassVar[int]
|
||||
PRINCIPAL_FIELD_NUMBER: _ClassVar[int]
|
||||
REGION_CODE_FIELD_NUMBER: _ClassVar[int]
|
||||
ip: str
|
||||
port: int
|
||||
labels: _containers.ScalarMap[str, str]
|
||||
principal: str
|
||||
region_code: str
|
||||
def __init__(
|
||||
self,
|
||||
ip: _Optional[str] = ...,
|
||||
port: _Optional[int] = ...,
|
||||
labels: _Optional[_Mapping[str, str]] = ...,
|
||||
principal: _Optional[str] = ...,
|
||||
region_code: _Optional[str] = ...,
|
||||
) -> None: ...
|
||||
|
||||
class Api(_message.Message):
|
||||
__slots__ = ("service", "operation", "protocol", "version")
|
||||
SERVICE_FIELD_NUMBER: _ClassVar[int]
|
||||
OPERATION_FIELD_NUMBER: _ClassVar[int]
|
||||
PROTOCOL_FIELD_NUMBER: _ClassVar[int]
|
||||
VERSION_FIELD_NUMBER: _ClassVar[int]
|
||||
service: str
|
||||
operation: str
|
||||
protocol: str
|
||||
version: str
|
||||
def __init__(
|
||||
self,
|
||||
service: _Optional[str] = ...,
|
||||
operation: _Optional[str] = ...,
|
||||
protocol: _Optional[str] = ...,
|
||||
version: _Optional[str] = ...,
|
||||
) -> None: ...
|
||||
|
||||
class Auth(_message.Message):
|
||||
__slots__ = ("principal", "audiences", "presenter", "claims", "access_levels")
|
||||
PRINCIPAL_FIELD_NUMBER: _ClassVar[int]
|
||||
AUDIENCES_FIELD_NUMBER: _ClassVar[int]
|
||||
PRESENTER_FIELD_NUMBER: _ClassVar[int]
|
||||
CLAIMS_FIELD_NUMBER: _ClassVar[int]
|
||||
ACCESS_LEVELS_FIELD_NUMBER: _ClassVar[int]
|
||||
principal: str
|
||||
audiences: _containers.RepeatedScalarFieldContainer[str]
|
||||
presenter: str
|
||||
claims: _struct_pb2.Struct
|
||||
access_levels: _containers.RepeatedScalarFieldContainer[str]
|
||||
def __init__(
|
||||
self,
|
||||
principal: _Optional[str] = ...,
|
||||
audiences: _Optional[_Iterable[str]] = ...,
|
||||
presenter: _Optional[str] = ...,
|
||||
claims: _Optional[_Union[_struct_pb2.Struct, _Mapping]] = ...,
|
||||
access_levels: _Optional[_Iterable[str]] = ...,
|
||||
) -> None: ...
|
||||
|
||||
class Request(_message.Message):
|
||||
__slots__ = (
|
||||
"id",
|
||||
"method",
|
||||
"headers",
|
||||
"path",
|
||||
"host",
|
||||
"scheme",
|
||||
"query",
|
||||
"time",
|
||||
"size",
|
||||
"protocol",
|
||||
"reason",
|
||||
"auth",
|
||||
)
|
||||
|
||||
class HeadersEntry(_message.Message):
|
||||
__slots__ = ("key", "value")
|
||||
KEY_FIELD_NUMBER: _ClassVar[int]
|
||||
VALUE_FIELD_NUMBER: _ClassVar[int]
|
||||
key: str
|
||||
value: str
|
||||
def __init__(
|
||||
self, key: _Optional[str] = ..., value: _Optional[str] = ...
|
||||
) -> None: ...
|
||||
ID_FIELD_NUMBER: _ClassVar[int]
|
||||
METHOD_FIELD_NUMBER: _ClassVar[int]
|
||||
HEADERS_FIELD_NUMBER: _ClassVar[int]
|
||||
PATH_FIELD_NUMBER: _ClassVar[int]
|
||||
HOST_FIELD_NUMBER: _ClassVar[int]
|
||||
SCHEME_FIELD_NUMBER: _ClassVar[int]
|
||||
QUERY_FIELD_NUMBER: _ClassVar[int]
|
||||
TIME_FIELD_NUMBER: _ClassVar[int]
|
||||
SIZE_FIELD_NUMBER: _ClassVar[int]
|
||||
PROTOCOL_FIELD_NUMBER: _ClassVar[int]
|
||||
REASON_FIELD_NUMBER: _ClassVar[int]
|
||||
AUTH_FIELD_NUMBER: _ClassVar[int]
|
||||
id: str
|
||||
method: str
|
||||
headers: _containers.ScalarMap[str, str]
|
||||
path: str
|
||||
host: str
|
||||
scheme: str
|
||||
query: str
|
||||
time: _timestamp_pb2.Timestamp
|
||||
size: int
|
||||
protocol: str
|
||||
reason: str
|
||||
auth: AttributeContext.Auth
|
||||
def __init__(
|
||||
self,
|
||||
id: _Optional[str] = ...,
|
||||
method: _Optional[str] = ...,
|
||||
headers: _Optional[_Mapping[str, str]] = ...,
|
||||
path: _Optional[str] = ...,
|
||||
host: _Optional[str] = ...,
|
||||
scheme: _Optional[str] = ...,
|
||||
query: _Optional[str] = ...,
|
||||
time: _Optional[_Union[_timestamp_pb2.Timestamp, _Mapping]] = ...,
|
||||
size: _Optional[int] = ...,
|
||||
protocol: _Optional[str] = ...,
|
||||
reason: _Optional[str] = ...,
|
||||
auth: _Optional[_Union[AttributeContext.Auth, _Mapping]] = ...,
|
||||
) -> None: ...
|
||||
|
||||
class Response(_message.Message):
|
||||
__slots__ = ("code", "size", "headers", "time", "backend_latency")
|
||||
|
||||
class HeadersEntry(_message.Message):
|
||||
__slots__ = ("key", "value")
|
||||
KEY_FIELD_NUMBER: _ClassVar[int]
|
||||
VALUE_FIELD_NUMBER: _ClassVar[int]
|
||||
key: str
|
||||
value: str
|
||||
def __init__(
|
||||
self, key: _Optional[str] = ..., value: _Optional[str] = ...
|
||||
) -> None: ...
|
||||
CODE_FIELD_NUMBER: _ClassVar[int]
|
||||
SIZE_FIELD_NUMBER: _ClassVar[int]
|
||||
HEADERS_FIELD_NUMBER: _ClassVar[int]
|
||||
TIME_FIELD_NUMBER: _ClassVar[int]
|
||||
BACKEND_LATENCY_FIELD_NUMBER: _ClassVar[int]
|
||||
code: int
|
||||
size: int
|
||||
headers: _containers.ScalarMap[str, str]
|
||||
time: _timestamp_pb2.Timestamp
|
||||
backend_latency: _duration_pb2.Duration
|
||||
def __init__(
|
||||
self,
|
||||
code: _Optional[int] = ...,
|
||||
size: _Optional[int] = ...,
|
||||
headers: _Optional[_Mapping[str, str]] = ...,
|
||||
time: _Optional[_Union[_timestamp_pb2.Timestamp, _Mapping]] = ...,
|
||||
backend_latency: _Optional[_Union[_duration_pb2.Duration, _Mapping]] = ...,
|
||||
) -> None: ...
|
||||
|
||||
class Resource(_message.Message):
|
||||
__slots__ = (
|
||||
"service",
|
||||
"name",
|
||||
"type",
|
||||
"labels",
|
||||
"uid",
|
||||
"annotations",
|
||||
"display_name",
|
||||
"create_time",
|
||||
"update_time",
|
||||
"delete_time",
|
||||
"etag",
|
||||
"location",
|
||||
)
|
||||
|
||||
class LabelsEntry(_message.Message):
|
||||
__slots__ = ("key", "value")
|
||||
KEY_FIELD_NUMBER: _ClassVar[int]
|
||||
VALUE_FIELD_NUMBER: _ClassVar[int]
|
||||
key: str
|
||||
value: str
|
||||
def __init__(
|
||||
self, key: _Optional[str] = ..., value: _Optional[str] = ...
|
||||
) -> None: ...
|
||||
|
||||
class AnnotationsEntry(_message.Message):
|
||||
__slots__ = ("key", "value")
|
||||
KEY_FIELD_NUMBER: _ClassVar[int]
|
||||
VALUE_FIELD_NUMBER: _ClassVar[int]
|
||||
key: str
|
||||
value: str
|
||||
def __init__(
|
||||
self, key: _Optional[str] = ..., value: _Optional[str] = ...
|
||||
) -> None: ...
|
||||
SERVICE_FIELD_NUMBER: _ClassVar[int]
|
||||
NAME_FIELD_NUMBER: _ClassVar[int]
|
||||
TYPE_FIELD_NUMBER: _ClassVar[int]
|
||||
LABELS_FIELD_NUMBER: _ClassVar[int]
|
||||
UID_FIELD_NUMBER: _ClassVar[int]
|
||||
ANNOTATIONS_FIELD_NUMBER: _ClassVar[int]
|
||||
DISPLAY_NAME_FIELD_NUMBER: _ClassVar[int]
|
||||
CREATE_TIME_FIELD_NUMBER: _ClassVar[int]
|
||||
UPDATE_TIME_FIELD_NUMBER: _ClassVar[int]
|
||||
DELETE_TIME_FIELD_NUMBER: _ClassVar[int]
|
||||
ETAG_FIELD_NUMBER: _ClassVar[int]
|
||||
LOCATION_FIELD_NUMBER: _ClassVar[int]
|
||||
service: str
|
||||
name: str
|
||||
type: str
|
||||
labels: _containers.ScalarMap[str, str]
|
||||
uid: str
|
||||
annotations: _containers.ScalarMap[str, str]
|
||||
display_name: str
|
||||
create_time: _timestamp_pb2.Timestamp
|
||||
update_time: _timestamp_pb2.Timestamp
|
||||
delete_time: _timestamp_pb2.Timestamp
|
||||
etag: str
|
||||
location: str
|
||||
def __init__(
|
||||
self,
|
||||
service: _Optional[str] = ...,
|
||||
name: _Optional[str] = ...,
|
||||
type: _Optional[str] = ...,
|
||||
labels: _Optional[_Mapping[str, str]] = ...,
|
||||
uid: _Optional[str] = ...,
|
||||
annotations: _Optional[_Mapping[str, str]] = ...,
|
||||
display_name: _Optional[str] = ...,
|
||||
create_time: _Optional[_Union[_timestamp_pb2.Timestamp, _Mapping]] = ...,
|
||||
update_time: _Optional[_Union[_timestamp_pb2.Timestamp, _Mapping]] = ...,
|
||||
delete_time: _Optional[_Union[_timestamp_pb2.Timestamp, _Mapping]] = ...,
|
||||
etag: _Optional[str] = ...,
|
||||
location: _Optional[str] = ...,
|
||||
) -> None: ...
|
||||
ORIGIN_FIELD_NUMBER: _ClassVar[int]
|
||||
SOURCE_FIELD_NUMBER: _ClassVar[int]
|
||||
DESTINATION_FIELD_NUMBER: _ClassVar[int]
|
||||
REQUEST_FIELD_NUMBER: _ClassVar[int]
|
||||
RESPONSE_FIELD_NUMBER: _ClassVar[int]
|
||||
RESOURCE_FIELD_NUMBER: _ClassVar[int]
|
||||
API_FIELD_NUMBER: _ClassVar[int]
|
||||
EXTENSIONS_FIELD_NUMBER: _ClassVar[int]
|
||||
origin: AttributeContext.Peer
|
||||
source: AttributeContext.Peer
|
||||
destination: AttributeContext.Peer
|
||||
request: AttributeContext.Request
|
||||
response: AttributeContext.Response
|
||||
resource: AttributeContext.Resource
|
||||
api: AttributeContext.Api
|
||||
extensions: _containers.RepeatedCompositeFieldContainer[_any_pb2.Any]
|
||||
def __init__(
|
||||
self,
|
||||
origin: _Optional[_Union[AttributeContext.Peer, _Mapping]] = ...,
|
||||
source: _Optional[_Union[AttributeContext.Peer, _Mapping]] = ...,
|
||||
destination: _Optional[_Union[AttributeContext.Peer, _Mapping]] = ...,
|
||||
request: _Optional[_Union[AttributeContext.Request, _Mapping]] = ...,
|
||||
response: _Optional[_Union[AttributeContext.Response, _Mapping]] = ...,
|
||||
resource: _Optional[_Union[AttributeContext.Resource, _Mapping]] = ...,
|
||||
api: _Optional[_Union[AttributeContext.Api, _Mapping]] = ...,
|
||||
extensions: _Optional[_Iterable[_Union[_any_pb2.Any, _Mapping]]] = ...,
|
||||
) -> None: ...
|
||||
@@ -0,0 +1,48 @@
|
||||
// Copyright 2025 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.rpc.context;
|
||||
|
||||
import "google/protobuf/struct.proto";
|
||||
|
||||
option go_package = "google.golang.org/genproto/googleapis/rpc/context;context";
|
||||
option java_multiple_files = true;
|
||||
option java_outer_classname = "AuditContextProto";
|
||||
option java_package = "com.google.rpc.context";
|
||||
|
||||
// `AuditContext` provides information that is needed for audit logging.
|
||||
message AuditContext {
|
||||
// Serialized audit log.
|
||||
bytes audit_log = 1;
|
||||
|
||||
// An API request message that is scrubbed based on the method annotation.
|
||||
// This field should only be filled if audit_log field is present.
|
||||
// Service Control will use this to assemble a complete log for Cloud Audit
|
||||
// Logs and Google internal audit logs.
|
||||
google.protobuf.Struct scrubbed_request = 2;
|
||||
|
||||
// An API response message that is scrubbed based on the method annotation.
|
||||
// This field should only be filled if audit_log field is present.
|
||||
// Service Control will use this to assemble a complete log for Cloud Audit
|
||||
// Logs and Google internal audit logs.
|
||||
google.protobuf.Struct scrubbed_response = 3;
|
||||
|
||||
// Number of scrubbed response items.
|
||||
int32 scrubbed_response_item_count = 4;
|
||||
|
||||
// Audit resource name which is scrubbed.
|
||||
string target_resource = 5;
|
||||
}
|
||||
@@ -0,0 +1,49 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Copyright 2025 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.
|
||||
|
||||
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
||||
# source: google/rpc/context/audit_context.proto
|
||||
# Protobuf Python Version: 4.25.3
|
||||
"""Generated protocol buffer code."""
|
||||
from google.protobuf import descriptor as _descriptor
|
||||
from google.protobuf import descriptor_pool as _descriptor_pool
|
||||
from google.protobuf import symbol_database as _symbol_database
|
||||
from google.protobuf.internal import builder as _builder
|
||||
|
||||
# @@protoc_insertion_point(imports)
|
||||
|
||||
_sym_db = _symbol_database.Default()
|
||||
|
||||
|
||||
from google.protobuf import struct_pb2 as google_dot_protobuf_dot_struct__pb2
|
||||
|
||||
DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(
|
||||
b'\n&google/rpc/context/audit_context.proto\x12\x12google.rpc.context\x1a\x1cgoogle/protobuf/struct.proto"\xc7\x01\n\x0c\x41uditContext\x12\x11\n\taudit_log\x18\x01 \x01(\x0c\x12\x31\n\x10scrubbed_request\x18\x02 \x01(\x0b\x32\x17.google.protobuf.Struct\x12\x32\n\x11scrubbed_response\x18\x03 \x01(\x0b\x32\x17.google.protobuf.Struct\x12$\n\x1cscrubbed_response_item_count\x18\x04 \x01(\x05\x12\x17\n\x0ftarget_resource\x18\x05 \x01(\tBh\n\x16\x63om.google.rpc.contextB\x11\x41uditContextProtoP\x01Z9google.golang.org/genproto/googleapis/rpc/context;contextb\x06proto3'
|
||||
)
|
||||
|
||||
_globals = globals()
|
||||
_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
|
||||
_builder.BuildTopDescriptorsAndMessages(
|
||||
DESCRIPTOR, "google.rpc.context.audit_context_pb2", _globals
|
||||
)
|
||||
if _descriptor._USE_C_DESCRIPTORS == False:
|
||||
_globals["DESCRIPTOR"]._options = None
|
||||
_globals[
|
||||
"DESCRIPTOR"
|
||||
]._serialized_options = b"\n\026com.google.rpc.contextB\021AuditContextProtoP\001Z9google.golang.org/genproto/googleapis/rpc/context;context"
|
||||
_globals["_AUDITCONTEXT"]._serialized_start = 93
|
||||
_globals["_AUDITCONTEXT"]._serialized_end = 292
|
||||
# @@protoc_insertion_point(module_scope)
|
||||
@@ -0,0 +1,51 @@
|
||||
# Copyright 2025 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.
|
||||
|
||||
from typing import ClassVar as _ClassVar
|
||||
from typing import Mapping as _Mapping
|
||||
from typing import Optional as _Optional
|
||||
from typing import Union as _Union
|
||||
|
||||
from google.protobuf import descriptor as _descriptor
|
||||
from google.protobuf import message as _message
|
||||
from google.protobuf import struct_pb2 as _struct_pb2
|
||||
|
||||
DESCRIPTOR: _descriptor.FileDescriptor
|
||||
|
||||
class AuditContext(_message.Message):
|
||||
__slots__ = (
|
||||
"audit_log",
|
||||
"scrubbed_request",
|
||||
"scrubbed_response",
|
||||
"scrubbed_response_item_count",
|
||||
"target_resource",
|
||||
)
|
||||
AUDIT_LOG_FIELD_NUMBER: _ClassVar[int]
|
||||
SCRUBBED_REQUEST_FIELD_NUMBER: _ClassVar[int]
|
||||
SCRUBBED_RESPONSE_FIELD_NUMBER: _ClassVar[int]
|
||||
SCRUBBED_RESPONSE_ITEM_COUNT_FIELD_NUMBER: _ClassVar[int]
|
||||
TARGET_RESOURCE_FIELD_NUMBER: _ClassVar[int]
|
||||
audit_log: bytes
|
||||
scrubbed_request: _struct_pb2.Struct
|
||||
scrubbed_response: _struct_pb2.Struct
|
||||
scrubbed_response_item_count: int
|
||||
target_resource: str
|
||||
def __init__(
|
||||
self,
|
||||
audit_log: _Optional[bytes] = ...,
|
||||
scrubbed_request: _Optional[_Union[_struct_pb2.Struct, _Mapping]] = ...,
|
||||
scrubbed_response: _Optional[_Union[_struct_pb2.Struct, _Mapping]] = ...,
|
||||
scrubbed_response_item_count: _Optional[int] = ...,
|
||||
target_resource: _Optional[str] = ...,
|
||||
) -> None: ...
|
||||
@@ -0,0 +1,363 @@
|
||||
// Copyright 2025 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.rpc;
|
||||
|
||||
import "google/protobuf/duration.proto";
|
||||
|
||||
option go_package = "google.golang.org/genproto/googleapis/rpc/errdetails;errdetails";
|
||||
option java_multiple_files = true;
|
||||
option java_outer_classname = "ErrorDetailsProto";
|
||||
option java_package = "com.google.rpc";
|
||||
option objc_class_prefix = "RPC";
|
||||
|
||||
// Describes the cause of the error with structured details.
|
||||
//
|
||||
// Example of an error when contacting the "pubsub.googleapis.com" API when it
|
||||
// is not enabled:
|
||||
//
|
||||
// { "reason": "API_DISABLED"
|
||||
// "domain": "googleapis.com"
|
||||
// "metadata": {
|
||||
// "resource": "projects/123",
|
||||
// "service": "pubsub.googleapis.com"
|
||||
// }
|
||||
// }
|
||||
//
|
||||
// This response indicates that the pubsub.googleapis.com API is not enabled.
|
||||
//
|
||||
// Example of an error that is returned when attempting to create a Spanner
|
||||
// instance in a region that is out of stock:
|
||||
//
|
||||
// { "reason": "STOCKOUT"
|
||||
// "domain": "spanner.googleapis.com",
|
||||
// "metadata": {
|
||||
// "availableRegions": "us-central1,us-east2"
|
||||
// }
|
||||
// }
|
||||
message ErrorInfo {
|
||||
// The reason of the error. This is a constant value that identifies the
|
||||
// proximate cause of the error. Error reasons are unique within a particular
|
||||
// domain of errors. This should be at most 63 characters and match a
|
||||
// regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`, which represents
|
||||
// UPPER_SNAKE_CASE.
|
||||
string reason = 1;
|
||||
|
||||
// The logical grouping to which the "reason" belongs. The error domain
|
||||
// is typically the registered service name of the tool or product that
|
||||
// generates the error. Example: "pubsub.googleapis.com". If the error is
|
||||
// generated by some common infrastructure, the error domain must be a
|
||||
// globally unique value that identifies the infrastructure. For Google API
|
||||
// infrastructure, the error domain is "googleapis.com".
|
||||
string domain = 2;
|
||||
|
||||
// Additional structured details about this error.
|
||||
//
|
||||
// Keys must match a regular expression of `[a-z][a-zA-Z0-9-_]+` but should
|
||||
// ideally be lowerCamelCase. Also, they must be limited to 64 characters in
|
||||
// length. When identifying the current value of an exceeded limit, the units
|
||||
// should be contained in the key, not the value. For example, rather than
|
||||
// `{"instanceLimit": "100/request"}`, should be returned as,
|
||||
// `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
|
||||
// instances that can be created in a single (batch) request.
|
||||
map<string, string> metadata = 3;
|
||||
}
|
||||
|
||||
// Describes when the clients can retry a failed request. Clients could ignore
|
||||
// the recommendation here or retry when this information is missing from error
|
||||
// responses.
|
||||
//
|
||||
// It's always recommended that clients should use exponential backoff when
|
||||
// retrying.
|
||||
//
|
||||
// Clients should wait until `retry_delay` amount of time has passed since
|
||||
// receiving the error response before retrying. If retrying requests also
|
||||
// fail, clients should use an exponential backoff scheme to gradually increase
|
||||
// the delay between retries based on `retry_delay`, until either a maximum
|
||||
// number of retries have been reached or a maximum retry delay cap has been
|
||||
// reached.
|
||||
message RetryInfo {
|
||||
// Clients should wait at least this long between retrying the same request.
|
||||
google.protobuf.Duration retry_delay = 1;
|
||||
}
|
||||
|
||||
// Describes additional debugging info.
|
||||
message DebugInfo {
|
||||
// The stack trace entries indicating where the error occurred.
|
||||
repeated string stack_entries = 1;
|
||||
|
||||
// Additional debugging information provided by the server.
|
||||
string detail = 2;
|
||||
}
|
||||
|
||||
// Describes how a quota check failed.
|
||||
//
|
||||
// For example if a daily limit was exceeded for the calling project,
|
||||
// a service could respond with a QuotaFailure detail containing the project
|
||||
// id and the description of the quota limit that was exceeded. If the
|
||||
// calling project hasn't enabled the service in the developer console, then
|
||||
// a service could respond with the project id and set `service_disabled`
|
||||
// to true.
|
||||
//
|
||||
// Also see RetryInfo and Help types for other details about handling a
|
||||
// quota failure.
|
||||
message QuotaFailure {
|
||||
// A message type used to describe a single quota violation. For example, a
|
||||
// daily quota or a custom quota that was exceeded.
|
||||
message Violation {
|
||||
// The subject on which the quota check failed.
|
||||
// For example, "clientip:<ip address of client>" or "project:<Google
|
||||
// developer project id>".
|
||||
string subject = 1;
|
||||
|
||||
// A description of how the quota check failed. Clients can use this
|
||||
// description to find more about the quota configuration in the service's
|
||||
// public documentation, or find the relevant quota limit to adjust through
|
||||
// developer console.
|
||||
//
|
||||
// For example: "Service disabled" or "Daily Limit for read operations
|
||||
// exceeded".
|
||||
string description = 2;
|
||||
|
||||
// The API Service from which the `QuotaFailure.Violation` orginates. In
|
||||
// some cases, Quota issues originate from an API Service other than the one
|
||||
// that was called. In other words, a dependency of the called API Service
|
||||
// could be the cause of the `QuotaFailure`, and this field would have the
|
||||
// dependency API service name.
|
||||
//
|
||||
// For example, if the called API is Kubernetes Engine API
|
||||
// (container.googleapis.com), and a quota violation occurs in the
|
||||
// Kubernetes Engine API itself, this field would be
|
||||
// "container.googleapis.com". On the other hand, if the quota violation
|
||||
// occurs when the Kubernetes Engine API creates VMs in the Compute Engine
|
||||
// API (compute.googleapis.com), this field would be
|
||||
// "compute.googleapis.com".
|
||||
string api_service = 3;
|
||||
|
||||
// The metric of the violated quota. A quota metric is a named counter to
|
||||
// measure usage, such as API requests or CPUs. When an activity occurs in a
|
||||
// service, such as Virtual Machine allocation, one or more quota metrics
|
||||
// may be affected.
|
||||
//
|
||||
// For example, "compute.googleapis.com/cpus_per_vm_family",
|
||||
// "storage.googleapis.com/internet_egress_bandwidth".
|
||||
string quota_metric = 4;
|
||||
|
||||
// The id of the violated quota. Also know as "limit name", this is the
|
||||
// unique identifier of a quota in the context of an API service.
|
||||
//
|
||||
// For example, "CPUS-PER-VM-FAMILY-per-project-region".
|
||||
string quota_id = 5;
|
||||
|
||||
// The dimensions of the violated quota. Every non-global quota is enforced
|
||||
// on a set of dimensions. While quota metric defines what to count, the
|
||||
// dimensions specify for what aspects the counter should be increased.
|
||||
//
|
||||
// For example, the quota "CPUs per region per VM family" enforces a limit
|
||||
// on the metric "compute.googleapis.com/cpus_per_vm_family" on dimensions
|
||||
// "region" and "vm_family". And if the violation occurred in region
|
||||
// "us-central1" and for VM family "n1", the quota_dimensions would be,
|
||||
//
|
||||
// {
|
||||
// "region": "us-central1",
|
||||
// "vm_family": "n1",
|
||||
// }
|
||||
//
|
||||
// When a quota is enforced globally, the quota_dimensions would always be
|
||||
// empty.
|
||||
map<string, string> quota_dimensions = 6;
|
||||
|
||||
// The enforced quota value at the time of the `QuotaFailure`.
|
||||
//
|
||||
// For example, if the enforced quota value at the time of the
|
||||
// `QuotaFailure` on the number of CPUs is "10", then the value of this
|
||||
// field would reflect this quantity.
|
||||
int64 quota_value = 7;
|
||||
|
||||
// The new quota value being rolled out at the time of the violation. At the
|
||||
// completion of the rollout, this value will be enforced in place of
|
||||
// quota_value. If no rollout is in progress at the time of the violation,
|
||||
// this field is not set.
|
||||
//
|
||||
// For example, if at the time of the violation a rollout is in progress
|
||||
// changing the number of CPUs quota from 10 to 20, 20 would be the value of
|
||||
// this field.
|
||||
optional int64 future_quota_value = 8;
|
||||
}
|
||||
|
||||
// Describes all quota violations.
|
||||
repeated Violation violations = 1;
|
||||
}
|
||||
|
||||
// Describes what preconditions have failed.
|
||||
//
|
||||
// For example, if an RPC failed because it required the Terms of Service to be
|
||||
// acknowledged, it could list the terms of service violation in the
|
||||
// PreconditionFailure message.
|
||||
message PreconditionFailure {
|
||||
// A message type used to describe a single precondition failure.
|
||||
message Violation {
|
||||
// The type of PreconditionFailure. We recommend using a service-specific
|
||||
// enum type to define the supported precondition violation subjects. For
|
||||
// example, "TOS" for "Terms of Service violation".
|
||||
string type = 1;
|
||||
|
||||
// The subject, relative to the type, that failed.
|
||||
// For example, "google.com/cloud" relative to the "TOS" type would indicate
|
||||
// which terms of service is being referenced.
|
||||
string subject = 2;
|
||||
|
||||
// A description of how the precondition failed. Developers can use this
|
||||
// description to understand how to fix the failure.
|
||||
//
|
||||
// For example: "Terms of service not accepted".
|
||||
string description = 3;
|
||||
}
|
||||
|
||||
// Describes all precondition violations.
|
||||
repeated Violation violations = 1;
|
||||
}
|
||||
|
||||
// Describes violations in a client request. This error type focuses on the
|
||||
// syntactic aspects of the request.
|
||||
message BadRequest {
|
||||
// A message type used to describe a single bad request field.
|
||||
message FieldViolation {
|
||||
// A path that leads to a field in the request body. The value will be a
|
||||
// sequence of dot-separated identifiers that identify a protocol buffer
|
||||
// field.
|
||||
//
|
||||
// Consider the following:
|
||||
//
|
||||
// message CreateContactRequest {
|
||||
// message EmailAddress {
|
||||
// enum Type {
|
||||
// TYPE_UNSPECIFIED = 0;
|
||||
// HOME = 1;
|
||||
// WORK = 2;
|
||||
// }
|
||||
//
|
||||
// optional string email = 1;
|
||||
// repeated EmailType type = 2;
|
||||
// }
|
||||
//
|
||||
// string full_name = 1;
|
||||
// repeated EmailAddress email_addresses = 2;
|
||||
// }
|
||||
//
|
||||
// In this example, in proto `field` could take one of the following values:
|
||||
//
|
||||
// * `full_name` for a violation in the `full_name` value
|
||||
// * `email_addresses[1].email` for a violation in the `email` field of the
|
||||
// first `email_addresses` message
|
||||
// * `email_addresses[3].type[2]` for a violation in the second `type`
|
||||
// value in the third `email_addresses` message.
|
||||
//
|
||||
// In JSON, the same values are represented as:
|
||||
//
|
||||
// * `fullName` for a violation in the `fullName` value
|
||||
// * `emailAddresses[1].email` for a violation in the `email` field of the
|
||||
// first `emailAddresses` message
|
||||
// * `emailAddresses[3].type[2]` for a violation in the second `type`
|
||||
// value in the third `emailAddresses` message.
|
||||
string field = 1;
|
||||
|
||||
// A description of why the request element is bad.
|
||||
string description = 2;
|
||||
|
||||
// The reason of the field-level error. This is a constant value that
|
||||
// identifies the proximate cause of the field-level error. It should
|
||||
// uniquely identify the type of the FieldViolation within the scope of the
|
||||
// google.rpc.ErrorInfo.domain. This should be at most 63
|
||||
// characters and match a regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`,
|
||||
// which represents UPPER_SNAKE_CASE.
|
||||
string reason = 3;
|
||||
|
||||
// Provides a localized error message for field-level errors that is safe to
|
||||
// return to the API consumer.
|
||||
LocalizedMessage localized_message = 4;
|
||||
}
|
||||
|
||||
// Describes all violations in a client request.
|
||||
repeated FieldViolation field_violations = 1;
|
||||
}
|
||||
|
||||
// Contains metadata about the request that clients can attach when filing a bug
|
||||
// or providing other forms of feedback.
|
||||
message RequestInfo {
|
||||
// An opaque string that should only be interpreted by the service generating
|
||||
// it. For example, it can be used to identify requests in the service's logs.
|
||||
string request_id = 1;
|
||||
|
||||
// Any data that was used to serve this request. For example, an encrypted
|
||||
// stack trace that can be sent back to the service provider for debugging.
|
||||
string serving_data = 2;
|
||||
}
|
||||
|
||||
// Describes the resource that is being accessed.
|
||||
message ResourceInfo {
|
||||
// A name for the type of resource being accessed, e.g. "sql table",
|
||||
// "cloud storage bucket", "file", "Google calendar"; or the type URL
|
||||
// of the resource: e.g. "type.googleapis.com/google.pubsub.v1.Topic".
|
||||
string resource_type = 1;
|
||||
|
||||
// The name of the resource being accessed. For example, a shared calendar
|
||||
// name: "example.com_4fghdhgsrgh@group.calendar.google.com", if the current
|
||||
// error is
|
||||
// [google.rpc.Code.PERMISSION_DENIED][google.rpc.Code.PERMISSION_DENIED].
|
||||
string resource_name = 2;
|
||||
|
||||
// The owner of the resource (optional).
|
||||
// For example, "user:<owner email>" or "project:<Google developer project
|
||||
// id>".
|
||||
string owner = 3;
|
||||
|
||||
// Describes what error is encountered when accessing this resource.
|
||||
// For example, updating a cloud project may require the `writer` permission
|
||||
// on the developer console project.
|
||||
string description = 4;
|
||||
}
|
||||
|
||||
// Provides links to documentation or for performing an out of band action.
|
||||
//
|
||||
// For example, if a quota check failed with an error indicating the calling
|
||||
// project hasn't enabled the accessed service, this can contain a URL pointing
|
||||
// directly to the right place in the developer console to flip the bit.
|
||||
message Help {
|
||||
// Describes a URL link.
|
||||
message Link {
|
||||
// Describes what the link offers.
|
||||
string description = 1;
|
||||
|
||||
// The URL of the link.
|
||||
string url = 2;
|
||||
}
|
||||
|
||||
// URL(s) pointing to additional information on handling the current error.
|
||||
repeated Link links = 1;
|
||||
}
|
||||
|
||||
// Provides a localized error message that is safe to return to the user
|
||||
// which can be attached to an RPC error.
|
||||
message LocalizedMessage {
|
||||
// The locale used following the specification defined at
|
||||
// https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
|
||||
// Examples are: "en-US", "fr-CH", "es-MX"
|
||||
string locale = 1;
|
||||
|
||||
// The localized error message in the above locale.
|
||||
string message = 2;
|
||||
}
|
||||
@@ -0,0 +1,85 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Copyright 2025 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.
|
||||
|
||||
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
||||
# source: google/rpc/error_details.proto
|
||||
# Protobuf Python Version: 4.25.3
|
||||
"""Generated protocol buffer code."""
|
||||
from google.protobuf import descriptor as _descriptor
|
||||
from google.protobuf import descriptor_pool as _descriptor_pool
|
||||
from google.protobuf import symbol_database as _symbol_database
|
||||
from google.protobuf.internal import builder as _builder
|
||||
|
||||
# @@protoc_insertion_point(imports)
|
||||
|
||||
_sym_db = _symbol_database.Default()
|
||||
|
||||
|
||||
from google.protobuf import duration_pb2 as google_dot_protobuf_dot_duration__pb2
|
||||
|
||||
DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(
|
||||
b'\n\x1egoogle/rpc/error_details.proto\x12\ngoogle.rpc\x1a\x1egoogle/protobuf/duration.proto"\x93\x01\n\tErrorInfo\x12\x0e\n\x06reason\x18\x01 \x01(\t\x12\x0e\n\x06\x64omain\x18\x02 \x01(\t\x12\x35\n\x08metadata\x18\x03 \x03(\x0b\x32#.google.rpc.ErrorInfo.MetadataEntry\x1a/\n\rMetadataEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01";\n\tRetryInfo\x12.\n\x0bretry_delay\x18\x01 \x01(\x0b\x32\x19.google.protobuf.Duration"2\n\tDebugInfo\x12\x15\n\rstack_entries\x18\x01 \x03(\t\x12\x0e\n\x06\x64\x65tail\x18\x02 \x01(\t"\x8f\x03\n\x0cQuotaFailure\x12\x36\n\nviolations\x18\x01 \x03(\x0b\x32".google.rpc.QuotaFailure.Violation\x1a\xc6\x02\n\tViolation\x12\x0f\n\x07subject\x18\x01 \x01(\t\x12\x13\n\x0b\x64\x65scription\x18\x02 \x01(\t\x12\x13\n\x0b\x61pi_service\x18\x03 \x01(\t\x12\x14\n\x0cquota_metric\x18\x04 \x01(\t\x12\x10\n\x08quota_id\x18\x05 \x01(\t\x12Q\n\x10quota_dimensions\x18\x06 \x03(\x0b\x32\x37.google.rpc.QuotaFailure.Violation.QuotaDimensionsEntry\x12\x13\n\x0bquota_value\x18\x07 \x01(\x03\x12\x1f\n\x12\x66uture_quota_value\x18\x08 \x01(\x03H\x00\x88\x01\x01\x1a\x36\n\x14QuotaDimensionsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\x42\x15\n\x13_future_quota_value"\x95\x01\n\x13PreconditionFailure\x12=\n\nviolations\x18\x01 \x03(\x0b\x32).google.rpc.PreconditionFailure.Violation\x1a?\n\tViolation\x12\x0c\n\x04type\x18\x01 \x01(\t\x12\x0f\n\x07subject\x18\x02 \x01(\t\x12\x13\n\x0b\x64\x65scription\x18\x03 \x01(\t"\xcc\x01\n\nBadRequest\x12?\n\x10\x66ield_violations\x18\x01 \x03(\x0b\x32%.google.rpc.BadRequest.FieldViolation\x1a}\n\x0e\x46ieldViolation\x12\r\n\x05\x66ield\x18\x01 \x01(\t\x12\x13\n\x0b\x64\x65scription\x18\x02 \x01(\t\x12\x0e\n\x06reason\x18\x03 \x01(\t\x12\x37\n\x11localized_message\x18\x04 \x01(\x0b\x32\x1c.google.rpc.LocalizedMessage"7\n\x0bRequestInfo\x12\x12\n\nrequest_id\x18\x01 \x01(\t\x12\x14\n\x0cserving_data\x18\x02 \x01(\t"`\n\x0cResourceInfo\x12\x15\n\rresource_type\x18\x01 \x01(\t\x12\x15\n\rresource_name\x18\x02 \x01(\t\x12\r\n\x05owner\x18\x03 \x01(\t\x12\x13\n\x0b\x64\x65scription\x18\x04 \x01(\t"V\n\x04Help\x12$\n\x05links\x18\x01 \x03(\x0b\x32\x15.google.rpc.Help.Link\x1a(\n\x04Link\x12\x13\n\x0b\x64\x65scription\x18\x01 \x01(\t\x12\x0b\n\x03url\x18\x02 \x01(\t"3\n\x10LocalizedMessage\x12\x0e\n\x06locale\x18\x01 \x01(\t\x12\x0f\n\x07message\x18\x02 \x01(\tBl\n\x0e\x63om.google.rpcB\x11\x45rrorDetailsProtoP\x01Z?google.golang.org/genproto/googleapis/rpc/errdetails;errdetails\xa2\x02\x03RPCb\x06proto3'
|
||||
)
|
||||
|
||||
_globals = globals()
|
||||
_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
|
||||
_builder.BuildTopDescriptorsAndMessages(
|
||||
DESCRIPTOR, "google.rpc.error_details_pb2", _globals
|
||||
)
|
||||
if _descriptor._USE_C_DESCRIPTORS == False:
|
||||
_globals["DESCRIPTOR"]._options = None
|
||||
_globals[
|
||||
"DESCRIPTOR"
|
||||
]._serialized_options = b"\n\016com.google.rpcB\021ErrorDetailsProtoP\001Z?google.golang.org/genproto/googleapis/rpc/errdetails;errdetails\242\002\003RPC"
|
||||
_globals["_ERRORINFO_METADATAENTRY"]._options = None
|
||||
_globals["_ERRORINFO_METADATAENTRY"]._serialized_options = b"8\001"
|
||||
_globals["_QUOTAFAILURE_VIOLATION_QUOTADIMENSIONSENTRY"]._options = None
|
||||
_globals[
|
||||
"_QUOTAFAILURE_VIOLATION_QUOTADIMENSIONSENTRY"
|
||||
]._serialized_options = b"8\001"
|
||||
_globals["_ERRORINFO"]._serialized_start = 79
|
||||
_globals["_ERRORINFO"]._serialized_end = 226
|
||||
_globals["_ERRORINFO_METADATAENTRY"]._serialized_start = 179
|
||||
_globals["_ERRORINFO_METADATAENTRY"]._serialized_end = 226
|
||||
_globals["_RETRYINFO"]._serialized_start = 228
|
||||
_globals["_RETRYINFO"]._serialized_end = 287
|
||||
_globals["_DEBUGINFO"]._serialized_start = 289
|
||||
_globals["_DEBUGINFO"]._serialized_end = 339
|
||||
_globals["_QUOTAFAILURE"]._serialized_start = 342
|
||||
_globals["_QUOTAFAILURE"]._serialized_end = 741
|
||||
_globals["_QUOTAFAILURE_VIOLATION"]._serialized_start = 415
|
||||
_globals["_QUOTAFAILURE_VIOLATION"]._serialized_end = 741
|
||||
_globals["_QUOTAFAILURE_VIOLATION_QUOTADIMENSIONSENTRY"]._serialized_start = 664
|
||||
_globals["_QUOTAFAILURE_VIOLATION_QUOTADIMENSIONSENTRY"]._serialized_end = 718
|
||||
_globals["_PRECONDITIONFAILURE"]._serialized_start = 744
|
||||
_globals["_PRECONDITIONFAILURE"]._serialized_end = 893
|
||||
_globals["_PRECONDITIONFAILURE_VIOLATION"]._serialized_start = 830
|
||||
_globals["_PRECONDITIONFAILURE_VIOLATION"]._serialized_end = 893
|
||||
_globals["_BADREQUEST"]._serialized_start = 896
|
||||
_globals["_BADREQUEST"]._serialized_end = 1100
|
||||
_globals["_BADREQUEST_FIELDVIOLATION"]._serialized_start = 975
|
||||
_globals["_BADREQUEST_FIELDVIOLATION"]._serialized_end = 1100
|
||||
_globals["_REQUESTINFO"]._serialized_start = 1102
|
||||
_globals["_REQUESTINFO"]._serialized_end = 1157
|
||||
_globals["_RESOURCEINFO"]._serialized_start = 1159
|
||||
_globals["_RESOURCEINFO"]._serialized_end = 1255
|
||||
_globals["_HELP"]._serialized_start = 1257
|
||||
_globals["_HELP"]._serialized_end = 1343
|
||||
_globals["_HELP_LINK"]._serialized_start = 1303
|
||||
_globals["_HELP_LINK"]._serialized_end = 1343
|
||||
_globals["_LOCALIZEDMESSAGE"]._serialized_start = 1345
|
||||
_globals["_LOCALIZEDMESSAGE"]._serialized_end = 1396
|
||||
# @@protoc_insertion_point(module_scope)
|
||||
@@ -0,0 +1,246 @@
|
||||
# Copyright 2025 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.
|
||||
|
||||
from typing import ClassVar as _ClassVar
|
||||
from typing import Iterable as _Iterable
|
||||
from typing import Mapping as _Mapping
|
||||
from typing import Optional as _Optional
|
||||
from typing import Union as _Union
|
||||
|
||||
from google.protobuf import descriptor as _descriptor
|
||||
from google.protobuf import duration_pb2 as _duration_pb2
|
||||
from google.protobuf import message as _message
|
||||
from google.protobuf.internal import containers as _containers
|
||||
|
||||
DESCRIPTOR: _descriptor.FileDescriptor
|
||||
|
||||
class ErrorInfo(_message.Message):
|
||||
__slots__ = ("reason", "domain", "metadata")
|
||||
|
||||
class MetadataEntry(_message.Message):
|
||||
__slots__ = ("key", "value")
|
||||
KEY_FIELD_NUMBER: _ClassVar[int]
|
||||
VALUE_FIELD_NUMBER: _ClassVar[int]
|
||||
key: str
|
||||
value: str
|
||||
def __init__(
|
||||
self, key: _Optional[str] = ..., value: _Optional[str] = ...
|
||||
) -> None: ...
|
||||
REASON_FIELD_NUMBER: _ClassVar[int]
|
||||
DOMAIN_FIELD_NUMBER: _ClassVar[int]
|
||||
METADATA_FIELD_NUMBER: _ClassVar[int]
|
||||
reason: str
|
||||
domain: str
|
||||
metadata: _containers.ScalarMap[str, str]
|
||||
def __init__(
|
||||
self,
|
||||
reason: _Optional[str] = ...,
|
||||
domain: _Optional[str] = ...,
|
||||
metadata: _Optional[_Mapping[str, str]] = ...,
|
||||
) -> None: ...
|
||||
|
||||
class RetryInfo(_message.Message):
|
||||
__slots__ = ("retry_delay",)
|
||||
RETRY_DELAY_FIELD_NUMBER: _ClassVar[int]
|
||||
retry_delay: _duration_pb2.Duration
|
||||
def __init__(
|
||||
self, retry_delay: _Optional[_Union[_duration_pb2.Duration, _Mapping]] = ...
|
||||
) -> None: ...
|
||||
|
||||
class DebugInfo(_message.Message):
|
||||
__slots__ = ("stack_entries", "detail")
|
||||
STACK_ENTRIES_FIELD_NUMBER: _ClassVar[int]
|
||||
DETAIL_FIELD_NUMBER: _ClassVar[int]
|
||||
stack_entries: _containers.RepeatedScalarFieldContainer[str]
|
||||
detail: str
|
||||
def __init__(
|
||||
self,
|
||||
stack_entries: _Optional[_Iterable[str]] = ...,
|
||||
detail: _Optional[str] = ...,
|
||||
) -> None: ...
|
||||
|
||||
class QuotaFailure(_message.Message):
|
||||
__slots__ = ("violations",)
|
||||
|
||||
class Violation(_message.Message):
|
||||
__slots__ = (
|
||||
"subject",
|
||||
"description",
|
||||
"api_service",
|
||||
"quota_metric",
|
||||
"quota_id",
|
||||
"quota_dimensions",
|
||||
"quota_value",
|
||||
"future_quota_value",
|
||||
)
|
||||
|
||||
class QuotaDimensionsEntry(_message.Message):
|
||||
__slots__ = ("key", "value")
|
||||
KEY_FIELD_NUMBER: _ClassVar[int]
|
||||
VALUE_FIELD_NUMBER: _ClassVar[int]
|
||||
key: str
|
||||
value: str
|
||||
def __init__(
|
||||
self, key: _Optional[str] = ..., value: _Optional[str] = ...
|
||||
) -> None: ...
|
||||
SUBJECT_FIELD_NUMBER: _ClassVar[int]
|
||||
DESCRIPTION_FIELD_NUMBER: _ClassVar[int]
|
||||
API_SERVICE_FIELD_NUMBER: _ClassVar[int]
|
||||
QUOTA_METRIC_FIELD_NUMBER: _ClassVar[int]
|
||||
QUOTA_ID_FIELD_NUMBER: _ClassVar[int]
|
||||
QUOTA_DIMENSIONS_FIELD_NUMBER: _ClassVar[int]
|
||||
QUOTA_VALUE_FIELD_NUMBER: _ClassVar[int]
|
||||
FUTURE_QUOTA_VALUE_FIELD_NUMBER: _ClassVar[int]
|
||||
subject: str
|
||||
description: str
|
||||
api_service: str
|
||||
quota_metric: str
|
||||
quota_id: str
|
||||
quota_dimensions: _containers.ScalarMap[str, str]
|
||||
quota_value: int
|
||||
future_quota_value: int
|
||||
def __init__(
|
||||
self,
|
||||
subject: _Optional[str] = ...,
|
||||
description: _Optional[str] = ...,
|
||||
api_service: _Optional[str] = ...,
|
||||
quota_metric: _Optional[str] = ...,
|
||||
quota_id: _Optional[str] = ...,
|
||||
quota_dimensions: _Optional[_Mapping[str, str]] = ...,
|
||||
quota_value: _Optional[int] = ...,
|
||||
future_quota_value: _Optional[int] = ...,
|
||||
) -> None: ...
|
||||
VIOLATIONS_FIELD_NUMBER: _ClassVar[int]
|
||||
violations: _containers.RepeatedCompositeFieldContainer[QuotaFailure.Violation]
|
||||
def __init__(
|
||||
self,
|
||||
violations: _Optional[
|
||||
_Iterable[_Union[QuotaFailure.Violation, _Mapping]]
|
||||
] = ...,
|
||||
) -> None: ...
|
||||
|
||||
class PreconditionFailure(_message.Message):
|
||||
__slots__ = ("violations",)
|
||||
|
||||
class Violation(_message.Message):
|
||||
__slots__ = ("type", "subject", "description")
|
||||
TYPE_FIELD_NUMBER: _ClassVar[int]
|
||||
SUBJECT_FIELD_NUMBER: _ClassVar[int]
|
||||
DESCRIPTION_FIELD_NUMBER: _ClassVar[int]
|
||||
type: str
|
||||
subject: str
|
||||
description: str
|
||||
def __init__(
|
||||
self,
|
||||
type: _Optional[str] = ...,
|
||||
subject: _Optional[str] = ...,
|
||||
description: _Optional[str] = ...,
|
||||
) -> None: ...
|
||||
VIOLATIONS_FIELD_NUMBER: _ClassVar[int]
|
||||
violations: _containers.RepeatedCompositeFieldContainer[
|
||||
PreconditionFailure.Violation
|
||||
]
|
||||
def __init__(
|
||||
self,
|
||||
violations: _Optional[
|
||||
_Iterable[_Union[PreconditionFailure.Violation, _Mapping]]
|
||||
] = ...,
|
||||
) -> None: ...
|
||||
|
||||
class BadRequest(_message.Message):
|
||||
__slots__ = ("field_violations",)
|
||||
|
||||
class FieldViolation(_message.Message):
|
||||
__slots__ = ("field", "description", "reason", "localized_message")
|
||||
FIELD_FIELD_NUMBER: _ClassVar[int]
|
||||
DESCRIPTION_FIELD_NUMBER: _ClassVar[int]
|
||||
REASON_FIELD_NUMBER: _ClassVar[int]
|
||||
LOCALIZED_MESSAGE_FIELD_NUMBER: _ClassVar[int]
|
||||
field: str
|
||||
description: str
|
||||
reason: str
|
||||
localized_message: LocalizedMessage
|
||||
def __init__(
|
||||
self,
|
||||
field: _Optional[str] = ...,
|
||||
description: _Optional[str] = ...,
|
||||
reason: _Optional[str] = ...,
|
||||
localized_message: _Optional[_Union[LocalizedMessage, _Mapping]] = ...,
|
||||
) -> None: ...
|
||||
FIELD_VIOLATIONS_FIELD_NUMBER: _ClassVar[int]
|
||||
field_violations: _containers.RepeatedCompositeFieldContainer[
|
||||
BadRequest.FieldViolation
|
||||
]
|
||||
def __init__(
|
||||
self,
|
||||
field_violations: _Optional[
|
||||
_Iterable[_Union[BadRequest.FieldViolation, _Mapping]]
|
||||
] = ...,
|
||||
) -> None: ...
|
||||
|
||||
class RequestInfo(_message.Message):
|
||||
__slots__ = ("request_id", "serving_data")
|
||||
REQUEST_ID_FIELD_NUMBER: _ClassVar[int]
|
||||
SERVING_DATA_FIELD_NUMBER: _ClassVar[int]
|
||||
request_id: str
|
||||
serving_data: str
|
||||
def __init__(
|
||||
self, request_id: _Optional[str] = ..., serving_data: _Optional[str] = ...
|
||||
) -> None: ...
|
||||
|
||||
class ResourceInfo(_message.Message):
|
||||
__slots__ = ("resource_type", "resource_name", "owner", "description")
|
||||
RESOURCE_TYPE_FIELD_NUMBER: _ClassVar[int]
|
||||
RESOURCE_NAME_FIELD_NUMBER: _ClassVar[int]
|
||||
OWNER_FIELD_NUMBER: _ClassVar[int]
|
||||
DESCRIPTION_FIELD_NUMBER: _ClassVar[int]
|
||||
resource_type: str
|
||||
resource_name: str
|
||||
owner: str
|
||||
description: str
|
||||
def __init__(
|
||||
self,
|
||||
resource_type: _Optional[str] = ...,
|
||||
resource_name: _Optional[str] = ...,
|
||||
owner: _Optional[str] = ...,
|
||||
description: _Optional[str] = ...,
|
||||
) -> None: ...
|
||||
|
||||
class Help(_message.Message):
|
||||
__slots__ = ("links",)
|
||||
|
||||
class Link(_message.Message):
|
||||
__slots__ = ("description", "url")
|
||||
DESCRIPTION_FIELD_NUMBER: _ClassVar[int]
|
||||
URL_FIELD_NUMBER: _ClassVar[int]
|
||||
description: str
|
||||
url: str
|
||||
def __init__(
|
||||
self, description: _Optional[str] = ..., url: _Optional[str] = ...
|
||||
) -> None: ...
|
||||
LINKS_FIELD_NUMBER: _ClassVar[int]
|
||||
links: _containers.RepeatedCompositeFieldContainer[Help.Link]
|
||||
def __init__(
|
||||
self, links: _Optional[_Iterable[_Union[Help.Link, _Mapping]]] = ...
|
||||
) -> None: ...
|
||||
|
||||
class LocalizedMessage(_message.Message):
|
||||
__slots__ = ("locale", "message")
|
||||
LOCALE_FIELD_NUMBER: _ClassVar[int]
|
||||
MESSAGE_FIELD_NUMBER: _ClassVar[int]
|
||||
locale: str
|
||||
message: str
|
||||
def __init__(
|
||||
self, locale: _Optional[str] = ..., message: _Optional[str] = ...
|
||||
) -> None: ...
|
||||
@@ -0,0 +1,64 @@
|
||||
// Copyright 2025 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.rpc;
|
||||
|
||||
option go_package = "google.golang.org/genproto/googleapis/rpc/http;http";
|
||||
option java_multiple_files = true;
|
||||
option java_outer_classname = "HttpProto";
|
||||
option java_package = "com.google.rpc";
|
||||
option objc_class_prefix = "RPC";
|
||||
|
||||
// Represents an HTTP request.
|
||||
message HttpRequest {
|
||||
// The HTTP request method.
|
||||
string method = 1;
|
||||
|
||||
// The HTTP request URI.
|
||||
string uri = 2;
|
||||
|
||||
// The HTTP request headers. The ordering of the headers is significant.
|
||||
// Multiple headers with the same key may present for the request.
|
||||
repeated HttpHeader headers = 3;
|
||||
|
||||
// The HTTP request body. If the body is not expected, it should be empty.
|
||||
bytes body = 4;
|
||||
}
|
||||
|
||||
// Represents an HTTP response.
|
||||
message HttpResponse {
|
||||
// The HTTP status code, such as 200 or 404.
|
||||
int32 status = 1;
|
||||
|
||||
// The HTTP reason phrase, such as "OK" or "Not Found".
|
||||
string reason = 2;
|
||||
|
||||
// The HTTP response headers. The ordering of the headers is significant.
|
||||
// Multiple headers with the same key may present for the response.
|
||||
repeated HttpHeader headers = 3;
|
||||
|
||||
// The HTTP response body. If the body is not expected, it should be empty.
|
||||
bytes body = 4;
|
||||
}
|
||||
|
||||
// Represents an HTTP header.
|
||||
message HttpHeader {
|
||||
// The HTTP header key. It is case insensitive.
|
||||
string key = 1;
|
||||
|
||||
// The HTTP header value.
|
||||
string value = 2;
|
||||
}
|
||||
@@ -0,0 +1,49 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Copyright 2025 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.
|
||||
|
||||
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
||||
# source: google/rpc/http.proto
|
||||
# Protobuf Python Version: 4.25.3
|
||||
"""Generated protocol buffer code."""
|
||||
from google.protobuf import descriptor as _descriptor
|
||||
from google.protobuf import descriptor_pool as _descriptor_pool
|
||||
from google.protobuf import symbol_database as _symbol_database
|
||||
from google.protobuf.internal import builder as _builder
|
||||
|
||||
# @@protoc_insertion_point(imports)
|
||||
|
||||
_sym_db = _symbol_database.Default()
|
||||
|
||||
|
||||
DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(
|
||||
b'\n\x15google/rpc/http.proto\x12\ngoogle.rpc"a\n\x0bHttpRequest\x12\x0e\n\x06method\x18\x01 \x01(\t\x12\x0b\n\x03uri\x18\x02 \x01(\t\x12\'\n\x07headers\x18\x03 \x03(\x0b\x32\x16.google.rpc.HttpHeader\x12\x0c\n\x04\x62ody\x18\x04 \x01(\x0c"e\n\x0cHttpResponse\x12\x0e\n\x06status\x18\x01 \x01(\x05\x12\x0e\n\x06reason\x18\x02 \x01(\t\x12\'\n\x07headers\x18\x03 \x03(\x0b\x32\x16.google.rpc.HttpHeader\x12\x0c\n\x04\x62ody\x18\x04 \x01(\x0c"(\n\nHttpHeader\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\tBX\n\x0e\x63om.google.rpcB\tHttpProtoP\x01Z3google.golang.org/genproto/googleapis/rpc/http;http\xa2\x02\x03RPCb\x06proto3'
|
||||
)
|
||||
|
||||
_globals = globals()
|
||||
_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
|
||||
_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, "google.rpc.http_pb2", _globals)
|
||||
if _descriptor._USE_C_DESCRIPTORS == False:
|
||||
_globals["DESCRIPTOR"]._options = None
|
||||
_globals[
|
||||
"DESCRIPTOR"
|
||||
]._serialized_options = b"\n\016com.google.rpcB\tHttpProtoP\001Z3google.golang.org/genproto/googleapis/rpc/http;http\242\002\003RPC"
|
||||
_globals["_HTTPREQUEST"]._serialized_start = 37
|
||||
_globals["_HTTPREQUEST"]._serialized_end = 134
|
||||
_globals["_HTTPRESPONSE"]._serialized_start = 136
|
||||
_globals["_HTTPRESPONSE"]._serialized_end = 237
|
||||
_globals["_HTTPHEADER"]._serialized_start = 239
|
||||
_globals["_HTTPHEADER"]._serialized_end = 279
|
||||
# @@protoc_insertion_point(module_scope)
|
||||
@@ -0,0 +1,71 @@
|
||||
# Copyright 2025 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.
|
||||
|
||||
from typing import ClassVar as _ClassVar
|
||||
from typing import Iterable as _Iterable
|
||||
from typing import Mapping as _Mapping
|
||||
from typing import Optional as _Optional
|
||||
from typing import Union as _Union
|
||||
|
||||
from google.protobuf import descriptor as _descriptor
|
||||
from google.protobuf import message as _message
|
||||
from google.protobuf.internal import containers as _containers
|
||||
|
||||
DESCRIPTOR: _descriptor.FileDescriptor
|
||||
|
||||
class HttpRequest(_message.Message):
|
||||
__slots__ = ("method", "uri", "headers", "body")
|
||||
METHOD_FIELD_NUMBER: _ClassVar[int]
|
||||
URI_FIELD_NUMBER: _ClassVar[int]
|
||||
HEADERS_FIELD_NUMBER: _ClassVar[int]
|
||||
BODY_FIELD_NUMBER: _ClassVar[int]
|
||||
method: str
|
||||
uri: str
|
||||
headers: _containers.RepeatedCompositeFieldContainer[HttpHeader]
|
||||
body: bytes
|
||||
def __init__(
|
||||
self,
|
||||
method: _Optional[str] = ...,
|
||||
uri: _Optional[str] = ...,
|
||||
headers: _Optional[_Iterable[_Union[HttpHeader, _Mapping]]] = ...,
|
||||
body: _Optional[bytes] = ...,
|
||||
) -> None: ...
|
||||
|
||||
class HttpResponse(_message.Message):
|
||||
__slots__ = ("status", "reason", "headers", "body")
|
||||
STATUS_FIELD_NUMBER: _ClassVar[int]
|
||||
REASON_FIELD_NUMBER: _ClassVar[int]
|
||||
HEADERS_FIELD_NUMBER: _ClassVar[int]
|
||||
BODY_FIELD_NUMBER: _ClassVar[int]
|
||||
status: int
|
||||
reason: str
|
||||
headers: _containers.RepeatedCompositeFieldContainer[HttpHeader]
|
||||
body: bytes
|
||||
def __init__(
|
||||
self,
|
||||
status: _Optional[int] = ...,
|
||||
reason: _Optional[str] = ...,
|
||||
headers: _Optional[_Iterable[_Union[HttpHeader, _Mapping]]] = ...,
|
||||
body: _Optional[bytes] = ...,
|
||||
) -> None: ...
|
||||
|
||||
class HttpHeader(_message.Message):
|
||||
__slots__ = ("key", "value")
|
||||
KEY_FIELD_NUMBER: _ClassVar[int]
|
||||
VALUE_FIELD_NUMBER: _ClassVar[int]
|
||||
key: str
|
||||
value: str
|
||||
def __init__(
|
||||
self, key: _Optional[str] = ..., value: _Optional[str] = ...
|
||||
) -> None: ...
|
||||
@@ -0,0 +1,49 @@
|
||||
// Copyright 2025 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.rpc;
|
||||
|
||||
import "google/protobuf/any.proto";
|
||||
|
||||
option cc_enable_arenas = true;
|
||||
option go_package = "google.golang.org/genproto/googleapis/rpc/status;status";
|
||||
option java_multiple_files = true;
|
||||
option java_outer_classname = "StatusProto";
|
||||
option java_package = "com.google.rpc";
|
||||
option objc_class_prefix = "RPC";
|
||||
|
||||
// The `Status` type defines a logical error model that is suitable for
|
||||
// different programming environments, including REST APIs and RPC APIs. It is
|
||||
// used by [gRPC](https://github.com/grpc). Each `Status` message contains
|
||||
// three pieces of data: error code, error message, and error details.
|
||||
//
|
||||
// You can find out more about this error model and how to work with it in the
|
||||
// [API Design Guide](https://cloud.google.com/apis/design/errors).
|
||||
message Status {
|
||||
// The status code, which should be an enum value of
|
||||
// [google.rpc.Code][google.rpc.Code].
|
||||
int32 code = 1;
|
||||
|
||||
// A developer-facing error message, which should be in English. Any
|
||||
// user-facing error message should be localized and sent in the
|
||||
// [google.rpc.Status.details][google.rpc.Status.details] field, or localized
|
||||
// by the client.
|
||||
string message = 2;
|
||||
|
||||
// A list of messages that carry the error details. There is a common set of
|
||||
// message types for APIs to use.
|
||||
repeated google.protobuf.Any details = 3;
|
||||
}
|
||||
@@ -0,0 +1,47 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Copyright 2025 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.
|
||||
|
||||
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
||||
# source: google/rpc/status.proto
|
||||
# Protobuf Python Version: 4.25.3
|
||||
"""Generated protocol buffer code."""
|
||||
from google.protobuf import descriptor as _descriptor
|
||||
from google.protobuf import descriptor_pool as _descriptor_pool
|
||||
from google.protobuf import symbol_database as _symbol_database
|
||||
from google.protobuf.internal import builder as _builder
|
||||
|
||||
# @@protoc_insertion_point(imports)
|
||||
|
||||
_sym_db = _symbol_database.Default()
|
||||
|
||||
|
||||
from google.protobuf import any_pb2 as google_dot_protobuf_dot_any__pb2
|
||||
|
||||
DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(
|
||||
b'\n\x17google/rpc/status.proto\x12\ngoogle.rpc\x1a\x19google/protobuf/any.proto"N\n\x06Status\x12\x0c\n\x04\x63ode\x18\x01 \x01(\x05\x12\x0f\n\x07message\x18\x02 \x01(\t\x12%\n\x07\x64\x65tails\x18\x03 \x03(\x0b\x32\x14.google.protobuf.AnyBa\n\x0e\x63om.google.rpcB\x0bStatusProtoP\x01Z7google.golang.org/genproto/googleapis/rpc/status;status\xf8\x01\x01\xa2\x02\x03RPCb\x06proto3'
|
||||
)
|
||||
|
||||
_globals = globals()
|
||||
_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
|
||||
_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, "google.rpc.status_pb2", _globals)
|
||||
if _descriptor._USE_C_DESCRIPTORS == False:
|
||||
_globals["DESCRIPTOR"]._options = None
|
||||
_globals[
|
||||
"DESCRIPTOR"
|
||||
]._serialized_options = b"\n\016com.google.rpcB\013StatusProtoP\001Z7google.golang.org/genproto/googleapis/rpc/status;status\370\001\001\242\002\003RPC"
|
||||
_globals["_STATUS"]._serialized_start = 66
|
||||
_globals["_STATUS"]._serialized_end = 144
|
||||
# @@protoc_insertion_point(module_scope)
|
||||
@@ -0,0 +1,41 @@
|
||||
# Copyright 2025 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.
|
||||
|
||||
from typing import ClassVar as _ClassVar
|
||||
from typing import Iterable as _Iterable
|
||||
from typing import Mapping as _Mapping
|
||||
from typing import Optional as _Optional
|
||||
from typing import Union as _Union
|
||||
|
||||
from google.protobuf import any_pb2 as _any_pb2
|
||||
from google.protobuf import descriptor as _descriptor
|
||||
from google.protobuf import message as _message
|
||||
from google.protobuf.internal import containers as _containers
|
||||
|
||||
DESCRIPTOR: _descriptor.FileDescriptor
|
||||
|
||||
class Status(_message.Message):
|
||||
__slots__ = ("code", "message", "details")
|
||||
CODE_FIELD_NUMBER: _ClassVar[int]
|
||||
MESSAGE_FIELD_NUMBER: _ClassVar[int]
|
||||
DETAILS_FIELD_NUMBER: _ClassVar[int]
|
||||
code: int
|
||||
message: str
|
||||
details: _containers.RepeatedCompositeFieldContainer[_any_pb2.Any]
|
||||
def __init__(
|
||||
self,
|
||||
code: _Optional[int] = ...,
|
||||
message: _Optional[str] = ...,
|
||||
details: _Optional[_Iterable[_Union[_any_pb2.Any, _Mapping]]] = ...,
|
||||
) -> None: ...
|
||||
Reference in New Issue
Block a user