Class: Google::Apis::ServicenetworkingV1beta::Service

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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Service

Returns a new instance of Service.



3226
3227
3228
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 3226

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

Instance Attribute Details

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



2962
2963
2964
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 2962

def apis
  @apis
end

#authentication ⇒ Google::Apis::ServicenetworkingV1beta::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

Returns:



2971
2972
2973
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 2971

def authentication
  @authentication
end

#backend ⇒ Google::Apis::ServicenetworkingV1beta::Backend

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

Returns:



2976
2977
2978
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 2976

def backend
  @backend
end

#billing ⇒ Google::Apis::ServicenetworkingV1beta::Billing

Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing, consumer_destinations is the only supported destination and the monitored resources need at least one label key cloud.googleapis.com/location to indicate the location of the billing usage, using different monitored resources between monitoring and billing is recommended so they can be evolved independently: monitored_resources: - type: library.googleapis.com/ billing_branch labels: - key: cloud.googleapis.com/location description: | Predefined label to support billing location restriction. - key: city description: | Custom label to define the city where the library branch is located in. - key: name description: Custom label to define the name of the library branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations:

  • monitored_resource: library.googleapis.com/billing_branch metrics: - library. googleapis.com/book/borrowed_count Corresponds to the JSON property billing

Returns:



2995
2996
2997
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 2995

def billing
  @billing
end

#config_version ⇒ Fixnum

Deprecated. The service config compiler always sets this field to 3. Corresponds to the JSON property configVersion

Returns:

  • (Fixnum) 


3000
3001
3002
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 3000

def config_version
  @config_version
end

#context ⇒ Google::Apis::ServicenetworkingV1beta::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. This also provides mechanism to allowlist 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

Returns:



3017
3018
3019
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 3017

def context
  @context
end

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



3024
3025
3026
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 3024

def control
  @control
end

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



3032
3033
3034
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 3032

def custom_error
  @custom_error
end

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

Returns:



3062
3063
3064
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 3062

def documentation
  @documentation
end

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



3069
3070
3071
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 3069

def endpoints
  @endpoints
end

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



3077
3078
3079
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 3077

def enums
  @enums
end

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



3084
3085
3086
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 3084

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

Returns:

  • (String) 


3092
3093
3094
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 3092

def id
  @id
end

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



3107
3108
3109
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 3107

def logging
  @logging
end

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

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

Returns:



3112
3113
3114
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 3112

def logs
  @logs
end

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

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

Returns:



3117
3118
3119
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 3117

def metrics
  @metrics
end

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



3123
3124
3125
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 3123

def monitored_resources
  @monitored_resources
end

#monitoring ⇒ Google::Apis::ServicenetworkingV1beta::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/num_overdue metric is only sent to the consumer project. monitored_resources: - type: library.googleapis.com/ Branch display_name: "Library Branch" description: "A branch of a library." launch_stage: GA labels: - key: resource_container description: "The Cloud container (ie. project id) for the Branch." - key: location description: "The location of the library branch." - key: branch_id description: "The id of the branch." metrics: - name: library.googleapis.com/book/returned_count display_name: "Books Returned" description: "The count of books that have been returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1" labels: - key: customer_id description: "The id of the customer." - name: library.googleapis.com/book/num_overdue display_name: "Books Overdue" description: "The current number of overdue books." launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id description: "The id of the customer." 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/num_overdue Corresponds to the JSON property monitoring

Returns:



3149
3150
3151
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 3149

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

Returns:

  • (String) 


3156
3157
3158
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 3156

def name
  @name
end

#producer_project_id ⇒ String

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

Returns:

  • (String) 


3161
3162
3163
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 3161

def producer_project_id
  @producer_project_id
end

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

Returns:



3184
3185
3186
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 3184

def quota
  @quota
end

#source_info ⇒ Google::Apis::ServicenetworkingV1beta::SourceInfo

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

Returns:



3189
3190
3191
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 3189

def source_info
  @source_info
end

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



3197
3198
3199
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 3197

def system_parameters
  @system_parameters
end

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



3205
3206
3207
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 3205

def system_types
  @system_types
end

#title ⇒ String

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

Returns:

  • (String) 


3210
3211
3212
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 3210

def title
  @title
end

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



3219
3220
3221
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 3219

def types
  @types
end

#usage ⇒ Google::Apis::ServicenetworkingV1beta::Usage

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

Returns:



3224
3225
3226
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 3224

def usage
  @usage
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
 
# File 'lib/google/apis/servicenetworking_v1beta/classes.rb', line 3231

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