Service class final

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
Inheritance

Constructors

Service({String name = '', String title = '', String producerProjectId = '', String id = '', List<Api> apis = const [], List<Type> types = const [], List<Enum> enums = const [], Documentation? documentation, Backend? backend, Http? http, Quota? quota, Authentication? authentication, Context? context, Usage? usage, List<Endpoint> endpoints = const [], Control? control, List<LogDescriptor> logs = const [], List<MetricDescriptor> metrics = const [], List<MonitoredResourceDescriptor> monitoredResources = const [], Billing? billing, Logging? logging, Monitoring? monitoring, SystemParameters? systemParameters, SourceInfo? sourceInfo, Publishing? publishing, Uint32Value? configVersion})
Service.fromJson(Object? j)
factory

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.
final
authentication → Authentication?
Auth configuration.
final
backend → Backend?
API backend configuration.
final
billing → Billing?
Billing configuration.
final
configVersion → Uint32Value?
Obsolete. Do not use.
final
context → Context?
Context configuration.
final
control → Control?
Configuration for the service control plane.
final
documentation → Documentation?
Additional API documentation.
final
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.
final
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 by the configuration author. Example:
final
hashCode → int
The hash code for this object.
no setterinherited
http → Http?
HTTP configuration.
final
id → String
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.
final
logging → Logging?
Logging configuration.
final
logs → List<LogDescriptor>
Defines the logs used by this service.
final
metrics → List<MetricDescriptor>
Defines the metrics used by this service.
final
monitoredResources → List<MonitoredResourceDescriptor>
Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
final
monitoring → Monitoring?
Monitoring configuration.
final
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.
final
producerProjectId → String
The Google project that owns this service.
final
publishing → Publishing?
Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.
final
qualifiedName → String
The fully qualified name of this message, i.e., google.protobuf.Duration or google.rpc.ErrorInfo.
finalinherited
quota → Quota?
Quota configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sourceInfo → SourceInfo?
Output only. The source information for this configuration if available.
final
systemParameters → SystemParameters?
System parameter configuration.
final
title → String
The product title for this service, it is the name displayed in Google Cloud Console.
final
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 by the configuration author. Example:
final
usage → Usage?
Configuration controlling usage of this service.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Object
override
toString() → String
A string representation of this object.
override

Operators

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

Constants

fullyQualifiedName → const String