Class: Google::Api::Endpoint
- Inherits:
-
Object
- Object
- Google::Api::Endpoint
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/api/endpoint.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
-
#aliases ⇒ ::Array<::String>
deprecated
Deprecated.
This field is deprecated and may be removed in the next major version update.
-
#allow_cors ⇒ ::Boolean
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 Attribute Details
#aliases ⇒ ::Array<::String>
This field is deprecated and may be removed in the next major version update.
Returns Unimplemented. Dot not use.
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.
71 72 73 74 |
# File 'proto_docs/google/api/endpoint.rb', line 71 class Endpoint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#allow_cors ⇒ ::Boolean
Returns 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.
71 72 73 74 |
# File 'proto_docs/google/api/endpoint.rb', line 71 class Endpoint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#name ⇒ ::String
Returns The canonical name of this endpoint.
71 72 73 74 |
# File 'proto_docs/google/api/endpoint.rb', line 71 class Endpoint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#target ⇒ ::String
Returns 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".
71 72 73 74 |
# File 'proto_docs/google/api/endpoint.rb', line 71 class Endpoint include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |