Class: Google::Apis::ServiceusageV1beta1::GoogleApiService
- Inherits:
-
Object
- Object
- Google::Apis::ServiceusageV1beta1::GoogleApiService
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/serviceusage_v1beta1/classes.rb,
generated/google/apis/serviceusage_v1beta1/representations.rb,
generated/google/apis/serviceusage_v1beta1/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::ServiceusageV1beta1::Api>
A list of API interfaces exported by this service.
-
#authentication ⇒ Google::Apis::ServiceusageV1beta1::Authentication
Authentication
defines the authentication configuration for an API. -
#backend ⇒ Google::Apis::ServiceusageV1beta1::Backend
Backend
defines the backend configuration for a service. -
#billing ⇒ Google::Apis::ServiceusageV1beta1::Billing
Billing related configuration of the service.
-
#config_version ⇒ Fixnum
The semantic version of the service configuration.
-
#context ⇒ Google::Apis::ServiceusageV1beta1::Context
Context
defines which contexts an API requests. -
#control ⇒ Google::Apis::ServiceusageV1beta1::Control
Selects and configures the service controller used by the service.
-
#custom_error ⇒ Google::Apis::ServiceusageV1beta1::CustomError
Customize service error responses.
-
#documentation ⇒ Google::Apis::ServiceusageV1beta1::Documentation
Documentation
provides the information for describing a service. -
#endpoints ⇒ Array<Google::Apis::ServiceusageV1beta1::Endpoint>
Configuration for network endpoints.
-
#enums ⇒ Array<Google::Apis::ServiceusageV1beta1::Enum>
A list of all enum types included in this API service.
-
#experimental ⇒ Google::Apis::ServiceusageV1beta1::Experimental
Experimental service configuration.
-
#http ⇒ Google::Apis::ServiceusageV1beta1::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::ServiceusageV1beta1::Logging
Logging configuration of the service.
-
#logs ⇒ Array<Google::Apis::ServiceusageV1beta1::LogDescriptor>
Defines the logs used by this service.
-
#metrics ⇒ Array<Google::Apis::ServiceusageV1beta1::MetricDescriptor>
Defines the metrics used by this service.
-
#monitored_resources ⇒ Array<Google::Apis::ServiceusageV1beta1::MonitoredResourceDescriptor>
Defines the monitored resources used by this service.
-
#monitoring ⇒ Google::Apis::ServiceusageV1beta1::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::ServiceusageV1beta1::Quota
Quota configuration helps to achieve fairness and budgeting in service usage.
-
#source_info ⇒ Google::Apis::ServiceusageV1beta1::SourceInfo
Source information used to create a Service Config Corresponds to the JSON property
sourceInfo
. -
#system_parameters ⇒ Google::Apis::ServiceusageV1beta1::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::ServiceusageV1beta1::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::ServiceusageV1beta1::Type>
A list of all proto message types included in this API service.
-
#usage ⇒ Google::Apis::ServiceusageV1beta1::Usage
Configuration controlling usage of a service.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleApiService
constructor
A new instance of GoogleApiService.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ GoogleApiService
Returns a new instance of GoogleApiService
1663 1664 1665 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 1663 def initialize(**args) update!(**args) end |
Instance Attribute Details
#apis ⇒ Array<Google::Apis::ServiceusageV1beta1::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
1280 1281 1282 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 1280 def apis @apis end |
#authentication ⇒ Google::Apis::ServiceusageV1beta1::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
1296 1297 1298 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 1296 def authentication @authentication end |
#backend ⇒ Google::Apis::ServiceusageV1beta1::Backend
Backend
defines the backend configuration for a service.
Corresponds to the JSON property backend
1301 1302 1303 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 1301 def backend @backend end |
#billing ⇒ Google::Apis::ServiceusageV1beta1::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
1324 1325 1326 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 1324 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
1332 1333 1334 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 1332 def config_version @config_version end |
#context ⇒ Google::Apis::ServiceusageV1beta1::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
1364 1365 1366 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 1364 def context @context end |
#control ⇒ Google::Apis::ServiceusageV1beta1::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
1371 1372 1373 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 1371 def control @control end |
#custom_error ⇒ Google::Apis::ServiceusageV1beta1::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
1383 1384 1385 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 1383 def custom_error @custom_error end |
#documentation ⇒ Google::Apis::ServiceusageV1beta1::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
1437 1438 1439 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 1437 def documentation @documentation end |
#endpoints ⇒ Array<Google::Apis::ServiceusageV1beta1::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
1444 1445 1446 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 1444 def endpoints @endpoints end |
#enums ⇒ Array<Google::Apis::ServiceusageV1beta1::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
1454 1455 1456 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 1454 def enums @enums end |
#experimental ⇒ Google::Apis::ServiceusageV1beta1::Experimental
Experimental service configuration. These configuration options can
only be used by whitelisted users.
Corresponds to the JSON property experimental
1460 1461 1462 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 1460 def experimental @experimental end |
#http ⇒ Google::Apis::ServiceusageV1beta1::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
1467 1468 1469 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 1467 def http @http end |
#id ⇒ String
A unique ID for a specific instance of this message, typically assigned
by the client for tracking purpose. If empty, the server may choose to
generate one instead. Must be no longer than 60 characters.
Corresponds to the JSON property id
1474 1475 1476 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 1474 def id @id end |
#logging ⇒ Google::Apis::ServiceusageV1beta1::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
1505 1506 1507 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 1505 def logging @logging end |
#logs ⇒ Array<Google::Apis::ServiceusageV1beta1::LogDescriptor>
Defines the logs used by this service.
Corresponds to the JSON property logs
1510 1511 1512 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 1510 def logs @logs end |
#metrics ⇒ Array<Google::Apis::ServiceusageV1beta1::MetricDescriptor>
Defines the metrics used by this service.
Corresponds to the JSON property metrics
1515 1516 1517 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 1515 def metrics @metrics end |
#monitored_resources ⇒ Array<Google::Apis::ServiceusageV1beta1::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
1521 1522 1523 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 1521 def monitored_resources @monitored_resources end |
#monitoring ⇒ Google::Apis::ServiceusageV1beta1::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
1560 1561 1562 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 1560 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
1568 1569 1570 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 1568 def name @name end |
#producer_project_id ⇒ String
The Google project that owns this service.
Corresponds to the JSON property producerProjectId
1573 1574 1575 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 1573 def producer_project_id @producer_project_id end |
#quota ⇒ Google::Apis::ServiceusageV1beta1::Quota
Quota configuration helps to achieve fairness and budgeting in service usage. The 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
1617 1618 1619 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 1617 def quota @quota end |
#source_info ⇒ Google::Apis::ServiceusageV1beta1::SourceInfo
Source information used to create a Service Config
Corresponds to the JSON property sourceInfo
1622 1623 1624 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 1622 def source_info @source_info end |
#system_parameters ⇒ Google::Apis::ServiceusageV1beta1::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
1631 1632 1633 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 1631 def system_parameters @system_parameters end |
#system_types ⇒ Array<Google::Apis::ServiceusageV1beta1::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
1640 1641 1642 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 1640 def system_types @system_types end |
#title ⇒ String
The product title for this service.
Corresponds to the JSON property title
1645 1646 1647 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 1645 def title @title end |
#types ⇒ Array<Google::Apis::ServiceusageV1beta1::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
1656 1657 1658 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 1656 def types @types end |
#usage ⇒ Google::Apis::ServiceusageV1beta1::Usage
Configuration controlling usage of a service.
Corresponds to the JSON property usage
1661 1662 1663 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 1661 def usage @usage end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 1668 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) @experimental = args[:experimental] if args.key?(:experimental) @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 |