envoy.api.v2

Interface Discovery.IncrementalDiscoveryRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Discovery.IncrementalDiscoveryRequest, Discovery.IncrementalDiscoveryRequest.Builder

Enclosing class:

Discovery

public static interface Discovery.IncrementalDiscoveryRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsInitialResourceVersions(String key) This map must be populated when the IncrementalDiscoveryRequest is the first in a stream.
Status	getErrorDetail() This is populated when the previous :ref:`DiscoveryResponse <envoy_api_msg_DiscoveryResponse>` failed to update configuration.
StatusOrBuilder	getErrorDetailOrBuilder() This is populated when the previous :ref:`DiscoveryResponse <envoy_api_msg_DiscoveryResponse>` failed to update configuration.
Map<String,String>	getInitialResourceVersions() Deprecated.
int	getInitialResourceVersionsCount() This map must be populated when the IncrementalDiscoveryRequest is the first in a stream.
Map<String,String>	getInitialResourceVersionsMap() This map must be populated when the IncrementalDiscoveryRequest is the first in a stream.
String	getInitialResourceVersionsOrDefault(String key, String defaultValue) This map must be populated when the IncrementalDiscoveryRequest is the first in a stream.
String	getInitialResourceVersionsOrThrow(String key) This map must be populated when the IncrementalDiscoveryRequest is the first in a stream.
Base.Node	getNode() The node making the request.
Base.NodeOrBuilder	getNodeOrBuilder() The node making the request.
String	getResourceNamesSubscribe(int index) IncrementalDiscoveryRequests 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) IncrementalDiscoveryRequests allow the client to add or remove individual resources to the set of tracked resources in the context of a stream.
int	getResourceNamesSubscribeCount() IncrementalDiscoveryRequests allow the client to add or remove individual resources to the set of tracked resources in the context of a stream.
List<String>	getResourceNamesSubscribeList() IncrementalDiscoveryRequests 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 IncrementalDiscoveryRequest is a ACK or NACK message in response to a previous IncrementalDiscoveryResponse, the response_nonce must be the nonce in the IncrementalDiscoveryResponse.
com.google.protobuf.ByteString	getResponseNonceBytes() When the IncrementalDiscoveryRequest is a ACK or NACK message in response to a previous IncrementalDiscoveryResponse, the response_nonce must be the nonce in the IncrementalDiscoveryResponse.
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_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.api.v2.core.Node node = 1;

getNode

Base.Node getNode()

 The node making the request.
 

.envoy.api.v2.core.Node node = 1;

getNodeOrBuilder

Base.NodeOrBuilder getNodeOrBuilder()

 The node making the request.
 

.envoy.api.v2.core.Node node = 1;

getTypeUrl

String getTypeUrl()

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

string type_url = 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 is implicit
 in requests made via singleton xDS APIs such as CDS, LDS, etc. but is
 required for ADS.
 

string type_url = 2;

getResourceNamesSubscribeList

List<String> getResourceNamesSubscribeList()

 IncrementalDiscoveryRequests 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 in non incremental 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.
 The xDS server must send updates for all tracked resources but can also
 send updates for resources the client has not subscribed to. This behavior
 is similar to non incremental xDS.
 These two fields can be set for all types of IncrementalDiscoveryRequests
 (initial, ACK/NACK or spontaneous).
 A list of Resource names to add to the list of tracked resources.
 

repeated string resource_names_subscribe = 3;

getResourceNamesSubscribeCount

int getResourceNamesSubscribeCount()

 IncrementalDiscoveryRequests 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 in non incremental 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.
 The xDS server must send updates for all tracked resources but can also
 send updates for resources the client has not subscribed to. This behavior
 is similar to non incremental xDS.
 These two fields can be set for all types of IncrementalDiscoveryRequests
 (initial, ACK/NACK or spontaneous).
 A list of Resource names to add to the list of tracked resources.
 

repeated string resource_names_subscribe = 3;

getResourceNamesSubscribe

