Package io.envoyproxy.envoy.api.v2.core

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

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

      • 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_api_field_core.HealthCheck.HttpHealthCheck.service_name_matcher>`,
 :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;
        Returns:
        The cluster.

      • 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_api_field_core.HealthCheck.HttpHealthCheck.service_name_matcher>`,
 :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;
        Returns:
        The bytes for cluster.

      • hasMetadata

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

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

      • 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;

      • hasLocality

        boolean hasLocality()
         Locality specifying where the Envoy instance is running.
        .envoy.api.v2.core.Locality locality = 4;
        Returns:
        Whether the locality field is set.

      • getLocality

        Locality getLocality()
         Locality specifying where the Envoy instance is running.
        .envoy.api.v2.core.Locality locality = 4;
        Returns:
        The locality.

      • getLocalityOrBuilder

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

      • getBuildVersion

        @Deprecated
String getBuildVersion()
        Deprecated.
        envoy.api.v2.core.Node.build_version is deprecated. See envoy/api/v2/core/base.proto;l=165
         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.
        string build_version = 5 [deprecated = true];
        Returns:
        The buildVersion.

      • getBuildVersionBytes

        @Deprecated
com.google.protobuf.ByteString getBuildVersionBytes()
        Deprecated.
        envoy.api.v2.core.Node.build_version is deprecated. See envoy/api/v2/core/base.proto;l=165
         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.
        string build_version = 5 [deprecated = true];
        Returns:
        The bytes for buildVersion.

      • getUserAgentName

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

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

      • hasUserAgentVersion

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

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

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

      • hasUserAgentBuildVersion

        boolean hasUserAgentBuildVersion()
         Structured version of the entity requesting config.
        .envoy.api.v2.core.BuildVersion user_agent_build_version = 8;
        Returns:
        Whether the userAgentBuildVersion field is set.

      • getUserAgentBuildVersion

        BuildVersion getUserAgentBuildVersion()
         Structured version of the entity requesting config.
        .envoy.api.v2.core.BuildVersion user_agent_build_version = 8;
        Returns:
        The userAgentBuildVersion.

      • getUserAgentBuildVersionOrBuilder

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

      • getExtensionsList

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

      • getExtensions

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

      • getExtensionsCount

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

      • getExtensionsOrBuilderList

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

      • getExtensionsOrBuilder

        ExtensionOrBuilder getExtensionsOrBuilder​(int index)
         List of extensions and their versions supported by the node.
        repeated .envoy.api.v2.core.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;
        Returns:
        A list containing the clientFeatures.

      • 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;
        Returns:
        The count of clientFeatures.

      • 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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The clientFeatures at the given index.

      • 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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the clientFeatures at the given index.

      • getListeningAddressesList

        List<Address> getListeningAddressesList()
         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.api.v2.core.Address listening_addresses = 11;

      • getListeningAddresses

        Address getListeningAddresses​(int index)
         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.api.v2.core.Address listening_addresses = 11;

      • getListeningAddressesCount

        int getListeningAddressesCount()
         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.api.v2.core.Address listening_addresses = 11;

      • getListeningAddressesOrBuilderList

        List<? extends AddressOrBuilder> getListeningAddressesOrBuilderList()
         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.api.v2.core.Address listening_addresses = 11;

      • getListeningAddressesOrBuilder

        AddressOrBuilder getListeningAddressesOrBuilder​(int index)
         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.api.v2.core.Address listening_addresses = 11;