Class Endpoint

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

Inheritance

System.Object

Endpoint

Implements

IMessage<Endpoint>

IMessage

System.IEquatable<Endpoint>

IDeepCloneable<Endpoint>

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Api

Assembly: Google.Api.CommonProtos.dll

Syntax

public sealed class Endpoint : IMessage<Endpoint>, IMessage, IEquatable<Endpoint>, IDeepCloneable<Endpoint>

Constructors

Endpoint()

Declaration

public Endpoint()

Endpoint(Endpoint)

Declaration

public Endpoint(Endpoint other)

Parameters

Type	Name	Description
Endpoint	other

Fields

AliasesFieldNumber

Field number for the "aliases" field.

Declaration

public const int AliasesFieldNumber = 2

Field Value

Type	Description
System.Int32

AllowCorsFieldNumber

Field number for the "allow_cors" field.

Declaration

public const int AllowCorsFieldNumber = 5

Field Value

Type	Description
System.Int32

FeaturesFieldNumber

Field number for the "features" field.

Declaration

public const int FeaturesFieldNumber = 4

Field Value

Type	Description
System.Int32

NameFieldNumber

Field number for the "name" field.

Declaration

public const int NameFieldNumber = 1

Field Value

Type	Description
System.Int32

TargetFieldNumber

Field number for the "target" field.

Declaration

public const int TargetFieldNumber = 101

Field Value

Type	Description
System.Int32

Properties

Aliases

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.

Declaration

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

Property Value

Type	Description
RepeatedField<System.String>

AllowCors

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.

Declaration

public bool AllowCors { get; set; }

Property Value

Type	Description
System.Boolean

Descriptor

Declaration

public static MessageDescriptor Descriptor { get; }

Property Value

Type	Description
MessageDescriptor

Features

The list of features enabled on this endpoint.

Declaration

public RepeatedField<string> Features { get; }

Property Value

Type	Description
RepeatedField<System.String>

Name

The canonical name of this endpoint.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

Parser

Declaration

public static MessageParser<Endpoint> Parser { get; }

Property Value

Type	Description
MessageParser<Endpoint>

Target

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".

Declaration

public string Target { get; set; }

Property Value

Type	Description
System.String

Methods

CalculateSize()

Declaration

public int CalculateSize()

Returns

Type	Description
System.Int32

Implements

IMessage.CalculateSize()

Clone()

Declaration

public Endpoint Clone()

Returns

Type	Description
Endpoint

Implements

IDeepCloneable<T>.Clone()

Equals(Endpoint)

Declaration

public bool Equals(Endpoint other)

Parameters

Type	Name	Description
Endpoint	other

Returns

Type	Description
System.Boolean

Implements

System.IEquatable<T>.Equals(T)

Equals(Object)

Declaration

public override bool Equals(object other)

Parameters

Type	Name	Description
System.Object	other

Returns

Type	Description
System.Boolean

Overrides

System.Object.Equals(System.Object)

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.Object.GetHashCode()

MergeFrom(Endpoint)

Declaration

public void MergeFrom(Endpoint other)

Parameters

Type	Name	Description
Endpoint	other

Implements

IMessage<T>.MergeFrom(T)

MergeFrom(CodedInputStream)

Declaration

public void MergeFrom(CodedInputStream input)

Parameters

Type	Name	Description
CodedInputStream	input

Implements

IMessage.MergeFrom(CodedInputStream)

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()

WriteTo(CodedOutputStream)

Declaration

public void WriteTo(CodedOutputStream output)

Parameters

Type	Name	Description
CodedOutputStream	output

Implements

IMessage.WriteTo(CodedOutputStream)

Explicit Interface Implementations

IMessage.Descriptor

Declaration

MessageDescriptor IMessage.Descriptor { get; }

Returns

Type	Description
MessageDescriptor

Implements

IMessage.Descriptor