Interface DiscoveryResponseOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    DiscoveryResponse, DiscoveryResponse.Builder

    public interface DiscoveryResponseOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean getCanary()
      [#not-implemented-hide:] Canary is used to support two Envoy command line flags: * --terminate-on-canary-transition-failure.
      ControlPlane getControlPlane()
      The control plane instance that sent the response.
      ControlPlaneOrBuilder getControlPlaneOrBuilder()
      The control plane instance that sent the response.
      java.lang.String getNonce()
      For gRPC based subscriptions, the nonce provides a way to explicitly ack a specific DiscoveryResponse in a following DiscoveryRequest.
      com.google.protobuf.ByteString getNonceBytes()
      For gRPC based subscriptions, the nonce provides a way to explicitly ack a specific DiscoveryResponse in a following DiscoveryRequest.
      com.google.protobuf.Any getResources​(int index)
      The response resources.
      int getResourcesCount()
      The response resources.
      java.util.List<com.google.protobuf.Any> getResourcesList()
      The response resources.
      com.google.protobuf.AnyOrBuilder getResourcesOrBuilder​(int index)
      The response resources.
      java.util.List<? extends com.google.protobuf.AnyOrBuilder> getResourcesOrBuilderList()
      The response resources.
      java.lang.String getTypeUrl()
      Type URL for resources.
      com.google.protobuf.ByteString getTypeUrlBytes()
      Type URL for resources.
      java.lang.String getVersionInfo()
      The version of the response data.
      com.google.protobuf.ByteString getVersionInfoBytes()
      The version of the response data.
      boolean hasControlPlane()
      The control plane instance that sent the response.
      • 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 Detail

      • getVersionInfo

        java.lang.String getVersionInfo()
         The version of the response data.
         
        string version_info = 1;
        Returns:
        The versionInfo.
      • getVersionInfoBytes

        com.google.protobuf.ByteString getVersionInfoBytes()
         The version of the response data.
         
        string version_info = 1;
        Returns:
        The bytes for versionInfo.
      • getResourcesList

        java.util.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;
      • getResources

        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;
      • getResourcesCount

        int getResourcesCount()
         The response resources. These resources are typed and depend on the API being called.
         
        repeated .google.protobuf.Any resources = 2;
      • getResourcesOrBuilderList

        java.util.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;
      • getResourcesOrBuilder

        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;
      • getCanary

        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;
        Returns:
        The canary.
      • getTypeUrl

        java.lang.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;
        Returns:
        The typeUrl.
      • getTypeUrlBytes

        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;
        Returns:
        The bytes for typeUrl.
      • getNonce

        java.lang.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;
        Returns:
        The nonce.
      • getNonceBytes

        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;
        Returns:
        The bytes for nonce.
      • hasControlPlane

        boolean hasControlPlane()
         The control plane instance that sent the response.
         
        .envoy.config.core.v3.ControlPlane control_plane = 6;
        Returns:
        Whether the controlPlane field is set.
      • getControlPlane

        ControlPlane getControlPlane()
         The control plane instance that sent the response.
         
        .envoy.config.core.v3.ControlPlane control_plane = 6;
        Returns:
        The controlPlane.
      • getControlPlaneOrBuilder

        ControlPlaneOrBuilder getControlPlaneOrBuilder()
         The control plane instance that sent the response.
         
        .envoy.config.core.v3.ControlPlane control_plane = 6;