Class Endpoint (2.10.0)

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

Inheritance

object > Endpoint

Namespace

Google.Api

Assembly

Google.Api.CommonProtos.dll

Constructors

Endpoint()

public Endpoint()

Endpoint(Endpoint)

public Endpoint(Endpoint other)
Parameter
Name Description
other Endpoint

Fields

AliasesFieldNumber

public const int AliasesFieldNumber = 2

Field number for the "aliases" field.

Field Value
Type Description
int

AllowCorsFieldNumber

public const int AllowCorsFieldNumber = 5

Field number for the "allow_cors" field.

Field Value
Type Description
int

NameFieldNumber

public const int NameFieldNumber = 1

Field number for the "name" field.

Field Value
Type Description
int

TargetFieldNumber

public const int TargetFieldNumber = 101

Field number for the "target" field.

Field Value
Type Description
int

Properties

Aliases

[Obsolete]
public RepeatedField<string> Aliases { get; }

Unimplemented. Dot not use.

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.

Property Value
Type Description
RepeatedFieldstring

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
bool

Descriptor

public static MessageDescriptor Descriptor { get; }
Property Value
Type Description
MessageDescriptor

Name

public string Name { get; set; }

The canonical name of this endpoint.

Property Value
Type Description
string

Parser

public static MessageParser<Endpoint> Parser { get; }
Property Value
Type Description
MessageParserEndpoint

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
int

Clone()

public Endpoint Clone()
Returns
Type Description
Endpoint

Equals(Endpoint)

public bool Equals(Endpoint other)
Parameter
Name Description
other Endpoint
Returns
Type Description
bool

Equals(object)

public override bool Equals(object other)
Parameter
Name Description
other object
Returns
Type Description
bool
Overrides

GetHashCode()

public override int GetHashCode()
Returns
Type Description
int
Overrides

MergeFrom(Endpoint)

public void MergeFrom(Endpoint other)
Parameter
Name Description
other Endpoint

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream

ToString()

public override string ToString()
Returns
Type Description
string
Overrides

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream