Service Management V1 API - Class Google::Api::Service (v0.9.0)

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

#apis=

def apis=(value) -> ::Array<::Google::Protobuf::Api>
Parameter
  • 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.
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.

#authentication

def authentication() -> ::Google::Api::Authentication
Returns

#authentication=

def authentication=(value) -> ::Google::Api::Authentication
Parameter
Returns

#backend

def backend() -> ::Google::Api::Backend
Returns

#backend=

def backend=(value) -> ::Google::Api::Backend
Parameter
Returns

#billing

def billing() -> ::Google::Api::Billing
Returns

#billing=

def billing=(value) -> ::Google::Api::Billing
Parameter
Returns

#config_version

def config_version() -> ::Google::Protobuf::UInt32Value
Returns

#config_version=

def config_version=(value) -> ::Google::Protobuf::UInt32Value
Parameter
  • value (::Google::Protobuf::UInt32Value) — Obsolete. Do not use.

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

Returns

#context

def context() -> ::Google::Api::Context
Returns

#context=

def context=(value) -> ::Google::Api::Context
Parameter
Returns

#control

def control() -> ::Google::Api::Control
Returns

#control=

def control=(value) -> ::Google::Api::Control
Parameter
Returns

#documentation

def documentation() -> ::Google::Api::Documentation
Returns

#documentation=

def documentation=(value) -> ::Google::Api::Documentation
Parameter
Returns

#endpoints

def endpoints() -> ::Array<::Google::Api::Endpoint>
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.

#endpoints=

def endpoints=(value) -> ::Array<::Google::Api::Endpoint>
Parameter
  • 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.
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.

#enums

def enums() -> ::Array<::Google::Protobuf::Enum>
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

#enums=

def enums=(value) -> ::Array<::Google::Protobuf::Enum>
Parameter
  • 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
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

#http

def http() -> ::Google::Api::Http
Returns
  • (::Google::Api::Http) — HTTP configuration.

#http=

def http=(value) -> ::Google::Api::Http
Parameter
  • value (::Google::Api::Http) — HTTP configuration.
Returns
  • (::Google::Api::Http) — HTTP configuration.

#id

def id() -> ::String
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.

#id=

def id=(value) -> ::String
Parameter
  • 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.
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.

#logging

def logging() -> ::Google::Api::Logging
Returns

#logging=

def logging=(value) -> ::Google::Api::Logging
Parameter
Returns

#logs

def logs() -> ::Array<::Google::Api::LogDescriptor>
Returns

#logs=

def logs=(value) -> ::Array<::Google::Api::LogDescriptor>
Parameter
Returns

#metrics

def metrics() -> ::Array<::Google::Api::MetricDescriptor>
Returns

#metrics=

def metrics=(value) -> ::Array<::Google::Api::MetricDescriptor>
Parameter
Returns

#monitored_resources

def monitored_resources() -> ::Array<::Google::Api::MonitoredResourceDescriptor>
Returns

#monitored_resources=

def monitored_resources=(value) -> ::Array<::Google::Api::MonitoredResourceDescriptor>
Parameter
Returns

#monitoring

def monitoring() -> ::Google::Api::Monitoring
Returns

#monitoring=

def monitoring=(value) -> ::Google::Api::Monitoring
Parameter
Returns

#name

def name() -> ::String
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.

#name=

def name=(value) -> ::String
Parameter
  • 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.
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.

#producer_project_id

def producer_project_id() -> ::String
Returns
  • (::String) — The Google project that owns this service.

#producer_project_id=

def producer_project_id=(value) -> ::String
Parameter
  • value (::String) — The Google project that owns this service.
Returns
  • (::String) — The Google project that owns this service.

#publishing

def publishing() -> ::Google::Api::Publishing
Returns

#publishing=

def publishing=(value) -> ::Google::Api::Publishing
Parameter
Returns

#quota

def quota() -> ::Google::Api::Quota
Returns

#quota=

def quota=(value) -> ::Google::Api::Quota
Parameter
Returns

#source_info

def source_info() -> ::Google::Api::SourceInfo
Returns

#source_info=

def source_info=(value) -> ::Google::Api::SourceInfo
Parameter
Returns

#system_parameters

def system_parameters() -> ::Google::Api::SystemParameters
Returns

#system_parameters=

def system_parameters=(value) -> ::Google::Api::SystemParameters
Parameter
Returns

#title

def title() -> ::String
Returns
  • (::String) — The product title for this service, it is the name displayed in Google Cloud Console.

#title=

def title=(value) -> ::String
Parameter
  • value (::String) — 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.

#types

def types() -> ::Array<::Google::Protobuf::Type>
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

#types=

def types=(value) -> ::Array<::Google::Protobuf::Type>
Parameter
  • 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 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

#usage

def usage() -> ::Google::Api::Usage
Returns

#usage=

def usage=(value) -> ::Google::Api::Usage
Parameter
Returns