Reference documentation and code samples for the Service Management V1 API class Google::Api::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
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#apis
def apis() -> ::Array<::Google::Protobuf::Api>
-
(::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.
#apis=
def apis=(value) -> ::Array<::Google::Protobuf::Api>
-
value (::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.
-
(::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.
#authentication
def authentication() -> ::Google::Api::Authentication
- (::Google::Api::Authentication) — Auth configuration.
#authentication=
def authentication=(value) -> ::Google::Api::Authentication
- value (::Google::Api::Authentication) — Auth configuration.
- (::Google::Api::Authentication) — Auth configuration.
#backend
def backend() -> ::Google::Api::Backend
- (::Google::Api::Backend) — API backend configuration.
#backend=
def backend=(value) -> ::Google::Api::Backend
- value (::Google::Api::Backend) — API backend configuration.
- (::Google::Api::Backend) — API backend configuration.
#billing
def billing() -> ::Google::Api::Billing
- (::Google::Api::Billing) — Billing configuration.
#billing=
def billing=(value) -> ::Google::Api::Billing
- value (::Google::Api::Billing) — Billing configuration.
- (::Google::Api::Billing) — Billing configuration.
#config_version
def config_version() -> ::Google::Protobuf::UInt32Value
-
(::Google::Protobuf::UInt32Value) — Obsolete. Do not use.
This field has no semantic meaning. The service config compiler always sets this field to
3
.
#config_version=
def config_version=(value) -> ::Google::Protobuf::UInt32Value
-
value (::Google::Protobuf::UInt32Value) — Obsolete. Do not use.
This field has no semantic meaning. The service config compiler always sets this field to
3
.
-
(::Google::Protobuf::UInt32Value) — Obsolete. Do not use.
This field has no semantic meaning. The service config compiler always sets this field to
3
.
#context
def context() -> ::Google::Api::Context
- (::Google::Api::Context) — Context configuration.
#context=
def context=(value) -> ::Google::Api::Context
- value (::Google::Api::Context) — Context configuration.
- (::Google::Api::Context) — Context configuration.
#control
def control() -> ::Google::Api::Control
- (::Google::Api::Control) — Configuration for the service control plane.
#control=
def control=(value) -> ::Google::Api::Control
- value (::Google::Api::Control) — Configuration for the service control plane.
- (::Google::Api::Control) — Configuration for the service control plane.
#documentation
def documentation() -> ::Google::Api::Documentation
- (::Google::Api::Documentation) — Additional API documentation.
#documentation=
def documentation=(value) -> ::Google::Api::Documentation
- value (::Google::Api::Documentation) — Additional API documentation.
- (::Google::Api::Documentation) — Additional API documentation.
#endpoints
def endpoints() -> ::Array<::Google::Api::Endpoint>
- (::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.
#endpoints=
def endpoints=(value) -> ::Array<::Google::Api::Endpoint>
- value (::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.
- (::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.
#enums
def enums() -> ::Array<::Google::Protobuf::Enum>
-
(::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
#enums=
def enums=(value) -> ::Array<::Google::Protobuf::Enum>
-
value (::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
-
(::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
#http
def http() -> ::Google::Api::Http
- (::Google::Api::Http) — HTTP configuration.
#http=
def http=(value) -> ::Google::Api::Http
- value (::Google::Api::Http) — HTTP configuration.
- (::Google::Api::Http) — HTTP configuration.
#id
def id() -> ::String
- (::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.
#id=
def id=(value) -> ::String
- value (::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.
- (::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.
#logging
def logging() -> ::Google::Api::Logging
- (::Google::Api::Logging) — Logging configuration.
#logging=
def logging=(value) -> ::Google::Api::Logging
- value (::Google::Api::Logging) — Logging configuration.
- (::Google::Api::Logging) — Logging configuration.
#logs
def logs() -> ::Array<::Google::Api::LogDescriptor>
- (::Array<::Google::Api::LogDescriptor>) — Defines the logs used by this service.
#logs=
def logs=(value) -> ::Array<::Google::Api::LogDescriptor>
- value (::Array<::Google::Api::LogDescriptor>) — Defines the logs used by this service.
- (::Array<::Google::Api::LogDescriptor>) — Defines the logs used by this service.
#metrics
def metrics() -> ::Array<::Google::Api::MetricDescriptor>
- (::Array<::Google::Api::MetricDescriptor>) — Defines the metrics used by this service.
#metrics=
def metrics=(value) -> ::Array<::Google::Api::MetricDescriptor>
- value (::Array<::Google::Api::MetricDescriptor>) — Defines the metrics used by this service.
- (::Array<::Google::Api::MetricDescriptor>) — Defines the metrics used by this service.
#monitored_resources
def monitored_resources() -> ::Array<::Google::Api::MonitoredResourceDescriptor>
- (::Array<::Google::Api::MonitoredResourceDescriptor>) — Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
#monitored_resources=
def monitored_resources=(value) -> ::Array<::Google::Api::MonitoredResourceDescriptor>
- value (::Array<::Google::Api::MonitoredResourceDescriptor>) — Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
- (::Array<::Google::Api::MonitoredResourceDescriptor>) — Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
#monitoring
def monitoring() -> ::Google::Api::Monitoring
- (::Google::Api::Monitoring) — Monitoring configuration.
#monitoring=
def monitoring=(value) -> ::Google::Api::Monitoring
- value (::Google::Api::Monitoring) — Monitoring configuration.
- (::Google::Api::Monitoring) — Monitoring configuration.
#name
def name() -> ::String
-
(::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.
#name=
def name=(value) -> ::String
-
value (::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.
-
(::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.
#producer_project_id
def producer_project_id() -> ::String
- (::String) — The Google project that owns this service.
#producer_project_id=
def producer_project_id=(value) -> ::String
- value (::String) — The Google project that owns this service.
- (::String) — The Google project that owns this service.
#publishing
def publishing() -> ::Google::Api::Publishing
- (::Google::Api::Publishing) — Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.
#publishing=
def publishing=(value) -> ::Google::Api::Publishing
- value (::Google::Api::Publishing) — Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.
- (::Google::Api::Publishing) — Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.
#quota
def quota() -> ::Google::Api::Quota
- (::Google::Api::Quota) — Quota configuration.
#quota=
def quota=(value) -> ::Google::Api::Quota
- value (::Google::Api::Quota) — Quota configuration.
- (::Google::Api::Quota) — Quota configuration.
#source_info
def source_info() -> ::Google::Api::SourceInfo
- (::Google::Api::SourceInfo) — Output only. The source information for this configuration if available.
#source_info=
def source_info=(value) -> ::Google::Api::SourceInfo
- value (::Google::Api::SourceInfo) — Output only. The source information for this configuration if available.
- (::Google::Api::SourceInfo) — Output only. The source information for this configuration if available.
#system_parameters
def system_parameters() -> ::Google::Api::SystemParameters
- (::Google::Api::SystemParameters) — System parameter configuration.
#system_parameters=
def system_parameters=(value) -> ::Google::Api::SystemParameters
- value (::Google::Api::SystemParameters) — System parameter configuration.
- (::Google::Api::SystemParameters) — System parameter configuration.
#title
def title() -> ::String
- (::String) — The product title for this service, it is the name displayed in Google Cloud Console.
#title=
def title=(value) -> ::String
- value (::String) — The product title for this service, it is the name displayed in Google Cloud Console.
- (::String) — The product title for this service, it is the name displayed in Google Cloud Console.
#types
def types() -> ::Array<::Google::Protobuf::Type>
-
(::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 thegoogle.protobuf.Any
type, should be listed here by name by the configuration author. Example:types: - name: google.protobuf.Int32
#types=
def types=(value) -> ::Array<::Google::Protobuf::Type>
-
value (::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 thegoogle.protobuf.Any
type, should be listed here by name by the configuration author. Example:types: - name: google.protobuf.Int32
-
(::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 thegoogle.protobuf.Any
type, should be listed here by name by the configuration author. Example:types: - name: google.protobuf.Int32
#usage
def usage() -> ::Google::Api::Usage
- (::Google::Api::Usage) — Configuration controlling usage of this service.
#usage=
def usage=(value) -> ::Google::Api::Usage
- value (::Google::Api::Usage) — Configuration controlling usage of this service.
- (::Google::Api::Usage) — Configuration controlling usage of this service.