Service
import type { Service } from "https://googleapis.deno.dev/v1/serviceconsumermanagement:v1.ts";
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
§Properties
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.
Auth configuration.
Obsolete. Do not use. This field has no semantic meaning. The service
config compiler always sets this field to 3
.
Custom error configuration.
Additional API documentation.
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
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.
Defines the logs used by this service.
Defines the metrics used by this service.
Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
Monitoring configuration.
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.
Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.
Output only. The source information for this configuration if available.
System parameter configuration.
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.
The product title for this service, it is the name displayed in Google Cloud Console.
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