# generated by fastapi-codegen:
# filename: openapi.yaml
# timestamp: 2025-06-29T02:51:12+00:00
from __future__ import annotations
from enum import Enum
from typing import Any, Dict, List, Optional
from pydantic import BaseModel, Field, RootModel
class AdminQuotaPolicy(BaseModel):
container: Optional[str] = Field(
None,
description='The cloud resource container at which the quota policy is created. The format is `{container_type}/{container_number}`',
)
dimensions: Optional[Dict[str, str]] = Field(
None,
description=' If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, an policy on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the policy is only applied to quota consumed in that region. This map has the following restrictions: * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * Keys other than `region` or `zone` are not valid.',
)
metric: Optional[str] = Field(
None,
description='The name of the metric to which this policy applies. An example name would be: `compute.googleapis.com/cpus`',
)
name: Optional[str] = Field(
None,
description='The resource name of the policy. This name is generated by the server when the policy is created. Example names would be: `organizations/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminQuotaPolicies/4a3f2c1d`',
)
policyValue: Optional[str] = Field(
None,
description='The quota policy value. Can be any nonnegative integer, or -1 (unlimited quota).',
)
unit: Optional[str] = Field(
None,
description='The limit unit of the limit to which this policy applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string.',
)
class Syntax(Enum):
SYNTAX_PROTO2 = 'SYNTAX_PROTO2'
SYNTAX_PROTO3 = 'SYNTAX_PROTO3'
SYNTAX_EDITIONS = 'SYNTAX_EDITIONS'
class AuthRequirement(BaseModel):
audiences: Optional[str] = Field(
None,
description='NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com',
)
providerId: Optional[str] = Field(
None,
description='id from authentication provider. Example: provider_id: bookstore_auth',
)
class PathTranslation(Enum):
PATH_TRANSLATION_UNSPECIFIED = 'PATH_TRANSLATION_UNSPECIFIED'
CONSTANT_ADDRESS = 'CONSTANT_ADDRESS'
APPEND_PATH_TO_ADDRESS = 'APPEND_PATH_TO_ADDRESS'
class BackendRule(BaseModel):
address: Optional[str] = Field(
None,
description='The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version.',
)
deadline: Optional[float] = Field(
None,
description='The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.',
)
disableAuth: Optional[bool] = Field(
None,
description='When disable_auth is true, a JWT ID token won\'t be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header.',
)
jwtAudience: Optional[str] = Field(
None,
description='The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend.',
)
minDeadline: Optional[float] = Field(None, description='Deprecated, do not use.')
operationDeadline: Optional[float] = Field(
None,
description='The number of seconds to wait for the completion of a long running operation. The default is no deadline.',
)
overridesByRequestProtocol: Optional[Dict[str, BackendRule]] = Field(
None, description='The map between request protocol and the backend address.'
)
pathTranslation: Optional[PathTranslation] = None
protocol: Optional[str] = Field(
None,
description='The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values.',
)
selector: Optional[str] = Field(
None,
description='Selects the methods to which this rule applies. Refer to selector for syntax details.',
)
class BatchEnableServicesRequest(BaseModel):
serviceIds: Optional[List[str]] = Field(
None,
description='The identifiers of the services to enable on the project. A valid identifier would be: serviceusage.googleapis.com Enabling services requires that each service is public or is shared with the user enabling the service. Two or more services must be specified. To enable a single service, use the `EnableService` method instead. A single request can enable a maximum of 20 services at a time. If more than 20 services are specified, the request will fail, and no state changes will occur.',
)
class BillingDestination(BaseModel):
metrics: Optional[List[str]] = Field(
None,
description='Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.',
)
monitoredResource: Optional[str] = Field(
None,
description='The monitored resource type. The type must be defined in Service.monitored_resources section.',
)
class LaunchStage(Enum):
LAUNCH_STAGE_UNSPECIFIED = 'LAUNCH_STAGE_UNSPECIFIED'
UNIMPLEMENTED = 'UNIMPLEMENTED'
PRELAUNCH = 'PRELAUNCH'
EARLY_ACCESS = 'EARLY_ACCESS'
ALPHA = 'ALPHA'
BETA = 'BETA'
GA = 'GA'
DEPRECATED = 'DEPRECATED'
class Destination(Enum):
CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 'CLIENT_LIBRARY_DESTINATION_UNSPECIFIED'
GITHUB = 'GITHUB'
PACKAGE_MANAGER = 'PACKAGE_MANAGER'
class CommonLanguageSettings(BaseModel):
destinations: Optional[List[Destination]] = Field(
None,
description='The destination where API teams want this client library to be published.',
)
referenceDocsUri: Optional[str] = Field(
None,
description='Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest',
)
class ContextRule(BaseModel):
allowedRequestExtensions: Optional[List[str]] = Field(
None,
description='A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.',
)
allowedResponseExtensions: Optional[List[str]] = Field(
None,
description='A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.',
)
provided: Optional[List[str]] = Field(
None, description='A list of full type names of provided contexts.'
)
requested: Optional[List[str]] = Field(
None, description='A list of full type names of requested contexts.'
)
selector: Optional[str] = Field(
None,
description='Selects the methods to which this rule applies. Refer to selector for syntax details.',
)
class Control(BaseModel):
environment: Optional[str] = Field(
None,
description='The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com',
)
class CppSettings(BaseModel):
common: Optional[CommonLanguageSettings] = Field(None, description='Some settings.')
class CreateAdminQuotaPolicyMetadata(BaseModel):
pass
class CustomErrorRule(BaseModel):
isErrorType: Optional[bool] = Field(
None,
description='Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.',
)
selector: Optional[str] = Field(
None,
description='Selects messages to which this rule applies. Refer to selector for syntax details.',
)
class CustomHttpPattern(BaseModel):
kind: Optional[str] = Field(None, description='The name of this custom HTTP verb.')
path: Optional[str] = Field(
None, description='The path matched by this custom verb.'
)
class DeleteAdminQuotaPolicyMetadata(BaseModel):
pass
class DisableServiceRequest(BaseModel):
pass
class DocumentationRule(BaseModel):
deprecationDescription: Optional[str] = Field(
None,
description='Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`.',
)
description: Optional[str] = Field(
None,
description="Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.",
)
selector: Optional[str] = Field(
None,
description='The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.',
)
class DotnetSettings(BaseModel):
common: Optional[CommonLanguageSettings] = Field(None, description='Some settings.')
forcedNamespaceAliases: Optional[List[str]] = Field(
None,
description='Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision',
)
handwrittenSignatures: Optional[List[str]] = Field(
None,
description='Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn\'t be generated. Snippets *calling* these methods are still generated, however.',
)
ignoredResources: Optional[List[str]] = Field(
None,
description='List of full resource types to ignore during generation. This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location"',
)
renamedResources: Optional[Dict[str, str]] = Field(
None,
description='Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"',
)
renamedServices: Optional[Dict[str, str]] = Field(
None,
description='Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.',
)
class Empty(BaseModel):
pass
class EnableFailure(BaseModel):
errorMessage: Optional[str] = Field(
None,
description='An error message describing why the service could not be enabled.',
)
serviceId: Optional[str] = Field(
None, description='The service id of a service that could not be enabled.'
)
class EnableType(Enum):
ENABLE_TYPE_UNSPECIFIED = 'ENABLE_TYPE_UNSPECIFIED'
CLIENT = 'CLIENT'
RESOURCE = 'RESOURCE'
V1_COMPATIBLE = 'V1_COMPATIBLE'
class EnableRule(BaseModel):
enableType: Optional[EnableType] = Field(
None, description='Client and resource project enable type.'
)
groups: Optional[List[str]] = Field(
None,
description='DEPRECATED: Please use field `values`. Service group should have prefix `groups/`. The names of the service groups that are enabled (Not Implemented). go/predefined-service-groups. Example: `groups/googleServices`.',
)
services: Optional[List[str]] = Field(
None,
description='DEPRECATED: Please use field `values`. Service should have prefix `services/`. The names of the services that are enabled. Example: `storage.googleapis.com`.',
)
values: Optional[List[str]] = Field(
None,
description='The names of the services or service groups that are enabled. Example: `services/storage.googleapis.com`, groups/googleServices`, groups/allServices`.',
)
class EnableServiceRequest(BaseModel):
pass
class Endpoint(BaseModel):
aliases: Optional[List[str]] = Field(
None,
description='Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.',
)
allowCors: Optional[bool] = Field(
None,
description='Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.',
)
name: Optional[str] = Field(
None, description='The canonical name of this endpoint.'
)
target: Optional[str] = Field(
None,
description='The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".',
)
class Cardinality(Enum):
CARDINALITY_UNKNOWN = 'CARDINALITY_UNKNOWN'
CARDINALITY_OPTIONAL = 'CARDINALITY_OPTIONAL'
CARDINALITY_REQUIRED = 'CARDINALITY_REQUIRED'
CARDINALITY_REPEATED = 'CARDINALITY_REPEATED'
class Kind(Enum):
TYPE_UNKNOWN = 'TYPE_UNKNOWN'
TYPE_DOUBLE = 'TYPE_DOUBLE'
TYPE_FLOAT = 'TYPE_FLOAT'
TYPE_INT64 = 'TYPE_INT64'
TYPE_UINT64 = 'TYPE_UINT64'
TYPE_INT32 = 'TYPE_INT32'
TYPE_FIXED64 = 'TYPE_FIXED64'
TYPE_FIXED32 = 'TYPE_FIXED32'
TYPE_BOOL = 'TYPE_BOOL'
TYPE_STRING = 'TYPE_STRING'
TYPE_GROUP = 'TYPE_GROUP'
TYPE_MESSAGE = 'TYPE_MESSAGE'
TYPE_BYTES = 'TYPE_BYTES'
TYPE_UINT32 = 'TYPE_UINT32'
TYPE_ENUM = 'TYPE_ENUM'
TYPE_SFIXED32 = 'TYPE_SFIXED32'
TYPE_SFIXED64 = 'TYPE_SFIXED64'
TYPE_SINT32 = 'TYPE_SINT32'
TYPE_SINT64 = 'TYPE_SINT64'
class GetServiceIdentityMetadata(BaseModel):
pass
class State(Enum):
IDENTITY_STATE_UNSPECIFIED = 'IDENTITY_STATE_UNSPECIFIED'
ACTIVE = 'ACTIVE'
class GoSettings(BaseModel):
common: Optional[CommonLanguageSettings] = Field(None, description='Some settings.')
class GoogleApiServiceusageV1OperationMetadata(BaseModel):
resourceNames: Optional[List[str]] = Field(
None,
description='The full name of the resources that this operation is directly associated with.',
)
class State1(Enum):
STATE_UNSPECIFIED = 'STATE_UNSPECIFIED'
DISABLED = 'DISABLED'
ENABLED = 'ENABLED'
class State2(Enum):
IDENTITY_STATE_UNSPECIFIED = 'IDENTITY_STATE_UNSPECIFIED'
ACTIVE = 'ACTIVE'
class GoogleApiServiceusageV1beta1ServiceIdentity(BaseModel):
email: Optional[str] = Field(
None,
description='The email address of the service account that a service producer would use to access consumer resources.',
)
uniqueId: Optional[str] = Field(
None,
description='The unique and stable id of the service account. https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount',
)
class HttpRule(BaseModel):
additionalBindings: Optional[List[HttpRule]] = Field(
None,
description='Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep).',
)
body: Optional[str] = Field(
None,
description='The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.',
)
custom: Optional[CustomHttpPattern] = Field(
None,
description='The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients.',
)
delete: Optional[str] = Field(
None, description='Maps to HTTP DELETE. Used for deleting a resource.'
)
get: Optional[str] = Field(
None,
description='Maps to HTTP GET. Used for listing and getting information about resources.',
)
patch: Optional[str] = Field(
None, description='Maps to HTTP PATCH. Used for updating a resource.'
)
post: Optional[str] = Field(
None,
description='Maps to HTTP POST. Used for creating a resource or performing an action.',
)
put: Optional[str] = Field(
None, description='Maps to HTTP PUT. Used for replacing a resource.'
)
responseBody: Optional[str] = Field(
None,
description='Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type.',
)
selector: Optional[str] = Field(
None,
description='Selects a method to which this rule applies. Refer to selector for syntax details.',
)
class ImportAdminOverridesMetadata(BaseModel):
pass
class ForceOnlyEnum(Enum):
QUOTA_SAFETY_CHECK_UNSPECIFIED = 'QUOTA_SAFETY_CHECK_UNSPECIFIED'
LIMIT_DECREASE_BELOW_USAGE = 'LIMIT_DECREASE_BELOW_USAGE'
LIMIT_DECREASE_PERCENTAGE_TOO_HIGH = 'LIMIT_DECREASE_PERCENTAGE_TOO_HIGH'
class ImportAdminQuotaPoliciesMetadata(BaseModel):
pass
class ImportAdminQuotaPoliciesResponse(BaseModel):
policies: Optional[List[AdminQuotaPolicy]] = Field(
None, description='The policies that were created from the imported data.'
)
class ImportConsumerOverridesMetadata(BaseModel):
pass
class JavaSettings(BaseModel):
common: Optional[CommonLanguageSettings] = Field(None, description='Some settings.')
libraryPackage: Optional[str] = Field(
None,
description='The package name to use in Java. Clobbers the java_package option set in the protobuf. This should be used **only** by APIs who have already set the language_settings.java.package_name" field in gapic.yaml. API teams should use the protobuf java_package option where possible. Example of a YAML configuration:: publishing: java_settings: library_package: com.google.cloud.pubsub.v1',
)
serviceClassNames: Optional[Dict[str, str]] = Field(
None,
description='Configure the Java class name to use instead of the service\'s for its corresponding generated GAPIC client. Keys are fully-qualified service names as they appear in the protobuf (including the full the language_settings.java.interface_names" field in gapic.yaml. API teams should otherwise use the service name as it appears in the protobuf. Example of a YAML configuration:: publishing: java_settings: service_class_names: - google.pubsub.v1.Publisher: TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin',
)
class JwtLocation(BaseModel):
cookie: Optional[str] = Field(
None, description='Specifies cookie name to extract JWT token.'
)
header: Optional[str] = Field(
None, description='Specifies HTTP header name to extract JWT token.'
)
query: Optional[str] = Field(
None, description='Specifies URL query parameter name to extract JWT token.'
)
valuePrefix: Optional[str] = Field(
None,
description='The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end.',
)
class ValueType(Enum):
STRING = 'STRING'
BOOL = 'BOOL'
INT64 = 'INT64'
class LabelDescriptor(BaseModel):
description: Optional[str] = Field(
None, description='A human-readable description for the label.'
)
key: Optional[str] = Field(None, description='The label key.')
valueType: Optional[ValueType] = Field(
None, description='The type of data that can be assigned to the label.'
)
class LogDescriptor(BaseModel):
description: Optional[str] = Field(
None,
description='A human-readable description of this log. This information appears in the documentation and can contain details.',
)
displayName: Optional[str] = Field(
None,
description='The human-readable name for this log. This information appears on the user interface and should be concise.',
)
labels: Optional[List[LabelDescriptor]] = Field(
None,
description='The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.',
)
name: Optional[str] = Field(
None,
description='The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].',
)
class LoggingDestination(BaseModel):
logs: Optional[List[str]] = Field(
None,
description='Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".',
)
monitoredResource: Optional[str] = Field(
None,
description='The monitored resource type. The type must be defined in the Service.monitored_resources section.',
)
class LongRunning(BaseModel):
initialPollDelay: Optional[str] = Field(
None,
description='Initial delay after which the first poll request will be made. Default value: 5 seconds.',
)
maxPollDelay: Optional[str] = Field(
None,
description='Maximum time between two subsequent poll requests. Default value: 45 seconds.',
)
pollDelayMultiplier: Optional[float] = Field(
None,
description='Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.',
)
totalPollTimeout: Optional[str] = Field(
None, description='Total polling timeout. Default value: 5 minutes.'
)
class MethodSettings(BaseModel):
longRunning: Optional[LongRunning] = Field(
None,
description='Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes',
)
selector: Optional[str] = Field(
None,
description='The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.',
)
class MetricKind(Enum):
METRIC_KIND_UNSPECIFIED = 'METRIC_KIND_UNSPECIFIED'
GAUGE = 'GAUGE'
DELTA = 'DELTA'
CUMULATIVE = 'CUMULATIVE'
class ValueType1(Enum):
VALUE_TYPE_UNSPECIFIED = 'VALUE_TYPE_UNSPECIFIED'
BOOL = 'BOOL'
INT64 = 'INT64'
DOUBLE = 'DOUBLE'
STRING = 'STRING'
DISTRIBUTION = 'DISTRIBUTION'
MONEY = 'MONEY'
class MetricDescriptorMetadata(BaseModel):
ingestDelay: Optional[str] = Field(
None,
description='The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.',
)
launchStage: Optional[LaunchStage] = Field(
None,
description='Deprecated. Must use the MetricDescriptor.launch_stage instead.',
)
samplePeriod: Optional[str] = Field(
None,
description='The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.',
)
class MetricRule(BaseModel):
metricCosts: Optional[Dict[str, str]] = Field(
None,
description='Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.',
)
selector: Optional[str] = Field(
None,
description='Selects the methods to which this rule applies. Refer to selector for syntax details.',
)
class Mixin(BaseModel):
name: Optional[str] = Field(
None, description='The fully qualified name of the interface which is included.'
)
root: Optional[str] = Field(
None,
description='If non-empty specifies a path under which inherited HTTP paths are rooted.',
)
class MonitoredResourceDescriptor(BaseModel):
description: Optional[str] = Field(
None,
description='Optional. A detailed description of the monitored resource type that might be used in documentation.',
)
displayName: Optional[str] = Field(
None,
description='Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, `"Google Cloud SQL Database"`.',
)
labels: Optional[List[LabelDescriptor]] = Field(
None,
description='Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `"database_id"` and `"zone"`.',
)
launchStage: Optional[LaunchStage] = Field(
None,
description='Optional. The launch stage of the monitored resource definition.',
)
name: Optional[str] = Field(
None,
description='Optional. The resource name of the monitored resource descriptor: `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where {type} is the value of the `type` field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format `"monitoredResourceDescriptors/{type}"`.',
)
type: Optional[str] = Field(
None,
description='Required. The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL. For a list of types, see [Monitoring resource types](https://cloud.google.com/monitoring/api/resources) and [Logging resource types](https://cloud.google.com/logging/docs/api/v2/resource-list).',
)
class MonitoringDestination(BaseModel):
metrics: Optional[List[str]] = Field(
None,
description='Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section.',
)
monitoredResource: Optional[str] = Field(
None,
description='The monitored resource type. The type must be defined in Service.monitored_resources section.',
)
class NodeSettings(BaseModel):
common: Optional[CommonLanguageSettings] = Field(None, description='Some settings.')
class OAuthRequirements(BaseModel):
canonicalScopes: Optional[str] = Field(
None,
description='The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read',
)
class OperationMetadata(BaseModel):
resourceNames: Optional[List[str]] = Field(
None,
description='The full name of the resources that this operation is directly associated with.',
)
class Option(BaseModel):
name: Optional[str] = Field(
None,
description='The option\'s name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`.',
)
value: Optional[Dict[str, Any]] = Field(
None,
description="The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.",
)
class Page(BaseModel):
content: Optional[str] = Field(
None,
description='The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.',
)
name: Optional[str] = Field(
None,
description='The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`.',
)
subpages: Optional[List[Page]] = Field(
None,
description='Subpages of this page. The order of subpages specified here will be honored in the generated docset.',
)
class PhpSettings(BaseModel):
common: Optional[CommonLanguageSettings] = Field(None, description='Some settings.')
class Organization(Enum):
CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 'CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED'
CLOUD = 'CLOUD'
ADS = 'ADS'
PHOTOS = 'PHOTOS'
STREET_VIEW = 'STREET_VIEW'
SHOPPING = 'SHOPPING'
class PythonSettings(BaseModel):
common: Optional[CommonLanguageSettings] = Field(None, description='Some settings.')
class QuotaLimit(BaseModel):
defaultLimit: Optional[str] = Field(
None,
description='Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only.',
)
description: Optional[str] = Field(
None,
description="Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: `display_name`).",
)
displayName: Optional[str] = Field(
None,
description='User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.',
)
duration: Optional[str] = Field(
None,
description='Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only.',
)
freeTier: Optional[str] = Field(
None,
description='Free tier value displayed in the Developers Console for this limit. The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled. This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is no free tier for this service. Used by group-based quotas only.',
)
maxLimit: Optional[str] = Field(
None,
description='Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only.',
)
metric: Optional[str] = Field(
None,
description='The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config.',
)
name: Optional[str] = Field(
None,
description="Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters.",
)
unit: Optional[str] = Field(
None,
description='Specify the unit of the quota limit. It uses the same syntax as Metric.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax.',
)
values: Optional[Dict[str, str]] = Field(
None,
description='Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported.',
)
class QuotaOverride(BaseModel):
adminOverrideAncestor: Optional[str] = Field(
None,
description='The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only.',
)
dimensions: Optional[Dict[str, str]] = Field(
None,
description="If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit. For example, an override on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the override is only applied to quota consumed in that region. This map has the following restrictions: * Keys that are not defined in the limit's unit are not valid keys. Any string appearing in `{brackets}` in the unit (besides `{project}` or `{user}`) is a defined key. * `project` is not a valid key; the project is already specified in the parent resource name. * `user` is not a valid key; the API does not support quota overrides that apply only to a specific user. * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * If any valid key other than `region` or `zone` appears in the map, then all valid keys other than `region` or `zone` must also appear in the map.",
)
metric: Optional[str] = Field(
None,
description='The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus`',
)
name: Optional[str] = Field(
None,
description='The resource name of the override. This name is generated by the server when the override is created. Example names would be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` The resource name is intended to be opaque and should not be parsed for its component strings, since its representation could change in the future.',
)
overrideValue: Optional[str] = Field(
None,
description='The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).',
)
unit: Optional[str] = Field(
None,
description='The limit unit of the limit to which this override applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string.',
)
class RubySettings(BaseModel):
common: Optional[CommonLanguageSettings] = Field(None, description='Some settings.')
class State3(Enum):
STATE_UNSPECIFIED = 'STATE_UNSPECIFIED'
DISABLED = 'DISABLED'
ENABLED = 'ENABLED'
class ServiceIdentity(BaseModel):
email: Optional[str] = Field(
None,
description='The email address of the service account that a service producer would use to access consumer resources.',
)
uniqueId: Optional[str] = Field(
None,
description='The unique and stable id of the service account. https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount',
)
class SourceContext(BaseModel):
fileName: Optional[str] = Field(
None,
description='The path-qualified name of the .proto file that contained the associated protobuf element. For example: `"google/protobuf/source_context.proto"`.',
)
class SourceInfo(BaseModel):
sourceFiles: Optional[List[Dict[str, Any]]] = Field(
None, description='All files used during config generation.'
)
class Status(BaseModel):
code: Optional[int] = Field(
None,
description='The status code, which should be an enum value of google.rpc.Code.',
)
details: Optional[List[Dict[str, Any]]] = Field(
None,
description='A list of messages that carry the error details. There is a common set of message types for APIs to use.',
)
message: Optional[str] = Field(
None,
description='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 field, or localized by the client.',
)
class SystemParameter(BaseModel):
httpHeader: Optional[str] = Field(
None,
description='Define the HTTP header name to use for the parameter. It is case insensitive.',
)
name: Optional[str] = Field(
None,
description='Define the name of the parameter, such as "api_key" . It is case sensitive.',
)
urlQueryParameter: Optional[str] = Field(
None,
description='Define the URL query parameter name to use for the parameter. It is case sensitive.',
)
class SystemParameterRule(BaseModel):
parameters: Optional[List[SystemParameter]] = Field(
None,
description='Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent.',
)
selector: Optional[str] = Field(
None,
description="Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.",
)
class SystemParameters(BaseModel):
rules: Optional[List[SystemParameterRule]] = Field(
None,
description='Define system parameters. The parameters defined here will override the default parameters implemented by the system. If this field is missing from the service config, default system parameters will be used. Default system parameters and names is implementation-dependent. Example: define api key for all methods system_parameters rules: - selector: "*" parameters: - name: api_key url_query_parameter: api_key Example: define 2 api key names for a specific method. system_parameters rules: - selector: "/ListShelves" parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header: Api-Key2 **NOTE:** All service configuration rules follow "last one wins" order.',
)
class UpdateAdminQuotaPolicyMetadata(BaseModel):
pass
class UpdateConsumerPolicyLROMetadata(BaseModel):
pass
class UsageRule(BaseModel):
allowUnregisteredCalls: Optional[bool] = Field(
None,
description="If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.",
)
selector: Optional[str] = Field(
None,
description="Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.",
)
skipServiceControl: Optional[bool] = Field(
None,
description='If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods.',
)
class FieldXgafv(Enum):
field_1 = '1'
field_2 = '2'
class Alt(Enum):
json = 'json'
media = 'media'
proto = 'proto'
class ForceOnly(RootModel[List[ForceOnlyEnum]]):
root: List[ForceOnlyEnum]
class View(Enum):
QUOTA_VIEW_UNSPECIFIED = 'QUOTA_VIEW_UNSPECIFIED'
BASIC = 'BASIC'
FULL = 'FULL'
class ForceOnly1(RootModel[List[ForceOnlyEnum]]):
root: List[ForceOnlyEnum]
class ForceOnly2(RootModel[List[ForceOnlyEnum]]):
root: List[ForceOnlyEnum]
class ForceOnly3(RootModel[List[ForceOnlyEnum]]):
root: List[ForceOnlyEnum]
class AuthProvider(BaseModel):
audiences: Optional[str] = Field(
None,
description='The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com',
)
authorizationUrl: Optional[str] = Field(
None,
description='Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.',
)
id: Optional[str] = Field(
None,
description='The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`. Example: "bookstore_auth".',
)
issuer: Optional[str] = Field(
None,
description='Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com',
)
jwksUri: Optional[str] = Field(
None,
description="URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs",
)
jwtLocations: Optional[List[JwtLocation]] = Field(
None,
description='Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token',
)
class AuthenticationRule(BaseModel):
allowWithoutCredential: Optional[bool] = Field(
None,
description='If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.',
)
oauth: Optional[OAuthRequirements] = Field(
None, description='The requirements for OAuth credentials.'
)
requirements: Optional[List[AuthRequirement]] = Field(
None, description='Requirements for additional authentication providers.'
)
selector: Optional[str] = Field(
None,
description='Selects the methods to which this rule applies. Refer to selector for syntax details.',
)
class Backend(BaseModel):
rules: Optional[List[BackendRule]] = Field(
None,
description='A list of API backend rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.',
)
class BatchCreateAdminOverridesResponse(BaseModel):
overrides: Optional[List[QuotaOverride]] = Field(
None, description='The overrides that were created.'
)
class BatchCreateConsumerOverridesResponse(BaseModel):
overrides: Optional[List[QuotaOverride]] = Field(
None, description='The overrides that were created.'
)
class Billing(BaseModel):
consumerDestinations: Optional[List[BillingDestination]] = Field(
None,
description='Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination.',
)
class ClientLibrarySettings(BaseModel):
cppSettings: Optional[CppSettings] = Field(
None, description='Settings for C++ client libraries.'
)
dotnetSettings: Optional[DotnetSettings] = Field(
None, description='Settings for .NET client libraries.'
)
goSettings: Optional[GoSettings] = Field(
None, description='Settings for Go client libraries.'
)
javaSettings: Optional[JavaSettings] = Field(
None,
description='Settings for legacy Java features, supported in the Service YAML.',
)
launchStage: Optional[LaunchStage] = Field(
None, description='Launch stage of this version of the API.'
)
nodeSettings: Optional[NodeSettings] = Field(
None, description='Settings for Node client libraries.'
)
phpSettings: Optional[PhpSettings] = Field(
None, description='Settings for PHP client libraries.'
)
pythonSettings: Optional[PythonSettings] = Field(
None, description='Settings for Python client libraries.'
)
restNumericEnums: Optional[bool] = Field(
None,
description='When using transport=rest, the client request will encode enums as numbers rather than strings.',
)
rubySettings: Optional[RubySettings] = Field(
None, description='Settings for Ruby client libraries.'
)
version: Optional[str] = Field(
None,
description='Version of the API to apply these settings to. This is the full protobuf package for the API, ending in the version element. Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".',
)
class ConsumerPolicy(BaseModel):
annotations: Optional[Dict[str, str]] = Field(
None,
description='Optional. Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. [AIP-128](https://google.aip.dev/128#annotations)',
)
enableRules: Optional[List[EnableRule]] = Field(
None, description='Enable rules define usable services and service groups.'
)
etag: Optional[str] = Field(
None,
description='An opaque tag indicating the current version of the policy, used for concurrency control.',
)
name: Optional[str] = Field(
None,
description='Output only. The resource name of the policy. For example, `projects/12345/consumerPolicy`, `folders/12345/consumerPolicy`, `organizations/12345/consumerPolicy`.',
)
updateTime: Optional[str] = Field(None, description='The last-modified time.')
class Context(BaseModel):
rules: Optional[List[ContextRule]] = Field(
None,
description='A list of RPC context rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.',
)
class CustomError(BaseModel):
rules: Optional[List[CustomErrorRule]] = Field(
None,
description='The list of custom error rules that apply to individual API messages. **NOTE:** All service configuration rules follow "last one wins" order.',
)
types: Optional[List[str]] = Field(
None,
description="The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.",
)
class Documentation(BaseModel):
documentationRootUrl: Optional[str] = Field(
None, description='The URL to the root of documentation.'
)
overview: Optional[str] = Field(
None,
description='Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field.',
)
pages: Optional[List[Page]] = Field(
None, description='The top level pages for the documentation set.'
)
rules: Optional[List[DocumentationRule]] = Field(
None,
description='A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.',
)
serviceRootUrl: Optional[str] = Field(
None,
description='Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to.',
)
summary: Optional[str] = Field(
None,
description='A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field `description`.',
)
class EnumValue(BaseModel):
name: Optional[str] = Field(None, description='Enum value name.')
number: Optional[int] = Field(None, description='Enum value number.')
options: Optional[List[Option]] = Field(
None, description='Protocol buffer options.'
)
class FieldModel(BaseModel):
cardinality: Optional[Cardinality] = Field(
None, description='The field cardinality.'
)
defaultValue: Optional[str] = Field(
None,
description='The string value of the default value of this field. Proto2 syntax only.',
)
jsonName: Optional[str] = Field(None, description='The field JSON name.')
kind: Optional[Kind] = Field(None, description='The field type.')
name: Optional[str] = Field(None, description='The field name.')
number: Optional[int] = Field(None, description='The field number.')
oneofIndex: Optional[int] = Field(
None,
description='The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list.',
)
options: Optional[List[Option]] = Field(
None, description='The protocol buffer options.'
)
packed: Optional[bool] = Field(
None, description='Whether to use alternative packed wire representation.'
)
typeUrl: Optional[str] = Field(
None,
description='The field type URL, without the scheme, for message or enumeration types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.',
)
class GetServiceIdentityResponse(BaseModel):
identity: Optional[ServiceIdentity] = Field(
None,
description='Service identity that service producer can use to access consumer resources. If exists is true, it contains email and unique_id. If exists is false, it contains pre-constructed email and empty unique_id.',
)
state: Optional[State] = Field(None, description='Service identity state.')
class GoogleApiServiceusageV1beta1GetServiceIdentityResponse(BaseModel):
identity: Optional[GoogleApiServiceusageV1beta1ServiceIdentity] = Field(
None,
description='Service identity that service producer can use to access consumer resources. If exists is true, it contains email and unique_id. If exists is false, it contains pre-constructed email and empty unique_id.',
)
state: Optional[State2] = Field(None, description='Service identity state.')
class Http(BaseModel):
fullyDecodeReservedExpansion: Optional[bool] = Field(
None,
description='When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.',
)
rules: Optional[List[HttpRule]] = Field(
None,
description='A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.',
)
class ImportAdminOverridesResponse(BaseModel):
overrides: Optional[List[QuotaOverride]] = Field(
None, description='The overrides that were created from the imported data.'
)
class ImportConsumerOverridesResponse(BaseModel):
overrides: Optional[List[QuotaOverride]] = Field(
None, description='The overrides that were created from the imported data.'
)
class ListAdminOverridesResponse(BaseModel):
nextPageToken: Optional[str] = Field(
None,
description='Token identifying which result to start with; returned by a previous list call.',
)
overrides: Optional[List[QuotaOverride]] = Field(
None, description='Admin overrides on this limit.'
)
class ListConsumerOverridesResponse(BaseModel):
nextPageToken: Optional[str] = Field(
None,
description='Token identifying which result to start with; returned by a previous list call.',
)
overrides: Optional[List[QuotaOverride]] = Field(
None, description='Consumer overrides on this limit.'
)
class Logging(BaseModel):
consumerDestinations: Optional[List[LoggingDestination]] = Field(
None,
description='Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.',
)
producerDestinations: Optional[List[LoggingDestination]] = Field(
None,
description='Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.',
)
class Method(BaseModel):
name: Optional[str] = Field(None, description='The simple name of this method.')
options: Optional[List[Option]] = Field(
None, description='Any metadata attached to the method.'
)
requestStreaming: Optional[bool] = Field(
None, description='If true, the request is streamed.'
)
requestTypeUrl: Optional[str] = Field(
None, description='A URL of the input message type.'
)
responseStreaming: Optional[bool] = Field(
None, description='If true, the response is streamed.'
)
responseTypeUrl: Optional[str] = Field(
None, description='The URL of the output message type.'
)
syntax: Optional[Syntax] = Field(
None, description='The source syntax of this method.'
)
class MetricDescriptor(BaseModel):
description: Optional[str] = Field(
None,
description='A detailed description of the metric, which can be used in documentation.',
)
displayName: Optional[str] = Field(
None,
description='A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.',
)
labels: Optional[List[LabelDescriptor]] = Field(
None,
description='The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed.',
)
launchStage: Optional[LaunchStage] = Field(
None, description='Optional. The launch stage of the metric definition.'
)
metadata: Optional[MetricDescriptorMetadata] = Field(
None,
description='Optional. Metadata which can be used to guide usage of the metric.',
)
metricKind: Optional[MetricKind] = Field(
None,
description='Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported.',
)
monitoredResourceTypes: Optional[List[str]] = Field(
None,
description='Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.',
)
name: Optional[str] = Field(
None, description='The resource name of the metric descriptor.'
)
type: Optional[str] = Field(
None,
description='The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies"',
)
unit: Optional[str] = Field(
None,
description='The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of `0.02kBy` _might_ be displayed as `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is `kBy`, then the value of the metric is always in thousands of bytes, no matter how it might be displayed. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written as `12005`. Alternatively, if you want a custom metric to record data in a more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is `ks{CPU}`, and then write the value `12.005` (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which is `12005/1024`). The supported units are a subset of [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day * `1` dimensionless **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/{email}` or `MiBy/10ms` (although you should almost never have `/s` in a metric `unit`; rates should always be computed at query time from the underlying cumulative or delta value). * `.` multiplication or composition (as an infix operator). For examples, `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a comment if it follows a `UNIT`. If the annotation is used alone, then the unit is equivalent to `1`. For examples, `{request}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing `{` or `}`. * `1` represents a unitary [dimensionless unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a metric value of `5.3` would mean "5300 page views per day"). * `%` represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value `3` means "3 percent"). * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value `0.03` means "3 percent").',
)
valueType: Optional[ValueType1] = Field(
None,
description='Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported.',
)
class Monitoring(BaseModel):
consumerDestinations: Optional[List[MonitoringDestination]] = Field(
None,
description='Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.',
)
producerDestinations: Optional[List[MonitoringDestination]] = Field(
None,
description='Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.',
)
class Operation(BaseModel):
done: Optional[bool] = Field(
None,
description='If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.',
)
error: Optional[Status] = Field(
None,
description='The error result of the operation in case of failure or cancellation.',
)
metadata: Optional[Dict[str, Any]] = Field(
None,
description='Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.',
)
name: Optional[str] = Field(
None,
description='The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.',
)
response: Optional[Dict[str, Any]] = Field(
None,
description='The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.',
)
class OverrideInlineSource(BaseModel):
overrides: Optional[List[QuotaOverride]] = Field(
None,
description="The overrides to create. Each override must have a value for 'metric' and 'unit', to specify which metric and which limit the override should be applied to. The 'name' field of the override does not need to be set; it is ignored.",
)
class Publishing(BaseModel):
apiShortName: Optional[str] = Field(
None,
description='Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech".',
)
codeownerGithubTeams: Optional[List[str]] = Field(
None,
description='GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.',
)
docTagPrefix: Optional[str] = Field(
None,
description='A prefix used in sample code when demarking regions to be included in documentation.',
)
documentationUri: Optional[str] = Field(
None,
description='Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview',
)
githubLabel: Optional[str] = Field(
None,
description='GitHub label to apply to issues and pull requests opened for this API.',
)
librarySettings: Optional[List[ClientLibrarySettings]] = Field(
None,
description='Client library settings. If the same version string appears multiple times in this list, then the last one wins. Settings from earlier settings with the same version string are discarded.',
)
methodSettings: Optional[List[MethodSettings]] = Field(
None,
description='A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.',
)
newIssueUri: Optional[str] = Field(
None,
description='Link to a *public* URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103',
)
organization: Optional[Organization] = Field(
None, description='For whom the client library is being published.'
)
protoReferenceDocumentationUri: Optional[str] = Field(
None,
description='Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc',
)
class Quota(BaseModel):
limits: Optional[List[QuotaLimit]] = Field(
None, description='List of QuotaLimit definitions for the service.'
)
metricRules: Optional[List[MetricRule]] = Field(
None,
description='List of MetricRule definitions, each one mapping a selected method to one or more metrics.',
)
class QuotaBucket(BaseModel):
adminOverride: Optional[QuotaOverride] = Field(
None, description='Admin override on this quota bucket.'
)
consumerOverride: Optional[QuotaOverride] = Field(
None, description='Consumer override on this quota bucket.'
)
defaultLimit: Optional[str] = Field(
None,
description='The default limit of this quota bucket, as specified by the service configuration.',
)
dimensions: Optional[Dict[str, str]] = Field(
None,
description='The dimensions of this quota bucket. If this map is empty, this is the global bucket, which is the default quota value applied to all requests that do not have a more specific override. If this map is nonempty, the default limit, effective limit, and quota overrides apply only to requests that have the dimensions given in the map. For example, if the map has key `region` and value `us-east-1`, then the specified effective limit is only effective in that region, and the specified overrides apply only in that region.',
)
effectiveLimit: Optional[str] = Field(
None,
description='The effective limit of this quota bucket. Equal to default_limit if there are no overrides.',
)
producerOverride: Optional[QuotaOverride] = Field(
None, description='Producer override on this quota bucket.'
)
class Type(BaseModel):
edition: Optional[str] = Field(
None,
description='The source edition string, only valid when syntax is SYNTAX_EDITIONS.',
)
fields: Optional[List[FieldModel]] = Field(None, description='The list of fields.')
name: Optional[str] = Field(None, description='The fully qualified message name.')
oneofs: Optional[List[str]] = Field(
None,
description='The list of types appearing in `oneof` definitions in this type.',
)
options: Optional[List[Option]] = Field(
None, description='The protocol buffer options.'
)
sourceContext: Optional[SourceContext] = Field(
None, description='The source context.'
)
syntax: Optional[Syntax] = Field(None, description='The source syntax.')
class Usage(BaseModel):
producerNotificationChannel: Optional[str] = Field(
None,
description='The full resource name of a channel used for sending notifications to the service producer. Google Service Management currently only supports [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview.',
)
requirements: Optional[List[str]] = Field(
None,
description='Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form /; for example \'serviceusage.googleapis.com/billing-enabled\'. For Google APIs, a Terms of Service requirement must be included here. Google Cloud APIs must include "serviceusage.googleapis.com/tos/cloud". Other Google APIs should include "serviceusage.googleapis.com/tos/universal". Additional ToS can be included based on the business needs.',
)
rules: Optional[List[UsageRule]] = Field(
None,
description='A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.',
)
class Api(BaseModel):
methods: Optional[List[Method]] = Field(
None, description='The methods of this interface, in unspecified order.'
)
mixins: Optional[List[Mixin]] = Field(
None, description='Included interfaces. See Mixin.'
)
name: Optional[str] = Field(
None,
description="The fully qualified name of this interface, including package name followed by the interface's simple name.",
)
options: Optional[List[Option]] = Field(
None, description='Any metadata attached to the interface.'
)
sourceContext: Optional[SourceContext] = Field(
None,
description='Source context for the protocol buffer service represented by this message.',
)
syntax: Optional[Syntax] = Field(
None, description='The source syntax of the service.'
)
version: Optional[str] = Field(
None,
description='A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in `v`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces. ',
)
class Authentication(BaseModel):
providers: Optional[List[AuthProvider]] = Field(
None,
description='Defines a set of authentication providers that a service supports.',
)
rules: Optional[List[AuthenticationRule]] = Field(
None,
description='A list of authentication rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.',
)
class ConsumerQuotaLimit(BaseModel):
allowsAdminOverrides: Optional[bool] = Field(
None, description='Whether admin overrides are allowed on this limit'
)
isPrecise: Optional[bool] = Field(
None, description='Whether this limit is precise or imprecise.'
)
metric: Optional[str] = Field(
None,
description='The name of the parent metric of this limit. An example name would be: `compute.googleapis.com/cpus`',
)
name: Optional[str] = Field(
None,
description='The resource name of the quota limit. An example name would be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` The resource name is intended to be opaque and should not be parsed for its component strings, since its representation could change in the future.',
)
quotaBuckets: Optional[List[QuotaBucket]] = Field(
None,
description='Summary of the enforced quota buckets, organized by quota dimension, ordered from least specific to most specific (for example, the global default bucket, with no quota dimensions, will always appear first).',
)
supportedLocations: Optional[List[str]] = Field(
None,
description='List of all supported locations. This field is present only if the limit has a {region} or {zone} dimension.',
)
unit: Optional[str] = Field(
None,
description='The limit unit. An example unit would be `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string.',
)
class ConsumerQuotaMetric(BaseModel):
consumerQuotaLimits: Optional[List[ConsumerQuotaLimit]] = Field(
None,
description='The consumer quota for each quota limit defined on the metric.',
)
descendantConsumerQuotaLimits: Optional[List[ConsumerQuotaLimit]] = Field(
None,
description='The quota limits targeting the descendant containers of the consumer in request. If the consumer in request is of type `organizations` or `folders`, the field will list per-project limits in the metric; if the consumer in request is of type `project`, the field will be empty. The `quota_buckets` field of each descendant consumer quota limit will not be populated.',
)
displayName: Optional[str] = Field(
None,
description='The display name of the metric. An example name would be: `CPUs`',
)
metric: Optional[str] = Field(
None,
description='The name of the metric. An example name would be: `compute.googleapis.com/cpus`',
)
name: Optional[str] = Field(
None,
description='The resource name of the quota settings on this metric for this consumer. An example name would be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus` The resource name is intended to be opaque and should not be parsed for its component strings, since its representation could change in the future.',
)
unit: Optional[str] = Field(
None, description='The units in which the metric value is reported.'
)
class EnumModel(BaseModel):
edition: Optional[str] = Field(
None,
description='The source edition string, only valid when syntax is SYNTAX_EDITIONS.',
)
enumvalue: Optional[List[EnumValue]] = Field(
None, description='Enum value definitions.'
)
name: Optional[str] = Field(None, description='Enum type name.')
options: Optional[List[Option]] = Field(
None, description='Protocol buffer options.'
)
sourceContext: Optional[SourceContext] = Field(
None, description='The source context.'
)
syntax: Optional[Syntax] = Field(None, description='The source syntax.')
class GoogleApiService(BaseModel):
apis: Optional[List[Api]] = Field(
None,
description='A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files.',
)
authentication: Optional[Authentication] = Field(
None, description='Auth configuration.'
)
backend: Optional[Backend] = Field(None, description='API backend configuration.')
billing: Optional[Billing] = Field(None, description='Billing configuration.')
configVersion: Optional[int] = Field(
None,
description='Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to `3`.',
)
context: Optional[Context] = Field(None, description='Context configuration.')
control: Optional[Control] = Field(
None, description='Configuration for the service control plane.'
)
customError: Optional[CustomError] = Field(
None, description='Custom error configuration.'
)
documentation: Optional[Documentation] = Field(
None, description='Additional API documentation.'
)
endpoints: Optional[List[Endpoint]] = Field(
None,
description='Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.',
)
enums: Optional[List[EnumModel]] = Field(
None,
description='A list of all enum types included in this API service. Enums referenced directly or indirectly by the `apis` are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum',
)
http: Optional[Http] = Field(None, description='HTTP configuration.')
id: Optional[str] = Field(
None,
description="A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If empty, the server may choose to generate one instead.",
)
logging: Optional[Logging] = Field(None, description='Logging configuration.')
logs: Optional[List[LogDescriptor]] = Field(
None, description='Defines the logs used by this service.'
)
metrics: Optional[List[MetricDescriptor]] = Field(
None, description='Defines the metrics used by this service.'
)
monitoredResources: Optional[List[MonitoredResourceDescriptor]] = Field(
None,
description='Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.',
)
monitoring: Optional[Monitoring] = Field(
None, description='Monitoring configuration.'
)
name: Optional[str] = Field(
None,
description='The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name.',
)
producerProjectId: Optional[str] = Field(
None, description='The Google project that owns this service.'
)
publishing: Optional[Publishing] = Field(
None,
description='Settings for [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from APIs defined as protocol buffers.',
)
quota: Optional[Quota] = Field(None, description='Quota configuration.')
sourceInfo: Optional[SourceInfo] = Field(
None,
description='Output only. The source information for this configuration if available.',
)
systemParameters: Optional[SystemParameters] = Field(
None, description='System parameter configuration.'
)
systemTypes: Optional[List[Type]] = Field(
None,
description='A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.',
)
title: Optional[str] = Field(
None,
description='The product title for this service, it is the name displayed in Google Cloud Console.',
)
types: Optional[List[Type]] = Field(
None,
description='A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32',
)
usage: Optional[Usage] = Field(
None, description='Configuration controlling usage of this service.'
)
class GoogleApiServiceusageV1ServiceConfig(BaseModel):
apis: Optional[List[Api]] = Field(
None,
description='A list of API interfaces exported by this service. Contains only the names, versions, and method names of the interfaces.',
)
authentication: Optional[Authentication] = Field(
None, description='Auth configuration. Contains only the OAuth rules.'
)
documentation: Optional[Documentation] = Field(
None,
description='Additional API documentation. Contains only the summary and the documentation URL.',
)
endpoints: Optional[List[Endpoint]] = Field(
None,
description='Configuration for network endpoints. Contains only the names and aliases of the endpoints.',
)
monitoredResources: Optional[List[MonitoredResourceDescriptor]] = Field(
None,
description='Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.',
)
monitoring: Optional[Monitoring] = Field(
None,
description="Monitoring configuration. This should not include the 'producer_destinations' field.",
)
name: Optional[str] = Field(
None,
description='The DNS address at which this service is available. An example DNS address would be: `calendar.googleapis.com`.',
)
quota: Optional[Quota] = Field(None, description='Quota configuration.')
title: Optional[str] = Field(
None, description='The product title for this service.'
)
usage: Optional[Usage] = Field(
None, description='Configuration controlling usage of this service.'
)
class ImportAdminOverridesRequest(BaseModel):
force: Optional[bool] = Field(
None,
description="Whether to force the creation of the quota overrides. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations.",
)
forceOnly: Optional[List[ForceOnlyEnum]] = Field(
None,
description="The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set.",
)
inlineSource: Optional[OverrideInlineSource] = Field(
None, description='The import data is specified in the request message itself'
)
class ImportConsumerOverridesRequest(BaseModel):
force: Optional[bool] = Field(
None,
description="Whether to force the creation of the quota overrides. Setting the force parameter to 'true' ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations.",
)
forceOnly: Optional[List[ForceOnlyEnum]] = Field(
None,
description="The list of quota safety checks to ignore before the override mutation. Unlike 'force' field that ignores all the quota safety checks, the 'force_only' field ignores only the specified checks; other checks are still enforced. The 'force' and 'force_only' fields cannot both be set.",
)
inlineSource: Optional[OverrideInlineSource] = Field(
None, description='The import data is specified in the request message itself'
)
class ListConsumerQuotaMetricsResponse(BaseModel):
metrics: Optional[List[ConsumerQuotaMetric]] = Field(
None, description='Quota settings for the consumer, organized by quota metric.'
)
nextPageToken: Optional[str] = Field(
None,
description='Token identifying which result to start with; returned by a previous list call.',
)
class ListOperationsResponse(BaseModel):
nextPageToken: Optional[str] = Field(
None, description='The standard List next-page token.'
)
operations: Optional[List[Operation]] = Field(
None,
description='A list of operations that matches the specified filter in the request.',
)
class ServiceConfig(BaseModel):
apis: Optional[List[Api]] = Field(
None,
description='A list of API interfaces exported by this service. Contains only the names, versions, and method names of the interfaces.',
)
authentication: Optional[Authentication] = Field(
None, description='Auth configuration. Contains only the OAuth rules.'
)
documentation: Optional[Documentation] = Field(
None,
description='Additional API documentation. Contains only the summary and the documentation URL.',
)
endpoints: Optional[List[Endpoint]] = Field(
None,
description='Configuration for network endpoints. Contains only the names and aliases of the endpoints.',
)
monitoredResources: Optional[List[MonitoredResourceDescriptor]] = Field(
None,
description='Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.',
)
monitoring: Optional[Monitoring] = Field(
None,
description="Monitoring configuration. This should not include the 'producer_destinations' field.",
)
name: Optional[str] = Field(
None,
description='The DNS address at which this service is available. An example DNS address would be: `calendar.googleapis.com`.',
)
quota: Optional[Quota] = Field(None, description='Quota configuration.')
title: Optional[str] = Field(
None, description='The product title for this service.'
)
usage: Optional[Usage] = Field(
None, description='Configuration controlling usage of this service.'
)
class GoogleApiServiceusageV1Service(BaseModel):
config: Optional[GoogleApiServiceusageV1ServiceConfig] = Field(
None,
description='The service configuration of the available service. Some fields may be filtered out of the configuration in responses to the `ListServices` method. These fields are present only in responses to the `GetService` method.',
)
name: Optional[str] = Field(
None,
description='The resource name of the consumer and service. A valid name would be: - projects/123/services/serviceusage.googleapis.com',
)
parent: Optional[str] = Field(
None,
description='The resource name of the consumer. A valid name would be: - projects/123',
)
state: Optional[State1] = Field(
None,
description='Whether or not the service has been enabled for use by the consumer.',
)
class Service(BaseModel):
config: Optional[ServiceConfig] = Field(
None,
description='The service configuration of the available service. Some fields may be filtered out of the configuration in responses to the `ListServices` method. These fields are present only in responses to the `GetService` method.',
)
name: Optional[str] = Field(
None,
description='The resource name of the consumer and service. A valid name would be: - `projects/123/services/serviceusage.googleapis.com`',
)
parent: Optional[str] = Field(
None,
description='The resource name of the consumer. A valid name would be: - `projects/123`',
)
state: Optional[State3] = Field(
None,
description='Whether or not the service has been enabled for use by the consumer.',
)
class BatchEnableServicesResponse(BaseModel):
failures: Optional[List[EnableFailure]] = Field(
None,
description='If allow_partial_success is true, and one or more services could not be enabled, this field contains the details about each failure.',
)
services: Optional[List[GoogleApiServiceusageV1Service]] = Field(
None, description='The new state of the services after enabling.'
)
class DisableServiceResponse(BaseModel):
service: Optional[GoogleApiServiceusageV1Service] = Field(
None, description='The new state of the service after disabling.'
)
class EnableServiceResponse(BaseModel):
service: Optional[GoogleApiServiceusageV1Service] = Field(
None, description='The new state of the service after enabling.'
)
class ListServicesResponse(BaseModel):
nextPageToken: Optional[str] = Field(
None,
description='Token that can be passed to `ListServices` to resume a paginated query.',
)
services: Optional[List[Service]] = Field(
None, description='The available services for the requested project.'
)
BackendRule.model_rebuild()
HttpRule.model_rebuild()
Page.model_rebuild()
