Class: Google::Apis::ServiceuserV1::Service

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/serviceuser_v1/classes.rb,
generated/google/apis/serviceuser_v1/representations.rb,
generated/google/apis/serviceuser_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



1185
1186
1187
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1185

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#apis ⇒ Array<Google::Apis::ServiceuserV1::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:



1047
1048
1049
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1047

def apis
  @apis
end

#authentication ⇒ Google::Apis::ServiceuserV1::Authentication

Authentication defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: providers:

Returns:



870
871
872
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 870

def authentication
  @authentication
end

#backend ⇒ Google::Apis::ServiceuserV1::Backend

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

Returns:



1080
1081
1082
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1080

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) 


891
892
893
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 891

def config_version
  @config_version
end

#context ⇒ Google::Apis::ServiceuserV1::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:



837
838
839
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 837

def context
  @context
end

#control ⇒ Google::Apis::ServiceuserV1::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:



883
884
885
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 883

def control
  @control
end

#custom_error ⇒ Google::Apis::ServiceuserV1::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:



1026
1027
1028
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1026

def custom_error
  @custom_error
end

#documentation ⇒ Google::Apis::ServiceuserV1::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:



1146
1147
1148
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1146

def documentation
  @documentation
end

#endpoints ⇒ Array<Google::Apis::ServiceuserV1::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:



1038
1039
1040
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1038

def endpoints
  @endpoints
end

#enums ⇒ Array<Google::Apis::ServiceuserV1::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:



820
821
822
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 820

def enums
  @enums
end

#experimental ⇒ Google::Apis::ServiceuserV1::Experimental

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

Returns:



876
877
878
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 876

def experimental
  @experimental
end

#http ⇒ Google::Apis::ServiceuserV1::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

Returns:



1075
1076
1077
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1075

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) 


844
845
846
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 844

def id
  @id
end

#logging ⇒ Google::Apis::ServiceuserV1::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:



1183
1184
1185
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1183

def logging
  @logging
end

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

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

Returns:



1052
1053
1054
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1052

def logs
  @logs
end

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

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

Returns:



854
855
856
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 854

def metrics
  @metrics
end

#monitored_resources ⇒ Array<Google::Apis::ServiceuserV1::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:



1152
1153
1154
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1152

def monitored_resources
  @monitored_resources
end

#monitoring ⇒ Google::Apis::ServiceuserV1::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:



930
931
932
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 930

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) 


1014
1015
1016
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1014

def name
  @name
end

#producer_project_id ⇒ String

The Google project that owns this service. Corresponds to the JSON property producerProjectId

Returns:

  • (String) 


935
936
937
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 935

def producer_project_id
  @producer_project_id
end

#quota ⇒ Google::Apis::ServiceuserV1::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:



1008
1009
1010
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1008

def quota
  @quota
end

#source_info ⇒ Google::Apis::ServiceuserV1::SourceInfo

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

Returns:



1068
1069
1070
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1068

def source_info
  @source_info
end

#system_parameters ⇒ Google::Apis::ServiceuserV1::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:



1089
1090
1091
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1089

def system_parameters
  @system_parameters
end

#system_types ⇒ Array<Google::Apis::ServiceuserV1::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:



944
945
946
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 944

def system_types
  @system_types
end

#title ⇒ String

The product title for this service. Corresponds to the JSON property title

Returns:

  • (String) 


1031
1032
1033
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1031

def title
  @title
end

#types ⇒ Array<Google::Apis::ServiceuserV1::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:



1063
1064
1065
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1063

def types
  @types
end

#usage ⇒ Google::Apis::ServiceuserV1::Usage

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

Returns:



849
850
851
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 849

def usage
  @usage
end

#visibility ⇒ Google::Apis::ServiceuserV1::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:



965
966
967
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 965

def visibility
  @visibility
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1190

def update!(**args)
  @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)
  @apis = args[:apis] if args.key?(:apis)
  @logs = args[:logs] if args.key?(:logs)
  @types = args[:types] if args.key?(:types)
  @source_info = args[:source_info] if args.key?(:source_info)
  @http = args[:http] if args.key?(:http)
  @backend = args[:backend] if args.key?(:backend)
  @system_parameters = args[:system_parameters] if args.key?(:system_parameters)
  @documentation = args[:documentation] if args.key?(:documentation)
  @monitored_resources = args[:monitored_resources] if args.key?(:monitored_resources)
  @logging = args[:logging] if args.key?(:logging)
end