public sealed class Endpoint : IMessage<Endpoint>, IEquatable<Endpoint>, IDeepCloneable<Endpoint>, IBufferMessage, IMessage
Endpointdescribes 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.
AllowingCORS, 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 thisAPI
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-09-04 UTC."],[[["\u003cp\u003e\u003ccode\u003eEndpoint\u003c/code\u003e is a class that describes a service's network address, allowing for multiple endpoints with shared service definitions.\u003c/p\u003e\n"],["\u003cp\u003eThis class implements several interfaces, including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e, among others.\u003c/p\u003e\n"],["\u003cp\u003eKey properties of the \u003ccode\u003eEndpoint\u003c/code\u003e class include \u003ccode\u003eName\u003c/code\u003e, which is the canonical name of the endpoint, \u003ccode\u003eAllowCors\u003c/code\u003e, which controls cross-domain traffic, and \u003ccode\u003eTarget\u003c/code\u003e, specifying the routable address of the API frontend.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eEndpoint\u003c/code\u003e class offers methods for cloning (\u003ccode\u003eClone\u003c/code\u003e), calculating size (\u003ccode\u003eCalculateSize\u003c/code\u003e), merging (\u003ccode\u003eMergeFrom\u003c/code\u003e), and checking equality (\u003ccode\u003eEquals\u003c/code\u003e), among other actions.\u003c/p\u003e\n"],["\u003cp\u003eThe class includes deprecated fields like Aliases, which are no longer supported and to be replaced by specifying multiple endpoints instead.\u003c/p\u003e\n"]]],[],null,["# Class Endpoint (2.17.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.17.0 (latest)](/dotnet/docs/reference/Google.Api.CommonProtos/latest/Google.Api.Endpoint)\n- [2.15.0](/dotnet/docs/reference/Google.Api.CommonProtos/2.15.0/Google.Api.Endpoint)\n- [2.10.0](/dotnet/docs/reference/Google.Api.CommonProtos/2.10.0/Google.Api.Endpoint)\n- [2.2.0](/dotnet/docs/reference/Google.Api.CommonProtos/2.2.0/Google.Api.Endpoint) \n\n public sealed class Endpoint : IMessage\u003cEndpoint\u003e, IEquatable\u003cEndpoint\u003e, IDeepCloneable\u003cEndpoint\u003e, IBufferMessage, IMessage\n\n`Endpoint` describes a network address of a service that serves a set of\nAPIs. It is commonly known as a service endpoint. A service may expose\nany number of service endpoints, and all service endpoints share the same\nservice definition, such as quota limits and monitoring metrics.\n\nExample: \n\n type: google.api.Service\n name: library-example.googleapis.com\n endpoints:\n # Declares network address `https://library-example.googleapis.com`\n # for service `library-example.googleapis.com`. The `https` scheme\n # is implicit for all service endpoints. Other schemes may be\n # supported in the future.\n - name: library-example.googleapis.com\n allow_cors: false\n - name: content-staging-library-example.googleapis.com\n # Allows HTTP OPTIONS calls to be passed to the API frontend, for it\n # to decide whether the subsequent cross-origin request is allowed\n # to proceed.\n allow_cors: true\n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e Endpoint \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[Endpoint](/dotnet/docs/reference/Google.Api.CommonProtos/latest/Google.Api.Endpoint), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[Endpoint](/dotnet/docs/reference/Google.Api.CommonProtos/latest/Google.Api.Endpoint), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[Endpoint](/dotnet/docs/reference/Google.Api.CommonProtos/latest/Google.Api.Endpoint), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals)\n\nNamespace\n---------\n\n[Google.Api](/dotnet/docs/reference/Google.Api.CommonProtos/latest/Google.Api)\n\nAssembly\n--------\n\nGoogle.Api.CommonProtos.dll\n\nConstructors\n------------\n\n### Endpoint()\n\n public Endpoint()\n\n### Endpoint(Endpoint)\n\n public Endpoint(Endpoint other)\n\nFields\n------\n\n### AliasesFieldNumber\n\n public const int AliasesFieldNumber = 2\n\nField number for the \"aliases\" field.\n\n### AllowCorsFieldNumber\n\n public const int AllowCorsFieldNumber = 5\n\nField number for the \"allow_cors\" field.\n\n### NameFieldNumber\n\n public const int NameFieldNumber = 1\n\nField number for the \"name\" field.\n\n### TargetFieldNumber\n\n public const int TargetFieldNumber = 101\n\nField number for the \"target\" field.\n\nProperties\n----------\n\n### Aliases\n\n public RepeatedField\u003cstring\u003e Aliases { get; }\n\nAliases for this endpoint, these will be served by the same UrlMap as the\nparent endpoint, and will be provisioned in the GCP stack for the Regional\nEndpoints.\n\n### AllowCors\n\n public bool AllowCors { get; set; }\n\nAllowing\n[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka\ncross-domain traffic, would allow the backends served from this endpoint to\nreceive and respond to HTTP OPTIONS requests. The response will be used by\nthe browser to determine whether the subsequent cross-origin request is\nallowed to proceed.\n\n### Descriptor\n\n public static MessageDescriptor Descriptor { get; }\n\n### Name\n\n public string Name { get; set; }\n\nThe canonical name of this endpoint.\n\n### Parser\n\n public static MessageParser\u003cEndpoint\u003e Parser { get; }\n\n### Target\n\n public string Target { get; set; }\n\nThe specification of an Internet routable address of API frontend that will\nhandle requests to this [API\nEndpoint](https://cloud.google.com/apis/design/glossary). It should be\neither a valid IPv4 address or a fully-qualified domain name. For example,\n\"8.8.8.8\" or \"myservice.appspot.com\".\n\nMethods\n-------\n\n### CalculateSize()\n\n public int CalculateSize()\n\n### Clone()\n\n public Endpoint Clone()\n\n### Equals(Endpoint)\n\n public bool Equals(Endpoint other)\n\n### Equals(object)\n\n public override bool Equals(object other)\n\n**Overrides** \n[object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object))\n\n### GetHashCode()\n\n public override int GetHashCode()\n\n**Overrides** \n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode)\n\n### MergeFrom(Endpoint)\n\n public void MergeFrom(Endpoint other)\n\n### MergeFrom(CodedInputStream)\n\n public void MergeFrom(CodedInputStream input)\n\n### ToString()\n\n public override string ToString()\n\n**Overrides** \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\n### WriteTo(CodedOutputStream)\n\n public void WriteTo(CodedOutputStream output)"]]
