/* Type definitions for non-npm package Service Usage API v1 0.0 */ // Project: https://cloud.google.com/service-usage/ // Definitions by: Maxim Mazurok // Nick Amoscato // Declan Vong // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // IMPORTANT // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually. // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator // Generated from: https://serviceusage.googleapis.com/$discovery/rest?version=v1 // Revision: 20260609 /// declare namespace gapi.client { /** Load Service Usage API v1 */ function load( urlOrObject: 'https://serviceusage.googleapis.com/$discovery/rest?version=v1', ): Promise; /** @deprecated Please load APIs with discovery documents. */ function load(name: 'serviceusage', version: 'v1'): Promise; /** @deprecated Please load APIs with discovery documents. */ function load(name: 'serviceusage', version: 'v1', callback: () => any): void; namespace serviceusage { interface AddEnableRulesMetadata {} interface AddEnableRulesResponse { /** The values added to the parent consumer policy. */ addedValues?: string[]; /** The parent consumer policy. It can be `projects/12345/consumerPolicies/default`, or `folders/12345/consumerPolicies/default`, or `organizations/12345/consumerPolicies/default`. */ parent?: string; } interface AdminQuotaPolicy { /** The cloud resource container at which the quota policy is created. The format is `{container_type}/{container_number}` */ container?: string; /** If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, a 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. */ dimensions?: {[P in string]: string}; /** The name of the metric to which this policy applies. An example name would be: `compute.googleapis.com/cpus` */ metric?: string; /** 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` */ name?: string; /** The quota policy value. Can be any nonnegative integer, or -1 (unlimited quota). */ policyValue?: string; /** 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. */ unit?: string; } interface Analysis { /** Output only. Analysis result of updating a policy. */ analysis?: AnalysisResult; /** Output only. The type of analysis. */ analysisType?: | 'ANALYSIS_TYPE_UNSPECIFIED' | 'ANALYSIS_TYPE_DEPENDENCY' | 'ANALYSIS_TYPE_RESOURCE_USAGE' | 'ANALYSIS_TYPE_RESOURCE_EXISTENCE'; /** Output only. The user friendly display name of the analysis type. E.g. service dependency analysis, service resource usage analysis, etc. */ displayName?: string; /** The names of the service that has analysis result of warnings or blockers. Example: `services/storage.googleapis.com`. */ service?: string; } interface AnalysisResult { /** Blocking information that would prevent the policy changes at runtime. */ blockers?: Impact[]; /** Warning information indicating that the policy changes might be unsafe, but will not block the changes at runtime. */ warnings?: Impact[]; } interface AnalyzeConsumerPolicyMetadata {} interface AnalyzeConsumerPolicyResponse { /** The list of analyses returned from performing the intended policy update analysis. The analysis is grouped by service name and different analysis types. The empty analysis list means that the consumer policy can be updated without any warnings or blockers. */ analysis?: Analysis[]; } interface Api { /** The source edition string, only valid when syntax is SYNTAX_EDITIONS. */ edition?: string; /** The methods of this interface, in unspecified order. */ methods?: Method[]; /** Included interfaces. See Mixin. */ mixins?: Mixin[]; /** The fully qualified name of this interface, including package name followed by the interface's simple name. */ name?: string; /** Any metadata attached to the interface. */ options?: Option[]; /** Source context for the protocol buffer service represented by this message. */ sourceContext?: SourceContext; /** The source syntax of the service. */ syntax?: 'SYNTAX_PROTO2' | 'SYNTAX_PROTO3' | 'SYNTAX_EDITIONS'; /** 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. */ version?: string; } interface Aspect { /** The type of this aspect configuration. */ kind?: string; /** Optional. Rules of the Configuration. */ rules?: AspectRule[]; /** Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `google/api/configaspects/proto`. */ spec?: {[P in string]: any}; } interface AspectRule { /** Required. Rules of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `google/api/configaspects/proto`. */ config?: {[P in string]: any}; /** Required. Selects the RPC methods to which this rule applies. Refer to selector for syntax details. */ selector?: string; } interface Authentication { /** Defines a set of authentication providers that a service supports. */ providers?: AuthProvider[]; /** A list of authentication rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: AuthenticationRule[]; } interface AuthenticationRule { /** If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests. */ allowWithoutCredential?: boolean; /** The requirements for OAuth credentials. */ oauth?: OAuthRequirements; /** Requirements for additional authentication providers. */ requirements?: AuthRequirement[]; /** Selects the methods to which this rule applies. Refer to selector for syntax details. */ selector?: string; } interface AuthProvider { /** 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 */ audiences?: string; /** Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec. */ authorizationUrl?: string; /** The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`. Example: "bookstore_auth". */ id?: string; /** 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 */ issuer?: string; /** 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 */ jwksUri?: string; /** 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 */ jwtLocations?: JwtLocation[]; } interface AuthRequirement { /** 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 */ audiences?: string; /** id from authentication provider. Example: provider_id: bookstore_auth */ providerId?: string; } interface Backend { /** A list of API backend rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: BackendRule[]; } interface BackendRule { /** 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. */ address?: string; /** The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment. */ deadline?: number; /** 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. */ disableAuth?: boolean; /** 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. */ jwtAudience?: string; /** The load balancing policy used for connection to the application backend. Defined as an arbitrary string to accomondate custom load balancing policies supported by the underlying channel, but suggest most users use one of the standard policies, such as the default, "RoundRobin". */ loadBalancingPolicy?: string; /** Deprecated, do not use. */ minDeadline?: number; /** The number of seconds to wait for the completion of a long running operation. The default is no deadline. */ operationDeadline?: number; /** The map between request protocol and the backend address. */ overridesByRequestProtocol?: {[P in string]: BackendRule}; /** Path translation specifies how to combine the backend address with the request path in order to produce the appropriate forwarding URL for the request. See PathTranslation for more details. */ pathTranslation?: | 'PATH_TRANSLATION_UNSPECIFIED' | 'CONSTANT_ADDRESS' | 'APPEND_PATH_TO_ADDRESS'; /** 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. */ protocol?: string; /** Selects the methods to which this rule applies. Refer to selector for syntax details. */ selector?: string; } interface BatchCreateAdminOverridesResponse { /** The overrides that were created. */ overrides?: QuotaOverride[]; } interface BatchCreateConsumerOverridesResponse { /** The overrides that were created. */ overrides?: QuotaOverride[]; } interface BatchEnableServicesRequest { /** 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. 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. */ serviceIds?: string[]; } interface BatchEnableServicesResponse { /** If allow_partial_success is true, and one or more services could not be enabled, this field contains the details about each failure. */ failures?: EnableFailure[]; /** The new state of the services after enabling. */ services?: GoogleApiServiceusageV1Service[]; } interface BatchGetServicesResponse { /** The requested Service states. */ services?: GoogleApiServiceusageV1Service[]; } interface BatchingConfigProto { /** The request and response fields used in batching. */ batchDescriptor?: BatchingDescriptorProto; /** The thresholds which trigger a batched request to be sent. */ thresholds?: BatchingSettingsProto; } interface BatchingDescriptorProto { /** The repeated field in the request message to be aggregated by batching. */ batchedField?: string; /** A list of the fields in the request message. Two requests will be batched together only if the values of every field specified in `request_discriminator_fields` is equal between the two requests. */ discriminatorFields?: string[]; /** Optional. When present, indicates the field in the response message to be used to demultiplex the response into multiple response messages, in correspondence with the multiple request messages originally batched together. */ subresponseField?: string; } interface BatchingSettingsProto { /** The duration after which a batch should be sent, starting from the addition of the first message to that batch. */ delayThreshold?: string; /** The maximum number of elements collected in a batch that could be accepted by server. */ elementCountLimit?: number; /** The number of elements of a field collected into a batch which, if exceeded, causes the batch to be sent. */ elementCountThreshold?: number; /** The maximum size of data allowed by flow control. */ flowControlByteLimit?: number; /** The maximum number of elements allowed by flow control. */ flowControlElementLimit?: number; /** The behavior to take when the flow control limit is exceeded. */ flowControlLimitExceededBehavior?: | 'UNSET_BEHAVIOR' | 'THROW_EXCEPTION' | 'BLOCK' | 'IGNORE'; /** The maximum size of the request that could be accepted by server. */ requestByteLimit?: number; /** The aggregated size of the batched field which, if exceeded, causes the batch to be sent. This size is computed by aggregating the sizes of the request field to be batched, not of the entire request message. */ requestByteThreshold?: string; } interface Billing { /** 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. */ consumerDestinations?: BillingDestination[]; } interface BillingDestination { /** Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section. */ metrics?: string[]; /** The monitored resource type. The type must be defined in Service.monitored_resources section. */ monitoredResource?: string; } interface CancelOperationRequest {} interface ClientLibrarySettings { /** Settings for C++ client libraries. */ cppSettings?: CppSettings; /** Settings for .NET client libraries. */ dotnetSettings?: DotnetSettings; /** Settings for Go client libraries. */ goSettings?: GoSettings; /** Settings for legacy Java features, supported in the Service YAML. */ javaSettings?: JavaSettings; /** Launch stage of this version of the API. */ launchStage?: | 'LAUNCH_STAGE_UNSPECIFIED' | 'UNIMPLEMENTED' | 'PRELAUNCH' | 'EARLY_ACCESS' | 'ALPHA' | 'BETA' | 'GA' | 'DEPRECATED'; /** Settings for Node client libraries. */ nodeSettings?: NodeSettings; /** Settings for PHP client libraries. */ phpSettings?: PhpSettings; /** Settings for Python client libraries. */ pythonSettings?: PythonSettings; /** When using transport=rest, the client request will encode enums as numbers rather than strings. */ restNumericEnums?: boolean; /** Settings for Ruby client libraries. */ rubySettings?: RubySettings; /** 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". */ version?: string; } interface CommonLanguageSettings { /** The destination where API teams want this client library to be published. */ destinations?: | 'CLIENT_LIBRARY_DESTINATION_UNSPECIFIED' | 'GITHUB' | 'PACKAGE_MANAGER'[]; /** Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest */ referenceDocsUri?: string; /** Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. */ selectiveGapicGeneration?: SelectiveGapicGeneration; } interface ConsumerPolicy { /** 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) */ annotations?: {[P in string]: string}; /** Enable rules define usable services and service groups. */ enableRules?: EnableRule[]; /** An opaque tag indicating the current version of the policy, used for concurrency control. */ etag?: string; /** Output only. The resource name of the policy. We only allow consumer policy name as `default` for now: `projects/12345/consumerPolicies/default`, `folders/12345/consumerPolicies/default`, `organizations/12345/consumerPolicies/default`. */ name?: string; /** The last-modified time. */ updateTime?: string; } interface ContentSecurity { /** List of content security providers that are enabled for content scanning. */ contentSecurityProviders?: ContentSecurityProvider[]; } interface ContentSecurityPolicy { /** mcp_content_security contains the content security related settings at resource level for MCP traffic. */ mcpContentSecurity?: ContentSecurity; /** Output only. The resource name of the policy. Only the `default` policy is supported. We allow the following formats: `projects/{PROJECT_NUMBER}/contentSecurityPolicies/default`, `projects/{PROJECT_ID}/contentSecurityPolicies/default`, We only support project level content security policy for now. */ name?: string; } interface ContentSecurityProvider { /** Name of security service for content scanning, such as Google Cloud Model Armor or supported third-party ISV solutions. If it is Google 1P service, the name should be prefixed with `services/`. If it is a 3P service, the format needs to be documented. The currently supported values are: - `services/modelarmor.googleapis.com` for Google Cloud Model Armor. */ name?: string; } interface Context { /** A list of RPC context rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: ContextRule[]; } interface ContextRule { /** A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend. */ allowedRequestExtensions?: string[]; /** A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client. */ allowedResponseExtensions?: string[]; /** A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension. */ provided?: string[]; /** A list of full type names of requested contexts, only the requested context will be made available to the backend. */ requested?: string[]; /** Selects the methods to which this rule applies. Refer to selector for syntax details. */ selector?: string; } interface Control { /** The service controller environment to use. If empty, no control plane features (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com. */ environment?: string; /** Defines policies applying to the API methods of the service. */ methodPolicies?: MethodPolicy[]; } interface CppSettings { /** Some settings. */ common?: CommonLanguageSettings; } interface CreateAdminQuotaPolicyMetadata {} interface CustomError { /** The list of custom error rules that apply to individual API messages. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: CustomErrorRule[]; /** The list of custom error detail types, e.g. 'google.foo.v1.CustomError'. */ types?: string[]; } interface CustomErrorRule { /** Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload. */ isErrorType?: boolean; /** Selects messages to which this rule applies. Refer to selector for syntax details. */ selector?: string; } interface CustomHttpPattern { /** The name of this custom HTTP verb. */ kind?: string; /** The path matched by this custom verb. */ path?: string; } interface DeleteAdminQuotaPolicyMetadata {} interface DisableServiceRequest { /** Defines the behavior for checking service usage when disabling a service. */ checkIfServiceHasUsage?: | 'CHECK_IF_SERVICE_HAS_USAGE_UNSPECIFIED' | 'SKIP' | 'CHECK'; /** Indicates if services that are enabled and which depend on this service should also be disabled. If not set, an error will be generated if any enabled services depend on the service to be disabled. When set, the service, and any enabled services that depend on it, will be disabled together. */ disableDependentServices?: boolean; } interface DisableServiceResponse { /** The new state of the service after disabling. */ service?: GoogleApiServiceusageV1Service; } interface Documentation { /** Optional information about the IAM configuration. This is typically used to link to documentation about a product's IAM roles and permissions. */ additionalIamInfo?: string; /** The URL to the root of documentation. */ documentationRootUrl?: string; /** 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. */ overview?: string; /** The top level pages for the documentation set. */ pages?: Page[]; /** A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: DocumentationRule[]; /** Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries */ sectionOverrides?: Page[]; /** 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. */ serviceRootUrl?: string; /** 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`. */ summary?: string; } interface DocumentationRule { /** Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`. */ deprecationDescription?: string; /** 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. */ description?: string; /** String of comma or space separated case-sensitive words for which method/field name replacement will be disabled. */ disableReplacementWords?: string; /** 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. */ selector?: string; } interface DotnetSettings { /** Some settings. */ common?: CommonLanguageSettings; /** Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision */ forcedNamespaceAliases?: string[]; /** 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. */ handwrittenSignatures?: string[]; /** 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" */ ignoredResources?: string[]; /** 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" */ renamedResources?: {[P in string]: string}; /** 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. */ renamedServices?: {[P in string]: string}; } interface Empty {} interface EnableFailure { /** An error message describing why the service could not be enabled. */ errorMessage?: string; /** The service id of a service that could not be enabled. */ serviceId?: string; } interface EnableRule { /** Client and resource project enable type. */ enableType?: | 'ENABLE_TYPE_UNSPECIFIED' | 'CLIENT' | 'RESOURCE' | 'V1_COMPATIBLE'; /** DEPRECATED: Please use field `values`. Service group should have prefix `groups/`. The names of the service groups that are enabled (Not Implemented). Example: `groups/googleServices`. */ groups?: string[]; /** DEPRECATED: Please use field `values`. Service should have prefix `services/`. The names of the services that are enabled. Example: `storage.googleapis.com`. */ services?: string[]; /** The names of the services or service groups that are enabled. Example: `services/storage.googleapis.com`, `groups/googleServices`, `groups/allServices`. */ values?: string[]; } interface EnableServiceRequest {} interface EnableServiceResponse { /** The new state of the service after enabling. */ service?: GoogleApiServiceusageV1Service; } interface Endpoint { /** Aliases for this endpoint, these will be served by the same UrlMap as the parent endpoint, and will be provisioned in the GCP stack for the Regional Endpoints. */ aliases?: string[]; /** 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. */ allowCors?: boolean; /** The canonical name of this endpoint. */ name?: string; /** 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". */ target?: string; } interface Enum { /** The source edition string, only valid when syntax is SYNTAX_EDITIONS. */ edition?: string; /** Enum value definitions. */ enumvalue?: EnumValue[]; /** Enum type name. */ name?: string; /** Protocol buffer options. */ options?: Option[]; /** The source context. */ sourceContext?: SourceContext; /** The source syntax. */ syntax?: 'SYNTAX_PROTO2' | 'SYNTAX_PROTO3' | 'SYNTAX_EDITIONS'; } interface EnumValue { /** Enum value name. */ name?: string; /** Enum value number. */ number?: number; /** Protocol buffer options. */ options?: Option[]; } interface ExperimentalFeatures { /** Enables generation of protobuf code using new types that are more Pythonic which are included in `protobuf>=5.29.x`. This feature will be enabled by default 1 month after launching the feature in preview packages. */ protobufPythonicTypesEnabled?: boolean; /** Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages. */ restAsyncIoEnabled?: boolean; /** Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`. */ unversionedPackageDisabled?: boolean; } interface Field { /** The field cardinality. */ cardinality?: | 'CARDINALITY_UNKNOWN' | 'CARDINALITY_OPTIONAL' | 'CARDINALITY_REQUIRED' | 'CARDINALITY_REPEATED'; /** The string value of the default value of this field. Proto2 syntax only. */ defaultValue?: string; /** The field JSON name. */ jsonName?: string; /** The field type. */ kind?: | 'TYPE_UNKNOWN' | 'TYPE_DOUBLE' | 'TYPE_FLOAT' | 'TYPE_INT64' | 'TYPE_UINT64' | 'TYPE_INT32' | 'TYPE_FIXED64' | 'TYPE_FIXED32' | 'TYPE_BOOL' | 'TYPE_STRING' | 'TYPE_GROUP' | 'TYPE_MESSAGE' | 'TYPE_BYTES' | 'TYPE_UINT32' | 'TYPE_ENUM' | 'TYPE_SFIXED32' | 'TYPE_SFIXED64' | 'TYPE_SINT32' | 'TYPE_SINT64'; /** The field name. */ name?: string; /** The field number. */ number?: number; /** 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. */ oneofIndex?: number; /** The protocol buffer options. */ options?: Option[]; /** Whether to use alternative packed wire representation. */ packed?: boolean; /** The field type URL, without the scheme, for message or enumeration types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. */ typeUrl?: string; } interface FieldPolicy { /** Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get". */ resourcePermission?: string; /** Specifies the resource type for the resource referred to by the field. */ resourceType?: string; /** Selects one or more request or response message fields to apply this `FieldPolicy`. When a `FieldPolicy` is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value. When a `FieldPolicy` is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz". */ selector?: string; } interface GetServiceIdentityMetadata {} interface GetServiceIdentityResponse { /** 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. */ identity?: ServiceIdentity; /** Service identity state. */ state?: 'IDENTITY_STATE_UNSPECIFIED' | 'ACTIVE'; } interface GoogleApiService { /** 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. */ apis?: Api[]; /** Configuration aspects. This is a repeated field to allow multiple aspects to be configured. The kind field in each ConfigAspect specifies the type of aspect. The spec field contains the configuration for that aspect. The schema for the spec field is defined by the backend service owners. */ aspects?: Aspect[]; /** Auth configuration. */ authentication?: Authentication; /** API backend configuration. */ backend?: Backend; /** Billing configuration. */ billing?: Billing; /** Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to `3`. */ configVersion?: number; /** Context configuration. */ context?: Context; /** Configuration for the service control plane. */ control?: Control; /** Custom error configuration. */ customError?: CustomError; /** Additional API documentation. */ documentation?: Documentation; /** 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. */ endpoints?: Endpoint[]; /** 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 */ enums?: Enum[]; /** HTTP configuration. */ http?: Http; /** 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. */ id?: string; /** Logging configuration. */ logging?: Logging; /** Defines the logs used by this service. */ logs?: LogDescriptor[]; /** Defines the metrics used by this service. */ metrics?: MetricDescriptor[]; /** Defines the monitored resources used by this service. This is required by the `Service.monitoring` and `Service.logging` configurations. */ monitoredResources?: MonitoredResourceDescriptor[]; /** Monitoring configuration. */ monitoring?: Monitoring; /** 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. */ name?: string; /** The Google project that owns this service. */ producerProjectId?: string; /** Settings for [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from APIs defined as protocol buffers. */ publishing?: Publishing; /** Quota configuration. */ quota?: Quota; /** Output only. The source information for this configuration if available. */ sourceInfo?: SourceInfo; /** System parameter configuration. */ systemParameters?: SystemParameters; /** 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. */ systemTypes?: Type[]; /** The product title for this service, it is the name displayed in Google Cloud Console. */ title?: string; /** 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 */ types?: Type[]; /** Configuration controlling usage of this service. */ usage?: Usage; } interface GoogleApiServiceusageV1beta1GetServiceIdentityResponse { /** 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. */ identity?: GoogleApiServiceusageV1beta1ServiceIdentity; /** Service identity state. */ state?: 'IDENTITY_STATE_UNSPECIFIED' | 'ACTIVE'; } interface GoogleApiServiceusageV1beta1ServiceIdentity { /** The email address of the service account that a service producer would use to access consumer resources. */ email?: string; /** The unique and stable id of the service account. https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount */ uniqueId?: string; } interface GoogleApiServiceusageV1OperationMetadata { /** The full name of the resources that this operation is directly associated with. */ resourceNames?: string[]; } interface GoogleApiServiceusageV1Service { /** 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. */ config?: GoogleApiServiceusageV1ServiceConfig; /** The resource name of the consumer and service. A valid name would be: - projects/123/services/serviceusage.googleapis.com */ name?: string; /** The resource name of the consumer. A valid name would be: - projects/123 */ parent?: string; /** Whether or not the service has been enabled for use by the consumer. */ state?: 'STATE_UNSPECIFIED' | 'DISABLED' | 'ENABLED'; } interface GoogleApiServiceusageV1ServiceConfig { /** A list of API interfaces exported by this service. Contains only the names, versions, and method names of the interfaces. */ apis?: Api[]; /** Auth configuration. Contains only the OAuth rules. */ authentication?: Authentication; /** Additional API documentation. Contains only the summary and the documentation URL. */ documentation?: Documentation; /** Configuration for network endpoints. Contains only the names and aliases of the endpoints. */ endpoints?: Endpoint[]; /** Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations. */ monitoredResources?: MonitoredResourceDescriptor[]; /** Monitoring configuration. This should not include the 'producer_destinations' field. */ monitoring?: Monitoring; /** The DNS address at which this service is available. An example DNS address would be: `calendar.googleapis.com`. */ name?: string; /** Quota configuration. */ quota?: Quota; /** The product title for this service. */ title?: string; /** Configuration controlling usage of this service. */ usage?: Usage; } interface GoogleApiServiceusageV2alphaConsumerPolicy { /** 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) */ annotations?: {[P in string]: string}; /** Output only. The time the policy was created. For singleton policies, this is the first touch of the policy. */ createTime?: string; /** Enable rules define usable services, groups, and categories. There can currently be at most one `EnableRule`. This restriction will be lifted in later releases. */ enableRules?: GoogleApiServiceusageV2alphaEnableRule[]; /** Output only. An opaque tag indicating the current version of the policy, used for concurrency control. */ etag?: string; /** Output only. The resource name of the policy. Only the `default` policy is supported: `projects/12345/consumerPolicies/default`, `folders/12345/consumerPolicies/default`, `organizations/12345/consumerPolicies/default`. */ name?: string; /** Output only. The time the policy was last updated. */ updateTime?: string; } interface GoogleApiServiceusageV2alphaEnableRule { /** The names of the services that are enabled. Example: `services/storage.googleapis.com`. */ services?: string[]; } interface GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadata {} interface GoogleApiServiceusageV2betaAnalysis { /** Output only. Analysis result of updating a policy. */ analysisResult?: GoogleApiServiceusageV2betaAnalysisResult; /** Output only. The type of analysis. */ analysisType?: | 'ANALYSIS_TYPE_UNSPECIFIED' | 'ANALYSIS_TYPE_DEPENDENCY' | 'ANALYSIS_TYPE_RESOURCE_USAGE'; /** Output only. The user friendly display name of the analysis type. E.g. service dependency analysis, service resource usage analysis, etc. */ displayName?: string; /** The names of the service that has analysis result of warnings or blockers. Example: `services/storage.googleapis.com`. */ service?: string; } interface GoogleApiServiceusageV2betaAnalysisResult { /** Blocking information that would prevent the policy changes at runtime. */ blockers?: GoogleApiServiceusageV2betaImpact[]; /** Warning information indicating that the policy changes might be unsafe, but will not block the changes at runtime. */ warnings?: GoogleApiServiceusageV2betaImpact[]; } interface GoogleApiServiceusageV2betaAnalyzeConsumerPolicyMetadata {} interface GoogleApiServiceusageV2betaAnalyzeConsumerPolicyResponse { /** The list of analyses returned from performing the intended policy update analysis. The analysis is grouped by service name and different analysis types. The empty analysis list means that the consumer policy can be updated without any warnings or blockers. */ analysis?: GoogleApiServiceusageV2betaAnalysis[]; } interface GoogleApiServiceusageV2betaConsumerPolicy { /** Output only. The time the policy was created. For singleton policies, this is the first touch of the policy. */ createTime?: string; /** Enable rules define usable services, groups, and categories. There can currently be at most one `EnableRule`. This restriction will be lifted in later releases. */ enableRules?: GoogleApiServiceusageV2betaEnableRule[]; /** An opaque tag indicating the current version of the policy, used for concurrency control. */ etag?: string; /** Output only. The resource name of the policy. Only the `default` policy is supported: `projects/12345/consumerPolicies/default`, `folders/12345/consumerPolicies/default`, `organizations/12345/consumerPolicies/default`. */ name?: string; /** Output only. The time the policy was last updated. */ updateTime?: string; } interface GoogleApiServiceusageV2betaEnableRule { /** The names of the services that are enabled. Example: `services/storage.googleapis.com`. */ services?: string[]; } interface GoogleApiServiceusageV2betaImpact { /** Output only. User friendly impact detail in a free form message. */ detail?: string; /** Output only. The type of impact. */ impactType?: | 'IMPACT_TYPE_UNSPECIFIED' | 'DEPENDENCY_MISSING_DEPENDENCIES'; /** Output only. This field will be populated only for the `DEPENDENCY_MISSING_DEPENDENCIES` impact type. Example: `services/compute.googleapis.com`. Impact.detail will be in format : `missing service dependency: {missing_dependency}.` */ missingDependency?: string; } interface GoogleApiServiceusageV2betaMcpEnableRule { /** List of enabled MCP services. */ mcpServices?: GoogleApiServiceusageV2betaMcpService[]; } interface GoogleApiServiceusageV2betaMcpPolicy { /** Output only. The time the policy was created. For singleton policies (such as the `default` policy), this is the first touch of the policy. */ createTime?: string; /** An opaque tag indicating the current version of the policy, used for concurrency control. */ etag?: string; /** McpEnableRules contains MCP enablement related rules. */ mcpEnableRules?: GoogleApiServiceusageV2betaMcpEnableRule[]; /** Output only. The resource name of the policy. Only the `default` policy is supported. We allow the following formats: `projects/{PROJECT_NUMBER}/mcpPolicies/default`, `projects/{PROJECT_ID}/mcpPolicies/default`, `folders/{FOLDER_ID}/mcpPolicies/default`, `organizations/{ORG_ID}/mcpPolicies/default`. */ name?: string; /** Output only. The time the policy was last updated. */ updateTime?: string; } interface GoogleApiServiceusageV2betaMcpService { /** The names of the services that are enabled for MCP. Example: `services/library-example.googleapis.com` */ service?: string; } interface GoogleApiServiceusageV2betaUpdateConsumerPolicyMetadata {} interface GoogleApiServiceusageV2betaUpdateMcpPolicyMetadata {} interface GoSettings { /** Some settings. */ common?: CommonLanguageSettings; /** Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. Example: publishing: go_settings: renamed_services: Publisher: TopicAdmin */ renamedServices?: {[P in string]: string}; } interface Http { /** 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. */ fullyDecodeReservedExpansion?: boolean; /** A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: HttpRule[]; } interface HttpRule { /** 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). */ additionalBindings?: HttpRule[]; /** 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. */ body?: string; /** 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. */ custom?: CustomHttpPattern; /** Maps to HTTP DELETE. Used for deleting a resource. */ delete?: string; /** Maps to HTTP GET. Used for listing and getting information about resources. */ get?: string; /** Maps to HTTP PATCH. Used for updating a resource. */ patch?: string; /** Maps to HTTP POST. Used for creating a resource or performing an action. */ post?: string; /** Maps to HTTP PUT. Used for replacing a resource. */ put?: string; /** 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. */ responseBody?: string; /** Selects a method to which this rule applies. Refer to selector for syntax details. */ selector?: string; } interface Impact { /** Output only. User friendly impact detail in a free form message. */ detail?: string; /** Output only. The type of impact. */ impactType?: | 'IMPACT_TYPE_UNSPECIFIED' | 'DEPENDENCY_MISSING_DEPENDENCIES' | 'RESOURCE_EXISTENCE_PROJECT'; /** The parent resource that the analysis is based on and the service name that the analysis is for. Example: `projects/100/services/compute.googleapis.com`, folders/101/services/compute.googleapis.com` and `organizations/102/services/compute.googleapis.com`. Usually, the parent resource here is same as the parent resource of the analyzed policy. However, for some analysis types, the parent can be different. For example, for resource existence analysis, if the parent resource of the analyzed policy is a folder or an organization, the parent resource here can still be the project that contains the resources. */ parent?: string; } interface ImportAdminOverridesMetadata {} interface ImportAdminOverridesResponse { /** The overrides that were created from the imported data. */ overrides?: QuotaOverride[]; } interface ImportAdminQuotaPoliciesMetadata {} interface ImportAdminQuotaPoliciesResponse { /** The policies that were created from the imported data. */ policies?: AdminQuotaPolicy[]; } interface ImportConsumerOverridesMetadata {} interface ImportConsumerOverridesResponse { /** The overrides that were created from the imported data. */ overrides?: QuotaOverride[]; } interface JavaSettings { /** Some settings. */ common?: CommonLanguageSettings; /** 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: library_settings: java_settings: library_package: com.google.cloud.pubsub.v1 */ libraryPackage?: string; /** 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 */ serviceClassNames?: {[P in string]: string}; } interface JwtLocation { /** Specifies cookie name to extract JWT token. */ cookie?: string; /** Specifies HTTP header name to extract JWT token. */ header?: string; /** Specifies URL query parameter name to extract JWT token. */ query?: string; /** 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. */ valuePrefix?: string; } interface LabelDescriptor { /** A human-readable description for the label. */ description?: string; /** The label key. */ key?: string; /** The type of data that can be assigned to the label. */ valueType?: 'STRING' | 'BOOL' | 'INT64'; } interface ListOperationsResponse { /** The standard List next-page token. */ nextPageToken?: string; /** A list of operations that matches the specified filter in the request. */ operations?: Operation[]; /** Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. */ unreachable?: string[]; } interface ListServicesResponse { /** Token that can be passed to `ListServices` to resume a paginated query. */ nextPageToken?: string; /** The available services for the requested project. */ services?: GoogleApiServiceusageV1Service[]; } interface LogDescriptor { /** A human-readable description of this log. This information appears in the documentation and can contain details. */ description?: string; /** The human-readable name for this log. This information appears on the user interface and should be concise. */ displayName?: string; /** The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid. */ labels?: LabelDescriptor[]; /** 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 [/_-.]. */ name?: string; } interface Logging { /** 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. */ consumerDestinations?: LoggingDestination[]; /** 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. */ producerDestinations?: LoggingDestination[]; } interface LoggingDestination { /** 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 "/". */ logs?: string[]; /** The monitored resource type. The type must be defined in the Service.monitored_resources section. */ monitoredResource?: string; } interface LongRunning { /** Initial delay after which the first poll request will be made. Default value: 5 seconds. */ initialPollDelay?: string; /** Maximum time between two subsequent poll requests. Default value: 45 seconds. */ maxPollDelay?: string; /** Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5. */ pollDelayMultiplier?: number; /** Total polling timeout. Default value: 5 minutes. */ totalPollTimeout?: string; } interface Method { /** The source edition string, only valid when syntax is SYNTAX_EDITIONS. This field should be ignored, instead the edition should be inherited from Api. This is similar to Field and EnumValue. */ edition?: string; /** The simple name of this method. */ name?: string; /** Any metadata attached to the method. */ options?: Option[]; /** If true, the request is streamed. */ requestStreaming?: boolean; /** A URL of the input message type. */ requestTypeUrl?: string; /** If true, the response is streamed. */ responseStreaming?: boolean; /** The URL of the output message type. */ responseTypeUrl?: string; /** The source syntax of this method. This field should be ignored, instead the syntax should be inherited from Api. This is similar to Field and EnumValue. */ syntax?: 'SYNTAX_PROTO2' | 'SYNTAX_PROTO3' | 'SYNTAX_EDITIONS'; } interface MethodPolicy { /** Policies that are applicable to the request message. */ requestPolicies?: FieldPolicy[]; /** Selects a method to which these policies should be enforced, for example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to selector for syntax details. NOTE: This field must not be set in the proto annotation. It will be automatically filled by the service config compiler . */ selector?: string; } interface MethodSettings { /** List of top-level fields of the request message, that should be automatically populated by the client libraries based on their (google.api.field_info).format. Currently supported format: UUID4. Example of a YAML configuration: publishing: method_settings: - selector: google.example.v1.ExampleService.CreateExample auto_populated_fields: - request_id */ autoPopulatedFields?: string[]; /** Batching configuration for an API method in client libraries. Example of a YAML configuration: publishing: method_settings: - selector: google.example.v1.ExampleService.BatchCreateExample batching: element_count_threshold: 1000 request_byte_threshold: 100000000 delay_threshold_millis: 10 */ batching?: BatchingConfigProto; /** 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: 60s # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 minutes */ longRunning?: LongRunning; /** The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options. Example: publishing: method_settings: - selector: google.storage.control.v2.StorageControl.CreateFolder # method settings for CreateFolder... */ selector?: string; } interface MetricDescriptor { /** A detailed description of the metric, which can be used in documentation. */ description?: string; /** 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. */ displayName?: string; /** 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. */ labels?: LabelDescriptor[]; /** Optional. The launch stage of the metric definition. */ launchStage?: | 'LAUNCH_STAGE_UNSPECIFIED' | 'UNIMPLEMENTED' | 'PRELAUNCH' | 'EARLY_ACCESS' | 'ALPHA' | 'BETA' | 'GA' | 'DEPRECATED'; /** Optional. Metadata which can be used to guide usage of the metric. */ metadata?: MetricDescriptorMetadata; /** Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ metricKind?: 'METRIC_KIND_UNSPECIFIED' | 'GAUGE' | 'DELTA' | 'CUMULATIVE'; /** 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. */ monitoredResourceTypes?: string[]; /** The resource name of the metric descriptor. */ name?: string; /** 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" */ type?: string; /** 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"). */ unit?: string; /** Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */ valueType?: | 'VALUE_TYPE_UNSPECIFIED' | 'BOOL' | 'INT64' | 'DOUBLE' | 'STRING' | 'DISTRIBUTION' | 'MONEY'; } interface MetricDescriptorMetadata { /** 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. */ ingestDelay?: string; /** Deprecated. Must use the MetricDescriptor.launch_stage instead. */ launchStage?: | 'LAUNCH_STAGE_UNSPECIFIED' | 'UNIMPLEMENTED' | 'PRELAUNCH' | 'EARLY_ACCESS' | 'ALPHA' | 'BETA' | 'GA' | 'DEPRECATED'; /** 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. */ samplePeriod?: string; /** The scope of the timeseries data of the metric. */ timeSeriesResourceHierarchyLevel?: | 'TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED' | 'PROJECT' | 'ORGANIZATION' | 'FOLDER'[]; } interface MetricRule { /** 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. */ metricCosts?: {[P in string]: string}; /** Selects the methods to which this rule applies. Refer to selector for syntax details. */ selector?: string; } interface Mixin { /** The fully qualified name of the interface which is included. */ name?: string; /** If non-empty specifies a path under which inherited HTTP paths are rooted. */ root?: string; } interface MonitoredResourceDescriptor { /** Optional. A detailed description of the monitored resource type that might be used in documentation. */ description?: string; /** 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"`. */ displayName?: string; /** 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"`. */ labels?: LabelDescriptor[]; /** Optional. The launch stage of the monitored resource definition. */ launchStage?: | 'LAUNCH_STAGE_UNSPECIFIED' | 'UNIMPLEMENTED' | 'PRELAUNCH' | 'EARLY_ACCESS' | 'ALPHA' | 'BETA' | 'GA' | 'DEPRECATED'; /** 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}"`. */ name?: string; /** Required. The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL. For a list of types, see [Monitored resource types](https://cloud.google.com/monitoring/api/resources) and [Logging resource types](https://cloud.google.com/logging/docs/api/v2/resource-list). */ type?: string; } interface Monitoring { /** 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. */ consumerDestinations?: MonitoringDestination[]; /** 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. */ producerDestinations?: MonitoringDestination[]; } interface MonitoringDestination { /** Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section. */ metrics?: string[]; /** The monitored resource type. The type must be defined in Service.monitored_resources section. */ monitoredResource?: string; } interface NodeSettings { /** Some settings. */ common?: CommonLanguageSettings; } interface OAuthRequirements { /** 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 */ canonicalScopes?: string; } interface Operation { /** 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. */ done?: boolean; /** The error result of the operation in case of failure or cancellation. */ error?: Status; /** 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. */ metadata?: {[P in string]: any}; /** 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}`. */ name?: string; /** The normal, successful response of the operation. 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`. */ response?: {[P in string]: any}; } interface OperationMetadata { /** The full name of the resources that this operation is directly associated with. */ resourceNames?: string[]; } interface Option { /** 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"`. */ name?: string; /** 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. */ value?: {[P in string]: any}; } interface Page { /** 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. */ content?: string; /** 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`. */ name?: string; /** Subpages of this page. The order of subpages specified here will be honored in the generated docset. */ subpages?: Page[]; } interface PhpSettings { /** Some settings. */ common?: CommonLanguageSettings; /** The package name to use in Php. Clobbers the php_namespace option set in the protobuf. This should be used **only** by APIs who have already set the language_settings.php.package_name" field in gapic.yaml. API teams should use the protobuf php_namespace option where possible. Example of a YAML configuration:: publishing: library_settings: php_settings: library_package: Google\Cloud\PubSub\V1 */ libraryPackage?: string; } interface Publishing { /** Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech". */ apiShortName?: string; /** GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API. */ codeownerGithubTeams?: string[]; /** A prefix used in sample code when demarking regions to be included in documentation. */ docTagPrefix?: string; /** Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview */ documentationUri?: string; /** GitHub label to apply to issues and pull requests opened for this API. */ githubLabel?: string; /** 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. */ librarySettings?: ClientLibrarySettings[]; /** A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern. */ methodSettings?: MethodSettings[]; /** Link to a *public* URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103 */ newIssueUri?: string; /** For whom the client library is being published. */ organization?: | 'CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED' | 'CLOUD' | 'ADS' | 'PHOTOS' | 'STREET_VIEW' | 'SHOPPING' | 'GEO' | 'GENERATIVE_AI' | 'HEALTH'; /** Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc */ protoReferenceDocumentationUri?: string; /** Optional link to REST reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rest */ restReferenceDocumentationUri?: string; } interface PythonSettings { /** Some settings. */ common?: CommonLanguageSettings; /** Experimental features to be included during client library generation. */ experimentalFeatures?: ExperimentalFeatures; } interface Quota { /** List of QuotaLimit definitions for the service. */ limits?: QuotaLimit[]; /** List of MetricRule definitions, each one mapping a selected method to one or more metrics. */ metricRules?: MetricRule[]; } interface QuotaLimit { /** 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. */ defaultLimit?: string; /** 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`). */ description?: string; /** 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. */ displayName?: string; /** Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only. */ duration?: string; /** 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. */ freeTier?: string; /** 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. */ maxLimit?: string; /** 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. */ metric?: string; /** 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. */ name?: string; /** Specify the unit of the quota limit. It uses the same syntax as MetricDescriptor.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. */ unit?: string; /** 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. */ values?: {[P in string]: string}; } interface QuotaOverride { /** The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only. */ adminOverrideAncestor?: string; /** 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. */ dimensions?: {[P in string]: string}; /** The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus` */ metric?: string; /** 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. */ name?: string; /** The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota). */ overrideValue?: string; /** 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. */ unit?: string; } interface RemoveEnableRulesMetadata {} interface RemoveEnableRulesResponse { /** The parent consumer policy. It can be `projects/12345/consumerPolicies/default`, or `folders/12345/consumerPolicies/default`, or `organizations/12345/consumerPolicies/default`. */ parent?: string; /** The values removed from the parent consumer policy. */ removedValues?: string[]; } interface RubySettings { /** Some settings. */ common?: CommonLanguageSettings; } interface SelectiveGapicGeneration { /** Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. */ generateOmittedAsInternal?: boolean; /** An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. */ methods?: string[]; } interface ServiceIdentity { /** The email address of the service account that a service producer would use to access consumer resources. */ email?: string; /** The unique and stable id of the service account. https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount */ uniqueId?: string; } interface SourceContext { /** The path-qualified name of the .proto file that contained the associated protobuf element. For example: `"google/protobuf/source_context.proto"`. */ fileName?: string; } interface SourceInfo { /** All files used during config generation. */ sourceFiles?: {[P in string]: any}[]; } interface Status { /** The status code, which should be an enum value of google.rpc.Code. */ code?: number; /** A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: {[P in string]: any}[]; /** 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. */ message?: string; } interface SystemParameter { /** Define the HTTP header name to use for the parameter. It is case insensitive. */ httpHeader?: string; /** Define the name of the parameter, such as "api_key" . It is case sensitive. */ name?: string; /** Define the URL query parameter name to use for the parameter. It is case sensitive. */ urlQueryParameter?: string; } interface SystemParameterRule { /** 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. */ parameters?: SystemParameter[]; /** Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */ selector?: string; } interface SystemParameters { /** 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. */ rules?: SystemParameterRule[]; } interface Type { /** The source edition string, only valid when syntax is SYNTAX_EDITIONS. */ edition?: string; /** The list of fields. */ fields?: Field[]; /** The fully qualified message name. */ name?: string; /** The list of types appearing in `oneof` definitions in this type. */ oneofs?: string[]; /** The protocol buffer options. */ options?: Option[]; /** The source context. */ sourceContext?: SourceContext; /** The source syntax. */ syntax?: 'SYNTAX_PROTO2' | 'SYNTAX_PROTO3' | 'SYNTAX_EDITIONS'; } interface UpdateAdminQuotaPolicyMetadata {} interface UpdateConsumerPolicyMetadata {} interface UpdateContentSecurityPolicyMetadata {} interface Usage { /** 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. */ producerNotificationChannel?: string; /** 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. */ requirements?: string[]; /** A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: UsageRule[]; } interface UsageRule { /** Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. */ allowUnregisteredCalls?: boolean; /** Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */ selector?: string; /** 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. */ skipServiceControl?: boolean; } interface OperationsResource { /** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. */ cancel(request: { /** V1 error format. */ '$.xgafv'?: '1' | '2'; /** OAuth access token. */ access_token?: string; /** Data format for response. */ alt?: 'json' | 'media' | 'proto'; /** JSONP */ callback?: string; /** Selector specifying which fields to include in a partial response. */ fields?: string; /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** The name of the operation resource to be cancelled. */ name: string; /** OAuth 2.0 token for the current user. */ oauth_token?: string; /** Returns response with indentations and line breaks. */ prettyPrint?: boolean; /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** Upload protocol for media (e.g. "raw", "multipart"). */ upload_protocol?: string; /** Legacy upload protocol for media (e.g. "media", "multipart"). */ uploadType?: string; /** Request body */ resource: CancelOperationRequest; }): Request<{}>; cancel( request: { /** V1 error format. */ '$.xgafv'?: '1' | '2'; /** OAuth access token. */ access_token?: string; /** Data format for response. */ alt?: 'json' | 'media' | 'proto'; /** JSONP */ callback?: string; /** Selector specifying which fields to include in a partial response. */ fields?: string; /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** The name of the operation resource to be cancelled. */ name: string; /** OAuth 2.0 token for the current user. */ oauth_token?: string; /** Returns response with indentations and line breaks. */ prettyPrint?: boolean; /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** Upload protocol for media (e.g. "raw", "multipart"). */ upload_protocol?: string; /** Legacy upload protocol for media (e.g. "media", "multipart"). */ uploadType?: string; }, body: CancelOperationRequest, ): Request<{}>; /** Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. */ delete(request?: { /** V1 error format. */ '$.xgafv'?: '1' | '2'; /** OAuth access token. */ access_token?: string; /** Data format for response. */ alt?: 'json' | 'media' | 'proto'; /** JSONP */ callback?: string; /** Selector specifying which fields to include in a partial response. */ fields?: string; /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** The name of the operation resource to be deleted. */ name: string; /** OAuth 2.0 token for the current user. */ oauth_token?: string; /** Returns response with indentations and line breaks. */ prettyPrint?: boolean; /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** Upload protocol for media (e.g. "raw", "multipart"). */ upload_protocol?: string; /** Legacy upload protocol for media (e.g. "media", "multipart"). */ uploadType?: string; }): Request<{}>; /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */ get(request?: { /** V1 error format. */ '$.xgafv'?: '1' | '2'; /** OAuth access token. */ access_token?: string; /** Data format for response. */ alt?: 'json' | 'media' | 'proto'; /** JSONP */ callback?: string; /** Selector specifying which fields to include in a partial response. */ fields?: string; /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** The name of the operation resource. */ name: string; /** OAuth 2.0 token for the current user. */ oauth_token?: string; /** Returns response with indentations and line breaks. */ prettyPrint?: boolean; /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** Upload protocol for media (e.g. "raw", "multipart"). */ upload_protocol?: string; /** Legacy upload protocol for media (e.g. "media", "multipart"). */ uploadType?: string; }): Request; /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */ list(request?: { /** V1 error format. */ '$.xgafv'?: '1' | '2'; /** OAuth access token. */ access_token?: string; /** Data format for response. */ alt?: 'json' | 'media' | 'proto'; /** JSONP */ callback?: string; /** Selector specifying which fields to include in a partial response. */ fields?: string; /** The standard list filter. */ filter?: string; /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** The name of the operation's parent resource. */ name?: string; /** OAuth 2.0 token for the current user. */ oauth_token?: string; /** The standard list page size. */ pageSize?: number; /** The standard list page token. */ pageToken?: string; /** Returns response with indentations and line breaks. */ prettyPrint?: boolean; /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; /** Upload protocol for media (e.g. "raw", "multipart"). */ upload_protocol?: string; /** Legacy upload protocol for media (e.g. "media", "multipart"). */ uploadType?: string; }): Request; } interface ServicesResource { /** Enable multiple services on a project. The operation is atomic: if enabling any service fails, then the entire batch fails, and no state changes occur. To enable a single service, use the `EnableService` method instead. */ batchEnable(request: { /** V1 error format. */ '$.xgafv'?: '1' | '2'; /** OAuth access token. */ access_token?: string; /** Data format for response. */ alt?: 'json' | 'media' | 'proto'; /** JSONP */ callback?: string; /** Selector specifying which fields to include in a partial response. */ fields?: string; /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** OAuth 2.0 token for the current user. */ oauth_token?: string; /** Parent to enable services on. An example name would be: `projects/123` where `123` is the project number. The `BatchEnableServices` method currently only supports projects. */ parent: string; /** Returns response with indentations and line breaks. */ prettyPrint?: boolean; /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** Upload protocol for media (e.g. "raw", "multipart"). */ upload_protocol?: string; /** Legacy upload protocol for media (e.g. "media", "multipart"). */ uploadType?: string; /** Request body */ resource: BatchEnableServicesRequest; }): Request; batchEnable( request: { /** V1 error format. */ '$.xgafv'?: '1' | '2'; /** OAuth access token. */ access_token?: string; /** Data format for response. */ alt?: 'json' | 'media' | 'proto'; /** JSONP */ callback?: string; /** Selector specifying which fields to include in a partial response. */ fields?: string; /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** OAuth 2.0 token for the current user. */ oauth_token?: string; /** Parent to enable services on. An example name would be: `projects/123` where `123` is the project number. The `BatchEnableServices` method currently only supports projects. */ parent: string; /** Returns response with indentations and line breaks. */ prettyPrint?: boolean; /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** Upload protocol for media (e.g. "raw", "multipart"). */ upload_protocol?: string; /** Legacy upload protocol for media (e.g. "media", "multipart"). */ uploadType?: string; }, body: BatchEnableServicesRequest, ): Request; /** Returns the service configurations and enabled states for a given list of services. */ batchGet(request?: { /** V1 error format. */ '$.xgafv'?: '1' | '2'; /** OAuth access token. */ access_token?: string; /** Data format for response. */ alt?: 'json' | 'media' | 'proto'; /** JSONP */ callback?: string; /** Selector specifying which fields to include in a partial response. */ fields?: string; /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** Names of the services to retrieve. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project number. A single request can get a maximum of 30 services at a time. */ names?: string | string[]; /** OAuth 2.0 token for the current user. */ oauth_token?: string; /** Parent to retrieve services from. If this is set, the parent of all of the services specified in `names` must match this field. An example name would be: `projects/123` where `123` is the project number. The `BatchGetServices` method currently only supports projects. */ parent: string; /** Returns response with indentations and line breaks. */ prettyPrint?: boolean; /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** Upload protocol for media (e.g. "raw", "multipart"). */ upload_protocol?: string; /** Legacy upload protocol for media (e.g. "media", "multipart"). */ uploadType?: string; }): Request; /** Disable a service so that it can no longer be used with a project. This prevents unintended usage that may cause unexpected billing charges or security leaks. It is not valid to call the disable method on a service that is not currently enabled. Callers will receive a `FAILED_PRECONDITION` status if the target service is not currently enabled. */ disable(request: { /** V1 error format. */ '$.xgafv'?: '1' | '2'; /** OAuth access token. */ access_token?: string; /** Data format for response. */ alt?: 'json' | 'media' | 'proto'; /** JSONP */ callback?: string; /** Selector specifying which fields to include in a partial response. */ fields?: string; /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** Name of the consumer and service to disable the service on. The enable and disable methods currently only support projects. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project number. */ name: string; /** OAuth 2.0 token for the current user. */ oauth_token?: string; /** Returns response with indentations and line breaks. */ prettyPrint?: boolean; /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** Upload protocol for media (e.g. "raw", "multipart"). */ upload_protocol?: string; /** Legacy upload protocol for media (e.g. "media", "multipart"). */ uploadType?: string; /** Request body */ resource: DisableServiceRequest; }): Request; disable( request: { /** V1 error format. */ '$.xgafv'?: '1' | '2'; /** OAuth access token. */ access_token?: string; /** Data format for response. */ alt?: 'json' | 'media' | 'proto'; /** JSONP */ callback?: string; /** Selector specifying which fields to include in a partial response. */ fields?: string; /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** Name of the consumer and service to disable the service on. The enable and disable methods currently only support projects. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project number. */ name: string; /** OAuth 2.0 token for the current user. */ oauth_token?: string; /** Returns response with indentations and line breaks. */ prettyPrint?: boolean; /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** Upload protocol for media (e.g. "raw", "multipart"). */ upload_protocol?: string; /** Legacy upload protocol for media (e.g. "media", "multipart"). */ uploadType?: string; }, body: DisableServiceRequest, ): Request; /** Enable a service so that it can be used with a project. */ enable(request: { /** V1 error format. */ '$.xgafv'?: '1' | '2'; /** OAuth access token. */ access_token?: string; /** Data format for response. */ alt?: 'json' | 'media' | 'proto'; /** JSONP */ callback?: string; /** Selector specifying which fields to include in a partial response. */ fields?: string; /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** Name of the consumer and service to enable the service on. The `EnableService` and `DisableService` methods currently only support projects. Enabling a service requires that the service is public or is shared with the user enabling the service. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project number. */ name: string; /** OAuth 2.0 token for the current user. */ oauth_token?: string; /** Returns response with indentations and line breaks. */ prettyPrint?: boolean; /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** Upload protocol for media (e.g. "raw", "multipart"). */ upload_protocol?: string; /** Legacy upload protocol for media (e.g. "media", "multipart"). */ uploadType?: string; /** Request body */ resource: EnableServiceRequest; }): Request; enable( request: { /** V1 error format. */ '$.xgafv'?: '1' | '2'; /** OAuth access token. */ access_token?: string; /** Data format for response. */ alt?: 'json' | 'media' | 'proto'; /** JSONP */ callback?: string; /** Selector specifying which fields to include in a partial response. */ fields?: string; /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** Name of the consumer and service to enable the service on. The `EnableService` and `DisableService` methods currently only support projects. Enabling a service requires that the service is public or is shared with the user enabling the service. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project number. */ name: string; /** OAuth 2.0 token for the current user. */ oauth_token?: string; /** Returns response with indentations and line breaks. */ prettyPrint?: boolean; /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** Upload protocol for media (e.g. "raw", "multipart"). */ upload_protocol?: string; /** Legacy upload protocol for media (e.g. "media", "multipart"). */ uploadType?: string; }, body: EnableServiceRequest, ): Request; /** Returns the service configuration and enabled state for a given service. */ get(request?: { /** V1 error format. */ '$.xgafv'?: '1' | '2'; /** OAuth access token. */ access_token?: string; /** Data format for response. */ alt?: 'json' | 'media' | 'proto'; /** JSONP */ callback?: string; /** Selector specifying which fields to include in a partial response. */ fields?: string; /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** Name of the consumer and service to get the `ConsumerState` for. An example name would be: `projects/123/services/serviceusage.googleapis.com` where `123` is the project number. */ name: string; /** OAuth 2.0 token for the current user. */ oauth_token?: string; /** Returns response with indentations and line breaks. */ prettyPrint?: boolean; /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** Upload protocol for media (e.g. "raw", "multipart"). */ upload_protocol?: string; /** Legacy upload protocol for media (e.g. "media", "multipart"). */ uploadType?: string; }): Request; /** List all services available to the specified project, and the current state of those services with respect to the project. The list includes all public services, all services for which the calling user has the `servicemanagement.services.bind` permission, and all services that have already been enabled on the project. The list can be filtered to only include services in a specific state, for example to only include services enabled on the project. WARNING: If you need to query enabled services frequently or across an organization, you should use [Cloud Asset Inventory API](https://cloud.google.com/asset-inventory/docs/apis), which provides higher throughput and richer filtering capability. */ list(request?: { /** V1 error format. */ '$.xgafv'?: '1' | '2'; /** OAuth access token. */ access_token?: string; /** Data format for response. */ alt?: 'json' | 'media' | 'proto'; /** JSONP */ callback?: string; /** Selector specifying which fields to include in a partial response. */ fields?: string; /** Only list services that conform to the given filter. The allowed filter strings are `state:ENABLED` and `state:DISABLED`. */ filter?: string; /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */ key?: string; /** OAuth 2.0 token for the current user. */ oauth_token?: string; /** Requested size of the next page of data. Requested page size cannot exceed 200. If not set, the default page size is 50. */ pageSize?: number; /** Token identifying which result to start with, which is returned by a previous list call. */ pageToken?: string; /** Parent to search for services on. An example name would be: `projects/123` where `123` is the project number. */ parent: string; /** Returns response with indentations and line breaks. */ prettyPrint?: boolean; /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** Upload protocol for media (e.g. "raw", "multipart"). */ upload_protocol?: string; /** Legacy upload protocol for media (e.g. "media", "multipart"). */ uploadType?: string; }): Request; } const operations: OperationsResource; const services: ServicesResource; } }