Service class

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

Constructors

Service({List<Api>? apis, Authentication? authentication, Backend? backend, Billing? billing, int? configVersion, Context? context, Control? control, CustomError? customError, Documentation? documentation, List<Endpoint>? endpoints, List<Enum>? enums, Http? http, String? id, Logging? logging, List<LogDescriptor>? logs, List<MetricDescriptor>? metrics, List<MonitoredResourceDescriptor>? monitoredResources, Monitoring? monitoring, String? name, String? producerProjectId, Publishing? publishing, Quota? quota, SourceInfo? sourceInfo, SystemParameters? systemParameters, List<Type>? systemTypes, String? title, List<Type>? types, Usage? usage})

Service.fromJson(Map json_)

Properties

apis ↔ List<Api>?

A list of API interfaces exported by this service.

getter/setter pair

authentication ↔ Authentication?

Auth configuration.

getter/setter pair

backend ↔ Backend?

API backend configuration.

getter/setter pair

billing ↔ Billing?

Billing configuration.

getter/setter pair

configVersion ↔ int?

Obsolete.

getter/setter pair

context ↔ Context?

Context configuration.

getter/setter pair

control ↔ Control?

Configuration for the service control plane.

getter/setter pair

customError ↔ CustomError?

Custom error configuration.

getter/setter pair

documentation ↔ Documentation?

Additional API documentation.

getter/setter pair

endpoints ↔ List<Endpoint>?

Configuration for network endpoints.

getter/setter pair

enums ↔ List<Enum>?

A list of all enum types included in this API service.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

http ↔ Http?

HTTP configuration.

getter/setter pair

id ↔ String?

A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose.

getter/setter pair

logging ↔ Logging?

Logging configuration.

getter/setter pair

logs ↔ List<LogDescriptor>?

Defines the logs used by this service.

getter/setter pair

metrics ↔ List<MetricDescriptor>?

Defines the metrics used by this service.

getter/setter pair

monitoredResources ↔ List<MonitoredResourceDescriptor>?

Defines the monitored resources used by this service.

getter/setter pair

monitoring ↔ Monitoring?

Monitoring configuration.

getter/setter pair

name ↔ String?

The service name, which is a DNS-like logical identifier for the service, such as calendar.googleapis.com.

getter/setter pair

producerProjectId ↔ String?

The Google project that owns this service.

getter/setter pair

publishing ↔ Publishing?

Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.

getter/setter pair

quota ↔ Quota?

Quota configuration.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sourceInfo ↔ SourceInfo?

The source information for this configuration if available.

getter/setter pair

systemParameters ↔ SystemParameters?

System parameter configuration.

getter/setter pair

systemTypes ↔ List<Type>?

A list of all proto message types included in this API service.

getter/setter pair

title ↔ String?

The product title for this service, it is the name displayed in Google Cloud Console.

getter/setter pair

types ↔ List<Type>?

A list of all proto message types included in this API service.

getter/setter pair

usage ↔ Usage?

Configuration controlling usage of this service.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited