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] = _root_.scala.None, backend: Option[Backend] = _root_.scala.None, http: Option[Http] = _root_.scala.None, quota: Option[Quota] = _root_.scala.None, authentication: Option[Authentication] = _root_.scala.None, context: Option[Context] = _root_.scala.None, usage: Option[Usage] = _root_.scala.None, endpoints: Seq[Endpoint] = _root_.scala.Seq.empty, control: Option[Control] = _root_.scala.None, logs: Seq[LogDescriptor] = _root_.scala.Seq.empty, metrics: Seq[MetricDescriptor] = _root_.scala.Seq.empty, monitoredResources: Seq[MonitoredResourceDescriptor] = _root_.scala.Seq.empty, billing: Option[Billing] = _root_.scala.None, logging: Option[Logging] = _root_.scala.None, monitoring: Option[Monitoring] = _root_.scala.None, systemParameters: Option[SystemParameters] = _root_.scala.None, sourceInfo: Option[SourceInfo] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Service] with Product with Serializable

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()
Linear Supertypes
Product, Equals, Updatable[Service], GeneratedMessage, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Service
  2. Product
  3. Equals
  4. Updatable
  5. GeneratedMessage
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new 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] = _root_.scala.None, backend: Option[Backend] = _root_.scala.None, http: Option[Http] = _root_.scala.None, quota: Option[Quota] = _root_.scala.None, authentication: Option[Authentication] = _root_.scala.None, context: Option[Context] = _root_.scala.None, usage: Option[Usage] = _root_.scala.None, endpoints: Seq[Endpoint] = _root_.scala.Seq.empty, control: Option[Control] = _root_.scala.None, logs: Seq[LogDescriptor] = _root_.scala.Seq.empty, metrics: Seq[MetricDescriptor] = _root_.scala.Seq.empty, monitoredResources: Seq[MonitoredResourceDescriptor] = _root_.scala.Seq.empty, billing: Option[Billing] = _root_.scala.None, logging: Option[Logging] = _root_.scala.None, monitoring: Option[Monitoring] = _root_.scala.None, systemParameters: Option[SystemParameters] = _root_.scala.None, sourceInfo: Option[SourceInfo] = _root_.scala.None, unknownFields: UnknownFieldSet = ...)

    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.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAllApis(__vs: Iterable[Api]): Service
  5. def addAllEndpoints(__vs: Iterable[Endpoint]): Service
  6. def addAllEnums(__vs: Iterable[Enum]): Service
  7. def addAllLogs(__vs: Iterable[LogDescriptor]): Service
  8. def addAllMetrics(__vs: Iterable[MetricDescriptor]): Service
  9. def addAllMonitoredResources(__vs: Iterable[MonitoredResourceDescriptor]): Service
  10. def addAllTypes(__vs: Iterable[Type]): Service
  11. def addApis(__vs: Api*): Service
  12. def addEndpoints(__vs: Endpoint*): Service
  13. def addEnums(__vs: Enum*): Service
  14. def addLogs(__vs: LogDescriptor*): Service
  15. def addMetrics(__vs: MetricDescriptor*): Service
  16. def addMonitoredResources(__vs: MonitoredResourceDescriptor*): Service
  17. def addTypes(__vs: Type*): Service
  18. val apis: Seq[Api]
  19. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  20. val authentication: Option[Authentication]
  21. val backend: Option[Backend]
  22. val billing: Option[Billing]
  23. def clearApis: Service
  24. def clearAuthentication: Service
  25. def clearBackend: Service
  26. def clearBilling: Service
  27. def clearConfigVersion: Service
  28. def clearContext: Service
  29. def clearControl: Service
  30. def clearDocumentation: Service
  31. def clearEndpoints: Service
  32. def clearEnums: Service
  33. def clearHttp: Service
  34. def clearLogging: Service
  35. def clearLogs: Service
  36. def clearMetrics: Service
  37. def clearMonitoredResources: Service
  38. def clearMonitoring: Service
  39. def clearQuota: Service
  40. def clearSourceInfo: Service
  41. def clearSystemParameters: Service
  42. def clearTypes: Service
  43. def clearUsage: Service
  44. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  45. def companion: Service.type
    Definition Classes
    Service → GeneratedMessage
  46. val configVersion: Option[Int]
  47. val context: Option[Context]
  48. val control: Option[Control]
  49. def discardUnknownFields: Service
  50. val documentation: Option[Documentation]
  51. val endpoints: Seq[Endpoint]
  52. val enums: Seq[Enum]
  53. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  54. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  55. def getAuthentication: Authentication
  56. def getBackend: Backend
  57. def getBilling: Billing
  58. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  59. def getConfigVersion: Int
  60. def getContext: Context
  61. def getControl: Control
  62. def getDocumentation: Documentation
  63. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    Service → GeneratedMessage
  64. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    Service → GeneratedMessage
  65. def getHttp: Http
  66. def getLogging: Logging
  67. def getMonitoring: Monitoring
  68. def getQuota: Quota
  69. def getSourceInfo: SourceInfo
  70. def getSystemParameters: SystemParameters
  71. def getUsage: Usage
  72. val http: Option[Http]
  73. val id: String
  74. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  75. val logging: Option[Logging]
  76. val logs: Seq[LogDescriptor]
  77. val metrics: Seq[MetricDescriptor]
  78. val monitoredResources: Seq[MonitoredResourceDescriptor]
  79. val monitoring: Option[Monitoring]
  80. val name: String
  81. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  82. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  83. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  84. val producerProjectId: String
  85. val quota: Option[Quota]
  86. def serializedSize: Int
    Definition Classes
    Service → GeneratedMessage
  87. val sourceInfo: Option[SourceInfo]
  88. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  89. val systemParameters: Option[SystemParameters]
  90. val title: String
  91. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  92. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  93. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  94. def toProtoString: String
    Definition Classes
    Service → GeneratedMessage
  95. val types: Seq[Type]
  96. val unknownFields: UnknownFieldSet
  97. def update(ms: (Lens[Service, Service]) ⇒ Mutation[Service]*): Service
    Definition Classes
    Updatable
  98. val usage: Option[Usage]
  99. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  100. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  101. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  102. def withApis(__v: Seq[Api]): Service
  103. def withAuthentication(__v: Authentication): Service
  104. def withBackend(__v: Backend): Service
  105. def withBilling(__v: Billing): Service
  106. def withConfigVersion(__v: Int): Service
  107. def withContext(__v: Context): Service
  108. def withControl(__v: Control): Service
  109. def withDocumentation(__v: Documentation): Service
  110. def withEndpoints(__v: Seq[Endpoint]): Service
  111. def withEnums(__v: Seq[Enum]): Service
  112. def withHttp(__v: Http): Service
  113. def withId(__v: String): Service
  114. def withLogging(__v: Logging): Service
  115. def withLogs(__v: Seq[LogDescriptor]): Service
  116. def withMetrics(__v: Seq[MetricDescriptor]): Service
  117. def withMonitoredResources(__v: Seq[MonitoredResourceDescriptor]): Service
  118. def withMonitoring(__v: Monitoring): Service
  119. def withName(__v: String): Service
  120. def withProducerProjectId(__v: String): Service
  121. def withQuota(__v: Quota): Service
  122. def withSourceInfo(__v: SourceInfo): Service
  123. def withSystemParameters(__v: SystemParameters): Service
  124. def withTitle(__v: String): Service
  125. def withTypes(__v: Seq[Type]): Service
  126. def withUnknownFields(__v: UnknownFieldSet): Service
  127. def withUsage(__v: Usage): Service
  128. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  129. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    Service → GeneratedMessage
  130. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from Product

Inherited from Equals

Inherited from Updatable[Service]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped