Class: Google::Apis::ServiceusageV1::Endpoint
- Inherits:
-
Object
- Object
- Google::Apis::ServiceusageV1::Endpoint
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/serviceusage_v1/classes.rb,
lib/google/apis/serviceusage_v1/representations.rb,
lib/google/apis/serviceusage_v1/representations.rb
Overview
Endpoint
describes a network address of a service that serves a set of APIs.
It is commonly known as a service endpoint. A service may expose any number of
service endpoints, and all service endpoints share the same service definition,
such as quota limits and monitoring metrics. Example: type: google.api.
Service name: library-example.googleapis.com endpoints: # Declares network
address https://library-example.googleapis.com
# for service library-
example.googleapis.com
. The https
scheme # is implicit for all service
endpoints. Other schemes may be # supported in the future. - name: library-
example.googleapis.com allow_cors: false - name: content-staging-library-
example.googleapis.com # Allows HTTP OPTIONS calls to be passed to the API
frontend, for it # to decide whether the subsequent cross-origin request is
allowed # to proceed. allow_cors: true
Instance Attribute Summary collapse
-
#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.
-
#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.
Constructor Details
#initialize(**args) ⇒ Endpoint
Returns a new instance of Endpoint.
1155 1156 1157 |
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 1155 def initialize(**args) update!(**args) end |
Instance Attribute Details
#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
1139 1140 1141 |
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 1139 def allow_cors @allow_cors end |
#name ⇒ String
The canonical name of this endpoint.
Corresponds to the JSON property name
1145 1146 1147 |
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 1145 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
1153 1154 1155 |
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 1153 def target @target end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1160 1161 1162 1163 1164 |
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 1160 def update!(**args) @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 |