io.envoyproxy.envoy.api.v2.core

Class Node

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.api.v2.core.Node

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, NodeOrBuilder, Serializable

public final class Node
extends com.google.protobuf.GeneratedMessageV3
implements NodeOrBuilder

 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.
 

Protobuf type envoy.api.v2.core.Node

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Node.Builder Identifies a specific Envoy instance.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUILD_VERSION_FIELD_NUMBER
static int	CLUSTER_FIELD_NUMBER
static int	ID_FIELD_NUMBER
static int	LOCALITY_FIELD_NUMBER
static int	METADATA_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getBuildVersion() This is motivated by informing a management server during canary which version of Envoy is being tested in a heterogeneous fleet.
com.google.protobuf.ByteString	getBuildVersionBytes() This is motivated by informing a management server during canary which version of Envoy is being tested in a heterogeneous fleet.
String	getCluster() Defines the local service cluster name where Envoy is running.
com.google.protobuf.ByteString	getClusterBytes() Defines the local service cluster name where Envoy is running.
static Node	getDefaultInstance()
Node	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getId() An opaque node identifier for the Envoy node.
com.google.protobuf.ByteString	getIdBytes() An opaque node identifier for the Envoy node.
Locality	getLocality() Locality specifying where the Envoy instance is running.
LocalityOrBuilder	getLocalityOrBuilder() Locality specifying where the Envoy instance is running.
com.google.protobuf.Struct	getMetadata() Opaque metadata extending the node identifier.
com.google.protobuf.StructOrBuilder	getMetadataOrBuilder() Opaque metadata extending the node identifier.
com.google.protobuf.Parser<Node>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasLocality() Locality specifying where the Envoy instance is running.
boolean	hasMetadata() Opaque metadata extending the node identifier.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Node.Builder	newBuilder()
static Node.Builder	newBuilder(Node prototype)
Node.Builder	newBuilderForType()
protected Node.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static Node	parseDelimitedFrom(InputStream input)
static Node	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Node	parseFrom(byte[] data)
static Node	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Node	parseFrom(ByteBuffer data)
static Node	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Node	parseFrom(com.google.protobuf.ByteString data)
static Node	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Node	parseFrom(com.google.protobuf.CodedInputStream input)
static Node	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Node	parseFrom(InputStream input)
static Node	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Node>	parser()
Node.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

See Also:

Constant Field Values

CLUSTER_FIELD_NUMBER

public static final int CLUSTER_FIELD_NUMBER

See Also:

Constant Field Values

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER

See Also:

Constant Field Values

LOCALITY_FIELD_NUMBER

public static final int LOCALITY_FIELD_NUMBER

See Also:

Constant Field Values

BUILD_VERSION_FIELD_NUMBER

public static final int BUILD_VERSION_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getId

public String getId()

 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 <arch_overview_statistics>`, :ref:`CDS
 <config_cluster_manager_cds>`, and :ref:`HTTP tracing
 <arch_overview_tracing>`, either in this message or via
 :option:`--service-node`.
 

string id = 1;

Specified by:

getId in interface NodeOrBuilder

getIdBytes

public com.google.protobuf.ByteString getIdBytes()

 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 <arch_overview_statistics>`, :ref:`CDS
 <config_cluster_manager_cds>`, and :ref:`HTTP tracing
 <arch_overview_tracing>`, either in this message or via
 :option:`--service-node`.
 

string id = 1;

Specified by:

getIdBytes in interface NodeOrBuilder

getCluster

public String getCluster()

 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 <arch_overview_statistics>`, :ref:`health check cluster
 verification <envoy_api_field_core.HealthCheck.HttpHealthCheck.service_name>`,
 :ref:`runtime override directory <envoy_api_msg_config.bootstrap.v2.Runtime>`,
 :ref:`user agent addition
 <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.add_user_agent>`,
 :ref:`HTTP global rate limiting <config_http_filters_rate_limit>`,
 :ref:`CDS <config_cluster_manager_cds>`, and :ref:`HTTP tracing
 <arch_overview_tracing>`, either in this message or via
 :option:`--service-cluster`.
 

string cluster = 2;

Specified by:

getCluster in interface NodeOrBuilder

getClusterBytes

public com.google.protobuf.ByteString getClusterBytes()

 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 <arch_overview_statistics>`, :ref:`health check cluster
 verification <envoy_api_field_core.HealthCheck.HttpHealthCheck.service_name>`,
 :ref:`runtime override directory <envoy_api_msg_config.bootstrap.v2.Runtime>`,
 :ref:`user agent addition
 <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.add_user_agent>`,
 :ref:`HTTP global rate limiting <config_http_filters_rate_limit>`,
 :ref:`CDS <config_cluster_manager_cds>`, and :ref:`HTTP tracing
 <arch_overview_tracing>`, either in this message or via
 :option:`--service-cluster`.
 

string cluster = 2;

Specified by:

getClusterBytes in interface NodeOrBuilder

hasMetadata

public boolean hasMetadata()

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

.google.protobuf.Struct metadata = 3;

Specified by:

hasMetadata in interface NodeOrBuilder

getMetadata

public com.google.protobuf.Struct getMetadata()

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

.google.protobuf.Struct metadata = 3;

Specified by:

getMetadata in interface NodeOrBuilder

getMetadataOrBuilder

public com.google.protobuf.StructOrBuilder getMetadataOrBuilder()

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

.google.protobuf.Struct metadata = 3;

Specified by:

getMetadataOrBuilder in interface NodeOrBuilder

hasLocality

public boolean hasLocality()

 Locality specifying where the Envoy instance is running.
 

.envoy.api.v2.core.Locality locality = 4;

Specified by:

hasLocality in interface NodeOrBuilder

getLocality

public Locality getLocality()

 Locality specifying where the Envoy instance is running.
 

.envoy.api.v2.core.Locality locality = 4;

Specified by:

getLocality in interface NodeOrBuilder

getLocalityOrBuilder

public LocalityOrBuilder getLocalityOrBuilder()

 Locality specifying where the Envoy instance is running.
 

.envoy.api.v2.core.Locality locality = 4;

Specified by:

getLocalityOrBuilder in interface NodeOrBuilder

getBuildVersion

public String getBuildVersion()

 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.
 

string build_version = 5;

Specified by:

getBuildVersion in interface NodeOrBuilder

getBuildVersionBytes

public com.google.protobuf.ByteString getBuildVersionBytes()

 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.
 

string build_version = 5;

Specified by:

getBuildVersionBytes in interface NodeOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Node parseFrom(ByteBuffer data)
                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Node parseFrom(ByteBuffer data,
                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Node parseFrom(com.google.protobuf.ByteString data)
                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Node parseFrom(com.google.protobuf.ByteString data,
                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Node parseFrom(byte[] data)
                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Node parseFrom(byte[] data,
                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Node parseFrom(InputStream input)
                      throws IOException

Throws:

IOException

parseFrom

public static Node parseFrom(InputStream input,
                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static Node parseDelimitedFrom(InputStream input)
                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static Node parseDelimitedFrom(InputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException

Throws:

IOException

parseFrom

public static Node parseFrom(com.google.protobuf.CodedInputStream input)
                      throws IOException

Throws:

IOException

parseFrom

public static Node parseFrom(com.google.protobuf.CodedInputStream input,
                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                      throws IOException

Throws:

IOException

newBuilderForType

public Node.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Node.Builder newBuilder()

newBuilder

public static Node.Builder newBuilder(Node prototype)

toBuilder

public Node.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Node.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Node getDefaultInstance()

parser

public static com.google.protobuf.Parser<Node> parser()

getParserForType

public com.google.protobuf.Parser<Node> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Node getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder