public sealed class Endpoint : Protobuf.IMessage<Endpoint>, Protobuf.IBufferMessage
Endpoint describes a network endpoint that serves a set of APIs.
A service may expose any number of endpoints, and all endpoints share the
same service configuration, such as quota configuration and monitoring
configuration.
Example service configuration:
name: library-example.googleapis.com
endpoints:
Below entry makes 'google.example.library.v1.Library'
API be served from endpoint address library-example.googleapis.com.
It also allows HTTP OPTIONS calls to be passed to the backend, for
it to decide whether the subsequent cross-origin request is
allowed to proceed.
- name: library-example.googleapis.com
allow_cors: true
Namespace
Google.Api
Assembly
Google.Api.CommonProtos.dll
Constructors
Endpoint()
Endpoint(Endpoint)
public Endpoint(Endpoint other)
Fields
AliasesFieldNumber
public const int AliasesFieldNumber = 2
Field number for the "aliases" field.
| Field Value |
|---|
| Type | Description |
Int32 | |
AllowCorsFieldNumber
public const int AllowCorsFieldNumber = 5
Field number for the "allow_cors" field.
| Field Value |
|---|
| Type | Description |
Int32 | |
NameFieldNumber
public const int NameFieldNumber = 1
Field number for the "name" field.
| Field Value |
|---|
| Type | Description |
Int32 | |
TargetFieldNumber
public const int TargetFieldNumber = 101
Field number for the "target" field.
| Field Value |
|---|
| Type | Description |
Int32 | |
Properties
Aliases
[Obsolete]
public Protobuf.Collections.RepeatedField<string> Aliases { get; }
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.
AllowCors
public bool AllowCors { get; set; }
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.
| Property Value |
|---|
| Type | Description |
Boolean | |
Descriptor
public static Protobuf.Reflection.MessageDescriptor Descriptor { get; }
Name
public string Name { get; set; }
The canonical name of this endpoint.
| Property Value |
|---|
| Type | Description |
String | |
Parser
public static Protobuf.MessageParser<Endpoint> Parser { get; }
Target
public string Target { get; set; }
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".
| Property Value |
|---|
| Type | Description |
String | |
Methods
CalculateSize()
public int CalculateSize()
| Returns |
|---|
| Type | Description |
Int32 | |
Clone()
Equals(Endpoint)
public bool Equals(Endpoint other)
Equals(Object)
public override bool Equals(object other)
| Parameter |
|---|
| Name | Description |
other | Object
|
GetHashCode()
public override int GetHashCode()
| Returns |
|---|
| Type | Description |
Int32 | |
MergeFrom(Endpoint)
public void MergeFrom(Endpoint other)
public void MergeFrom(Protobuf.CodedInputStream input)
ToString()
public override string ToString()
WriteTo(Protobuf.CodedOutputStream)
public void WriteTo(Protobuf.CodedOutputStream output)
