io.envoyproxy.envoy.api.v2.DiscoveryRequestOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api Show documentation
There is a newer version: 1.0.47
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: envoy/api/v2/discovery.proto

package io.envoyproxy.envoy.api.v2;

public interface DiscoveryRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:envoy.api.v2.DiscoveryRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * 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;
   */
  java.lang.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;
   */
  com.google.protobuf.ByteString
      getVersionInfoBytes();

  /**
   *    * The node making the request.
   * 
   *
   * .envoy.api.v2.core.Node node = 2;
   */
  boolean hasNode();
  /**
   *    * The node making the request.
   * 
   *
   * .envoy.api.v2.core.Node node = 2;
   */
  io.envoyproxy.envoy.api.v2.core.Node getNode();
  /**
   *    * The node making the request.
   * 
   *
   * .envoy.api.v2.core.Node node = 2;
   */
  io.envoyproxy.envoy.api.v2.core.NodeOrBuilder getNodeOrBuilder();

  /**
   *    * 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 expect empty resource_names, since this is global
   * discovery for the Envoy instance. 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;
   */
  java.util.List
      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 expect empty resource_names, since this is global
   * discovery for the Envoy instance. 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;
   */
  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 expect empty resource_names, since this is global
   * discovery for the Envoy instance. 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;
   */
  java.lang.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 expect empty resource_names, since this is global
   * discovery for the Envoy instance. 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;
   */
  com.google.protobuf.ByteString
      getResourceNamesBytes(int index);

  /**
   *    * 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;
   */
  java.lang.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;
   */
  com.google.protobuf.ByteString
      getTypeUrlBytes();

  /**
   *    * nonce corresponding to DiscoveryResponse being ACK/NACKed. See above
   * discussion on version_info and the DiscoveryResponse nonce comment. This
   * may be empty if no nonce is available, e.g. at startup or for non-stream
   * xDS implementations.
   * 
   *
   * string response_nonce = 5;
   */
  java.lang.String getResponseNonce();
  /**
   *    * nonce corresponding to DiscoveryResponse being ACK/NACKed. See above
   * discussion on version_info and the DiscoveryResponse nonce comment. This
   * may be empty if no nonce is available, e.g. at startup or for non-stream
   * xDS implementations.
   * 
   *
   * string response_nonce = 5;
   */
  com.google.protobuf.ByteString
      getResponseNonceBytes();

  /**
   *    * 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;
   */
  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;
   */
  com.google.rpc.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;
   */
  com.google.rpc.StatusOrBuilder getErrorDetailOrBuilder();
}