Class: Google::Apis::ServicemanagementV1::Service
- Inherits:
-
Object
- Object
- Google::Apis::ServicemanagementV1::Service
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/servicemanagement_v1/classes.rb,
generated/google/apis/servicemanagement_v1/representations.rb,
generated/google/apis/servicemanagement_v1/representations.rb
Overview
Service
is the root object of Google service configuration schema. It
describes basic information about a service, such as the name and the
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. See each proto message definition for details.
Example:
type: google.api.Service
config_version: 3
name: calendar.googleapis.com
title: Google Calendar API
apis:
- name: google.calendar.v3.Calendar 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
-
#apis ⇒ Array<Google::Apis::ServicemanagementV1::Api>
A list of API interfaces exported by this service.
-
#authentication ⇒ Google::Apis::ServicemanagementV1::Authentication
Authentication
defines the authentication configuration for an API. -
#backend ⇒ Google::Apis::ServicemanagementV1::Backend
Backend
defines the backend configuration for a service. -
#billing ⇒ Google::Apis::ServicemanagementV1::Billing
Billing related configuration of the service.
-
#config_version ⇒ Fixnum
The semantic version of the service configuration.
-
#context ⇒ Google::Apis::ServicemanagementV1::Context
Context
defines which contexts an API requests. -
#control ⇒ Google::Apis::ServicemanagementV1::Control
Selects and configures the service controller used by the service.
-
#custom_error ⇒ Google::Apis::ServicemanagementV1::CustomError
Customize service error responses.
-
#documentation ⇒ Google::Apis::ServicemanagementV1::Documentation
Documentation
provides the information for describing a service. -
#endpoints ⇒ Array<Google::Apis::ServicemanagementV1::Endpoint>
Configuration for network endpoints.
-
#enums ⇒ Array<Google::Apis::ServicemanagementV1::Enum>
A list of all enum types included in this API service.
-
#http ⇒ Google::Apis::ServicemanagementV1::Http
Defines the HTTP configuration for an API service.
-
#id ⇒ String
A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose.
-
#logging ⇒ Google::Apis::ServicemanagementV1::Logging
Logging configuration of the service.
-
#logs ⇒ Array<Google::Apis::ServicemanagementV1::LogDescriptor>
Defines the logs used by this service.
-
#metrics ⇒ Array<Google::Apis::ServicemanagementV1::MetricDescriptor>
Defines the metrics used by this service.
-
#monitored_resources ⇒ Array<Google::Apis::ServicemanagementV1::MonitoredResourceDescriptor>
Defines the monitored resources used by this service.
-
#monitoring ⇒ Google::Apis::ServicemanagementV1::Monitoring
Monitoring configuration of the service.
-
#name ⇒ String
The service name, which is a DNS-like logical identifier for the service, such as
calendar.googleapis.com
. -
#producer_project_id ⇒ String
The Google project that owns this service.
-
#quota ⇒ Google::Apis::ServicemanagementV1::Quota
Quota configuration helps to achieve fairness and budgeting in service usage.
-
#source_info ⇒ Google::Apis::ServicemanagementV1::SourceInfo
Source information used to create a Service Config Corresponds to the JSON property
sourceInfo
. -
#system_parameters ⇒ Google::Apis::ServicemanagementV1::SystemParameters
System parameter configuration A system parameter is a special kind of parameter defined by the API system, not by an individual API.
-
#system_types ⇒ Array<Google::Apis::ServicemanagementV1::Type>
A list of all proto message types included in this API service.
-
#title ⇒ String
The product title for this service.
-
#types ⇒ Array<Google::Apis::ServicemanagementV1::Type>
A list of all proto message types included in this API service.
-
#usage ⇒ Google::Apis::ServicemanagementV1::Usage
Configuration controlling usage of a service.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Service
constructor
A new instance of Service.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Service
Returns a new instance of Service.
4015 4016 4017 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 4015 def initialize(**args) update!(**args) end |
Instance Attribute Details
#apis ⇒ Array<Google::Apis::ServicemanagementV1::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.
Corresponds to the JSON property apis
3637 3638 3639 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3637 def apis @apis end |
#authentication ⇒ Google::Apis::ServicemanagementV1::Authentication
Authentication
defines the authentication configuration for an API.
Example for an API targeted for external use:
name: calendar.googleapis.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
Corresponds to the JSON property
authentication
3653 3654 3655 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3653 def authentication @authentication end |
#backend ⇒ Google::Apis::ServicemanagementV1::Backend
Backend
defines the backend configuration for a service.
Corresponds to the JSON property backend
3658 3659 3660 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3658 def backend @backend end |
#billing ⇒ Google::Apis::ServicemanagementV1::Billing
Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing: monitored_resources:
- type: library.googleapis.com/branch labels:
- key: /city description: The city where the library branch is located in.
- key: /name description: The name of the branch. metrics:
- name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 billing: consumer_destinations:
- monitored_resource: library.googleapis.com/branch metrics:
- library.googleapis.com/book/borrowed_count
Corresponds to the JSON property
billing
3681 3682 3683 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3681 def billing @billing end |
#config_version ⇒ Fixnum
The semantic version of the service configuration. The config version
affects the interpretation of the service configuration. For example,
certain features are enabled by default for certain config versions.
The latest config version is 3
.
Corresponds to the JSON property configVersion
3689 3690 3691 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3689 def config_version @config_version end |
#context ⇒ Google::Apis::ServicemanagementV1::Context
Context
defines which contexts an API requests.
Example:
context:
rules:
- selector: "*" requested:
- google.rpc.context.ProjectContext
- google.rpc.context.OriginContext
The above specifies that all methods in the API request
google.rpc.context.ProjectContext
andgoogle.rpc.context.OriginContext
. Available context types are defined in packagegoogle.rpc.context
. This also provides mechanism to whitelist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext- -jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions:
- google.foo.v1.NewExtension allowed_response_extensions:
- google.foo.v1.NewExtension
You can also specify extension ID instead of fully qualified extension name
here.
Corresponds to the JSON property
context
3721 3722 3723 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3721 def context @context end |
#control ⇒ Google::Apis::ServicemanagementV1::Control
Selects and configures the service controller used by the service. The
service controller handles features like abuse, quota, billing, logging,
monitoring, etc.
Corresponds to the JSON property control
3728 3729 3730 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3728 def control @control end |
#custom_error ⇒ Google::Apis::ServicemanagementV1::CustomError
Customize service error responses. For example, list any service specific protobuf types that can appear in error detail lists of error responses. Example: custom_error: types:
- google.foo.v1.CustomError
- google.foo.v1.AnotherError
Corresponds to the JSON property
customError
3740 3741 3742 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3740 def custom_error @custom_error end |
#documentation ⇒ Google::Apis::ServicemanagementV1::Documentation
Documentation
provides the information for describing a service.
Example:
documentation:
summary: >
The Google Calendar API gives access
to most calendar features.
pages:
- name: Overview
content: (== include google/foo/overview.md ==)
- name: Tutorial
content: (== include google/foo/tutorial.md ==)
subpages;
- name: Java
content: (== include google/foo/tutorial_java.md ==)
rules:
- selector: google.calendar.Calendar.Get
description: >
...
- selector: google.calendar.Calendar.Put
description: >
...
Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used:
[fully.qualified.proto.name][]
To override the display text used for the link, this can be used:
[display text][fully.qualified.proto.name]
Text can be excluded from doc using the following notation:
(-- internal comment --)
A few directives are available in documentation. Note that
directives must appear on a single line to be properly
identified. The include
directive includes a markdown file from
an external source:
(== include path/to/file ==)
The resource_for
directive marks a message to be the resource of
a collection in REST view. If it is not specified, tools attempt
to infer the resource from the operations in a collection:
(== resource_for v1.shelves.books ==)
The directive suppress_warning
does not directly affect documentation
and is documented together with service config validation.
Corresponds to the JSON property documentation
3794 3795 3796 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3794 def documentation @documentation end |
#endpoints ⇒ Array<Google::Apis::ServicemanagementV1::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.
Corresponds to the JSON property endpoints
3801 3802 3803 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3801 def endpoints @endpoints end |
#enums ⇒ Array<Google::Apis::ServicemanagementV1::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. Example:
enums:
- name: google.someapi.v1.SomeEnum
Corresponds to the JSON property
enums
3811 3812 3813 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3811 def enums @enums end |
#http ⇒ Google::Apis::ServicemanagementV1::Http
Defines the HTTP configuration for an API service. It contains a list of
HttpRule, each specifying the mapping of an RPC method
to one or more HTTP REST API methods.
Corresponds to the JSON property http
3818 3819 3820 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3818 def http @http end |
#id ⇒ 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.
Corresponds to the JSON property id
3826 3827 3828 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3826 def id @id end |
#logging ⇒ Google::Apis::ServicemanagementV1::Logging
Logging configuration of the service.
The following example shows how to configure logs to be sent to the
producer and consumer projects. In the example, the activity_history
log is sent to both the producer and consumer projects, whereas the
purchase_history
log is only sent to the producer project.
monitored_resources:
- type: library.googleapis.com/branch labels:
- key: /city description: The city where the library branch is located in.
- key: /name description: The name of the branch. logs:
- name: activity_history labels:
- key: /customer_id
- name: purchase_history logging: producer_destinations:
- monitored_resource: library.googleapis.com/branch logs:
- activity_history
- purchase_history consumer_destinations:
- monitored_resource: library.googleapis.com/branch logs:
- activity_history
Corresponds to the JSON property
logging
3857 3858 3859 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3857 def logging @logging end |
#logs ⇒ Array<Google::Apis::ServicemanagementV1::LogDescriptor>
Defines the logs used by this service.
Corresponds to the JSON property logs
3862 3863 3864 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3862 def logs @logs end |
#metrics ⇒ Array<Google::Apis::ServicemanagementV1::MetricDescriptor>
Defines the metrics used by this service.
Corresponds to the JSON property metrics
3867 3868 3869 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3867 def metrics @metrics end |
#monitored_resources ⇒ Array<Google::Apis::ServicemanagementV1::MonitoredResourceDescriptor>
Defines the monitored resources used by this service. This is required
by the Service.monitoring and Service.logging configurations.
Corresponds to the JSON property monitoredResources
3873 3874 3875 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3873 def monitored_resources @monitored_resources end |
#monitoring ⇒ Google::Apis::ServicemanagementV1::Monitoring
Monitoring configuration of the service.
The example below shows how to configure monitored resources and metrics
for monitoring. In the example, a monitored resource and two metrics are
defined. The library.googleapis.com/book/returned_count
metric is sent
to both producer and consumer projects, whereas the
library.googleapis.com/book/overdue_count
metric is only sent to the
consumer project.
monitored_resources:
- type: library.googleapis.com/branch labels:
- key: /city description: The city where the library branch is located in.
- key: /name description: The name of the branch. metrics:
- name: library.googleapis.com/book/returned_count metric_kind: DELTA value_type: INT64 labels:
- key: /customer_id
- name: library.googleapis.com/book/overdue_count metric_kind: GAUGE value_type: INT64 labels:
- key: /customer_id monitoring: producer_destinations:
- monitored_resource: library.googleapis.com/branch metrics:
- library.googleapis.com/book/returned_count consumer_destinations:
- monitored_resource: library.googleapis.com/branch metrics:
- library.googleapis.com/book/returned_count
- library.googleapis.com/book/overdue_count
Corresponds to the JSON property
monitoring
3912 3913 3914 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3912 def monitoring @monitoring end |
#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.
Corresponds to the JSON property name
3920 3921 3922 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3920 def name @name end |
#producer_project_id ⇒ String
The Google project that owns this service.
Corresponds to the JSON property producerProjectId
3925 3926 3927 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3925 def producer_project_id @producer_project_id end |
#quota ⇒ Google::Apis::ServicemanagementV1::Quota
Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way:
- The service configuration defines a set of metrics.
- For API calls, the quota.metric_rules maps methods to metrics with corresponding costs.
- The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits:
- name: apiWriteQpsPerProject
metric: library.googleapis.com/write_calls
unit: "1/min/
project
" # rate limit for consumer projects values: STANDARD: 10000 # The metric rules bind all methods to the read_calls metric, # except for the UpdateBook and DeleteBook methods. These two methods # are mapped to the write_calls metric, with the UpdateBook method # consuming at twice rate as the DeleteBook method. metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1
- selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2
- selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics:
- name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64
- name: library.googleapis.com/write_calls
display_name: Write requests
metric_kind: DELTA
value_type: INT64
Corresponds to the JSON property
quota
3969 3970 3971 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3969 def quota @quota end |
#source_info ⇒ Google::Apis::ServicemanagementV1::SourceInfo
Source information used to create a Service Config
Corresponds to the JSON property sourceInfo
3974 3975 3976 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3974 def source_info @source_info end |
#system_parameters ⇒ Google::Apis::ServicemanagementV1::SystemParameters
System parameter configuration
A system parameter is a special kind of parameter defined by the API
system, not by an individual API. It is typically mapped to an HTTP header
and/or a URL query parameter. This configuration specifies which methods
change the names of the system parameters.
Corresponds to the JSON property systemParameters
3983 3984 3985 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3983 def system_parameters @system_parameters end |
#system_types ⇒ Array<Google::Apis::ServicemanagementV1::Type>
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.
Corresponds to the JSON property systemTypes
3992 3993 3994 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3992 def system_types @system_types end |
#title ⇒ String
The product title for this service.
Corresponds to the JSON property title
3997 3998 3999 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3997 def title @title end |
#types ⇒ Array<Google::Apis::ServicemanagementV1::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. Example:
types:
- name: google.protobuf.Int32
Corresponds to the JSON property
types
4008 4009 4010 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 4008 def types @types end |
#usage ⇒ Google::Apis::ServicemanagementV1::Usage
Configuration controlling usage of a service.
Corresponds to the JSON property usage
4013 4014 4015 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 4013 def usage @usage end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 |
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 4020 def update!(**args) @apis = args[:apis] if args.key?(:apis) @authentication = args[:authentication] if args.key?(:authentication) @backend = args[:backend] if args.key?(:backend) @billing = args[:billing] if args.key?(:billing) @config_version = args[:config_version] if args.key?(:config_version) @context = args[:context] if args.key?(:context) @control = args[:control] if args.key?(:control) @custom_error = args[:custom_error] if args.key?(:custom_error) @documentation = args[:documentation] if args.key?(:documentation) @endpoints = args[:endpoints] if args.key?(:endpoints) @enums = args[:enums] if args.key?(:enums) @http = args[:http] if args.key?(:http) @id = args[:id] if args.key?(:id) @logging = args[:logging] if args.key?(:logging) @logs = args[:logs] if args.key?(:logs) @metrics = args[:metrics] if args.key?(:metrics) @monitored_resources = args[:monitored_resources] if args.key?(:monitored_resources) @monitoring = args[:monitoring] if args.key?(:monitoring) @name = args[:name] if args.key?(:name) @producer_project_id = args[:producer_project_id] if args.key?(:producer_project_id) @quota = args[:quota] if args.key?(:quota) @source_info = args[:source_info] if args.key?(:source_info) @system_parameters = args[:system_parameters] if args.key?(:system_parameters) @system_types = args[:system_types] if args.key?(:system_types) @title = args[:title] if args.key?(:title) @types = args[:types] if args.key?(:types) @usage = args[:usage] if args.key?(:usage) end |