Class: Google::Apis::ServicemanagementV1::Service

Inherits:
Object
  • Object
show all
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:

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Service

Returns a new instance of Service



3189
3190
3191
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3189

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

Returns:



2826
2827
2828
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2826

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:

Returns:



3017
3018
3019
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3017

def authentication
  @authentication
end

#backend ⇒ Google::Apis::ServicemanagementV1::Backend

Backend defines the backend configuration for a service. Corresponds to the JSON property backend

Returns:



2863
2864
2865
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2863

def backend
  @backend
end

#config_version ⇒ Fixnum

The version of the service configuration. The config version may influence interpretation of the configuration, for example, to determine defaults. This is documented together with applicable options. The current default for the config version itself is 3. Corresponds to the JSON property configVersion

Returns:

  • (Fixnum) 


3038
3039
3040
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3038

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 and google.rpc.context.OriginContext. Available context types are defined in package google.rpc.context. Corresponds to the JSON property context

Returns:



2984
2985
2986
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2984

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

Returns:



3030
3031
3032
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3030

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

Returns:



3175
3176
3177
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3175

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

Comments can be made conditional using a visibility label. The below text will be only rendered if the BETA label is available:

(--BETA: comment for BETA users --)

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

Returns:



2920
2921
2922
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2920

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

Returns:



3187
3188
3189
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3187

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

Returns:



2967
2968
2969
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2967

def enums
  @enums
end

#experimental ⇒ Google::Apis::ServicemanagementV1::Experimental

Experimental service configuration. These configuration options can only be used by whitelisted users. Corresponds to the JSON property experimental

Returns:



3023
3024
3025
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3023

def experimental
  @experimental
end

#http ⇒ Google::Apis::ServicemanagementV1::Http

Defines the HTTP configuration for a 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

Returns:



2849
2850
2851
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2849

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. Corresponds to the JSON property id

Returns:

  • (String) 


2991
2992
2993
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2991

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

Returns:



2951
2952
2953
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2951

def logging
  @logging
end

#logs ⇒ Array<Google::Apis::ServicemanagementV1::LogDescriptor>

Defines the logs used by this service. Corresponds to the JSON property logs

Returns:



2817
2818
2819
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2817

def logs
  @logs
end

#metrics ⇒ Array<Google::Apis::ServicemanagementV1::MetricDescriptor>

Defines the metrics used by this service. Corresponds to the JSON property metrics

Returns:



3001
3002
3003
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3001

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

Returns:



2957
2958
2959
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2957

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

Returns:



3077
3078
3079
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3077

def monitoring
  @monitoring
end

#name ⇒ String

The DNS address at which this service is available, e.g. calendar.googleapis.com. Corresponds to the JSON property name

Returns:

  • (String) 


3163
3164
3165
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3163

def name
  @name
end

#producer_project_id ⇒ String

The id of the Google developer project that owns the service. Members of this project can manage the service configuration, manage consumption of the service, etc. Corresponds to the JSON property producerProjectId

Returns:

  • (String) 


3084
3085
3086
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3084

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 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:
  • 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

Returns:



3157
3158
3159
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3157

def quota
  @quota
end

#source_info ⇒ Google::Apis::ServicemanagementV1::SourceInfo

Source information used to create a Service Config Corresponds to the JSON property sourceInfo

Returns:



2842
2843
2844
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2842

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

Returns:



2858
2859
2860
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2858

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

Returns:



3093
3094
3095
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3093

def system_types
  @system_types
end

#title ⇒ String

The product title associated with this service. Corresponds to the JSON property title

Returns:

  • (String) 


3180
3181
3182
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3180

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

Returns:



2837
2838
2839
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2837

def types
  @types
end

#usage ⇒ Google::Apis::ServicemanagementV1::Usage

Configuration controlling usage of a service. Corresponds to the JSON property usage

Returns:



2996
2997
2998
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2996

def usage
  @usage
end

#visibility ⇒ Google::Apis::ServicemanagementV1::Visibility

Visibility defines restrictions for the visibility of service elements. Restrictions are specified using visibility labels (e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects. Users and projects can have access to more than one visibility label. The effective visibility for multiple labels is the union of each label's elements, plus any unrestricted elements. If an element and its parents have no restrictions, visibility is unconditionally granted. Example: visibility: rules:

  • selector: google.calendar.Calendar.EnhancedSearch restriction: TRUSTED_TESTER
  • selector: google.calendar.Calendar.Delegate restriction: GOOGLE_INTERNAL Here, all methods are publicly visible except for the restricted methods EnhancedSearch and Delegate. Corresponds to the JSON property visibility

Returns:



3114
3115
3116
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3114

def visibility
  @visibility
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 3194

def update!(**args)
  @logs = args[:logs] if args.key?(:logs)
  @apis = args[:apis] if args.key?(:apis)
  @types = args[:types] if args.key?(:types)
  @source_info = args[:source_info] if args.key?(:source_info)
  @http = args[:http] if args.key?(:http)
  @system_parameters = args[:system_parameters] if args.key?(:system_parameters)
  @backend = args[:backend] if args.key?(:backend)
  @documentation = args[:documentation] if args.key?(:documentation)
  @logging = args[:logging] if args.key?(:logging)
  @monitored_resources = args[:monitored_resources] if args.key?(:monitored_resources)
  @enums = args[:enums] if args.key?(:enums)
  @context = args[:context] if args.key?(:context)
  @id = args[:id] if args.key?(:id)
  @usage = args[:usage] if args.key?(:usage)
  @metrics = args[:metrics] if args.key?(:metrics)
  @authentication = args[:authentication] if args.key?(:authentication)
  @experimental = args[:experimental] if args.key?(:experimental)
  @control = args[:control] if args.key?(:control)
  @config_version = args[:config_version] if args.key?(:config_version)
  @monitoring = args[:monitoring] if args.key?(:monitoring)
  @producer_project_id = args[:producer_project_id] if args.key?(:producer_project_id)
  @system_types = args[:system_types] if args.key?(:system_types)
  @visibility = args[:visibility] if args.key?(:visibility)
  @quota = args[:quota] if args.key?(:quota)
  @name = args[:name] if args.key?(:name)
  @custom_error = args[:custom_error] if args.key?(:custom_error)
  @title = args[:title] if args.key?(:title)
  @endpoints = args[:endpoints] if args.key?(:endpoints)
end