Interface EndpointConditions

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    EndpointConditions.Jsii$Proxy

    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
               date="2024-08-03T12:13:25.679Z")
    @Stability(Stable)
    public interface EndpointConditions
    extends software.amazon.jsii.JsiiSerializable
    EndpointConditions represents the current condition of an endpoint.
    • Method Detail

      • getReady

        @Stability(Stable)
        @Nullable
        default Boolean getReady()
        ready indicates that this endpoint is prepared to receive traffic, according to whatever system is managing the endpoint.

        A nil value indicates an unknown state. In most cases consumers should interpret this unknown state as ready. For compatibility reasons, ready should never be "true" for terminating endpoints, except when the normal readiness behavior is being explicitly overridden, for example when the associated Service has set the publishNotReadyAddresses flag.

      • getServing

        @Stability(Stable)
        @Nullable
        default Boolean getServing()
        serving is identical to ready except that it is set regardless of the terminating state of endpoints.

        This condition should be set to true for a ready endpoint that is terminating. If nil, consumers should defer to the ready condition.

      • getTerminating

        @Stability(Stable)
        @Nullable
        default Boolean getTerminating()
        terminating indicates that this endpoint is terminating.

        A nil value indicates an unknown state. Consumers should interpret this unknown state to mean that the endpoint is not terminating.