io.envoyproxy.envoy.api.v2

Class DiscoveryRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.api.v2.DiscoveryRequest

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, DiscoveryRequestOrBuilder, Serializable

public final class DiscoveryRequest
extends com.google.protobuf.GeneratedMessageV3
implements DiscoveryRequestOrBuilder

 A DiscoveryRequest requests a set of versioned resources of the same type for
 a given Envoy node on some API.
 [#next-free-field: 7]
 

Protobuf type envoy.api.v2.DiscoveryRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DiscoveryRequest.Builder A DiscoveryRequest requests a set of versioned resources of the same type for a given Envoy node on some API.

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERROR_DETAIL_FIELD_NUMBER
static int	NODE_FIELD_NUMBER
static int	RESOURCE_NAMES_FIELD_NUMBER
static int	RESPONSE_NONCE_FIELD_NUMBER
static int	TYPE_URL_FIELD_NUMBER
static int	VERSION_INFO_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 and Description
boolean	equals(Object obj)
static DiscoveryRequest	getDefaultInstance()
DiscoveryRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
Node	getNode() The node making the request.
NodeOrBuilder	getNodeOrBuilder() The node making the request.
com.google.protobuf.Parser<DiscoveryRequest>	getParserForType()
String	getResourceNames(int index) List of resources to subscribe to, e.g. list of cluster names or a route configuration name.
com.google.protobuf.ByteString	getResourceNamesBytes(int index) List of resources to subscribe to, e.g. list of cluster names or a route configuration name.
int	getResourceNamesCount() List of resources to subscribe to, e.g. list of cluster names or a route configuration name.
com.google.protobuf.ProtocolStringList	getResourceNamesList() List of resources to subscribe to, e.g. list of cluster names or a route configuration name.
String	getResponseNonce() nonce corresponding to DiscoveryResponse being ACK/NACKed.
com.google.protobuf.ByteString	getResponseNonceBytes() nonce corresponding to DiscoveryResponse being ACK/NACKed.
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.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
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.
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.
boolean	hasErrorDetail() This is populated when the previous :ref:`DiscoveryResponse <envoy_api_msg_DiscoveryResponse>` failed to update configuration.
int	hashCode()
boolean	hasNode() The node making the request.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static DiscoveryRequest.Builder	newBuilder()
static DiscoveryRequest.Builder	newBuilder(DiscoveryRequest prototype)
DiscoveryRequest.Builder	newBuilderForType()
protected DiscoveryRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static DiscoveryRequest	parseDelimitedFrom(InputStream input)
static DiscoveryRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DiscoveryRequest	parseFrom(byte[] data)
static DiscoveryRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DiscoveryRequest	parseFrom(ByteBuffer data)
static DiscoveryRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DiscoveryRequest	parseFrom(com.google.protobuf.ByteString data)
static DiscoveryRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DiscoveryRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static DiscoveryRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DiscoveryRequest	parseFrom(InputStream input)
static DiscoveryRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<DiscoveryRequest>	parser()
DiscoveryRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

VERSION_INFO_FIELD_NUMBER

public static final int VERSION_INFO_FIELD_NUMBER

See Also:

Constant Field Values

NODE_FIELD_NUMBER

public static final int NODE_FIELD_NUMBER

See Also:

Constant Field Values

RESOURCE_NAMES_FIELD_NUMBER

public static final int RESOURCE_NAMES_FIELD_NUMBER

See Also:

Constant Field Values

TYPE_URL_FIELD_NUMBER

public static final int TYPE_URL_FIELD_NUMBER

See Also:

Constant Field Values

RESPONSE_NONCE_FIELD_NUMBER

public static final int RESPONSE_NONCE_FIELD_NUMBER

See Also:

Constant Field Values

ERROR_DETAIL_FIELD_NUMBER

public static final int ERROR_DETAIL_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getVersionInfo

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

Specified by:

getVersionInfo in interface DiscoveryRequestOrBuilder

getVersionInfoBytes

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

Specified by:

getVersionInfoBytes in interface DiscoveryRequestOrBuilder

hasNode

public boolean hasNode()

 The node making the request.
 

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

Specified by:

hasNode in interface DiscoveryRequestOrBuilder

getNode

public Node getNode()

 The node making the request.
 

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

Specified by:

getNode in interface DiscoveryRequestOrBuilder

getNodeOrBuilder

public NodeOrBuilder getNodeOrBuilder()

 The node making the request.
 

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

Specified by:

getNodeOrBuilder in interface DiscoveryRequestOrBuilder

getResourceNamesList

public com.google.protobuf.ProtocolStringList 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;

Specified by:

getResourceNamesList in interface DiscoveryRequestOrBuilder

getResourceNamesCount

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

Specified by:

getResourceNamesCount in interface DiscoveryRequestOrBuilder

getResourceNames

public String getResourceNames(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;

Specified by:

getResourceNames in interface DiscoveryRequestOrBuilder

getResourceNamesBytes

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

Specified by:

getResourceNamesBytes in interface DiscoveryRequestOrBuilder

getTypeUrl

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

Specified by:

getTypeUrl in interface DiscoveryRequestOrBuilder

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

string type_url = 4;

Specified by:

getTypeUrlBytes in interface DiscoveryRequestOrBuilder

getResponseNonce

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

Specified by:

getResponseNonce in interface DiscoveryRequestOrBuilder

getResponseNonceBytes

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

Specified by:

getResponseNonceBytes in interface DiscoveryRequestOrBuilder

hasErrorDetail

public 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. 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;

Specified by:

hasErrorDetail in interface DiscoveryRequestOrBuilder

getErrorDetail

public 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. 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;

Specified by:

getErrorDetail in interface DiscoveryRequestOrBuilder

getErrorDetailOrBuilder

public 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. 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;

Specified by:

getErrorDetailOrBuilder in interface DiscoveryRequestOrBuilder

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 DiscoveryRequest parseFrom(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DiscoveryRequest parseFrom(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DiscoveryRequest parseFrom(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DiscoveryRequest parseFrom(InputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static DiscoveryRequest parseDelimitedFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static DiscoveryRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public DiscoveryRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static DiscoveryRequest.Builder newBuilder()

newBuilder

public static DiscoveryRequest.Builder newBuilder(DiscoveryRequest prototype)

toBuilder

public DiscoveryRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected DiscoveryRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static DiscoveryRequest getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<DiscoveryRequest> 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 DiscoveryRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder