Class: Google::Apis::ServicemanagementV1::Endpoint

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

Endpoint describes a network endpoint that serves a set of APIs. A service may expose any number of endpoints, and all endpoints share the same service configuration, such as quota configuration and monitoring configuration. Example service configuration: name: library-example.googleapis.com endpoints:

Below entry makes 'google.example.library.v1.Library'

API be served from endpoint address library-example.googleapis.com.

It also allows HTTP OPTIONS calls to be passed to the backend, for

it to decide whether the subsequent cross-origin request is

allowed to proceed.

  • name: library-example.googleapis.com allow_cors: true

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

Returns a new instance of Endpoint



2037
2038
2039
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2037

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

Instance Attribute Details

#aliases ⇒ Array<String>

DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intented alias. Additional names that this endpoint will be hosted on. Corresponds to the JSON property aliases

Returns:

  • (Array<String>) 


2010
2011
2012
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2010

def aliases
  @aliases
end

#allow_cors ⇒ Boolean Also known as: allow_cors?

Allowing CORS, aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed. Corresponds to the JSON property allowCors

Returns:

  • (Boolean) 


2020
2021
2022
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2020

def allow_cors
  @allow_cors
end

#apis ⇒ Array<String>

The list of APIs served by this endpoint. If no APIs are specified this translates to "all APIs" exported by the service, as defined in the top-level service configuration. Corresponds to the JSON property apis

Returns:

  • (Array<String>) 


2002
2003
2004
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2002

def apis
  @apis
end

#features ⇒ Array<String>

The list of features enabled on this endpoint. Corresponds to the JSON property features

Returns:

  • (Array<String>) 


1995
1996
1997
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 1995

def features
  @features
end

#name ⇒ String

The canonical name of this endpoint. Corresponds to the JSON property name

Returns:

  • (String) 


2026
2027
2028
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2026

def name
  @name
end

#target ⇒ String

The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com". Corresponds to the JSON property target

Returns:

  • (String) 


2035
2036
2037
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2035

def target
  @target
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2042
2043
2044
2045
2046
2047
2048
2049
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2042

def update!(**args)
  @features = args[:features] if args.key?(:features)
  @apis = args[:apis] if args.key?(:apis)
  @aliases = args[:aliases] if args.key?(:aliases)
  @allow_cors = args[:allow_cors] if args.key?(:allow_cors)
  @name = args[:name] if args.key?(:name)
  @target = args[:target] if args.key?(:target)
end