Class: Google::Apis::ServicenetworkingV1::Endpoint
- Inherits:
-
Object
- Object
- Google::Apis::ServicenetworkingV1::Endpoint
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/servicenetworking_v1/classes.rb,
generated/google/apis/servicenetworking_v1/representations.rb,
generated/google/apis/servicenetworking_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
-
#aliases ⇒ Array<String>
DEPRECATED: This field is no longer supported.
-
#allow_cors ⇒ Boolean
(also: #allow_cors?)
Allowing CORS, aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests.
-
#features ⇒ Array<String>
The list of features enabled on this endpoint.
-
#name ⇒ String
The canonical name of this endpoint.
-
#target ⇒ String
The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Endpoint
constructor
A new instance of Endpoint.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Endpoint
Returns a new instance of Endpoint.
1165 1166 1167 |
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 1165 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 intended
aliases.
Additional names that this endpoint will be hosted on.
Corresponds to the JSON property aliases
1133 1134 1135 |
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 1133 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
1143 1144 1145 |
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 1143 def allow_cors @allow_cors end |
#features ⇒ Array<String>
The list of features enabled on this endpoint.
Corresponds to the JSON property features
1149 1150 1151 |
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 1149 def features @features end |
#name ⇒ String
The canonical name of this endpoint.
Corresponds to the JSON property name
1154 1155 1156 |
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 1154 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
1163 1164 1165 |
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 1163 def target @target end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1170 1171 1172 1173 1174 1175 1176 |
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 1170 def update!(**args) @aliases = args[:aliases] if args.key?(:aliases) @allow_cors = args[:allow_cors] if args.key?(:allow_cors) @features = args[:features] if args.key?(:features) @name = args[:name] if args.key?(:name) @target = args[:target] if args.key?(:target) end |