Service class

Service is the root object of Google service configuration schema. It describes basic information about a service, such as the name and the 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. See each proto message definition for details.

Example:

type: google.api.Service
config_version: 3
name: calendar.googleapis.com
title: Google Calendar API
apis:
- name: google.calendar.v3.Calendar
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

Constructors

Service()
Service.fromJson(Map _json)

Properties

apis ↔ List<Api>
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.
read / write
authentication Authentication
Auth configuration.
read / write
backend Backend
API backend configuration.
read / write
billing Billing
Billing configuration.
read / write
configVersion ↔ int
The semantic version of the service configuration. The config version affects the interpretation of the service configuration. For example, certain features are enabled by default for certain config versions. The latest config version is 3.
read / write
context Context
Context configuration.
read / write
control Control
Configuration for the service control plane.
read / write
customError CustomError
Custom error configuration.
read / write
documentation Documentation
Additional API documentation.
read / write
endpoints ↔ List<Endpoint>
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.
read / write
enums ↔ List<Enum>
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. Example: [...]
read / write
http Http
HTTP configuration.
read / write
id ↔ String
A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. If empty, the server may choose to generate one instead. Must be no longer than 60 characters.
read / write
logging Logging
Logging configuration.
read / write
logs ↔ List<LogDescriptor>
Defines the logs used by this service.
read / write
metrics ↔ List<MetricDescriptor>
Defines the metrics used by this service.
read / write
monitoredResources ↔ List<MonitoredResourceDescriptor>
Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
read / write
monitoring Monitoring
Monitoring configuration.
read / write
name ↔ String
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.
read / write
producerProjectId ↔ String
The Google project that owns this service.
read / write
quota Quota
Quota configuration.
read / write
sourceInfo SourceInfo
Output only. The source information for this configuration if available.
read / write
systemParameters SystemParameters
System parameter configuration.
read / write
systemTypes ↔ List<Type>
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.
read / write
title ↔ String
The product title for this service.
read / write
types ↔ List<Type>
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. Example: [...]
read / write
usage Usage
Configuration controlling usage of this service.
read / write
hashCode → int
The hash code for this object.
read-only, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited

Methods

toJson() → Map<String, Object>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
toString() → String
Returns a string representation of this object.
inherited

Operators

operator ==(dynamic other) → bool
The equality operator.
inherited