Class Node

Identifies a specific Envoy instance. The node identifier is presented to the management server, which may use this identifier to distinguish per Envoy configuration for serving. [#next-free-field: 12]

Inheritance

object

Node

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.TrafficDirectorService.v2.Data

Assembly: Google.Apis.TrafficDirectorService.v2.dll

Syntax

public class Node : IDirectResponseSchema

Properties

BuildVersion

This is motivated by informing a management server during canary which version of Envoy is being tested in a heterogeneous fleet. This will be set by Envoy in management server RPCs. This field is deprecated in favor of the user_agent_name and user_agent_version values.

Declaration

[JsonProperty("buildVersion")]
public virtual string BuildVersion { get; set; }

Property Value

Type	Description
string

ClientFeatures

Client feature support list. These are well known features described in the Envoy API repository for a given major version of an API. Client features use reverse DNS naming scheme, for example com.acme.feature. See :ref:the list of features that xDS client may support.

Declaration

[JsonProperty("clientFeatures")]
public virtual IList<string> ClientFeatures { get; set; }

Property Value

Type	Description
IList<string>

Cluster

Defines the local service cluster name where Envoy is running. Though optional, it should be set if any of the following features are used: :ref:statsd , :ref:health check cluster verification , :ref:runtime override directory , :ref:user agent addition , :ref:HTTP global rate limiting , :ref:CDS , and :ref:HTTP tracing , either in this message or via :option:--service-cluster.

Declaration

[JsonProperty("cluster")]
public virtual string Cluster { get; set; }

Property Value

Type	Description
string

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

Extensions

List of extensions and their versions supported by the node.

Declaration

[JsonProperty("extensions")]
public virtual IList<Extension> Extensions { get; set; }

Property Value

Type	Description
IList<Extension>

Id

An opaque node identifier for the Envoy node. This also provides the local service node name. It should be set if any of the following features are used: :ref:statsd , :ref:CDS , and :ref:HTTP tracing , either in this message or via :option:--service-node.

Declaration

[JsonProperty("id")]
public virtual string Id { get; set; }

Property Value

Type	Description
string

ListeningAddresses

Known listening ports on the node as a generic hint to the management server for filtering :ref:listeners to be returned. For example, if there is a listener bound to port 80, the list can optionally contain the SocketAddress (0.0.0.0,80). The field is optional and just a hint.

Declaration

[JsonProperty("listeningAddresses")]
public virtual IList<Address> ListeningAddresses { get; set; }

Property Value

Type	Description
IList<Address>

Locality

Locality specifying where the Envoy instance is running.

Declaration

[JsonProperty("locality")]
public virtual Locality Locality { get; set; }

Property Value

Type	Description
Locality

Metadata

Opaque metadata extending the node identifier. Envoy will pass this directly to the management server.

Declaration

[JsonProperty("metadata")]
public virtual IDictionary<string, object> Metadata { get; set; }

Property Value

Type	Description
IDictionary<string, object>

UserAgentBuildVersion

Structured version of the entity requesting config.

Declaration

[JsonProperty("userAgentBuildVersion")]
public virtual BuildVersion UserAgentBuildVersion { get; set; }

Property Value

Type	Description
BuildVersion

UserAgentName

Free-form string that identifies the entity requesting config. E.g. "envoy" or "grpc"

Declaration

[JsonProperty("userAgentName")]
public virtual string UserAgentName { get; set; }

Property Value

Type	Description
string

UserAgentVersion

Free-form string that identifies the version of the entity requesting config. E.g. "1.12.2" or "abcd1234", or "SpecialEnvoyBuild"

Declaration

[JsonProperty("userAgentVersion")]
public virtual string UserAgentVersion { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema