Type Members

1.  final case class Service(configVersion: Option[Int] = _root_.scala.None, name: String = "", id: String = "", title: String = "", producerProjectId: String = "", apis: Seq[Api] = _root_.scala.Seq.empty, types: Seq[Type] = _root_.scala.Seq.empty, enums: Seq[Enum] = _root_.scala.Seq.empty, documentation: Option[documentation.Documentation] = _root_.scala.None, backend: Option[backend.Backend] = _root_.scala.None, http: Option[http.Http] = _root_.scala.None, quota: Option[quota.Quota] = _root_.scala.None, authentication: Option[auth.Authentication] = _root_.scala.None, context: Option[context.Context] = _root_.scala.None, usage: Option[usage.Usage] = _root_.scala.None, endpoints: Seq[endpoint.Endpoint] = _root_.scala.Seq.empty, control: Option[control.Control] = _root_.scala.None, logs: Seq[log.LogDescriptor] = _root_.scala.Seq.empty, metrics: Seq[metric.MetricDescriptor] = _root_.scala.Seq.empty, monitoredResources: Seq[monitored_resource.MonitoredResourceDescriptor] = _root_.scala.Seq.empty, billing: Option[billing.Billing] = _root_.scala.None, logging: Option[logging.Logging] = _root_.scala.None, monitoring: Option[monitoring.Monitoring] = _root_.scala.None, systemParameters: Option[system_parameter.SystemParameters] = _root_.scala.None, sourceInfo: Option[source_info.SourceInfo] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Service] with Product with Serializable

   Service is the root object of Google service configuration schema.

   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

   configVersion

   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.

   name

   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.

   id

   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.

   title

   The product title for this service.

   producerProjectId

   The Google project that owns this service.

   apis

   A list of API interfaces exported by this service. Only the name field of the [google.protobuf.Api][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.

   types

   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: types:

   • name: google.protobuf.Int32

   enums

   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: enums:

   • name: google.someapi.v1.SomeEnum

   documentation

   Additional API documentation.

   backend

   API backend configuration.

   http

   HTTP configuration.

   quota

   Quota configuration.

   authentication

   Auth configuration.

   context

   Context configuration.

   usage

   Configuration controlling usage of this service.

   endpoints

   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.

   control

   Configuration for the service control plane.

   logs

   Defines the logs used by this service.

   metrics

   Defines the metrics used by this service.

   monitoredResources

   Defines the monitored resources used by this service. This is required by the [Service.monitoring][google.api.Service.monitoring] and [Service.logging][google.api.Service.logging] configurations.

   billing

   Billing configuration.

   logging

   Logging configuration.

   monitoring

   Monitoring configuration.

   systemParameters

   System parameter configuration.

   sourceInfo

   Output only. The source information for this configuration if available.

   Annotations

   @SerialVersionUID()