googleapis
Version:
Google APIs Client Library for Node.js
940 lines (939 loc) • 142 kB
TypeScript
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace serviceusage_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* 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;
/**
* 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;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Service Usage API
*
* Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use.
*
* @example
* ```js
* const {google} = require('googleapis');
* const serviceusage = google.serviceusage('v1');
* ```
*/
export class Serviceusage {
context: APIRequestContext;
operations: Resource$Operations;
services: Resource$Services;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Metadata for the `AddEnableRules` method.
*/
export interface Schema$AddEnableRulesMetadata {
}
/**
* The response message of "AddEnableRules" method.
*/
export interface Schema$AddEnableRulesResponse {
/**
* The values added to the parent consumer policy.
*/
addedValues?: string[] | null;
/**
* The parent consumer policy. It can be `projects/12345/consumerPolicies/default`, or `folders/12345/consumerPolicies/default`, or `organizations/12345/consumerPolicies/default`.
*/
parent?: string | null;
}
/**
* Quota policy created by quota administrator.
*/
export interface Schema$AdminQuotaPolicy {
/**
* The cloud resource container at which the quota policy is created. The format is `{container_type\}/{container_number\}`
*/
container?: string | null;
/**
* 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?: {
[key: string]: string;
} | null;
/**
* The name of the metric to which this policy applies. An example name would be: `compute.googleapis.com/cpus`
*/
metric?: string | null;
/**
* 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 | null;
/**
* The quota policy value. Can be any nonnegative integer, or -1 (unlimited quota).
*/
policyValue?: string | null;
/**
* 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 | null;
}
/**
* Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.
*/
export interface Schema$Api {
/**
* The methods of this interface, in unspecified order.
*/
methods?: Schema$Method[];
/**
* Included interfaces. See Mixin.
*/
mixins?: Schema$Mixin[];
/**
* The fully qualified name of this interface, including package name followed by the interface's simple name.
*/
name?: string | null;
/**
* Any metadata attached to the interface.
*/
options?: Schema$Option[];
/**
* Source context for the protocol buffer service represented by this message.
*/
sourceContext?: Schema$SourceContext;
/**
* The source syntax of the service.
*/
syntax?: string | null;
/**
* 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 | null;
}
/**
* `Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read
*/
export interface Schema$Authentication {
/**
* Defines a set of authentication providers that a service supports.
*/
providers?: Schema$AuthProvider[];
/**
* A list of authentication rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.
*/
rules?: Schema$AuthenticationRule[];
}
/**
* Authentication rules for the service. By default, if a method has any authentication requirements, every request must include a valid credential matching one of the requirements. It's an error to include more than one kind of credential in a single request. If a method doesn't have any auth requirements, request credentials will be ignored.
*/
export interface Schema$AuthenticationRule {
/**
* If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.
*/
allowWithoutCredential?: boolean | null;
/**
* The requirements for OAuth credentials.
*/
oauth?: Schema$OAuthRequirements;
/**
* Requirements for additional authentication providers.
*/
requirements?: Schema$AuthRequirement[];
/**
* Selects the methods to which this rule applies. Refer to selector for syntax details.
*/
selector?: string | null;
}
/**
* Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
*/
export interface Schema$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 | null;
/**
* Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
*/
authorizationUrl?: string | null;
/**
* The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`. Example: "bookstore_auth".
*/
id?: string | null;
/**
* 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 | null;
/**
* 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 | null;
/**
* 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?: Schema$JwtLocation[];
}
/**
* User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
*/
export interface Schema$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 | null;
/**
* id from authentication provider. Example: provider_id: bookstore_auth
*/
providerId?: string | null;
}
/**
* `Backend` defines the backend configuration for a service.
*/
export interface Schema$Backend {
/**
* A list of API backend rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.
*/
rules?: Schema$BackendRule[];
}
/**
* A backend rule provides configuration for an individual API element.
*/
export interface Schema$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 | null;
/**
* 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 | null;
/**
* 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 | null;
/**
* 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 | null;
/**
* Deprecated, do not use.
*/
minDeadline?: number | null;
/**
* The number of seconds to wait for the completion of a long running operation. The default is no deadline.
*/
operationDeadline?: number | null;
/**
* The map between request protocol and the backend address.
*/
overridesByRequestProtocol?: {
[key: string]: Schema$BackendRule;
} | null;
pathTranslation?: string | null;
/**
* 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 | null;
/**
* Selects the methods to which this rule applies. Refer to selector for syntax details.
*/
selector?: string | null;
}
/**
* Response message for BatchCreateAdminOverrides
*/
export interface Schema$BatchCreateAdminOverridesResponse {
/**
* The overrides that were created.
*/
overrides?: Schema$QuotaOverride[];
}
/**
* Response message for BatchCreateConsumerOverrides
*/
export interface Schema$BatchCreateConsumerOverridesResponse {
/**
* The overrides that were created.
*/
overrides?: Schema$QuotaOverride[];
}
/**
* Request message for the `BatchEnableServices` method.
*/
export interface Schema$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[] | null;
}
/**
* Response message for the `BatchEnableServices` method. This response message is assigned to the `response` field of the returned Operation when that operation is done.
*/
export interface Schema$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?: Schema$EnableFailure[];
/**
* The new state of the services after enabling.
*/
services?: Schema$GoogleApiServiceusageV1Service[];
}
/**
* Response message for the `BatchGetServices` method.
*/
export interface Schema$BatchGetServicesResponse {
/**
* The requested Service states.
*/
services?: Schema$GoogleApiServiceusageV1Service[];
}
/**
* Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing, `consumer_destinations` is the only supported destination and the monitored resources need at least one label key `cloud.googleapis.com/location` to indicate the location of the billing usage, using different monitored resources between monitoring and billing is recommended so they can be evolved independently: monitored_resources: - type: library.googleapis.com/billing_branch labels: - key: cloud.googleapis.com/location description: | Predefined label to support billing location restriction. - key: city description: | Custom label to define the city where the library branch is located in. - key: name description: Custom label to define the name of the library branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: - monitored_resource: library.googleapis.com/billing_branch metrics: - library.googleapis.com/book/borrowed_count
*/
export interface Schema$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?: Schema$BillingDestination[];
}
/**
* Configuration of a specific billing destination (Currently only support bill against consumer project).
*/
export interface Schema$BillingDestination {
/**
* Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.
*/
metrics?: string[] | null;
/**
* The monitored resource type. The type must be defined in Service.monitored_resources section.
*/
monitoredResource?: string | null;
}
/**
* The request message for Operations.CancelOperation.
*/
export interface Schema$CancelOperationRequest {
}
/**
* Details about how and where to publish client libraries.
*/
export interface Schema$ClientLibrarySettings {
/**
* Settings for C++ client libraries.
*/
cppSettings?: Schema$CppSettings;
/**
* Settings for .NET client libraries.
*/
dotnetSettings?: Schema$DotnetSettings;
/**
* Settings for Go client libraries.
*/
goSettings?: Schema$GoSettings;
/**
* Settings for legacy Java features, supported in the Service YAML.
*/
javaSettings?: Schema$JavaSettings;
/**
* Launch stage of this version of the API.
*/
launchStage?: string | null;
/**
* Settings for Node client libraries.
*/
nodeSettings?: Schema$NodeSettings;
/**
* Settings for PHP client libraries.
*/
phpSettings?: Schema$PhpSettings;
/**
* Settings for Python client libraries.
*/
pythonSettings?: Schema$PythonSettings;
/**
* When using transport=rest, the client request will encode enums as numbers rather than strings.
*/
restNumericEnums?: boolean | null;
/**
* Settings for Ruby client libraries.
*/
rubySettings?: Schema$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 | null;
}
/**
* Required information for every language.
*/
export interface Schema$CommonLanguageSettings {
/**
* The destination where API teams want this client library to be published.
*/
destinations?: string[] | null;
/**
* Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest
*/
referenceDocsUri?: string | null;
}
/**
* Consumer Policy is a set of rules that define what services or service groups can be used for a cloud resource hierarchy.
*/
export interface Schema$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?: {
[key: string]: string;
} | null;
/**
* Enable rules define usable services and service groups.
*/
enableRules?: Schema$EnableRule[];
/**
* An opaque tag indicating the current version of the policy, used for concurrency control.
*/
etag?: string | null;
/**
* Output only. The resource name of the policy. For example, We only allow consumer policy name as "default" for now: `projects/12345/consumerPolicies/default`, `folders/12345/consumerPolicies/default`, `organizations/12345/consumerPolicies/default`. Legacy format: `projects/12345/consumerPoly`
*/
name?: string | null;
/**
* The last-modified time.
*/
updateTime?: string | null;
}
/**
* `Context` defines which contexts an API requests. Example: context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to allowlist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here.
*/
export interface Schema$Context {
/**
* A list of RPC context rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.
*/
rules?: Schema$ContextRule[];
}
/**
* A context rule provides information about the context for an individual API element.
*/
export interface Schema$ContextRule {
/**
* A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
*/
allowedRequestExtensions?: string[] | null;
/**
* A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.
*/
allowedResponseExtensions?: string[] | null;
/**
* A list of full type names of provided contexts.
*/
provided?: string[] | null;
/**
* A list of full type names of requested contexts.
*/
requested?: string[] | null;
/**
* Selects the methods to which this rule applies. Refer to selector for syntax details.
*/
selector?: string | null;
}
/**
* Selects and configures the service controller used by the service. Example: control: environment: servicecontrol.googleapis.com
*/
export interface Schema$Control {
/**
* The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com
*/
environment?: string | null;
/**
* Defines policies applying to the API methods of the service.
*/
methodPolicies?: Schema$MethodPolicy[];
}
/**
* Settings for C++ client libraries.
*/
export interface Schema$CppSettings {
/**
* Some settings.
*/
common?: Schema$CommonLanguageSettings;
}
/**
* Metadata message that provides information such as progress, partial failures, and similar information on each GetOperation call of LRO returned by CreateAdminQuotaPolicy.
*/
export interface Schema$CreateAdminQuotaPolicyMetadata {
}
/**
* Customize service error responses. For example, list any service specific protobuf types that can appear in error detail lists of error responses. Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.AnotherError
*/
export interface Schema$CustomError {
/**
* The list of custom error rules that apply to individual API messages. **NOTE:** All service configuration rules follow "last one wins" order.
*/
rules?: Schema$CustomErrorRule[];
/**
* The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
*/
types?: string[] | null;
}
/**
* A custom error rule.
*/
export interface Schema$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 | null;
/**
* Selects messages to which this rule applies. Refer to selector for syntax details.
*/
selector?: string | null;
}
/**
* A custom pattern is used for defining custom HTTP verb.
*/
export interface Schema$CustomHttpPattern {
/**
* The name of this custom HTTP verb.
*/
kind?: string | null;
/**
* The path matched by this custom verb.
*/
path?: string | null;
}
/**
* Metadata message that provides information such as progress, partial failures, and similar information on each GetOperation call of LRO returned by DeleteAdminQuotaPolicy.
*/
export interface Schema$DeleteAdminQuotaPolicyMetadata {
}
/**
* Request message for the `DisableService` method.
*/
export interface Schema$DisableServiceRequest {
/**
* Defines the behavior for checking service usage when disabling a service.
*/
checkIfServiceHasUsage?: string | null;
/**
* 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 | null;
}
/**
* Response message for the `DisableService` method. This response message is assigned to the `response` field of the returned Operation when that operation is done.
*/
export interface Schema$DisableServiceResponse {
/**
* The new state of the service after disabling.
*/
service?: Schema$GoogleApiServiceusageV1Service;
}
/**
* `Documentation` provides the information for describing a service. Example: documentation: summary: \> The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: \> ... - selector: google.calendar.Calendar.Put description: \> ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.
*/
export interface Schema$Documentation {
/**
* The URL to the root of documentation.
*/
documentationRootUrl?: string | null;
/**
* 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 | null;
/**
* The top level pages for the documentation set.
*/
pages?: Schema$Page[];
/**
* A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.
*/
rules?: Schema$DocumentationRule[];
/**
* Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries
*/
sectionOverrides?: Schema$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 | null;
/**
* 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 | null;
}
/**
* A documentation rule provides information about individual API elements.
*/
export interface Schema$DocumentationRule {
/**
* Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`.
*/
deprecationDescription?: string | null;
/**
* 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 | null;
/**
* String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.
*/
disableReplacementWords?: string | null;
/**
* 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 | null;
}
/**
* Settings for Dotnet client libraries.
*/
export interface Schema$DotnetSettings {
/**
* Some settings.
*/
common?: Schema$CommonLanguageSettings;
/**
* Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision
*/
forcedNamespaceAliases?: string[] | null;
/**
* 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[] | null;
/**
* 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[] | null;
/**
* 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?: {
[key: string]: string;
} | null;
/**
* 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?: {
[key: string]: string;
} | null;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \}
*/
export interface Schema$Empty {
}
/**
* Provides error messages for the failing services.
*/
export interface Schema$EnableFailure {
/**
* An error message describing why the service could not be enabled.
*/
errorMessage?: string | null;
/**
* The service id of a service that could not be enabled.
*/
serviceId?: string | null;
}
/**
* The consumer policy rule that defines usable services and service groups.
*/
export interface Schema$EnableRule {
/**
* Client and resource project enable type.
*/
enableType?: string | null;
/**
* DEPRECATED: Please use field `values`. Service group should have prefix `groups/`. The names of the service groups that are enabled (Not Implemented). go/predefined-service-groups. Example: `groups/googleServices`.
*/
groups?: string[] | null;
/**
* DEPRECATED: Please use field `values`. Service should have prefix `services/`. The names of the services that are enabled. Example: `storage.googleapis.com`.
*/
services?: string[] | null;
/**
* The names of the services or service groups that are enabled. Example: `services/storage.googleapis.com`, groups/googleServices`, groups/allServices`.
*/
values?: string[] | null;
}
/**
* Request message for the `EnableService` method.
*/
export interface Schema$EnableServiceRequest {
}
/**
* Response message for the `EnableService` method. This response message is assigned to the `response` field of the returned Operation when that operation is done.
*/
export interface Schema$EnableServiceResponse {
/**
* The new state of the service after enabling.
*/
service?: Schema$GoogleApiServiceusageV1Service;
}
/**
* `Endpoint` describes a network address of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example: type: google.api.Service name: library-example.googleapis.com endpoints: # Declares network address `https://library-example.googleapis.com` # for service `library-example.googleapis.com`. The `https` scheme # is implicit for all service endpoints. Other schemes may be # supported in the future. - name: library-example.googleapis.com allow_cors: false - name: content-staging-library-example.googleapis.com # Allows HTTP OPTIONS calls to be passed to the API frontend, for it # to decide whether the subsequent cross-origin request is allowed # to proceed. allow_cors: true
*/
export interface Schema$Endpoint {
/**
* Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.
*/
aliases?: string[] | null;
/**
* 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 | null;
/**
* The canonical name of this endpoint.
*/
name?: string | null;
/**
* 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 | null;
}
/**
* Enum type definition.
*/
export interface Schema$Enum {
/**
* The source edition string, only valid when syntax is SYNTAX_EDITIONS.
*/
edition?: string | null;
/**
* Enum value definitions.
*/
enumvalue?: Schema$EnumValue[];
/**
* Enum type name.
*/
name?: string | null;
/**
* Protocol buffer options.
*/
options?: Schema$Option[];
/**
* The source context.
*/
sourceContext?: Schema$SourceContext;
/**
* The source syntax.
*/
syntax?: string | null;
}
/**
* Enum value definition.
*/
export interface Schema$EnumValue {
/**
* Enum value name.
*/
name?: string | null;
/**
* Enum value number.
*/
number?: number | null;
/**
* Protocol buffer options.
*/
options?: Schema$Option[];
}
/**
* A single field of a message type.
*/
export interface Schema$Field {
/**
* The field cardinality.
*/
cardinality?: string | null;
/**
* The string value of the default value of this field. Proto2 syntax only.
*/
defaultValue?: string | null;
/**
* The field JSON name.
*/
jsonName?: string | null;
/**
* The field type.
*/
kind?: string | null;
/**
* The field name.
*/
name?: string | null;
/**
* The field number.
*/
number?: number | null;
/**
* 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 | null;
/**
* The protocol buffer options.
*/
options?: Schema$Option[];
/**
* Whether to use alternative packed wire representation.
*/
packed?: boolean | null;
/**
* The field type URL, without the scheme, for message or enumeration types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
*/
typeUrl?: string | null;
}
/**
* Google API Policy Annotation This message defines a simple API policy annotation that can be used to annotate API request and response message fields with applicable policies. One field may have multiple applicable policies that must all be satisfied before a request can be processed. This policy annotation is used to generate the overall policy that will be used for automatic runtime policy enforcement and documentation generation.
*/
export interface Schema$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 | null;
/**
* Specifies the resource type for the resource referred to by the field.
*/
resourceType?: string | null;
/**
* 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 | null;
}
/**
* Metadata for the `GetServiceIdentity` method.
*/
export interface Schema$GetServiceIdentityMetadata {
}
/**
* Response message for getting service identity.
*/
export interface Schema$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?: Schema$ServiceIdentity;
/**
* Service identity state.
*/
state?: string | null;
}
/**
* `Service` is the root object of Google API service configuration (service config). It describes the basic information about a logical service, such as the service name and the user-facing title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. For more information, see each proto message definition. Example: type: google.api.Service name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar visibility: rules: - selector: "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: "google.calendar.v3.*" address: calendar.example.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth
*/
export interface Schema$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?: Schema$Api[];
/**
* Auth configuration.
*/
authentication?: Schema$Authentication;
/**
* API backend configuration.
*/
backend?: Schema$Backend;
/**
* Billing configuration.
*/
billing?: Schema$Billing;
/**
* Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to `3`.
*/
configVersion?: number | null;
/**
* Context configuration.
*/
context?: Schema$Context;
/**
* Configuration for the service control plane.
*/
control?: Schema$Control;
/**
* Custom error configuration.
*/
customError?: Schema$CustomError;
/**
* Additional API documentation.
*/
documentation?: Schema$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?: Schema$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?: Schema$Enum[];
/**
* HTTP configuration.
*/
http?: Schema$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 | null;
/**
* Logging configuration.
*/
logging?: Schema$Logging;
/**
* Defines the logs used by this service.
*/
logs?: Schema$LogDescriptor[];
/**
* Defines the metrics used by this service.
*/
metrics?: Schema$MetricDescriptor[];
/**
* Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
*/
monitoredResources?: Schema$MonitoredResourceDescriptor[];
/**
* Monitoring configuration.
*/