Interface DeltaDiscoveryRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
DeltaDiscoveryRequest, DeltaDiscoveryRequest.Builder

public interface DeltaDiscoveryRequestOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Informs the server of the versions of the resources the xDS client knows of, to enable the client to continue the same logical xDS session even in the face of gRPC stream reconnection.
    com.google.rpc.Status
    This is populated when the previous :ref:`DiscoveryResponse <envoy_v3_api_msg_service.discovery.v3.DiscoveryResponse>` failed to update configuration.
    com.google.rpc.StatusOrBuilder
    This is populated when the previous :ref:`DiscoveryResponse <envoy_v3_api_msg_service.discovery.v3.DiscoveryResponse>` failed to update configuration.
    Deprecated.
    int
    Informs the server of the versions of the resources the xDS client knows of, to enable the client to continue the same logical xDS session even in the face of gRPC stream reconnection.
    Informs the server of the versions of the resources the xDS client knows of, to enable the client to continue the same logical xDS session even in the face of gRPC stream reconnection.
    Informs the server of the versions of the resources the xDS client knows of, to enable the client to continue the same logical xDS session even in the face of gRPC stream reconnection.
    Informs the server of the versions of the resources the xDS client knows of, to enable the client to continue the same logical xDS session even in the face of gRPC stream reconnection.
    The node making the request.
    The node making the request.
    [#not-implemented-hide:] Alternative to ``resource_names_subscribe`` field that allows specifying dynamic parameters along with each resource name.
    int
    [#not-implemented-hide:] Alternative to ``resource_names_subscribe`` field that allows specifying dynamic parameters along with each resource name.
    [#not-implemented-hide:] Alternative to ``resource_names_subscribe`` field that allows specifying dynamic parameters along with each resource name.
    [#not-implemented-hide:] Alternative to ``resource_names_subscribe`` field that allows specifying dynamic parameters along with each resource name.
    [#not-implemented-hide:] Alternative to ``resource_names_subscribe`` field that allows specifying dynamic parameters along with each resource name.
    [#not-implemented-hide:] Alternative to ``resource_names_unsubscribe`` field that allows specifying dynamic parameters along with each resource name.
    int
    [#not-implemented-hide:] Alternative to ``resource_names_unsubscribe`` field that allows specifying dynamic parameters along with each resource name.
    [#not-implemented-hide:] Alternative to ``resource_names_unsubscribe`` field that allows specifying dynamic parameters along with each resource name.
    [#not-implemented-hide:] Alternative to ``resource_names_unsubscribe`` field that allows specifying dynamic parameters along with each resource name.
    [#not-implemented-hide:] Alternative to ``resource_names_unsubscribe`` field that allows specifying dynamic parameters along with each resource name.
    DeltaDiscoveryRequests allow the client to add or remove individual resources to the set of tracked resources in the context of a stream.
    com.google.protobuf.ByteString
    DeltaDiscoveryRequests allow the client to add or remove individual resources to the set of tracked resources in the context of a stream.
    int
    DeltaDiscoveryRequests allow the client to add or remove individual resources to the set of tracked resources in the context of a stream.
    DeltaDiscoveryRequests allow the client to add or remove individual resources to the set of tracked resources in the context of a stream.
    A list of Resource names to remove from the list of tracked resources.
    com.google.protobuf.ByteString
    A list of Resource names to remove from the list of tracked resources.
    int
    A list of Resource names to remove from the list of tracked resources.
    A list of Resource names to remove from the list of tracked resources.
    When the DeltaDiscoveryRequest is a ACK or NACK message in response to a previous DeltaDiscoveryResponse, the response_nonce must be the nonce in the DeltaDiscoveryResponse.
    com.google.protobuf.ByteString
    When the DeltaDiscoveryRequest is a ACK or NACK message in response to a previous DeltaDiscoveryResponse, the response_nonce must be the nonce in the DeltaDiscoveryResponse.
    Type of the resource that is being requested, e.g.
    com.google.protobuf.ByteString
    Type of the resource that is being requested, e.g.
    boolean
    This is populated when the previous :ref:`DiscoveryResponse <envoy_v3_api_msg_service.discovery.v3.DiscoveryResponse>` failed to update configuration.
    boolean
    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 Details

    • hasNode

      boolean hasNode()
       The node making the request.
       
      .envoy.config.core.v3.Node node = 1;
      Returns:
      Whether the node field is set.
    • getNode

      Node getNode()
       The node making the request.
       
      .envoy.config.core.v3.Node node = 1;
      Returns:
      The node.
    • getNodeOrBuilder

      NodeOrBuilder getNodeOrBuilder()
       The node making the request.
       
      .envoy.config.core.v3.Node node = 1;
    • getTypeUrl

      String getTypeUrl()
       Type of the resource that is being requested, e.g.
       ``type.googleapis.com/envoy.api.v2.ClusterLoadAssignment``. This does not need to be set if
       resources are only referenced via ``xds_resource_subscribe`` and
       ``xds_resources_unsubscribe``.
       
      string type_url = 2;
      Returns:
      The typeUrl.
    • getTypeUrlBytes

      com.google.protobuf.ByteString getTypeUrlBytes()
       Type of the resource that is being requested, e.g.
       ``type.googleapis.com/envoy.api.v2.ClusterLoadAssignment``. This does not need to be set if
       resources are only referenced via ``xds_resource_subscribe`` and
       ``xds_resources_unsubscribe``.
       
      string type_url = 2;
      Returns:
      The bytes for typeUrl.
    • getResourceNamesSubscribeList

      List<String> getResourceNamesSubscribeList()
       DeltaDiscoveryRequests allow the client to add or remove individual
       resources to the set of tracked resources in the context of a stream.
       All resource names in the resource_names_subscribe list are added to the
       set of tracked resources and all resource names in the resource_names_unsubscribe
       list are removed from the set of tracked resources.
      
       *Unlike* state-of-the-world xDS, an empty resource_names_subscribe or
       resource_names_unsubscribe list simply means that no resources are to be
       added or removed to the resource list.
       *Like* state-of-the-world xDS, the server must send updates for all tracked
       resources, but can also send updates for resources the client has not subscribed to.
      
       NOTE: the server must respond with all resources listed in resource_names_subscribe,
       even if it believes the client has the most recent version of them. The reason:
       the client may have dropped them, but then regained interest before it had a chance
       to send the unsubscribe message. See DeltaSubscriptionStateTest.RemoveThenAdd.
      
       These two fields can be set in any DeltaDiscoveryRequest, including ACKs
       and initial_resource_versions.
      
       A list of Resource names to add to the list of tracked resources.
       
      repeated string resource_names_subscribe = 3;
      Returns:
      A list containing the resourceNamesSubscribe.
    • getResourceNamesSubscribeCount

      int getResourceNamesSubscribeCount()
       DeltaDiscoveryRequests allow the client to add or remove individual
       resources to the set of tracked resources in the context of a stream.
       All resource names in the resource_names_subscribe list are added to the
       set of tracked resources and all resource names in the resource_names_unsubscribe
       list are removed from the set of tracked resources.
      
       *Unlike* state-of-the-world xDS, an empty resource_names_subscribe or
       resource_names_unsubscribe list simply means that no resources are to be
       added or removed to the resource list.
       *Like* state-of-the-world xDS, the server must send updates for all tracked
       resources, but can also send updates for resources the client has not subscribed to.
      
       NOTE: the server must respond with all resources listed in resource_names_subscribe,
       even if it believes the client has the most recent version of them. The reason:
       the client may have dropped them, but then regained interest before it had a chance
       to send the unsubscribe message. See DeltaSubscriptionStateTest.RemoveThenAdd.
      
       These two fields can be set in any DeltaDiscoveryRequest, including ACKs
       and initial_resource_versions.
      
       A list of Resource names to add to the list of tracked resources.
       
      repeated string resource_names_subscribe = 3;
      Returns:
      The count of resourceNamesSubscribe.
    • getResourceNamesSubscribe

      String getResourceNamesSubscribe(int index)
       DeltaDiscoveryRequests allow the client to add or remove individual
       resources to the set of tracked resources in the context of a stream.
       All resource names in the resource_names_subscribe list are added to the
       set of tracked resources and all resource names in the resource_names_unsubscribe
       list are removed from the set of tracked resources.
      
       *Unlike* state-of-the-world xDS, an empty resource_names_subscribe or
       resource_names_unsubscribe list simply means that no resources are to be
       added or removed to the resource list.
       *Like* state-of-the-world xDS, the server must send updates for all tracked
       resources, but can also send updates for resources the client has not subscribed to.
      
       NOTE: the server must respond with all resources listed in resource_names_subscribe,
       even if it believes the client has the most recent version of them. The reason:
       the client may have dropped them, but then regained interest before it had a chance
       to send the unsubscribe message. See DeltaSubscriptionStateTest.RemoveThenAdd.
      
       These two fields can be set in any DeltaDiscoveryRequest, including ACKs
       and initial_resource_versions.
      
       A list of Resource names to add to the list of tracked resources.
       
      repeated string resource_names_subscribe = 3;
      Parameters:
      index - The index of the element to return.
      Returns:
      The resourceNamesSubscribe at the given index.
    • getResourceNamesSubscribeBytes

      com.google.protobuf.ByteString getResourceNamesSubscribeBytes(int index)
       DeltaDiscoveryRequests allow the client to add or remove individual
       resources to the set of tracked resources in the context of a stream.
       All resource names in the resource_names_subscribe list are added to the
       set of tracked resources and all resource names in the resource_names_unsubscribe
       list are removed from the set of tracked resources.
      
       *Unlike* state-of-the-world xDS, an empty resource_names_subscribe or
       resource_names_unsubscribe list simply means that no resources are to be
       added or removed to the resource list.
       *Like* state-of-the-world xDS, the server must send updates for all tracked
       resources, but can also send updates for resources the client has not subscribed to.
      
       NOTE: the server must respond with all resources listed in resource_names_subscribe,
       even if it believes the client has the most recent version of them. The reason:
       the client may have dropped them, but then regained interest before it had a chance
       to send the unsubscribe message. See DeltaSubscriptionStateTest.RemoveThenAdd.
      
       These two fields can be set in any DeltaDiscoveryRequest, including ACKs
       and initial_resource_versions.
      
       A list of Resource names to add to the list of tracked resources.
       
      repeated string resource_names_subscribe = 3;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the resourceNamesSubscribe at the given index.
    • getResourceNamesUnsubscribeList

      List<String> getResourceNamesUnsubscribeList()
       A list of Resource names to remove from the list of tracked resources.
       
      repeated string resource_names_unsubscribe = 4;
      Returns:
      A list containing the resourceNamesUnsubscribe.
    • getResourceNamesUnsubscribeCount

      int getResourceNamesUnsubscribeCount()
       A list of Resource names to remove from the list of tracked resources.
       
      repeated string resource_names_unsubscribe = 4;
      Returns:
      The count of resourceNamesUnsubscribe.
    • getResourceNamesUnsubscribe

      String getResourceNamesUnsubscribe(int index)
       A list of Resource names to remove from the list of tracked resources.
       
      repeated string resource_names_unsubscribe = 4;
      Parameters:
      index - The index of the element to return.
      Returns:
      The resourceNamesUnsubscribe at the given index.
    • getResourceNamesUnsubscribeBytes

      com.google.protobuf.ByteString getResourceNamesUnsubscribeBytes(int index)
       A list of Resource names to remove from the list of tracked resources.
       
      repeated string resource_names_unsubscribe = 4;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the resourceNamesUnsubscribe at the given index.
    • getResourceLocatorsSubscribeList

      List<ResourceLocator> getResourceLocatorsSubscribeList()
       [#not-implemented-hide:]
       Alternative to ``resource_names_subscribe`` field that allows specifying dynamic parameters
       along with each resource name.
       Note that it is legal for a request to have some resources listed
       in ``resource_names_subscribe`` and others in ``resource_locators_subscribe``.
       
      repeated .envoy.service.discovery.v3.ResourceLocator resource_locators_subscribe = 8;
    • getResourceLocatorsSubscribe

      ResourceLocator getResourceLocatorsSubscribe(int index)
       [#not-implemented-hide:]
       Alternative to ``resource_names_subscribe`` field that allows specifying dynamic parameters
       along with each resource name.
       Note that it is legal for a request to have some resources listed
       in ``resource_names_subscribe`` and others in ``resource_locators_subscribe``.
       
      repeated .envoy.service.discovery.v3.ResourceLocator resource_locators_subscribe = 8;
    • getResourceLocatorsSubscribeCount

      int getResourceLocatorsSubscribeCount()
       [#not-implemented-hide:]
       Alternative to ``resource_names_subscribe`` field that allows specifying dynamic parameters
       along with each resource name.
       Note that it is legal for a request to have some resources listed
       in ``resource_names_subscribe`` and others in ``resource_locators_subscribe``.
       
      repeated .envoy.service.discovery.v3.ResourceLocator resource_locators_subscribe = 8;
    • getResourceLocatorsSubscribeOrBuilderList

      List<? extends ResourceLocatorOrBuilder> getResourceLocatorsSubscribeOrBuilderList()
       [#not-implemented-hide:]
       Alternative to ``resource_names_subscribe`` field that allows specifying dynamic parameters
       along with each resource name.
       Note that it is legal for a request to have some resources listed
       in ``resource_names_subscribe`` and others in ``resource_locators_subscribe``.
       
      repeated .envoy.service.discovery.v3.ResourceLocator resource_locators_subscribe = 8;
    • getResourceLocatorsSubscribeOrBuilder

      ResourceLocatorOrBuilder getResourceLocatorsSubscribeOrBuilder(int index)
       [#not-implemented-hide:]
       Alternative to ``resource_names_subscribe`` field that allows specifying dynamic parameters
       along with each resource name.
       Note that it is legal for a request to have some resources listed
       in ``resource_names_subscribe`` and others in ``resource_locators_subscribe``.
       
      repeated .envoy.service.discovery.v3.ResourceLocator resource_locators_subscribe = 8;
    • getResourceLocatorsUnsubscribeList

      List<ResourceLocator> getResourceLocatorsUnsubscribeList()
       [#not-implemented-hide:]
       Alternative to ``resource_names_unsubscribe`` field that allows specifying dynamic parameters
       along with each resource name.
       Note that it is legal for a request to have some resources listed
       in ``resource_names_unsubscribe`` and others in ``resource_locators_unsubscribe``.
       
      repeated .envoy.service.discovery.v3.ResourceLocator resource_locators_unsubscribe = 9;
    • getResourceLocatorsUnsubscribe

      ResourceLocator getResourceLocatorsUnsubscribe(int index)
       [#not-implemented-hide:]
       Alternative to ``resource_names_unsubscribe`` field that allows specifying dynamic parameters
       along with each resource name.
       Note that it is legal for a request to have some resources listed
       in ``resource_names_unsubscribe`` and others in ``resource_locators_unsubscribe``.
       
      repeated .envoy.service.discovery.v3.ResourceLocator resource_locators_unsubscribe = 9;
    • getResourceLocatorsUnsubscribeCount

      int getResourceLocatorsUnsubscribeCount()
       [#not-implemented-hide:]
       Alternative to ``resource_names_unsubscribe`` field that allows specifying dynamic parameters
       along with each resource name.
       Note that it is legal for a request to have some resources listed
       in ``resource_names_unsubscribe`` and others in ``resource_locators_unsubscribe``.
       
      repeated .envoy.service.discovery.v3.ResourceLocator resource_locators_unsubscribe = 9;
    • getResourceLocatorsUnsubscribeOrBuilderList

      List<? extends ResourceLocatorOrBuilder> getResourceLocatorsUnsubscribeOrBuilderList()
       [#not-implemented-hide:]
       Alternative to ``resource_names_unsubscribe`` field that allows specifying dynamic parameters
       along with each resource name.
       Note that it is legal for a request to have some resources listed
       in ``resource_names_unsubscribe`` and others in ``resource_locators_unsubscribe``.
       
      repeated .envoy.service.discovery.v3.ResourceLocator resource_locators_unsubscribe = 9;
    • getResourceLocatorsUnsubscribeOrBuilder

      ResourceLocatorOrBuilder getResourceLocatorsUnsubscribeOrBuilder(int index)
       [#not-implemented-hide:]
       Alternative to ``resource_names_unsubscribe`` field that allows specifying dynamic parameters
       along with each resource name.
       Note that it is legal for a request to have some resources listed
       in ``resource_names_unsubscribe`` and others in ``resource_locators_unsubscribe``.
       
      repeated .envoy.service.discovery.v3.ResourceLocator resource_locators_unsubscribe = 9;
    • getInitialResourceVersionsCount

      int getInitialResourceVersionsCount()
       Informs the server of the versions of the resources the xDS client knows of, to enable the
       client to continue the same logical xDS session even in the face of gRPC stream reconnection.
       It will not be populated: [1] in the very first stream of a session, since the client will
       not yet have any resources,  [2] in any message after the first in a stream (for a given
       type_url), since the server will already be correctly tracking the client's state.
       (In ADS, the first message *of each type_url* of a reconnected stream populates this map.)
       The map's keys are names of xDS resources known to the xDS client.
       The map's values are opaque resource versions.
       
      map<string, string> initial_resource_versions = 5;
    • containsInitialResourceVersions

      boolean containsInitialResourceVersions(String key)
       Informs the server of the versions of the resources the xDS client knows of, to enable the
       client to continue the same logical xDS session even in the face of gRPC stream reconnection.
       It will not be populated: [1] in the very first stream of a session, since the client will
       not yet have any resources,  [2] in any message after the first in a stream (for a given
       type_url), since the server will already be correctly tracking the client's state.
       (In ADS, the first message *of each type_url* of a reconnected stream populates this map.)
       The map's keys are names of xDS resources known to the xDS client.
       The map's values are opaque resource versions.
       
      map<string, string> initial_resource_versions = 5;
    • getInitialResourceVersions

      @Deprecated Map<String,String> getInitialResourceVersions()
      Deprecated.
    • getInitialResourceVersionsMap

      Map<String,String> getInitialResourceVersionsMap()
       Informs the server of the versions of the resources the xDS client knows of, to enable the
       client to continue the same logical xDS session even in the face of gRPC stream reconnection.
       It will not be populated: [1] in the very first stream of a session, since the client will
       not yet have any resources,  [2] in any message after the first in a stream (for a given
       type_url), since the server will already be correctly tracking the client's state.
       (In ADS, the first message *of each type_url* of a reconnected stream populates this map.)
       The map's keys are names of xDS resources known to the xDS client.
       The map's values are opaque resource versions.
       
      map<string, string> initial_resource_versions = 5;
    • getInitialResourceVersionsOrDefault

      String getInitialResourceVersionsOrDefault(String key, String defaultValue)
       Informs the server of the versions of the resources the xDS client knows of, to enable the
       client to continue the same logical xDS session even in the face of gRPC stream reconnection.
       It will not be populated: [1] in the very first stream of a session, since the client will
       not yet have any resources,  [2] in any message after the first in a stream (for a given
       type_url), since the server will already be correctly tracking the client's state.
       (In ADS, the first message *of each type_url* of a reconnected stream populates this map.)
       The map's keys are names of xDS resources known to the xDS client.
       The map's values are opaque resource versions.
       
      map<string, string> initial_resource_versions = 5;
    • getInitialResourceVersionsOrThrow

      String getInitialResourceVersionsOrThrow(String key)
       Informs the server of the versions of the resources the xDS client knows of, to enable the
       client to continue the same logical xDS session even in the face of gRPC stream reconnection.
       It will not be populated: [1] in the very first stream of a session, since the client will
       not yet have any resources,  [2] in any message after the first in a stream (for a given
       type_url), since the server will already be correctly tracking the client's state.
       (In ADS, the first message *of each type_url* of a reconnected stream populates this map.)
       The map's keys are names of xDS resources known to the xDS client.
       The map's values are opaque resource versions.
       
      map<string, string> initial_resource_versions = 5;
    • getResponseNonce

      String getResponseNonce()
       When the DeltaDiscoveryRequest is a ACK or NACK message in response
       to a previous DeltaDiscoveryResponse, the response_nonce must be the
       nonce in the DeltaDiscoveryResponse.
       Otherwise (unlike in DiscoveryRequest) response_nonce must be omitted.
       
      string response_nonce = 6;
      Returns:
      The responseNonce.
    • getResponseNonceBytes

      com.google.protobuf.ByteString getResponseNonceBytes()
       When the DeltaDiscoveryRequest is a ACK or NACK message in response
       to a previous DeltaDiscoveryResponse, the response_nonce must be the
       nonce in the DeltaDiscoveryResponse.
       Otherwise (unlike in DiscoveryRequest) response_nonce must be omitted.
       
      string response_nonce = 6;
      Returns:
      The bytes for responseNonce.
    • hasErrorDetail

      boolean hasErrorDetail()
       This is populated when the previous :ref:`DiscoveryResponse <envoy_v3_api_msg_service.discovery.v3.DiscoveryResponse>`
       failed to update configuration. The ``message`` field in ``error_details``
       provides the Envoy internal exception related to the failure.
       
      .google.rpc.Status error_detail = 7;
      Returns:
      Whether the errorDetail field is set.
    • getErrorDetail

      com.google.rpc.Status getErrorDetail()
       This is populated when the previous :ref:`DiscoveryResponse <envoy_v3_api_msg_service.discovery.v3.DiscoveryResponse>`
       failed to update configuration. The ``message`` field in ``error_details``
       provides the Envoy internal exception related to the failure.
       
      .google.rpc.Status error_detail = 7;
      Returns:
      The errorDetail.
    • getErrorDetailOrBuilder

      com.google.rpc.StatusOrBuilder getErrorDetailOrBuilder()
       This is populated when the previous :ref:`DiscoveryResponse <envoy_v3_api_msg_service.discovery.v3.DiscoveryResponse>`
       failed to update configuration. The ``message`` field in ``error_details``
       provides the Envoy internal exception related to the failure.
       
      .google.rpc.Status error_detail = 7;