Show / Hide Table of Contents

Class Endpoint

Endpoint describes a network endpoint 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 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
IDirectResponseSchema
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.ServiceUsage.v1.Data
Assembly: Google.Apis.ServiceUsage.v1.dll
Syntax
public class Endpoint : IDirectResponseSchema

Properties

Aliases

DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.

Declaration
[JsonProperty("aliases")]
public virtual IList<string> Aliases { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<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
[JsonProperty("allowCors")]
public virtual bool? AllowCors { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
System.String

Name

The canonical name of this endpoint.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
System.String

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
[JsonProperty("target")]
public virtual string Target { get; set; }
Property Value
Type Description
System.String

Implements

IDirectResponseSchema
In This Article
Back to top