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
Aliases for this endpoint, these will be served by the same UrlMap as the
parent endpoint, and will be provisioned in the GCP stack for the Regional
Endpoints.
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"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-09 UTC."],[[["`Endpoint` is a class that describes a service's network address, allowing for multiple endpoints with shared service definitions."],["This class implements several interfaces, including `IMessage`, `IEquatable`, `IDeepCloneable`, and `IBufferMessage`, among others."],["Key properties of the `Endpoint` class include `Name`, which is the canonical name of the endpoint, `AllowCors`, which controls cross-domain traffic, and `Target`, specifying the routable address of the API frontend."],["The `Endpoint` class offers methods for cloning (`Clone`), calculating size (`CalculateSize`), merging (`MergeFrom`), and checking equality (`Equals`), among other actions."],["The class includes deprecated fields like Aliases, which are no longer supported and to be replaced by specifying multiple endpoints instead."]]],[]]
