Class: Google::Api::Service

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/api/service.rb

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#apis ⇒ ::Array<::Google::Protobuf::Api>

Returns 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.

Returns:

  • (::Array<::Google::Protobuf::Api>) —

    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.



166
167
168
169
 
# File 'proto_docs/google/api/service.rb', line 166

class Service
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#authentication ⇒ ::Google::Api::Authentication

Returns Auth configuration.

Returns:



166
167
168
169
 
# File 'proto_docs/google/api/service.rb', line 166

class Service
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#backend ⇒ ::Google::Api::Backend

Returns API backend configuration.

Returns:



166
167
168
169
 
# File 'proto_docs/google/api/service.rb', line 166

class Service
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#billing ⇒ ::Google::Api::Billing

Returns Billing configuration.

Returns:



166
167
168
169
 
# File 'proto_docs/google/api/service.rb', line 166

class Service
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#config_version ⇒ ::Google::Protobuf::UInt32Value

Returns Obsolete. Do not use.

This field has no semantic meaning. The service config compiler always sets this field to 3.

Returns:



166
167
168
169
 
# File 'proto_docs/google/api/service.rb', line 166

class Service
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#context ⇒ ::Google::Api::Context

Returns Context configuration.

Returns:



166
167
168
169
 
# File 'proto_docs/google/api/service.rb', line 166

class Service
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#control ⇒ ::Google::Api::Control

Returns Configuration for the service control plane.

Returns:



166
167
168
169
 
# File 'proto_docs/google/api/service.rb', line 166

class Service
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#documentation ⇒ ::Google::Api::Documentation

Returns Additional API documentation.

Returns:



166
167
168
169
 
# File 'proto_docs/google/api/service.rb', line 166

class Service
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#endpoints ⇒ ::Array<::Google::Api::Endpoint>

Returns 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.

Returns:

  • (::Array<::Google::Api::Endpoint>) —

    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.



166
167
168
169
 
# File 'proto_docs/google/api/service.rb', line 166

class Service
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#enums ⇒ ::Array<::Google::Protobuf::Enum>

Returns 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.

Returns:

  • (::Array<::Google::Protobuf::Enum>) —

    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



166
167
168
169
 
# File 'proto_docs/google/api/service.rb', line 166

class Service
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#http ⇒ ::Google::Api::Http

Returns HTTP configuration.

Returns:

  • (::Google::Api::Http) —

    HTTP configuration.



166
167
168
169
 
# File 'proto_docs/google/api/service.rb', line 166

class Service
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#id ⇒ ::String

Returns 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.

Returns:

  • (::String) —

    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.



166
167
168
169
 
# File 'proto_docs/google/api/service.rb', line 166

class Service
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#logging ⇒ ::Google::Api::Logging

Returns Logging configuration.

Returns:



166
167
168
169
 
# File 'proto_docs/google/api/service.rb', line 166

class Service
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#logs ⇒ ::Array<::Google::Api::LogDescriptor>

Returns Defines the logs used by this service.

Returns:



166
167
168
169
 
# File 'proto_docs/google/api/service.rb', line 166

class Service
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#metrics ⇒ ::Array<::Google::Api::MetricDescriptor>

Returns Defines the metrics used by this service.

Returns:



166
167
168
169
 
# File 'proto_docs/google/api/service.rb', line 166

class Service
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#monitored_resources ⇒ ::Array<::Google::Api::MonitoredResourceDescriptor>

Returns Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.

Returns:



166
167
168
169
 
# File 'proto_docs/google/api/service.rb', line 166

class Service
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#monitoring ⇒ ::Google::Api::Monitoring

Returns Monitoring configuration.

Returns:



166
167
168
169
 
# File 'proto_docs/google/api/service.rb', line 166

class Service
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns 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.

Returns:

  • (::String) —

    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.



166
167
168
169
 
# File 'proto_docs/google/api/service.rb', line 166

class Service
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#producer_project_id ⇒ ::String

Returns The Google project that owns this service.

Returns:

  • (::String) —

    The Google project that owns this service.



166
167
168
169
 
# File 'proto_docs/google/api/service.rb', line 166

class Service
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#publishing ⇒ ::Google::Api::Publishing

Returns Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.

Returns:



166
167
168
169
 
# File 'proto_docs/google/api/service.rb', line 166

class Service
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#quota ⇒ ::Google::Api::Quota

Returns Quota configuration.

Returns:



166
167
168
169
 
# File 'proto_docs/google/api/service.rb', line 166

class Service
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#source_info ⇒ ::Google::Api::SourceInfo

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

Returns:



166
167
168
169
 
# File 'proto_docs/google/api/service.rb', line 166

class Service
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#system_parameters ⇒ ::Google::Api::SystemParameters

Returns System parameter configuration.

Returns:



166
167
168
169
 
# File 'proto_docs/google/api/service.rb', line 166

class Service
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#title ⇒ ::String

Returns The product title for this service, it is the name displayed in Google Cloud Console.

Returns:

  • (::String) —

    The product title for this service, it is the name displayed in Google Cloud Console.



166
167
168
169
 
# File 'proto_docs/google/api/service.rb', line 166

class Service
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#types ⇒ ::Array<::Google::Protobuf::Type>

Returns 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.

Returns:

  • (::Array<::Google::Protobuf::Type>) —

    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



166
167
168
169
 
# File 'proto_docs/google/api/service.rb', line 166

class Service
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#usage ⇒ ::Google::Api::Usage

Returns Configuration controlling usage of this service.

Returns:



166
167
168
169
 
# File 'proto_docs/google/api/service.rb', line 166

class Service
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end