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

Interface NodeOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Node, Node.Builder
    public interface NodeOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getId

        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;

      • getIdBytes

        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;

      • getCluster

        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;

      • getClusterBytes

        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;

      • hasMetadata

        boolean hasMetadata()
         Opaque metadata extending the node identifier. Envoy will pass this
 directly to the management server.
        .google.protobuf.Struct metadata = 3;

      • getMetadata

        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;

      • getMetadataOrBuilder

        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;

      • getDynamicParametersCount

        int getDynamicParametersCount()
         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;

      • containsDynamicParameters

        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;

      • getDynamicParametersMap

        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;

      • getDynamicParametersOrDefault

        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;

      • getDynamicParametersOrThrow

        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;

      • hasLocality

        boolean hasLocality()
         Locality specifying where the Envoy instance is running.
        .envoy.config.core.v3.Locality locality = 4;

      • getLocality

        Locality getLocality()
         Locality specifying where the Envoy instance is running.
        .envoy.config.core.v3.Locality locality = 4;

      • getLocalityOrBuilder

        LocalityOrBuilder getLocalityOrBuilder()
         Locality specifying where the Envoy instance is running.
        .envoy.config.core.v3.Locality locality = 4;

      • getUserAgentName

        String getUserAgentName()
         Free-form string that identifies the entity requesting config.
 E.g. "envoy" or "grpc"
        string user_agent_name = 6;

      • getUserAgentNameBytes

        com.google.protobuf.ByteString getUserAgentNameBytes()
         Free-form string that identifies the entity requesting config.
 E.g. "envoy" or "grpc"
        string user_agent_name = 6;

      • getUserAgentVersion

        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;

      • getUserAgentVersionBytes

        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;

      • hasUserAgentBuildVersion

        boolean hasUserAgentBuildVersion()
         Structured version of the entity requesting config.
        .envoy.config.core.v3.BuildVersion user_agent_build_version = 8;

      • getUserAgentBuildVersion

        BuildVersion getUserAgentBuildVersion()
         Structured version of the entity requesting config.
        .envoy.config.core.v3.BuildVersion user_agent_build_version = 8;

      • getUserAgentBuildVersionOrBuilder

        BuildVersionOrBuilder getUserAgentBuildVersionOrBuilder()
         Structured version of the entity requesting config.
        .envoy.config.core.v3.BuildVersion user_agent_build_version = 8;

      • getExtensionsList

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

      • getExtensions

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

      • getExtensionsCount

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

      • getExtensionsOrBuilderList

        List<? extends ExtensionOrBuilder> getExtensionsOrBuilderList()
         List of extensions and their versions supported by the node.
        repeated .envoy.config.core.v3.Extension extensions = 9;

      • getExtensionsOrBuilder

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

      • getClientFeaturesList

        List<String> 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;

      • getClientFeaturesCount

        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;

      • getClientFeatures

        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;

      • getClientFeaturesBytes

        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;

      • getListeningAddressesList

        @Deprecated
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"];

      • getListeningAddresses

        @Deprecated
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"];

      • getListeningAddressesCount

        @Deprecated
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"];

      • getListeningAddressesOrBuilderList

        @Deprecated
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"];

      • getListeningAddressesOrBuilder

        @Deprecated
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"];