String getResourceNamesSubscribe(int index)

 IncrementalDiscoveryRequests 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 in non incremental 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.
 The xDS server must send updates for all tracked resources but can also
 send updates for resources the client has not subscribed to. This behavior
 is similar to non incremental xDS.
 These two fields can be set for all types of IncrementalDiscoveryRequests
 (initial, ACK/NACK or spontaneous).
 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)

 IncrementalDiscoveryRequests 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 in non incremental 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.
 The xDS server must send updates for all tracked resources but can also
 send updates for resources the client has not subscribed to. This behavior
 is similar to non incremental xDS.
 These two fields can be set for all types of IncrementalDiscoveryRequests
 (initial, ACK/NACK or spontaneous).
 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()

 This map must be populated when the IncrementalDiscoveryRequest is the
 first in a stream. The keys are the resources names of the xDS resources
 known to the xDS client. The values in the map are the associated resource
 level version info.
 

map<string, string> initial_resource_versions = 5;

containsInitialResourceVersions

boolean containsInitialResourceVersions(String key)

 This map must be populated when the IncrementalDiscoveryRequest is the
 first in a stream. The keys are the resources names of the xDS resources
 known to the xDS client. The values in the map are the associated resource
 level version info.
 

map<string, string> initial_resource_versions = 5;

getInitialResourceVersions

@Deprecated
Map<String,String> getInitialResourceVersions()

Deprecated.

Use getInitialResourceVersionsMap() instead.

getInitialResourceVersionsMap

Map<String,String> getInitialResourceVersionsMap()

 This map must be populated when the IncrementalDiscoveryRequest is the
 first in a stream. The keys are the resources names of the xDS resources
 known to the xDS client. The values in the map are the associated resource
 level version info.
 

map<string, string> initial_resource_versions = 5;

getInitialResourceVersionsOrDefault

String getInitialResourceVersionsOrDefault(String key,
                                           String defaultValue)

 This map must be populated when the IncrementalDiscoveryRequest is the
 first in a stream. The keys are the resources names of the xDS resources
 known to the xDS client. The values in the map are the associated resource
 level version info.
 

map<string, string> initial_resource_versions = 5;

getInitialResourceVersionsOrThrow

String getInitialResourceVersionsOrThrow(String key)

 This map must be populated when the IncrementalDiscoveryRequest is the
 first in a stream. The keys are the resources names of the xDS resources
 known to the xDS client. The values in the map are the associated resource
 level version info.
 

map<string, string> initial_resource_versions = 5;

getResponseNonce

String getResponseNonce()

 When the IncrementalDiscoveryRequest is a ACK or NACK message in response
 to a previous IncrementalDiscoveryResponse, the response_nonce must be the
 nonce in the IncrementalDiscoveryResponse.
 Otherwise response_nonce must be omitted.
 

string response_nonce = 6;

getResponseNonceBytes

com.google.protobuf.ByteString getResponseNonceBytes()

 When the IncrementalDiscoveryRequest is a ACK or NACK message in response
 to a previous IncrementalDiscoveryResponse, the response_nonce must be the
 nonce in the IncrementalDiscoveryResponse.
 Otherwise response_nonce must be omitted.
 

string response_nonce = 6;

hasErrorDetail

boolean hasErrorDetail()

 This is populated when the previous :ref:`DiscoveryResponse <envoy_api_msg_DiscoveryResponse>`
 failed to update configuration. The *message* field in *error_details*
 provides the Envoy internal exception related to the failure.
 

.google.rpc.Status error_detail = 7;

getErrorDetail

Status getErrorDetail()

 This is populated when the previous :ref:`DiscoveryResponse <envoy_api_msg_DiscoveryResponse>`
 failed to update configuration. The *message* field in *error_details*
 provides the Envoy internal exception related to the failure.
 

.google.rpc.Status error_detail = 7;

getErrorDetailOrBuilder

StatusOrBuilder getErrorDetailOrBuilder()

 This is populated when the previous :ref:`DiscoveryResponse <envoy_api_msg_DiscoveryResponse>`
 failed to update configuration. The *message* field in *error_details*
 provides the Envoy internal exception related to the failure.
 

.google.rpc.Status error_detail = 7;