Packages

case class Endpoint(addresses: Vector[String], conditions: Optional[EndpointConditions] = Optional.Absent, deprecatedTopology: Optional[Map[String, String]] = Optional.Absent, hints: Optional[EndpointHints] = Optional.Absent, hostname: Optional[String] = Optional.Absent, nodeName: Optional[String] = Optional.Absent, targetRef: Optional[ObjectReference] = Optional.Absent, zone: Optional[String] = Optional.Absent) extends Product with Serializable

Endpoint represents a single logical "backend" implementing a service.

addresses

addresses of this endpoint. The contents of this field are interpreted according to the corresponding EndpointSlice addressType field. Consumers must handle different types of addresses in the context of their own capabilities. This must contain at least one address but no more than 100.

deprecatedTopology

deprecatedTopology contains topology information part of the v1beta1 API. This field is deprecated, and will be removed when the v1beta1 API is removed (no sooner than kubernetes v1.24). While this field can hold values, it is not writable through the v1 API, and any attempts to write to it will be silently ignored. Topology information can be found in the zone and nodeName fields instead.

hostname

hostname of this endpoint. This field may be used by consumers of endpoints to distinguish endpoints from each other (e.g. in DNS names). Multiple endpoints which use the same hostname should be considered fungible (e.g. multiple A values in DNS). Must be lowercase and pass DNS Label (RFC 1123) validation.

nodeName

nodeName represents the name of the Node hosting this endpoint. This can be used to determine endpoints local to a Node. This field can be enabled with the EndpointSliceNodeName feature gate.

zone

zone is the name of the Zone this endpoint exists in.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Endpoint
  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 Endpoint(addresses: Vector[String], conditions: Optional[EndpointConditions] = Optional.Absent, deprecatedTopology: Optional[Map[String, String]] = Optional.Absent, hints: Optional[EndpointHints] = Optional.Absent, hostname: Optional[String] = Optional.Absent, nodeName: Optional[String] = Optional.Absent, targetRef: Optional[ObjectReference] = Optional.Absent, zone: Optional[String] = Optional.Absent)

    addresses

    addresses of this endpoint. The contents of this field are interpreted according to the corresponding EndpointSlice addressType field. Consumers must handle different types of addresses in the context of their own capabilities. This must contain at least one address but no more than 100.

    deprecatedTopology

    deprecatedTopology contains topology information part of the v1beta1 API. This field is deprecated, and will be removed when the v1beta1 API is removed (no sooner than kubernetes v1.24). While this field can hold values, it is not writable through the v1 API, and any attempts to write to it will be silently ignored. Topology information can be found in the zone and nodeName fields instead.

    hostname

    hostname of this endpoint. This field may be used by consumers of endpoints to distinguish endpoints from each other (e.g. in DNS names). Multiple endpoints which use the same hostname should be considered fungible (e.g. multiple A values in DNS). Must be lowercase and pass DNS Label (RFC 1123) validation.

    nodeName

    nodeName represents the name of the Node hosting this endpoint. This can be used to determine endpoints local to a Node. This field can be enabled with the EndpointSliceNodeName feature gate.

    zone

    zone is the name of the Zone this endpoint exists in.

Value Members

  1. val addresses: Vector[String]
  2. val conditions: Optional[EndpointConditions]
  3. val deprecatedTopology: Optional[Map[String, String]]
  4. def getAddresses: IO[K8sFailure, Vector[String]]

    addresses of this endpoint.

    addresses of this endpoint. The contents of this field are interpreted according to the corresponding EndpointSlice addressType field. Consumers must handle different types of addresses in the context of their own capabilities. This must contain at least one address but no more than 100.

    This effect always succeeds, it is safe to use the field addresses directly.

  5. def getConditions: IO[K8sFailure, EndpointConditions]

    Gets conditions.

    Gets conditions.

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

  6. def getDeprecatedTopology: IO[K8sFailure, Map[String, String]]

    deprecatedTopology contains topology information part of the v1beta1 API.

    deprecatedTopology contains topology information part of the v1beta1 API. This field is deprecated, and will be removed when the v1beta1 API is removed (no sooner than kubernetes v1.24). While this field can hold values, it is not writable through the v1 API, and any attempts to write to it will be silently ignored. Topology information can be found in the zone and nodeName fields instead.

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

  7. def getHints: IO[K8sFailure, EndpointHints]

    Gets hints.

    Gets hints.

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

  8. def getHostname: IO[K8sFailure, String]

    hostname of this endpoint.

    hostname of this endpoint. This field may be used by consumers of endpoints to distinguish endpoints from each other (e.g. in DNS names). Multiple endpoints which use the same hostname should be considered fungible (e.g. multiple A values in DNS). Must be lowercase and pass DNS Label (RFC 1123) validation.

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

  9. def getNodeName: IO[K8sFailure, String]

    nodeName represents the name of the Node hosting this endpoint.

    nodeName represents the name of the Node hosting this endpoint. This can be used to determine endpoints local to a Node. This field can be enabled with the EndpointSliceNodeName feature gate.

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

  10. def getTargetRef: IO[K8sFailure, ObjectReference]

    Gets targetRef.

    Gets targetRef.

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

  11. def getZone: IO[K8sFailure, String]

    zone is the name of the Zone this endpoint exists in.

    zone is the name of the Zone this endpoint exists in.

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

  12. val hints: Optional[EndpointHints]
  13. val hostname: Optional[String]
  14. val nodeName: Optional[String]
  15. val targetRef: Optional[ObjectReference]
  16. val zone: Optional[String]