http4s-grpc-google-common-protos/com.google.api.service

com.google.api.service

Members list

Concise view

Type members

Classlikes

final case class Service(name: String, title: String, producerProjectId: String, id: String, apis: Seq[Api], types: Seq[Type], enums: Seq[Enum], documentation: Option[Documentation], backend: Option[Backend], http: Option[Http], quota: Option[Quota], authentication: Option[Authentication], context: Option[Context], usage: Option[Usage], endpoints: Seq[Endpoint], control: Option[Control], logs: Seq[LogDescriptor], metrics: Seq[MetricDescriptor], monitoredResources: Seq[MonitoredResourceDescriptor], billing: Option[Billing], logging: Option[Logging], monitoring: Option[Monitoring], systemParameters: Option[SystemParameters], sourceInfo: Option[SourceInfo], publishing: Option[Publishing], configVersion: Option[Int], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[Service]

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

Attributes

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.
authentication: Auth configuration.
backend: API backend configuration.
billing: Billing configuration.
configVersion: Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to 3.
context: Context configuration.
control: Configuration for the service control plane.
documentation: Additional API documentation.
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.
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 by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum
http: HTTP configuration.
id: 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.
logging: Logging configuration.
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.
monitoring: Monitoring configuration.
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.
producerProjectId: The Google project that owns this service.
publishing: Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.
quota: Quota configuration.
sourceInfo: Output only. The source information for this configuration if available.
systemParameters: System parameter configuration.
title: The product title for this service, it is the name displayed in Google Cloud Console.
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 by the configuration author. Example: types: - name: google.protobuf.Int32
usage: Configuration controlling usage of this service.
Companion:: object
Source:: Service.scala
Graph
Supertypes: trait Updatable[Service]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Attributes

Companion:: class
Source:: Service.scala
Graph
Supertypes: trait Product
trait Mirror
trait GeneratedMessageCompanion[Service]
trait Serializable
class Object
trait Matchable
class Any
Self type: Service.type

Attributes

Source:: ServiceProto.scala
Graph
Supertypes: class GeneratedFileObject
class Object
trait Matchable
class Any
Self type: ServiceProto.type

Generated with