Package io.envoyproxy.envoy.api.v2

Class DiscoveryResponse

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, DiscoveryResponseOrBuilder, Serializable
    public final class DiscoveryResponse
extends com.google.protobuf.GeneratedMessageV3
implements DiscoveryResponseOrBuilder
     [#next-free-field: 7]
    Protobuf type envoy.api.v2.DiscoveryResponse
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  DiscoveryResponse.Builder
      [#next-free-field: 7]

      • 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

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • 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

      • getVersionInfoBytes

        public com.google.protobuf.ByteString getVersionInfoBytes()
         The version of the response data.
        string version_info = 1;
        Specified by:
        getVersionInfoBytes in interface DiscoveryResponseOrBuilder
        Returns:
        The bytes for versionInfo.

      • getResourcesList

        public List<com.google.protobuf.Any> getResourcesList()
         The response resources. These resources are typed and depend on the API being called.
        repeated .google.protobuf.Any resources = 2;
        Specified by:
        getResourcesList in interface DiscoveryResponseOrBuilder

      • getResourcesOrBuilderList

        public List<? extends com.google.protobuf.AnyOrBuilder> getResourcesOrBuilderList()
         The response resources. These resources are typed and depend on the API being called.
        repeated .google.protobuf.Any resources = 2;
        Specified by:
        getResourcesOrBuilderList in interface DiscoveryResponseOrBuilder

      • getResourcesCount

        public int getResourcesCount()
         The response resources. These resources are typed and depend on the API being called.
        repeated .google.protobuf.Any resources = 2;
        Specified by:
        getResourcesCount in interface DiscoveryResponseOrBuilder

      • getResources

        public com.google.protobuf.Any getResources​(int index)
         The response resources. These resources are typed and depend on the API being called.
        repeated .google.protobuf.Any resources = 2;
        Specified by:
        getResources in interface DiscoveryResponseOrBuilder

      • getResourcesOrBuilder

        public com.google.protobuf.AnyOrBuilder getResourcesOrBuilder​(int index)
         The response resources. These resources are typed and depend on the API being called.
        repeated .google.protobuf.Any resources = 2;
        Specified by:
        getResourcesOrBuilder in interface DiscoveryResponseOrBuilder

      • getCanary

        public boolean getCanary()
         [#not-implemented-hide:]
 Canary is used to support two Envoy command line flags:
 * --terminate-on-canary-transition-failure. When set, Envoy is able to
   terminate if it detects that configuration is stuck at canary. Consider
   this example sequence of updates:
   - Management server applies a canary config successfully.
   - Management server rolls back to a production config.
   - Envoy rejects the new production config.
   Since there is no sensible way to continue receiving configuration
   updates, Envoy will then terminate and apply production config from a
   clean slate.
 * --dry-run-canary. When set, a canary response will never be applied, only
   validated via a dry run.
        bool canary = 3;
        Specified by:
        getCanary in interface DiscoveryResponseOrBuilder
        Returns:
        The canary.

      • getTypeUrl

        public String getTypeUrl()
         Type URL for resources. Identifies the xDS API when muxing over ADS.
 Must be consistent with the type_url in the 'resources' repeated Any (if non-empty).
        string type_url = 4;
        Specified by:
        getTypeUrl in interface DiscoveryResponseOrBuilder
        Returns:
        The typeUrl.

      • getTypeUrlBytes

        public com.google.protobuf.ByteString getTypeUrlBytes()
         Type URL for resources. Identifies the xDS API when muxing over ADS.
 Must be consistent with the type_url in the 'resources' repeated Any (if non-empty).
        string type_url = 4;
        Specified by:
        getTypeUrlBytes in interface DiscoveryResponseOrBuilder
        Returns:
        The bytes for typeUrl.

      • getNonce

        public String getNonce()
         For gRPC based subscriptions, the nonce provides a way to explicitly ack a
 specific DiscoveryResponse in a following DiscoveryRequest. Additional
 messages may have been sent by Envoy to the management server for the
 previous version on the stream prior to this DiscoveryResponse, that were
 unprocessed at response send time. The nonce allows the management server
 to ignore any further DiscoveryRequests for the previous version until a
 DiscoveryRequest bearing the nonce. The nonce is optional and is not
 required for non-stream based xDS implementations.
        string nonce = 5;
        Specified by:
        getNonce in interface DiscoveryResponseOrBuilder
        Returns:
        The nonce.

      • getNonceBytes

        public com.google.protobuf.ByteString getNonceBytes()
         For gRPC based subscriptions, the nonce provides a way to explicitly ack a
 specific DiscoveryResponse in a following DiscoveryRequest. Additional
 messages may have been sent by Envoy to the management server for the
 previous version on the stream prior to this DiscoveryResponse, that were
 unprocessed at response send time. The nonce allows the management server
 to ignore any further DiscoveryRequests for the previous version until a
 DiscoveryRequest bearing the nonce. The nonce is optional and is not
 required for non-stream based xDS implementations.
        string nonce = 5;
        Specified by:
        getNonceBytes in interface DiscoveryResponseOrBuilder
        Returns:
        The bytes for nonce.

      • hasControlPlane

        public boolean hasControlPlane()
         [#not-implemented-hide:]
 The control plane instance that sent the response.
        .envoy.api.v2.core.ControlPlane control_plane = 6;
        Specified by:
        hasControlPlane in interface DiscoveryResponseOrBuilder
        Returns:
        Whether the controlPlane field is set.

      • getControlPlane

        public ControlPlane getControlPlane()
         [#not-implemented-hide:]
 The control plane instance that sent the response.
        .envoy.api.v2.core.ControlPlane control_plane = 6;
        Specified by:
        getControlPlane in interface DiscoveryResponseOrBuilder
        Returns:
        The controlPlane.

      • 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 DiscoveryResponse parseFrom​(ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DiscoveryResponse parseFrom​(ByteBuffer data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DiscoveryResponse parseFrom​(com.google.protobuf.ByteString data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DiscoveryResponse parseFrom​(com.google.protobuf.ByteString data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DiscoveryResponse parseFrom​(byte[] data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DiscoveryResponse parseFrom​(byte[] data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DiscoveryResponse parseFrom​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException
        Throws:
        IOException

      • newBuilderForType

        public DiscoveryResponse.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public DiscoveryResponse.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected DiscoveryResponse.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<DiscoveryResponse> 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 DiscoveryResponse getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder