Class Endpoint (2.2.0)

 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

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

Fields

AliasesFieldNumber

  public 
  
 const 
  
 int 
  
 AliasesFieldNumber 
  
 = 
  
 2 
 

Field number for the "aliases" field.

Field Value
Type
Description

AllowCorsFieldNumber

  public 
  
 const 
  
 int 
  
 AllowCorsFieldNumber 
  
 = 
  
 5 
 

Field number for the "allow_cors" field.

Field Value
Type
Description

NameFieldNumber

  public 
  
 const 
  
 int 
  
 NameFieldNumber 
  
 = 
  
 1 
 

Field number for the "name" field.

Field Value
Type
Description

TargetFieldNumber

  public 
  
 const 
  
 int 
  
 TargetFieldNumber 
  
 = 
  
 101 
 

Field number for the "target" field.

Field Value
Type
Description

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.

Property Value
Type
Description

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

Descriptor

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

Name

 public string Name { get; set; } 

The canonical name of this endpoint.

Property Value
Type
Description

Parser

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

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

Methods

CalculateSize()

 public int CalculateSize() 
Returns
Type
Description

Clone()

 public Endpoint Clone() 
Returns
Type
Description

Equals(Endpoint)

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

Equals(Object)

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

GetHashCode()

 public override int GetHashCode() 
Returns
Type
Description

MergeFrom(Endpoint)

 public void MergeFrom(Endpoint other) 
Parameter
Name
Description
other

MergeFrom(Protobuf.CodedInputStream)

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

ToString()

 public override string ToString() 
Returns
Type
Description

WriteTo(Protobuf.CodedOutputStream)

 public void WriteTo(Protobuf.CodedOutputStream output) 
Parameter
Name
Description
Design a Mobile Site
View Site in Mobile | Classic
Share by: