io.envoyproxy.envoy.api.v2.core

Class Node.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<Node.Builder>

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

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, NodeOrBuilder, Cloneable

Enclosing class:

Node

public static final class Node.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Node.Builder>
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

Method Summary

Modifier and Type	Method and Description
Node.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Node	build()
Node	buildPartial()
Node.Builder	clear()
Node.Builder	clearBuildVersion() This is motivated by informing a management server during canary which version of Envoy is being tested in a heterogeneous fleet.
Node.Builder	clearCluster() Defines the local service cluster name where Envoy is running.
Node.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Node.Builder	clearId() An opaque node identifier for the Envoy node.
Node.Builder	clearLocality() Locality specifying where the Envoy instance is running.
Node.Builder	clearMetadata() Opaque metadata extending the node identifier.
Node.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Node.Builder	clone()
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.
Node	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
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.
Locality.Builder	getLocalityBuilder() 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.Struct.Builder	getMetadataBuilder() Opaque metadata extending the node identifier.
com.google.protobuf.StructOrBuilder	getMetadataOrBuilder() Opaque metadata extending the node identifier.
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()
Node.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Node.Builder	mergeFrom(com.google.protobuf.Message other)
Node.Builder	mergeFrom(Node other)
Node.Builder	mergeLocality(Locality value) Locality specifying where the Envoy instance is running.
Node.Builder	mergeMetadata(com.google.protobuf.Struct value) Opaque metadata extending the node identifier.
Node.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Node.Builder	setBuildVersion(String value) This is motivated by informing a management server during canary which version of Envoy is being tested in a heterogeneous fleet.
Node.Builder	setBuildVersionBytes(com.google.protobuf.ByteString value) This is motivated by informing a management server during canary which version of Envoy is being tested in a heterogeneous fleet.
Node.Builder	setCluster(String value) Defines the local service cluster name where Envoy is running.
Node.Builder	setClusterBytes(com.google.protobuf.ByteString value) Defines the local service cluster name where Envoy is running.
Node.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Node.Builder	setId(String value) An opaque node identifier for the Envoy node.
Node.Builder	setIdBytes(com.google.protobuf.ByteString value) An opaque node identifier for the Envoy node.
Node.Builder	setLocality(Locality.Builder builderForValue) Locality specifying where the Envoy instance is running.
Node.Builder	setLocality(Locality value) Locality specifying where the Envoy instance is running.
Node.Builder	setMetadata(com.google.protobuf.Struct.Builder builderForValue) Opaque metadata extending the node identifier.
Node.Builder	setMetadata(com.google.protobuf.Struct value) Opaque metadata extending the node identifier.
Node.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
Node.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

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.Builder<Node.Builder>

clear

public Node.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Node.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Node.Builder>

getDefaultInstanceForType

public Node getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Node build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Node buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public Node.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Node.Builder>

setField

public Node.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                             Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<Node.Builder>

clearField

public Node.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Node.Builder>

clearOneof

public Node.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Node.Builder>

setRepeatedField

public Node.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                     int index,
                                     Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Node.Builder>

addRepeatedField

public Node.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                     Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Node.Builder>

mergeFrom

public Node.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Node.Builder>

mergeFrom

public Node.Builder mergeFrom(Node other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Node.Builder>

mergeFrom

public Node.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Node.Builder>

Throws:

IOException

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

setId

public Node.Builder setId(String value)

 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;

clearId

public Node.Builder clearId()

 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;

setIdBytes

public Node.Builder setIdBytes(com.google.protobuf.ByteString value)

 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;

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

setCluster

public Node.Builder setCluster(String value)

 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;

clearCluster

public Node.Builder clearCluster()

 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;

setClusterBytes

public Node.Builder setClusterBytes(com.google.protobuf.ByteString value)

 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;

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

setMetadata

public Node.Builder setMetadata(com.google.protobuf.Struct value)

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

.google.protobuf.Struct metadata = 3;

setMetadata

public Node.Builder setMetadata(com.google.protobuf.Struct.Builder builderForValue)

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

.google.protobuf.Struct metadata = 3;

mergeMetadata

public Node.Builder mergeMetadata(com.google.protobuf.Struct value)

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

.google.protobuf.Struct metadata = 3;

clearMetadata

public Node.Builder clearMetadata()

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

.google.protobuf.Struct metadata = 3;

getMetadataBuilder

public com.google.protobuf.Struct.Builder getMetadataBuilder()

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

.google.protobuf.Struct metadata = 3;

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

setLocality

public Node.Builder setLocality(Locality value)

 Locality specifying where the Envoy instance is running.
 

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

setLocality

public Node.Builder setLocality(Locality.Builder builderForValue)

 Locality specifying where the Envoy instance is running.
 

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

mergeLocality

public Node.Builder mergeLocality(Locality value)

 Locality specifying where the Envoy instance is running.
 

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

clearLocality

public Node.Builder clearLocality()

 Locality specifying where the Envoy instance is running.
 

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

getLocalityBuilder

public Locality.Builder getLocalityBuilder()

 Locality specifying where the Envoy instance is running.
 

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

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

setBuildVersion

public Node.Builder setBuildVersion(String value)

 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;

clearBuildVersion

public Node.Builder clearBuildVersion()

 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;

setBuildVersionBytes

public Node.Builder setBuildVersionBytes(com.google.protobuf.ByteString value)

 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;

setUnknownFields

public final Node.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Node.Builder>

mergeUnknownFields

public final Node.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Node.Builder>