io.envoyproxy.envoy.service.discovery.v3

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 and 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.
Status	getErrorDetail() This is populated when the previous :ref:`DiscoveryResponse <envoy_api_msg_service.discovery.v3.DiscoveryResponse>` failed to update configuration.
StatusOrBuilder	getErrorDetailOrBuilder() This is populated when the previous :ref:`DiscoveryResponse <envoy_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.
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.
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.
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.
List<String>	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.
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_api_msg_service.discovery.v3.DiscoveryResponse>` failed to update configuration.
boolean	hasNode() The node making the request.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasNode

boolean hasNode()

 The node making the request.
 

.envoy.config.core.v3.Node node = 1;

getNode

Node getNode()

 The node making the request.
 

.envoy.config.core.v3.Node node = 1;

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;

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;

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;

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;

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;

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;

getResourceNamesUnsubscribeList

List<String> getResourceNamesUnsubscribeList()

 A list of Resource names to remove from the list of tracked resources.
 

repeated string resource_names_unsubscribe = 4;

getResourceNamesUnsubscribeCount

int getResourceNamesUnsubscribeCount()

 A list of Resource names to remove from the list of tracked resources.
 

repeated string resource_names_unsubscribe = 4;

getResourceNamesUnsubscribe

String getResourceNamesUnsubscribe(int index)

 A list of Resource names to remove from the list of tracked resources.
 

repeated string resource_names_unsubscribe = 4;

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;

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.

Use getInitialResourceVersionsMap() instead.

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;

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;

hasErrorDetail

boolean hasErrorDetail()

 This is populated when the previous :ref:`DiscoveryResponse <envoy_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;

getErrorDetail

Status getErrorDetail()

 This is populated when the previous :ref:`DiscoveryResponse <envoy_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;

getErrorDetailOrBuilder

StatusOrBuilder getErrorDetailOrBuilder()

 This is populated when the previous :ref:`DiscoveryResponse <envoy_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;