Package io.envoyproxy.envoy.config.core.v3

Class 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.
 [#next-free-field: 13]
    Protobuf type envoy.config.core.v3.Node
    See Also:
    Serialized Form

    • Field Detail

      • DYNAMIC_PARAMETERS_FIELD_NUMBER

        public static final int DYNAMIC_PARAMETERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • USER_AGENT_NAME_FIELD_NUMBER

        public static final int USER_AGENT_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • USER_AGENT_VERSION_FIELD_NUMBER

        public static final int USER_AGENT_VERSION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • USER_AGENT_BUILD_VERSION_FIELD_NUMBER

        public static final int USER_AGENT_BUILD_VERSION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXTENSIONS_FIELD_NUMBER

        public static final int EXTENSIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CLIENT_FEATURES_FIELD_NUMBER

        public static final int CLIENT_FEATURES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LISTENING_ADDRESSES_FIELD_NUMBER

        public static final int LISTENING_ADDRESSES_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • 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()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • 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
        Returns:
        The id.

      • 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
        Returns:
        The bytes for id.

      • 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_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.service_name_matcher>`,
 :ref:`runtime override directory <envoy_v3_api_msg_config.bootstrap.v3.Runtime>`,
 :ref:`user agent addition
 <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.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
        Returns:
        The cluster.

      • 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_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.service_name_matcher>`,
 :ref:`runtime override directory <envoy_v3_api_msg_config.bootstrap.v3.Runtime>`,
 :ref:`user agent addition
 <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.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
        Returns:
        The bytes for cluster.

      • 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
        Returns:
        Whether the metadata field is set.

      • 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
        Returns:
        The metadata.

      • 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

      • getDynamicParametersCount

        public int getDynamicParametersCount()
        Description copied from interface: NodeOrBuilder
         Map from xDS resource type URL to dynamic context parameters. These may vary at runtime (unlike
 other fields in this message). For example, the xDS client may have a shard identifier that
 changes during the lifetime of the xDS client. In Envoy, this would be achieved by updating the
 dynamic context on the Server::Instance's LocalInfo context provider. The shard ID dynamic
 parameter then appears in this field during future discovery requests.
        map<string, .xds.core.v3.ContextParams> dynamic_parameters = 12;
        Specified by:
        getDynamicParametersCount in interface NodeOrBuilder

      • containsDynamicParameters

        public boolean containsDynamicParameters​(String key)
         Map from xDS resource type URL to dynamic context parameters. These may vary at runtime (unlike
 other fields in this message). For example, the xDS client may have a shard identifier that
 changes during the lifetime of the xDS client. In Envoy, this would be achieved by updating the
 dynamic context on the Server::Instance's LocalInfo context provider. The shard ID dynamic
 parameter then appears in this field during future discovery requests.
        map<string, .xds.core.v3.ContextParams> dynamic_parameters = 12;
        Specified by:
        containsDynamicParameters in interface NodeOrBuilder

      • getDynamicParametersMap

        public Map<String,​ContextParams> getDynamicParametersMap()
         Map from xDS resource type URL to dynamic context parameters. These may vary at runtime (unlike
 other fields in this message). For example, the xDS client may have a shard identifier that
 changes during the lifetime of the xDS client. In Envoy, this would be achieved by updating the
 dynamic context on the Server::Instance's LocalInfo context provider. The shard ID dynamic
 parameter then appears in this field during future discovery requests.
        map<string, .xds.core.v3.ContextParams> dynamic_parameters = 12;
        Specified by:
        getDynamicParametersMap in interface NodeOrBuilder

      • getDynamicParametersOrDefault

        public ContextParams getDynamicParametersOrDefault​(String key,
                                                   ContextParams defaultValue)
         Map from xDS resource type URL to dynamic context parameters. These may vary at runtime (unlike
 other fields in this message). For example, the xDS client may have a shard identifier that
 changes during the lifetime of the xDS client. In Envoy, this would be achieved by updating the
 dynamic context on the Server::Instance's LocalInfo context provider. The shard ID dynamic
 parameter then appears in this field during future discovery requests.
        map<string, .xds.core.v3.ContextParams> dynamic_parameters = 12;
        Specified by:
        getDynamicParametersOrDefault in interface NodeOrBuilder

      • getDynamicParametersOrThrow

        public ContextParams getDynamicParametersOrThrow​(String key)
         Map from xDS resource type URL to dynamic context parameters. These may vary at runtime (unlike
 other fields in this message). For example, the xDS client may have a shard identifier that
 changes during the lifetime of the xDS client. In Envoy, this would be achieved by updating the
 dynamic context on the Server::Instance's LocalInfo context provider. The shard ID dynamic
 parameter then appears in this field during future discovery requests.
        map<string, .xds.core.v3.ContextParams> dynamic_parameters = 12;
        Specified by:
        getDynamicParametersOrThrow in interface NodeOrBuilder

      • hasLocality

        public boolean hasLocality()
         Locality specifying where the Envoy instance is running.
        .envoy.config.core.v3.Locality locality = 4;
        Specified by:
        hasLocality in interface NodeOrBuilder
        Returns:
        Whether the locality field is set.

      • getLocality

        public Locality getLocality()
         Locality specifying where the Envoy instance is running.
        .envoy.config.core.v3.Locality locality = 4;
        Specified by:
        getLocality in interface NodeOrBuilder
        Returns:
        The locality.

      • getUserAgentName

        public String getUserAgentName()
         Free-form string that identifies the entity requesting config.
 E.g. "envoy" or "grpc"
        string user_agent_name = 6;
        Specified by:
        getUserAgentName in interface NodeOrBuilder
        Returns:
        The userAgentName.

      • getUserAgentNameBytes

        public com.google.protobuf.ByteString getUserAgentNameBytes()
         Free-form string that identifies the entity requesting config.
 E.g. "envoy" or "grpc"
        string user_agent_name = 6;
        Specified by:
        getUserAgentNameBytes in interface NodeOrBuilder
        Returns:
        The bytes for userAgentName.

      • hasUserAgentVersion

        public boolean hasUserAgentVersion()
         Free-form string that identifies the version of the entity requesting config.
 E.g. "1.12.2" or "abcd1234", or "SpecialEnvoyBuild"
        string user_agent_version = 7;
        Specified by:
        hasUserAgentVersion in interface NodeOrBuilder
        Returns:
        Whether the userAgentVersion field is set.

      • getUserAgentVersion

        public String getUserAgentVersion()
         Free-form string that identifies the version of the entity requesting config.
 E.g. "1.12.2" or "abcd1234", or "SpecialEnvoyBuild"
        string user_agent_version = 7;
        Specified by:
        getUserAgentVersion in interface NodeOrBuilder
        Returns:
        The userAgentVersion.

      • getUserAgentVersionBytes

        public com.google.protobuf.ByteString getUserAgentVersionBytes()
         Free-form string that identifies the version of the entity requesting config.
 E.g. "1.12.2" or "abcd1234", or "SpecialEnvoyBuild"
        string user_agent_version = 7;
        Specified by:
        getUserAgentVersionBytes in interface NodeOrBuilder
        Returns:
        The bytes for userAgentVersion.

      • hasUserAgentBuildVersion

        public boolean hasUserAgentBuildVersion()
         Structured version of the entity requesting config.
        .envoy.config.core.v3.BuildVersion user_agent_build_version = 8;
        Specified by:
        hasUserAgentBuildVersion in interface NodeOrBuilder
        Returns:
        Whether the userAgentBuildVersion field is set.

      • getUserAgentBuildVersion

        public BuildVersion getUserAgentBuildVersion()
         Structured version of the entity requesting config.
        .envoy.config.core.v3.BuildVersion user_agent_build_version = 8;
        Specified by:
        getUserAgentBuildVersion in interface NodeOrBuilder
        Returns:
        The userAgentBuildVersion.

      • getExtensionsList

        public List<Extension> getExtensionsList()
         List of extensions and their versions supported by the node.
        repeated .envoy.config.core.v3.Extension extensions = 9;
        Specified by:
        getExtensionsList in interface NodeOrBuilder

      • getExtensionsCount

        public int getExtensionsCount()
         List of extensions and their versions supported by the node.
        repeated .envoy.config.core.v3.Extension extensions = 9;
        Specified by:
        getExtensionsCount in interface NodeOrBuilder

      • getExtensions

        public Extension getExtensions​(int index)
         List of extensions and their versions supported by the node.
        repeated .envoy.config.core.v3.Extension extensions = 9;
        Specified by:
        getExtensions in interface NodeOrBuilder

      • getExtensionsOrBuilder

        public ExtensionOrBuilder getExtensionsOrBuilder​(int index)
         List of extensions and their versions supported by the node.
        repeated .envoy.config.core.v3.Extension extensions = 9;
        Specified by:
        getExtensionsOrBuilder in interface NodeOrBuilder

      • getClientFeaturesList

        public com.google.protobuf.ProtocolStringList getClientFeaturesList()
         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 <client_features>` that xDS client may
 support.
        repeated string client_features = 10;
        Specified by:
        getClientFeaturesList in interface NodeOrBuilder
        Returns:
        A list containing the clientFeatures.

      • getClientFeaturesCount

        public int getClientFeaturesCount()
         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 <client_features>` that xDS client may
 support.
        repeated string client_features = 10;
        Specified by:
        getClientFeaturesCount in interface NodeOrBuilder
        Returns:
        The count of clientFeatures.

      • getClientFeatures

        public String getClientFeatures​(int index)
         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 <client_features>` that xDS client may
 support.
        repeated string client_features = 10;
        Specified by:
        getClientFeatures in interface NodeOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The clientFeatures at the given index.

      • getClientFeaturesBytes

        public com.google.protobuf.ByteString getClientFeaturesBytes​(int index)
         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 <client_features>` that xDS client may
 support.
        repeated string client_features = 10;
        Specified by:
        getClientFeaturesBytes in interface NodeOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the clientFeatures at the given index.

      • getListeningAddressesList

        @Deprecated
public List<Address> getListeningAddressesList()
        Deprecated.
         Known listening ports on the node as a generic hint to the management server
 for filtering :ref:`listeners <config_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.
        repeated .envoy.config.core.v3.Address listening_addresses = 11 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getListeningAddressesList in interface NodeOrBuilder

      • getListeningAddressesOrBuilderList

        @Deprecated
public List<? extends AddressOrBuilder> getListeningAddressesOrBuilderList()
        Deprecated.
         Known listening ports on the node as a generic hint to the management server
 for filtering :ref:`listeners <config_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.
        repeated .envoy.config.core.v3.Address listening_addresses = 11 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getListeningAddressesOrBuilderList in interface NodeOrBuilder

      • getListeningAddressesCount

        @Deprecated
public int getListeningAddressesCount()
        Deprecated.
         Known listening ports on the node as a generic hint to the management server
 for filtering :ref:`listeners <config_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.
        repeated .envoy.config.core.v3.Address listening_addresses = 11 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getListeningAddressesCount in interface NodeOrBuilder

      • getListeningAddresses

        @Deprecated
public Address getListeningAddresses​(int index)
        Deprecated.
         Known listening ports on the node as a generic hint to the management server
 for filtering :ref:`listeners <config_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.
        repeated .envoy.config.core.v3.Address listening_addresses = 11 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getListeningAddresses in interface NodeOrBuilder

      • getListeningAddressesOrBuilder

        @Deprecated
public AddressOrBuilder getListeningAddressesOrBuilder​(int index)
        Deprecated.
         Known listening ports on the node as a generic hint to the management server
 for filtering :ref:`listeners <config_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.
        repeated .envoy.config.core.v3.Address listening_addresses = 11 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getListeningAddressesOrBuilder 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​(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

      • 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