# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# NOTE: This file is auto generated by the elixir code generator program.
# Do not edit this file manually.

defmodule GoogleApi.ServiceNetworking.V1.Model.Service do
  @moduledoc """
  `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.ServiceNetworking.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.
  *   `aspects` (*type:* `list(GoogleApi.ServiceNetworking.V1.Model.Aspect.t)`, *default:* `nil`) - Configuration aspects. This is a repeated field to allow multiple aspects to be configured. The kind field in each ConfigAspect specifies the type of aspect. The spec field contains the configuration for that aspect. The schema for the spec field is defined by the backend service owners.
  *   `authentication` (*type:* `GoogleApi.ServiceNetworking.V1.Model.Authentication.t`, *default:* `nil`) - Auth configuration.
  *   `backend` (*type:* `GoogleApi.ServiceNetworking.V1.Model.Backend.t`, *default:* `nil`) - API backend configuration.
  *   `billing` (*type:* `GoogleApi.ServiceNetworking.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.ServiceNetworking.V1.Model.Context.t`, *default:* `nil`) - Context configuration.
  *   `control` (*type:* `GoogleApi.ServiceNetworking.V1.Model.Control.t`, *default:* `nil`) - Configuration for the service control plane.
  *   `customError` (*type:* `GoogleApi.ServiceNetworking.V1.Model.CustomError.t`, *default:* `nil`) - Custom error configuration.
  *   `documentation` (*type:* `GoogleApi.ServiceNetworking.V1.Model.Documentation.t`, *default:* `nil`) - Additional API documentation.
  *   `endpoints` (*type:* `list(GoogleApi.ServiceNetworking.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.ServiceNetworking.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 by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum
  *   `http` (*type:* `GoogleApi.ServiceNetworking.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.ServiceNetworking.V1.Model.Logging.t`, *default:* `nil`) - Logging configuration.
  *   `logs` (*type:* `list(GoogleApi.ServiceNetworking.V1.Model.LogDescriptor.t)`, *default:* `nil`) - Defines the logs used by this service.
  *   `metrics` (*type:* `list(GoogleApi.ServiceNetworking.V1.Model.MetricDescriptor.t)`, *default:* `nil`) - Defines the metrics used by this service.
  *   `monitoredResources` (*type:* `list(GoogleApi.ServiceNetworking.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.ServiceNetworking.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.
  *   `publishing` (*type:* `GoogleApi.ServiceNetworking.V1.Model.Publishing.t`, *default:* `nil`) - Settings for [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from APIs defined as protocol buffers.
  *   `quota` (*type:* `GoogleApi.ServiceNetworking.V1.Model.Quota.t`, *default:* `nil`) - Quota configuration.
  *   `sourceInfo` (*type:* `GoogleApi.ServiceNetworking.V1.Model.SourceInfo.t`, *default:* `nil`) - Output only. The source information for this configuration if available.
  *   `systemParameters` (*type:* `GoogleApi.ServiceNetworking.V1.Model.SystemParameters.t`, *default:* `nil`) - System parameter configuration.
  *   `systemTypes` (*type:* `list(GoogleApi.ServiceNetworking.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, it is the name displayed in Google Cloud Console.
  *   `types` (*type:* `list(GoogleApi.ServiceNetworking.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 by the configuration author. Example: types: - name: google.protobuf.Int32
  *   `usage` (*type:* `GoogleApi.ServiceNetworking.V1.Model.Usage.t`, *default:* `nil`) - Configuration controlling usage of this service.
  """

  use GoogleApi.Gax.ModelBase

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

  field(:apis, as: GoogleApi.ServiceNetworking.V1.Model.Api, type: :list)
  field(:aspects, as: GoogleApi.ServiceNetworking.V1.Model.Aspect, type: :list)
  field(:authentication, as: GoogleApi.ServiceNetworking.V1.Model.Authentication)
  field(:backend, as: GoogleApi.ServiceNetworking.V1.Model.Backend)
  field(:billing, as: GoogleApi.ServiceNetworking.V1.Model.Billing)
  field(:configVersion)
  field(:context, as: GoogleApi.ServiceNetworking.V1.Model.Context)
  field(:control, as: GoogleApi.ServiceNetworking.V1.Model.Control)
  field(:customError, as: GoogleApi.ServiceNetworking.V1.Model.CustomError)
  field(:documentation, as: GoogleApi.ServiceNetworking.V1.Model.Documentation)
  field(:endpoints, as: GoogleApi.ServiceNetworking.V1.Model.Endpoint, type: :list)
  field(:enums, as: GoogleApi.ServiceNetworking.V1.Model.Enum, type: :list)
  field(:http, as: GoogleApi.ServiceNetworking.V1.Model.Http)
  field(:id)
  field(:logging, as: GoogleApi.ServiceNetworking.V1.Model.Logging)
  field(:logs, as: GoogleApi.ServiceNetworking.V1.Model.LogDescriptor, type: :list)
  field(:metrics, as: GoogleApi.ServiceNetworking.V1.Model.MetricDescriptor, type: :list)

  field(:monitoredResources,
    as: GoogleApi.ServiceNetworking.V1.Model.MonitoredResourceDescriptor,
    type: :list
  )

  field(:monitoring, as: GoogleApi.ServiceNetworking.V1.Model.Monitoring)
  field(:name)
  field(:producerProjectId)
  field(:publishing, as: GoogleApi.ServiceNetworking.V1.Model.Publishing)
  field(:quota, as: GoogleApi.ServiceNetworking.V1.Model.Quota)
  field(:sourceInfo, as: GoogleApi.ServiceNetworking.V1.Model.SourceInfo)
  field(:systemParameters, as: GoogleApi.ServiceNetworking.V1.Model.SystemParameters)
  field(:systemTypes, as: GoogleApi.ServiceNetworking.V1.Model.Type, type: :list)
  field(:title)
  field(:types, as: GoogleApi.ServiceNetworking.V1.Model.Type, type: :list)
  field(:usage, as: GoogleApi.ServiceNetworking.V1.Model.Usage)
end

defimpl Poison.Decoder, for: GoogleApi.ServiceNetworking.V1.Model.Service do
  def decode(value, options) do
    GoogleApi.ServiceNetworking.V1.Model.Service.decode(value, options)
  end
end

defimpl Poison.Encoder, for: GoogleApi.ServiceNetworking.V1.Model.Service do
  def encode(value, options) do
    GoogleApi.Gax.ModelBase.encode(value, options)
  end
end
