Class: Google::Apis::ServiceusageV1beta1::ServiceConfig
- Inherits:
-
Object
- Object
- Google::Apis::ServiceusageV1beta1::ServiceConfig
- 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
The configuration of the service.
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. -
#documentation ⇒ Google::Apis::ServiceusageV1beta1::Documentation
Documentation
provides the information for describing a service. -
#endpoints ⇒ Array<Google::Apis::ServiceusageV1beta1::Endpoint>
Configuration for network endpoints.
-
#name ⇒ String
The DNS address at which this service is available.
-
#quota ⇒ Google::Apis::ServiceusageV1beta1::Quota
Quota configuration helps to achieve fairness and budgeting in service usage.
-
#title ⇒ String
The product title for this service.
-
#usage ⇒ Google::Apis::ServiceusageV1beta1::Usage
Configuration controlling usage of a service.
Instance Method Summary collapse
-
#initialize(**args) ⇒ ServiceConfig
constructor
A new instance of ServiceConfig.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ ServiceConfig
Returns a new instance of ServiceConfig
3617 3618 3619 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 3617 def initialize(**args) update!(**args) end |
Instance Attribute Details
#apis ⇒ Array<Google::Apis::ServiceusageV1beta1::Api>
A list of API interfaces exported by this service. Contains only the names,
versions, and method names of the interfaces.
Corresponds to the JSON property apis
3478 3479 3480 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 3478 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
3494 3495 3496 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 3494 def authentication @authentication 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
3548 3549 3550 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 3548 def documentation @documentation end |
#endpoints ⇒ Array<Google::Apis::ServiceusageV1beta1::Endpoint>
Configuration for network endpoints. Contains only the names and aliases
of the endpoints.
Corresponds to the JSON property endpoints
3554 3555 3556 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 3554 def endpoints @endpoints end |
#name ⇒ String
The DNS address at which this service is available.
An example DNS address would be:
calendar.googleapis.com
.
Corresponds to the JSON property name
3561 3562 3563 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 3561 def name @name end |
#quota ⇒ Google::Apis::ServiceusageV1beta1::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
3605 3606 3607 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 3605 def quota @quota end |
#title ⇒ String
The product title for this service.
Corresponds to the JSON property title
3610 3611 3612 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 3610 def title @title end |
#usage ⇒ Google::Apis::ServiceusageV1beta1::Usage
Configuration controlling usage of a service.
Corresponds to the JSON property usage
3615 3616 3617 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 3615 def usage @usage end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 3622 def update!(**args) @apis = args[:apis] if args.key?(:apis) @authentication = args[:authentication] if args.key?(:authentication) @documentation = args[:documentation] if args.key?(:documentation) @endpoints = args[:endpoints] if args.key?(:endpoints) @name = args[:name] if args.key?(:name) @quota = args[:quota] if args.key?(:quota) @title = args[:title] if args.key?(:title) @usage = args[:usage] if args.key?(:usage) end |