Package io.envoyproxy.envoy.api.v2

Interface DiscoveryRequestOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Status getErrorDetail()
      This is populated when the previous :ref:`DiscoveryResponse <envoy_api_msg_DiscoveryResponse>` failed to update configuration.
      StatusOrBuilder getErrorDetailOrBuilder()
      This is populated when the previous :ref:`DiscoveryResponse <envoy_api_msg_DiscoveryResponse>` failed to update configuration.
      Node getNode()
      The node making the request.
      NodeOrBuilder getNodeOrBuilder()
      The node making the request.
      String getResourceNames​(int index)
      List of resources to subscribe to, e.g. list of cluster names or a route configuration name.
      com.google.protobuf.ByteString getResourceNamesBytes​(int index)
      List of resources to subscribe to, e.g. list of cluster names or a route configuration name.
      int getResourceNamesCount()
      List of resources to subscribe to, e.g. list of cluster names or a route configuration name.
      List<String> getResourceNamesList()
      List of resources to subscribe to, e.g. list of cluster names or a route configuration name.
      String getResponseNonce()
      nonce corresponding to DiscoveryResponse being ACK/NACKed.
      com.google.protobuf.ByteString getResponseNonceBytes()
      nonce corresponding to DiscoveryResponse being ACK/NACKed.
      String getTypeUrl()
      Type of the resource that is being requested, e.g.
      com.google.protobuf.ByteString getTypeUrlBytes()
      Type of the resource that is being requested, e.g.
      String getVersionInfo()
      The version_info provided in the request messages will be the version_info received with the most recent successfully processed response or empty on the first request.
      com.google.protobuf.ByteString getVersionInfoBytes()
      The version_info provided in the request messages will be the version_info received with the most recent successfully processed response or empty on the first request.
      boolean hasErrorDetail()
      This is populated when the previous :ref:`DiscoveryResponse <envoy_api_msg_DiscoveryResponse>` failed to update configuration.
      boolean hasNode()
      The node making the request.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • getVersionInfo

        String getVersionInfo()
         The version_info provided in the request messages will be the version_info
 received with the most recent successfully processed response or empty on
 the first request. It is expected that no new request is sent after a
 response is received until the Envoy instance is ready to ACK/NACK the new
 configuration. ACK/NACK takes place by returning the new API config version
 as applied or the previous API config version respectively. Each type_url
 (see below) has an independent version associated with it.
        string version_info = 1;

      • getVersionInfoBytes

        com.google.protobuf.ByteString getVersionInfoBytes()
         The version_info provided in the request messages will be the version_info
 received with the most recent successfully processed response or empty on
 the first request. It is expected that no new request is sent after a
 response is received until the Envoy instance is ready to ACK/NACK the new
 configuration. ACK/NACK takes place by returning the new API config version
 as applied or the previous API config version respectively. Each type_url
 (see below) has an independent version associated with it.
        string version_info = 1;

      • hasNode

        boolean hasNode()
         The node making the request.
        .envoy.api.v2.core.Node node = 2;

      • getNode

        Node getNode()
         The node making the request.
        .envoy.api.v2.core.Node node = 2;

      • getNodeOrBuilder

        NodeOrBuilder getNodeOrBuilder()
         The node making the request.
        .envoy.api.v2.core.Node node = 2;

      • getResourceNamesList

        List<String> getResourceNamesList()
         List of resources to subscribe to, e.g. list of cluster names or a route
 configuration name. If this is empty, all resources for the API are
 returned. LDS/CDS may have empty resource_names, which will cause all
 resources for the Envoy instance to be returned. The LDS and CDS responses
 will then imply a number of resources that need to be fetched via EDS/RDS,
 which will be explicitly enumerated in resource_names.
        repeated string resource_names = 3;

      • getResourceNamesCount

        int getResourceNamesCount()
         List of resources to subscribe to, e.g. list of cluster names or a route
 configuration name. If this is empty, all resources for the API are
 returned. LDS/CDS may have empty resource_names, which will cause all
 resources for the Envoy instance to be returned. The LDS and CDS responses
 will then imply a number of resources that need to be fetched via EDS/RDS,
 which will be explicitly enumerated in resource_names.
        repeated string resource_names = 3;

      • getResourceNames

        String getResourceNames​(int index)
         List of resources to subscribe to, e.g. list of cluster names or a route
 configuration name. If this is empty, all resources for the API are
 returned. LDS/CDS may have empty resource_names, which will cause all
 resources for the Envoy instance to be returned. The LDS and CDS responses
 will then imply a number of resources that need to be fetched via EDS/RDS,
 which will be explicitly enumerated in resource_names.
        repeated string resource_names = 3;

      • getResourceNamesBytes

        com.google.protobuf.ByteString getResourceNamesBytes​(int index)
         List of resources to subscribe to, e.g. list of cluster names or a route
 configuration name. If this is empty, all resources for the API are
 returned. LDS/CDS may have empty resource_names, which will cause all
 resources for the Envoy instance to be returned. The LDS and CDS responses
 will then imply a number of resources that need to be fetched via EDS/RDS,
 which will be explicitly enumerated in resource_names.
        repeated string resource_names = 3;

      • getTypeUrl

        String getTypeUrl()
         Type of the resource that is being requested, e.g.
 "type.googleapis.com/envoy.api.v2.ClusterLoadAssignment". This is implicit
 in requests made via singleton xDS APIs such as CDS, LDS, etc. but is
 required for ADS.
        string type_url = 4;

      • getTypeUrlBytes

        com.google.protobuf.ByteString getTypeUrlBytes()
         Type of the resource that is being requested, e.g.
 "type.googleapis.com/envoy.api.v2.ClusterLoadAssignment". This is implicit
 in requests made via singleton xDS APIs such as CDS, LDS, etc. but is
 required for ADS.
        string type_url = 4;

      • getResponseNonce

        String getResponseNonce()
         nonce corresponding to DiscoveryResponse being ACK/NACKed. See above
 discussion on version_info and the DiscoveryResponse nonce comment. This
 may be empty only if 1) this is a non-persistent-stream xDS such as HTTP,
 or 2) the client has not yet accepted an update in this xDS stream (unlike
 delta, where it is populated only for new explicit ACKs).
        string response_nonce = 5;

      • getResponseNonceBytes

        com.google.protobuf.ByteString getResponseNonceBytes()
         nonce corresponding to DiscoveryResponse being ACK/NACKed. See above
 discussion on version_info and the DiscoveryResponse nonce comment. This
 may be empty only if 1) this is a non-persistent-stream xDS such as HTTP,
 or 2) the client has not yet accepted an update in this xDS stream (unlike
 delta, where it is populated only for new explicit ACKs).
        string response_nonce = 5;

      • hasErrorDetail

        boolean hasErrorDetail()
         This is populated when the previous :ref:`DiscoveryResponse <envoy_api_msg_DiscoveryResponse>`
 failed to update configuration. The *message* field in *error_details* provides the Envoy
 internal exception related to the failure. It is only intended for consumption during manual
 debugging, the string provided is not guaranteed to be stable across Envoy versions.
        .google.rpc.Status error_detail = 6;

      • getErrorDetail

        Status getErrorDetail()
         This is populated when the previous :ref:`DiscoveryResponse <envoy_api_msg_DiscoveryResponse>`
 failed to update configuration. The *message* field in *error_details* provides the Envoy
 internal exception related to the failure. It is only intended for consumption during manual
 debugging, the string provided is not guaranteed to be stable across Envoy versions.
        .google.rpc.Status error_detail = 6;

      • getErrorDetailOrBuilder

        StatusOrBuilder getErrorDetailOrBuilder()
         This is populated when the previous :ref:`DiscoveryResponse <envoy_api_msg_DiscoveryResponse>`
 failed to update configuration. The *message* field in *error_details* provides the Envoy
 internal exception related to the failure. It is only intended for consumption during manual
 debugging, the string provided is not guaranteed to be stable across Envoy versions.
        .google.rpc.Status error_detail = 6;