public sealed class Endpoint : IMessage<Endpoint>, IEquatable<Endpoint>, IDeepCloneable<Endpoint>, IBufferMessage, IMessage
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
DEPRECATED: This field is no longer supported. Instead of using aliases,
please specify multiple [google.api.Endpoint][google.api.Endpoint] for each
of the intended aliases.
Additional names that this endpoint will be hosted on.
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.
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".
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["The `Endpoint` class describes a network address of a service, commonly referred to as a service endpoint, where a service can have multiple endpoints sharing the same definition."],["`Endpoint` objects can specify the `name` of the endpoint and whether to `AllowCors` (cross-origin resource sharing), which allows backends to handle HTTP OPTIONS requests."],["An `Endpoint` object also specifies a `Target`, which is the Internet routable address, such as an IPv4 address or a fully-qualified domain name, that handles requests to the API."],["The `Aliases` field was removed and is no longer supported."],["This class implements multiple interfaces, including `IMessage`, `IEquatable\u003cEndpoint\u003e`, `IDeepCloneable\u003cEndpoint\u003e`, `IBufferMessage`, and inherits from the `object` class."]]],[]]
