GoogleApi.ServiceUsage.V1.Model.GoogleApiService (google_api_service_usage v0.17.1) View Source

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 (type: list(GoogleApi.ServiceUsage.V1.Model.Api.t), default: nil) - 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.
  • authentication (type: GoogleApi.ServiceUsage.V1.Model.Authentication.t, default: nil) - Auth configuration.
  • backend (type: GoogleApi.ServiceUsage.V1.Model.Backend.t, default: nil) - API backend configuration.
  • billing (type: GoogleApi.ServiceUsage.V1.Model.Billing.t, default: nil) - Billing configuration.
  • configVersion (type: integer(), default: nil) - Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to 3.
  • context (type: GoogleApi.ServiceUsage.V1.Model.Context.t, default: nil) - Context configuration.
  • control (type: GoogleApi.ServiceUsage.V1.Model.Control.t, default: nil) - Configuration for the service control plane.
  • customError (type: GoogleApi.ServiceUsage.V1.Model.CustomError.t, default: nil) - Custom error configuration.
  • documentation (type: GoogleApi.ServiceUsage.V1.Model.Documentation.t, default: nil) - Additional API documentation.
  • endpoints (type: list(GoogleApi.ServiceUsage.V1.Model.Endpoint.t), default: nil) - 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 (type: list(GoogleApi.ServiceUsage.V1.Model.Enum.t), default: nil) - 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
  • http (type: GoogleApi.ServiceUsage.V1.Model.Http.t, default: nil) - HTTP configuration.
  • id (type: String.t, default: nil) - 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 (type: GoogleApi.ServiceUsage.V1.Model.Logging.t, default: nil) - Logging configuration.
  • logs (type: list(GoogleApi.ServiceUsage.V1.Model.LogDescriptor.t), default: nil) - Defines the logs used by this service.
  • metrics (type: list(GoogleApi.ServiceUsage.V1.Model.MetricDescriptor.t), default: nil) - Defines the metrics used by this service.
  • monitoredResources (type: list(GoogleApi.ServiceUsage.V1.Model.MonitoredResourceDescriptor.t), default: nil) - Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
  • monitoring (type: GoogleApi.ServiceUsage.V1.Model.Monitoring.t, default: nil) - Monitoring configuration.
  • name (type: String.t, default: nil) - 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 (type: String.t, default: nil) - The Google project that owns this service.
  • quota (type: GoogleApi.ServiceUsage.V1.Model.Quota.t, default: nil) - Quota configuration.
  • sourceInfo (type: GoogleApi.ServiceUsage.V1.Model.SourceInfo.t, default: nil) - Output only. The source information for this configuration if available.
  • systemParameters (type: GoogleApi.ServiceUsage.V1.Model.SystemParameters.t, default: nil) - System parameter configuration.
  • systemTypes (type: list(GoogleApi.ServiceUsage.V1.Model.Type.t), default: nil) - A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.
  • title (type: String.t, default: nil) - The product title for this service.
  • types (type: list(GoogleApi.ServiceUsage.V1.Model.Type.t), default: nil) - 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
  • usage (type: GoogleApi.ServiceUsage.V1.Model.Usage.t, default: nil) - Configuration controlling usage of this service.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.ServiceUsage.V1.Model.GoogleApiService{
  apis: [GoogleApi.ServiceUsage.V1.Model.Api.t()] | nil,
  authentication: GoogleApi.ServiceUsage.V1.Model.Authentication.t() | nil,
  backend: GoogleApi.ServiceUsage.V1.Model.Backend.t() | nil,
  billing: GoogleApi.ServiceUsage.V1.Model.Billing.t() | nil,
  configVersion: integer() | nil,
  context: GoogleApi.ServiceUsage.V1.Model.Context.t() | nil,
  control: GoogleApi.ServiceUsage.V1.Model.Control.t() | nil,
  customError: GoogleApi.ServiceUsage.V1.Model.CustomError.t() | nil,
  documentation: GoogleApi.ServiceUsage.V1.Model.Documentation.t() | nil,
  endpoints: [GoogleApi.ServiceUsage.V1.Model.Endpoint.t()] | nil,
  enums: [GoogleApi.ServiceUsage.V1.Model.Enum.t()] | nil,
  http: GoogleApi.ServiceUsage.V1.Model.Http.t() | nil,
  id: String.t() | nil,
  logging: GoogleApi.ServiceUsage.V1.Model.Logging.t() | nil,
  logs: [GoogleApi.ServiceUsage.V1.Model.LogDescriptor.t()] | nil,
  metrics: [GoogleApi.ServiceUsage.V1.Model.MetricDescriptor.t()] | nil,
  monitoredResources:
    [GoogleApi.ServiceUsage.V1.Model.MonitoredResourceDescriptor.t()] | nil,
  monitoring: GoogleApi.ServiceUsage.V1.Model.Monitoring.t() | nil,
  name: String.t() | nil,
  producerProjectId: String.t() | nil,
  quota: GoogleApi.ServiceUsage.V1.Model.Quota.t() | nil,
  sourceInfo: GoogleApi.ServiceUsage.V1.Model.SourceInfo.t() | nil,
  systemParameters: GoogleApi.ServiceUsage.V1.Model.SystemParameters.t() | nil,
  systemTypes: [GoogleApi.ServiceUsage.V1.Model.Type.t()] | nil,
  title: String.t() | nil,
  types: [GoogleApi.ServiceUsage.V1.Model.Type.t()] | nil,
  usage: GoogleApi.ServiceUsage.V1.Model.Usage.t() | nil
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.