Interface DiscoveryRequestOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
DiscoveryRequest
,DiscoveryRequest.Builder
public interface DiscoveryRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptioncom.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.getNode()
The node making the request.The node making the request.getResourceLocators
(int index) [#not-implemented-hide:] Alternative to ``resource_names`` field that allows specifying dynamic parameters along with each resource name.int
[#not-implemented-hide:] Alternative to ``resource_names`` field that allows specifying dynamic parameters along with each resource name.[#not-implemented-hide:] Alternative to ``resource_names`` field that allows specifying dynamic parameters along with each resource name.getResourceLocatorsOrBuilder
(int index) [#not-implemented-hide:] Alternative to ``resource_names`` field that allows specifying dynamic parameters along with each resource name.List
<? extends ResourceLocatorOrBuilder> [#not-implemented-hide:] Alternative to ``resource_names`` field that allows specifying dynamic parameters along with each resource name.getResourceNames
(int index) List of resources to subscribe to, e.g.com.google.protobuf.ByteString
getResourceNamesBytes
(int index) List of resources to subscribe to, e.g.int
List of resources to subscribe to, e.g.List of resources to subscribe to, e.g.nonce corresponding to DiscoveryResponse being ACK/NACKed.com.google.protobuf.ByteString
nonce corresponding to DiscoveryResponse being ACK/NACKed.Type of the resource that is being requested, e.g.com.google.protobuf.ByteString
Type of the resource that is being requested, e.g.The version_info provided in the request messages will be the version_info received with the most recent successfully processed response or empty on the first request.com.google.protobuf.ByteString
The version_info provided in the request messages will be the version_info received with the most recent successfully processed response or empty on the first request.boolean
This is populated when the previous :ref:`DiscoveryResponse <envoy_v3_api_msg_service.discovery.v3.DiscoveryResponse>` failed to update configuration.boolean
hasNode()
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
-
getVersionInfo
String getVersionInfo()The version_info provided in the request messages will be the version_info received with the most recent successfully processed response or empty on the first request. It is expected that no new request is sent after a response is received until the Envoy instance is ready to ACK/NACK the new configuration. ACK/NACK takes place by returning the new API config version as applied or the previous API config version respectively. Each type_url (see below) has an independent version associated with it.
string version_info = 1;
- Returns:
- The versionInfo.
-
getVersionInfoBytes
com.google.protobuf.ByteString getVersionInfoBytes()The version_info provided in the request messages will be the version_info received with the most recent successfully processed response or empty on the first request. It is expected that no new request is sent after a response is received until the Envoy instance is ready to ACK/NACK the new configuration. ACK/NACK takes place by returning the new API config version as applied or the previous API config version respectively. Each type_url (see below) has an independent version associated with it.
string version_info = 1;
- Returns:
- The bytes for versionInfo.
-
hasNode
boolean hasNode()The node making the request.
.envoy.config.core.v3.Node node = 2;
- Returns:
- Whether the node field is set.
-
getNode
Node getNode()The node making the request.
.envoy.config.core.v3.Node node = 2;
- Returns:
- The node.
-
getNodeOrBuilder
NodeOrBuilder getNodeOrBuilder()The node making the request.
.envoy.config.core.v3.Node node = 2;
-
getResourceNamesList
List of resources to subscribe to, e.g. list of cluster names or a route configuration name. If this is empty, all resources for the API are returned. LDS/CDS may have empty resource_names, which will cause all resources for the Envoy instance to be returned. The LDS and CDS responses will then imply a number of resources that need to be fetched via EDS/RDS, which will be explicitly enumerated in resource_names.
repeated string resource_names = 3;
- Returns:
- A list containing the resourceNames.
-
getResourceNamesCount
int getResourceNamesCount()List of resources to subscribe to, e.g. list of cluster names or a route configuration name. If this is empty, all resources for the API are returned. LDS/CDS may have empty resource_names, which will cause all resources for the Envoy instance to be returned. The LDS and CDS responses will then imply a number of resources that need to be fetched via EDS/RDS, which will be explicitly enumerated in resource_names.
repeated string resource_names = 3;
- Returns:
- The count of resourceNames.
-
getResourceNames
List of resources to subscribe to, e.g. list of cluster names or a route configuration name. If this is empty, all resources for the API are returned. LDS/CDS may have empty resource_names, which will cause all resources for the Envoy instance to be returned. The LDS and CDS responses will then imply a number of resources that need to be fetched via EDS/RDS, which will be explicitly enumerated in resource_names.
repeated string resource_names = 3;
- Parameters:
index
- The index of the element to return.- Returns:
- The resourceNames at the given index.
-
getResourceNamesBytes
com.google.protobuf.ByteString getResourceNamesBytes(int index) List of resources to subscribe to, e.g. list of cluster names or a route configuration name. If this is empty, all resources for the API are returned. LDS/CDS may have empty resource_names, which will cause all resources for the Envoy instance to be returned. The LDS and CDS responses will then imply a number of resources that need to be fetched via EDS/RDS, which will be explicitly enumerated in resource_names.
repeated string resource_names = 3;
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the resourceNames at the given index.
-
getResourceLocatorsList
List<ResourceLocator> getResourceLocatorsList()[#not-implemented-hide:] Alternative to ``resource_names`` field that allows specifying dynamic parameters along with each resource name. Clients that populate this field must be able to handle responses from the server where resources are wrapped in a Resource message. Note that it is legal for a request to have some resources listed in ``resource_names`` and others in ``resource_locators``.
repeated .envoy.service.discovery.v3.ResourceLocator resource_locators = 7;
-
getResourceLocators
[#not-implemented-hide:] Alternative to ``resource_names`` field that allows specifying dynamic parameters along with each resource name. Clients that populate this field must be able to handle responses from the server where resources are wrapped in a Resource message. Note that it is legal for a request to have some resources listed in ``resource_names`` and others in ``resource_locators``.
repeated .envoy.service.discovery.v3.ResourceLocator resource_locators = 7;
-
getResourceLocatorsCount
int getResourceLocatorsCount()[#not-implemented-hide:] Alternative to ``resource_names`` field that allows specifying dynamic parameters along with each resource name. Clients that populate this field must be able to handle responses from the server where resources are wrapped in a Resource message. Note that it is legal for a request to have some resources listed in ``resource_names`` and others in ``resource_locators``.
repeated .envoy.service.discovery.v3.ResourceLocator resource_locators = 7;
-
getResourceLocatorsOrBuilderList
List<? extends ResourceLocatorOrBuilder> getResourceLocatorsOrBuilderList()[#not-implemented-hide:] Alternative to ``resource_names`` field that allows specifying dynamic parameters along with each resource name. Clients that populate this field must be able to handle responses from the server where resources are wrapped in a Resource message. Note that it is legal for a request to have some resources listed in ``resource_names`` and others in ``resource_locators``.
repeated .envoy.service.discovery.v3.ResourceLocator resource_locators = 7;
-
getResourceLocatorsOrBuilder
[#not-implemented-hide:] Alternative to ``resource_names`` field that allows specifying dynamic parameters along with each resource name. Clients that populate this field must be able to handle responses from the server where resources are wrapped in a Resource message. Note that it is legal for a request to have some resources listed in ``resource_names`` and others in ``resource_locators``.
repeated .envoy.service.discovery.v3.ResourceLocator resource_locators = 7;
-
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 = 4;
- 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 is implicit in requests made via singleton xDS APIs such as CDS, LDS, etc. but is required for ADS.
string type_url = 4;
- Returns:
- The bytes for typeUrl.
-
getResponseNonce
String getResponseNonce()nonce corresponding to DiscoveryResponse being ACK/NACKed. See above discussion on version_info and the DiscoveryResponse nonce comment. This may be empty only if 1) this is a non-persistent-stream xDS such as HTTP, or 2) the client has not yet accepted an update in this xDS stream (unlike delta, where it is populated only for new explicit ACKs).
string response_nonce = 5;
- Returns:
- The responseNonce.
-
getResponseNonceBytes
com.google.protobuf.ByteString getResponseNonceBytes()nonce corresponding to DiscoveryResponse being ACK/NACKed. See above discussion on version_info and the DiscoveryResponse nonce comment. This may be empty only if 1) this is a non-persistent-stream xDS such as HTTP, or 2) the client has not yet accepted an update in this xDS stream (unlike delta, where it is populated only for new explicit ACKs).
string response_nonce = 5;
- 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. It is only intended for consumption during manual debugging, the string provided is not guaranteed to be stable across Envoy versions.
.google.rpc.Status error_detail = 6;
- 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. It is only intended for consumption during manual debugging, the string provided is not guaranteed to be stable across Envoy versions.
.google.rpc.Status error_detail = 6;
- 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. It is only intended for consumption during manual debugging, the string provided is not guaranteed to be stable across Envoy versions.
.google.rpc.Status error_detail = 6;
-