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

Class DiscoveryRequest.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, DiscoveryRequestOrBuilder, Cloneable
    Enclosing class:
    DiscoveryRequest
    public static final class DiscoveryRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<DiscoveryRequest.Builder>
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.service.discovery.v3.DiscoveryRequest

    • Method Detail

      • 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.Builder<DiscoveryRequest.Builder>

      • clear

        public DiscoveryRequest.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<DiscoveryRequest.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<DiscoveryRequest.Builder>

      • getDefaultInstanceForType

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

      • build

        public DiscoveryRequest build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public DiscoveryRequest buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public DiscoveryRequest.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<DiscoveryRequest.Builder>

      • setField

        public DiscoveryRequest.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<DiscoveryRequest.Builder>

      • clearField

        public DiscoveryRequest.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<DiscoveryRequest.Builder>

      • clearOneof

        public DiscoveryRequest.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<DiscoveryRequest.Builder>

      • setRepeatedField

        public DiscoveryRequest.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 int index,
                                                 Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DiscoveryRequest.Builder>

      • addRepeatedField

        public DiscoveryRequest.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DiscoveryRequest.Builder>

      • mergeFrom

        public DiscoveryRequest.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DiscoveryRequest.Builder>

      • isInitialized

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

      • mergeFrom

        public DiscoveryRequest.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DiscoveryRequest.Builder>
        Throws:
        IOException

      • 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

      • setVersionInfo

        public DiscoveryRequest.Builder setVersionInfo​(String value)
         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;

      • clearVersionInfo

        public DiscoveryRequest.Builder clearVersionInfo()
         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;

      • setVersionInfoBytes

        public DiscoveryRequest.Builder setVersionInfoBytes​(com.google.protobuf.ByteString value)
         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;

      • hasNode

        public boolean hasNode()
         The node making the request.
        .envoy.config.core.v3.Node node = 2;
        Specified by:
        hasNode in interface DiscoveryRequestOrBuilder

      • clearNode

        public DiscoveryRequest.Builder clearNode()
         The node making the request.
        .envoy.config.core.v3.Node node = 2;

      • getNodeBuilder

        public Node.Builder getNodeBuilder()
         The node making the request.
        .envoy.config.core.v3.Node node = 2;

      • 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

      • setResourceNames

        public DiscoveryRequest.Builder setResourceNames​(int index,
                                                 String value)
         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;

      • addResourceNames

        public DiscoveryRequest.Builder addResourceNames​(String value)
         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;

      • addAllResourceNames

        public DiscoveryRequest.Builder addAllResourceNames​(Iterable<String> values)
         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;

      • clearResourceNames

        public DiscoveryRequest.Builder clearResourceNames()
         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;

      • addResourceNamesBytes

        public DiscoveryRequest.Builder addResourceNamesBytes​(com.google.protobuf.ByteString value)
         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;

      • 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

      • setTypeUrl

        public DiscoveryRequest.Builder setTypeUrl​(String value)
         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;

      • clearTypeUrl

        public DiscoveryRequest.Builder clearTypeUrl()
         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;

      • setTypeUrlBytes

        public DiscoveryRequest.Builder setTypeUrlBytes​(com.google.protobuf.ByteString value)
         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;

      • 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

      • setResponseNonce

        public DiscoveryRequest.Builder setResponseNonce​(String value)
         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;

      • clearResponseNonce

        public DiscoveryRequest.Builder clearResponseNonce()
         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;

      • setResponseNonceBytes

        public DiscoveryRequest.Builder setResponseNonceBytes​(com.google.protobuf.ByteString value)
         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;

      • 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. 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_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;
        Specified by:
        getErrorDetail in interface DiscoveryRequestOrBuilder

      • setErrorDetail

        public DiscoveryRequest.Builder setErrorDetail​(Status value)
         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;

      • setErrorDetail

        public DiscoveryRequest.Builder setErrorDetail​(Status.Builder builderForValue)
         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;

      • mergeErrorDetail

        public DiscoveryRequest.Builder mergeErrorDetail​(Status value)
         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;

      • clearErrorDetail

        public DiscoveryRequest.Builder clearErrorDetail()
         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;

      • getErrorDetailBuilder

        public Status.Builder getErrorDetailBuilder()
         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;

      • 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. 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

      • setUnknownFields

        public final DiscoveryRequest.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DiscoveryRequest.Builder>

      • mergeUnknownFields

        public final DiscoveryRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DiscoveryRequest.Builder>