Packages

case class EndpointConditions(ready: Optional[Boolean] = Optional.Absent, serving: Optional[Boolean] = Optional.Absent, terminating: Optional[Boolean] = Optional.Absent) extends Product with Serializable

EndpointConditions represents the current condition of an endpoint.

ready

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.

serving

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. This field can be enabled with the EndpointSliceTerminatingCondition feature gate.

terminating

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. This field can be enabled with the EndpointSliceTerminatingCondition feature gate.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EndpointConditions
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new EndpointConditions(ready: Optional[Boolean] = Optional.Absent, serving: Optional[Boolean] = Optional.Absent, terminating: Optional[Boolean] = Optional.Absent)

    ready

    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.

    serving

    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. This field can be enabled with the EndpointSliceTerminatingCondition feature gate.

    terminating

    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. This field can be enabled with the EndpointSliceTerminatingCondition feature gate.

Value Members

  1. def getReady: IO[K8sFailure, Boolean]

    ready indicates that this endpoint is prepared to receive traffic, according to whatever system is managing the endpoint.

    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.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  2. def getServing: IO[K8sFailure, Boolean]

    serving is identical to ready except that it is set regardless of the terminating state of endpoints.

    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. This field can be enabled with the EndpointSliceTerminatingCondition feature gate.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  3. def getTerminating: IO[K8sFailure, Boolean]

    terminating indicates that this endpoint is terminating.

    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. This field can be enabled with the EndpointSliceTerminatingCondition feature gate.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  4. val ready: Optional[Boolean]
  5. val serving: Optional[Boolean]
  6. val terminating: Optional[Boolean]