Package io.envoyproxy.envoy.service.discovery.v3

Class DeltaDiscoveryRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.service.discovery.v3.DeltaDiscoveryRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, DeltaDiscoveryRequestOrBuilder, Serializable
public final class DeltaDiscoveryRequest extends com.google.protobuf.GeneratedMessageV3 implements DeltaDiscoveryRequestOrBuilder
 DeltaDiscoveryRequest and DeltaDiscoveryResponse are used in a new gRPC
 endpoint for Delta xDS.

 With Delta xDS, the DeltaDiscoveryResponses do not need to include a full
 snapshot of the tracked resources. Instead, DeltaDiscoveryResponses are a
 diff to the state of a xDS client.
 In Delta XDS there are per-resource versions, which allow tracking state at
 the resource granularity.
 An xDS Delta session is always in the context of a gRPC bidirectional
 stream. This allows the xDS server to keep track of the state of xDS clients
 connected to it.

 In Delta xDS the nonce field is required and used to pair
 ``DeltaDiscoveryResponse`` to a ``DeltaDiscoveryRequest`` ACK or NACK.
 Optionally, a response message level ``system_version_info`` is present for
 debugging purposes only.

 ``DeltaDiscoveryRequest`` plays two independent roles. Any ``DeltaDiscoveryRequest``
 can be either or both of:

 * Informing the server of what resources the client has gained/lost interest in
   (using ``resource_names_subscribe`` and ``resource_names_unsubscribe``), or
 * (N)ACKing an earlier resource update from the server (using ``response_nonce``,
   with presence of ``error_detail`` making it a NACK).

 Additionally, the first message (for a given ``type_url``) of a reconnected gRPC stream
 has a third role: informing the server of the resources (and their versions)
 that the client already possesses, using the ``initial_resource_versions`` field.

 As with state-of-the-world, when multiple resource types are multiplexed (ADS),
 all requests/acknowledgments/updates are logically walled off by ``type_url``:
 a Cluster ACK exists in a completely separate world from a prior Route NACK.
 In particular, ``initial_resource_versions`` being sent at the "start" of every
 gRPC stream actually entails a message for each ``type_url``, each with its own
 ``initial_resource_versions``.
 [#next-free-field: 10]
Protobuf type envoy.service.discovery.v3.DeltaDiscoveryRequest
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    DeltaDiscoveryRequest.Builder
    DeltaDiscoveryRequest and DeltaDiscoveryResponse are used in a new gRPC endpoint for Delta xDS.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ERROR_DETAIL_FIELD_NUMBER
     
    static final int
    INITIAL_RESOURCE_VERSIONS_FIELD_NUMBER
     
    static final int
    NODE_FIELD_NUMBER
     
    static final int
    RESOURCE_LOCATORS_SUBSCRIBE_FIELD_NUMBER
     
    static final int
    RESOURCE_LOCATORS_UNSUBSCRIBE_FIELD_NUMBER
     
    static final int
    RESOURCE_NAMES_SUBSCRIBE_FIELD_NUMBER
     
    static final int
    RESOURCE_NAMES_UNSUBSCRIBE_FIELD_NUMBER
     
    static final int
    RESPONSE_NONCE_FIELD_NUMBER
     
    static final int
    TYPE_URL_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    boolean
    equals(Object obj)
     
    static DeltaDiscoveryRequest
    getDefaultInstance()
     
    DeltaDiscoveryRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    Status
    getErrorDetail()
    This is populated when the previous :ref:`DiscoveryResponse <envoy_v3_api_msg_service.discovery.v3.DiscoveryResponse>` failed to update configuration.
    StatusOrBuilder
    getErrorDetailOrBuilder()
    This is populated when the previous :ref:`DiscoveryResponse <envoy_v3_api_msg_service.discovery.v3.DiscoveryResponse>` failed to update configuration.
    Map<String,String>
    getInitialResourceVersions()
    Deprecated.
    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.
    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.
    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.
    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.
    Node
    getNode()
    The node making the request.
    NodeOrBuilder
    getNodeOrBuilder()
    The node making the request.
    com.google.protobuf.Parser<DeltaDiscoveryRequest>
    getParserForType()
     
    ResourceLocator
    getResourceLocatorsSubscribe(int index)
    [#not-implemented-hide:] Alternative to ``resource_names_subscribe`` field that allows specifying dynamic parameters along with each resource name. .. note:: It is legal for a request to have some resources listed in ``resource_names_subscribe`` and others in ``resource_locators_subscribe``.
    int
    getResourceLocatorsSubscribeCount()
    [#not-implemented-hide:] Alternative to ``resource_names_subscribe`` field that allows specifying dynamic parameters along with each resource name. .. note:: It is legal for a request to have some resources listed in ``resource_names_subscribe`` and others in ``resource_locators_subscribe``.
    List<ResourceLocator>
    getResourceLocatorsSubscribeList()
    [#not-implemented-hide:] Alternative to ``resource_names_subscribe`` field that allows specifying dynamic parameters along with each resource name. .. note:: It is legal for a request to have some resources listed in ``resource_names_subscribe`` and others in ``resource_locators_subscribe``.
    ResourceLocatorOrBuilder
    getResourceLocatorsSubscribeOrBuilder(int index)
    [#not-implemented-hide:] Alternative to ``resource_names_subscribe`` field that allows specifying dynamic parameters along with each resource name. .. note:: It is legal for a request to have some resources listed in ``resource_names_subscribe`` and others in ``resource_locators_subscribe``.
    List<? extends ResourceLocatorOrBuilder>
    getResourceLocatorsSubscribeOrBuilderList()
    [#not-implemented-hide:] Alternative to ``resource_names_subscribe`` field that allows specifying dynamic parameters along with each resource name. .. note:: It is legal for a request to have some resources listed in ``resource_names_subscribe`` and others in ``resource_locators_subscribe``.
    ResourceLocator
    getResourceLocatorsUnsubscribe(int index)
    [#not-implemented-hide:] Alternative to ``resource_names_unsubscribe`` field that allows specifying dynamic parameters along with each resource name. .. note:: It is legal for a request to have some resources listed in ``resource_names_unsubscribe`` and others in ``resource_locators_unsubscribe``.
    int
    getResourceLocatorsUnsubscribeCount()
    [#not-implemented-hide:] Alternative to ``resource_names_unsubscribe`` field that allows specifying dynamic parameters along with each resource name. .. note:: It is legal for a request to have some resources listed in ``resource_names_unsubscribe`` and others in ``resource_locators_unsubscribe``.
    List<ResourceLocator>
    getResourceLocatorsUnsubscribeList()
    [#not-implemented-hide:] Alternative to ``resource_names_unsubscribe`` field that allows specifying dynamic parameters along with each resource name. .. note:: It is legal for a request to have some resources listed in ``resource_names_unsubscribe`` and others in ``resource_locators_unsubscribe``.
    ResourceLocatorOrBuilder
    getResourceLocatorsUnsubscribeOrBuilder(int index)
    [#not-implemented-hide:] Alternative to ``resource_names_unsubscribe`` field that allows specifying dynamic parameters along with each resource name. .. note:: It is legal for a request to have some resources listed in ``resource_names_unsubscribe`` and others in ``resource_locators_unsubscribe``.
    List<? extends ResourceLocatorOrBuilder>
    getResourceLocatorsUnsubscribeOrBuilderList()
    [#not-implemented-hide:] Alternative to ``resource_names_unsubscribe`` field that allows specifying dynamic parameters along with each resource name. .. note:: It is legal for a request to have some resources listed in ``resource_names_unsubscribe`` and others in ``resource_locators_unsubscribe``.
    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.
    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.
    int
    getResourceNamesSubscribeCount()
    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.ProtocolStringList
    getResourceNamesSubscribeList()
    DeltaDiscoveryRequests allow the client to add or remove individual resources to the set of tracked resources in the context of a stream.
    String
    getResourceNamesUnsubscribe(int index)
    A list of Resource names to remove from the list of tracked resources.
    com.google.protobuf.ByteString
    getResourceNamesUnsubscribeBytes(int index)
    A list of Resource names to remove from the list of tracked resources.
    int
    getResourceNamesUnsubscribeCount()
    A list of Resource names to remove from the list of tracked resources.
    com.google.protobuf.ProtocolStringList
    getResourceNamesUnsubscribeList()
    A list of Resource names to remove from the list of tracked resources.
    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``.
    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``.
    int
    getSerializedSize()
     
    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.
    boolean
    hasErrorDetail()
    This is populated when the previous :ref:`DiscoveryResponse <envoy_v3_api_msg_service.discovery.v3.DiscoveryResponse>` failed to update configuration.
    int
    hashCode()
     
    boolean
    hasNode()
    The node making the request.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMapFieldReflection(int number)
     
    final boolean
    isInitialized()
     
    static DeltaDiscoveryRequest.Builder
    newBuilder()
     
    static DeltaDiscoveryRequest.Builder
    newBuilder(DeltaDiscoveryRequest prototype)
     
    DeltaDiscoveryRequest.Builder
    newBuilderForType()
     
    protected DeltaDiscoveryRequest.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static DeltaDiscoveryRequest
    parseDelimitedFrom(InputStream input)
     
    static DeltaDiscoveryRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DeltaDiscoveryRequest
    parseFrom(byte[] data)
     
    static DeltaDiscoveryRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DeltaDiscoveryRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static DeltaDiscoveryRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DeltaDiscoveryRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static DeltaDiscoveryRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DeltaDiscoveryRequest
    parseFrom(InputStream input)
     
    static DeltaDiscoveryRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DeltaDiscoveryRequest
    parseFrom(ByteBuffer data)
     
    static DeltaDiscoveryRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<DeltaDiscoveryRequest>
    parser()
     
    DeltaDiscoveryRequest.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • NODE_FIELD_NUMBER

      public static final int NODE_FIELD_NUMBER
      See Also:

    • TYPE_URL_FIELD_NUMBER

      public static final int TYPE_URL_FIELD_NUMBER
      See Also:

    • RESOURCE_NAMES_SUBSCRIBE_FIELD_NUMBER

      public static final int RESOURCE_NAMES_SUBSCRIBE_FIELD_NUMBER
      See Also:

    • RESOURCE_NAMES_UNSUBSCRIBE_FIELD_NUMBER

      public static final int RESOURCE_NAMES_UNSUBSCRIBE_FIELD_NUMBER
      See Also:

    • RESOURCE_LOCATORS_SUBSCRIBE_FIELD_NUMBER

      public static final int RESOURCE_LOCATORS_SUBSCRIBE_FIELD_NUMBER
      See Also:

    • RESOURCE_LOCATORS_UNSUBSCRIBE_FIELD_NUMBER

      public static final int RESOURCE_LOCATORS_UNSUBSCRIBE_FIELD_NUMBER
      See Also:

    • INITIAL_RESOURCE_VERSIONS_FIELD_NUMBER

      public static final int INITIAL_RESOURCE_VERSIONS_FIELD_NUMBER
      See Also:

    • RESPONSE_NONCE_FIELD_NUMBER

      public static final int RESPONSE_NONCE_FIELD_NUMBER
      See Also:

    • ERROR_DETAIL_FIELD_NUMBER

      public static final int ERROR_DETAIL_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • hasNode

      public boolean hasNode()
       The node making the request.
      .envoy.config.core.v3.Node node = 1;
      Specified by:
      hasNode in interface DeltaDiscoveryRequestOrBuilder
      Returns:
      Whether the node field is set.

    • getNode

      public Node getNode()
       The node making the request.
      .envoy.config.core.v3.Node node = 1;
      Specified by:
      getNode in interface DeltaDiscoveryRequestOrBuilder
      Returns:
      The node.

    • getNodeOrBuilder

      public NodeOrBuilder getNodeOrBuilder()
       The node making the request.
      .envoy.config.core.v3.Node node = 1;
      Specified by:
      getNodeOrBuilder in interface DeltaDiscoveryRequestOrBuilder

    • getTypeUrl

      public 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;
      Specified by:
      getTypeUrl in interface DeltaDiscoveryRequestOrBuilder
      Returns:
      The typeUrl.

    • getTypeUrlBytes

      public 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;
      Specified by:
      getTypeUrlBytes in interface DeltaDiscoveryRequestOrBuilder
      Returns:
      The bytes for typeUrl.

    • getResourceNamesSubscribeList

      public com.google.protobuf.ProtocolStringList 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;
      Specified by:
      getResourceNamesSubscribeList in interface DeltaDiscoveryRequestOrBuilder
      Returns:
      A list containing the resourceNamesSubscribe.

    • getResourceNamesSubscribeCount

      public 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;
      Specified by:
      getResourceNamesSubscribeCount in interface DeltaDiscoveryRequestOrBuilder
      Returns:
      The count of resourceNamesSubscribe.

    • getResourceNamesSubscribe

      public 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;
      Specified by:
      getResourceNamesSubscribe in interface DeltaDiscoveryRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The resourceNamesSubscribe at the given index.

    • getResourceNamesSubscribeBytes

      public 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;
      Specified by:
      getResourceNamesSubscribeBytes in interface DeltaDiscoveryRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the resourceNamesSubscribe at the given index.

    • getResourceNamesUnsubscribeList

      public com.google.protobuf.ProtocolStringList getResourceNamesUnsubscribeList()
       A list of Resource names to remove from the list of tracked resources.
      repeated string resource_names_unsubscribe = 4;
      Specified by:
      getResourceNamesUnsubscribeList in interface DeltaDiscoveryRequestOrBuilder
      Returns:
      A list containing the resourceNamesUnsubscribe.

    • getResourceNamesUnsubscribeCount

      public int getResourceNamesUnsubscribeCount()
       A list of Resource names to remove from the list of tracked resources.
      repeated string resource_names_unsubscribe = 4;
      Specified by:
      getResourceNamesUnsubscribeCount in interface DeltaDiscoveryRequestOrBuilder
      Returns:
      The count of resourceNamesUnsubscribe.

    • getResourceNamesUnsubscribe

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

    • getResourceNamesUnsubscribeBytes

      public 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;
      Specified by:
      getResourceNamesUnsubscribeBytes in interface DeltaDiscoveryRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the resourceNamesUnsubscribe at the given index.

    • getResourceLocatorsSubscribeList

      public List<ResourceLocator> getResourceLocatorsSubscribeList()
       [#not-implemented-hide:]
 Alternative to ``resource_names_subscribe`` field that allows specifying dynamic parameters
 along with each resource name.

 .. note::
   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;
      Specified by:
      getResourceLocatorsSubscribeList in interface DeltaDiscoveryRequestOrBuilder

    • getResourceLocatorsSubscribeOrBuilderList

      public List<? extends ResourceLocatorOrBuilder> getResourceLocatorsSubscribeOrBuilderList()
       [#not-implemented-hide:]
 Alternative to ``resource_names_subscribe`` field that allows specifying dynamic parameters
 along with each resource name.

 .. note::
   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;
      Specified by:
      getResourceLocatorsSubscribeOrBuilderList in interface DeltaDiscoveryRequestOrBuilder

    • getResourceLocatorsSubscribeCount

      public int getResourceLocatorsSubscribeCount()
       [#not-implemented-hide:]
 Alternative to ``resource_names_subscribe`` field that allows specifying dynamic parameters
 along with each resource name.

 .. note::
   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;
      Specified by:
      getResourceLocatorsSubscribeCount in interface DeltaDiscoveryRequestOrBuilder

    • getResourceLocatorsSubscribe

      public ResourceLocator getResourceLocatorsSubscribe(int index)
       [#not-implemented-hide:]
 Alternative to ``resource_names_subscribe`` field that allows specifying dynamic parameters
 along with each resource name.

 .. note::
   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;
      Specified by:
      getResourceLocatorsSubscribe in interface DeltaDiscoveryRequestOrBuilder

    • getResourceLocatorsSubscribeOrBuilder

      public ResourceLocatorOrBuilder getResourceLocatorsSubscribeOrBuilder(int index)
       [#not-implemented-hide:]
 Alternative to ``resource_names_subscribe`` field that allows specifying dynamic parameters
 along with each resource name.

 .. note::
   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;
      Specified by:
      getResourceLocatorsSubscribeOrBuilder in interface DeltaDiscoveryRequestOrBuilder

    • getResourceLocatorsUnsubscribeList

      public List<ResourceLocator> getResourceLocatorsUnsubscribeList()
       [#not-implemented-hide:]
 Alternative to ``resource_names_unsubscribe`` field that allows specifying dynamic parameters
 along with each resource name.

 .. note::
   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;
      Specified by:
      getResourceLocatorsUnsubscribeList in interface DeltaDiscoveryRequestOrBuilder

    • getResourceLocatorsUnsubscribeOrBuilderList

      public List<? extends ResourceLocatorOrBuilder> getResourceLocatorsUnsubscribeOrBuilderList()
       [#not-implemented-hide:]
 Alternative to ``resource_names_unsubscribe`` field that allows specifying dynamic parameters
 along with each resource name.

 .. note::
   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;
      Specified by:
      getResourceLocatorsUnsubscribeOrBuilderList in interface DeltaDiscoveryRequestOrBuilder

    • getResourceLocatorsUnsubscribeCount

      public int getResourceLocatorsUnsubscribeCount()
       [#not-implemented-hide:]
 Alternative to ``resource_names_unsubscribe`` field that allows specifying dynamic parameters
 along with each resource name.

 .. note::
   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;
      Specified by:
      getResourceLocatorsUnsubscribeCount in interface DeltaDiscoveryRequestOrBuilder

    • getResourceLocatorsUnsubscribe

      public ResourceLocator getResourceLocatorsUnsubscribe(int index)
       [#not-implemented-hide:]
 Alternative to ``resource_names_unsubscribe`` field that allows specifying dynamic parameters
 along with each resource name.

 .. note::
   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;
      Specified by:
      getResourceLocatorsUnsubscribe in interface DeltaDiscoveryRequestOrBuilder

    • getResourceLocatorsUnsubscribeOrBuilder

      public ResourceLocatorOrBuilder getResourceLocatorsUnsubscribeOrBuilder(int index)
       [#not-implemented-hide:]
 Alternative to ``resource_names_unsubscribe`` field that allows specifying dynamic parameters
 along with each resource name.

 .. note::
   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;
      Specified by:
      getResourceLocatorsUnsubscribeOrBuilder in interface DeltaDiscoveryRequestOrBuilder

    • getInitialResourceVersionsCount

      public int getInitialResourceVersionsCount()
      Description copied from interface: DeltaDiscoveryRequestOrBuilder
       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:

 * In the very first stream of a session, since the client will not yet have any resources.
 * 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;
      Specified by:
      getInitialResourceVersionsCount in interface DeltaDiscoveryRequestOrBuilder

    • containsInitialResourceVersions

      public 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:

 * In the very first stream of a session, since the client will not yet have any resources.
 * 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;
      Specified by:
      containsInitialResourceVersions in interface DeltaDiscoveryRequestOrBuilder

    • getInitialResourceVersions

      @Deprecated public Map<String,String> getInitialResourceVersions()
      Deprecated.
      Use getInitialResourceVersionsMap() instead.
      Specified by:
      getInitialResourceVersions in interface DeltaDiscoveryRequestOrBuilder

    • getInitialResourceVersionsMap

      public 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:

 * In the very first stream of a session, since the client will not yet have any resources.
 * 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;
      Specified by:
      getInitialResourceVersionsMap in interface DeltaDiscoveryRequestOrBuilder

    • getInitialResourceVersionsOrDefault

      public 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:

 * In the very first stream of a session, since the client will not yet have any resources.
 * 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;
      Specified by:
      getInitialResourceVersionsOrDefault in interface DeltaDiscoveryRequestOrBuilder

    • getInitialResourceVersionsOrThrow

      public 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:

 * In the very first stream of a session, since the client will not yet have any resources.
 * 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;
      Specified by:
      getInitialResourceVersionsOrThrow in interface DeltaDiscoveryRequestOrBuilder

    • getResponseNonce

      public 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;
      Specified by:
      getResponseNonce in interface DeltaDiscoveryRequestOrBuilder
      Returns:
      The responseNonce.

    • getResponseNonceBytes

      public 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;
      Specified by:
      getResponseNonceBytes in interface DeltaDiscoveryRequestOrBuilder
      Returns:
      The bytes for responseNonce.

    • hasErrorDetail

      public 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;
      Specified by:
      hasErrorDetail in interface DeltaDiscoveryRequestOrBuilder
      Returns:
      Whether the errorDetail field is set.

    • getErrorDetail

      public 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;
      Specified by:
      getErrorDetail in interface DeltaDiscoveryRequestOrBuilder
      Returns:
      The errorDetail.

    • getErrorDetailOrBuilder

      public 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;
      Specified by:
      getErrorDetailOrBuilder in interface DeltaDiscoveryRequestOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static DeltaDiscoveryRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DeltaDiscoveryRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DeltaDiscoveryRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DeltaDiscoveryRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DeltaDiscoveryRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DeltaDiscoveryRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DeltaDiscoveryRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DeltaDiscoveryRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DeltaDiscoveryRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DeltaDiscoveryRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DeltaDiscoveryRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DeltaDiscoveryRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public DeltaDiscoveryRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static DeltaDiscoveryRequest.Builder newBuilder()

    • newBuilder

      public static DeltaDiscoveryRequest.Builder newBuilder(DeltaDiscoveryRequest prototype)

    • toBuilder

      public DeltaDiscoveryRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected DeltaDiscoveryRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static DeltaDiscoveryRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<DeltaDiscoveryRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<DeltaDiscoveryRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public DeltaDiscoveryRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder