Packages

case class Endpoint(addresses: Vector[String], conditions: Optional[EndpointConditions] = Optional.Absent, hints: Optional[EndpointHints] = Optional.Absent, hostname: Optional[String] = Optional.Absent, nodeName: Optional[String] = Optional.Absent, targetRef: Optional[ObjectReference] = Optional.Absent, topology: Optional[Map[String, 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.

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.

topology

topology contains arbitrary topology information associated with the endpoint. These key/value pairs must conform with the label format. https://kubernetes.io/docs/concepts/overview/working-with-objects/labels Topology may include a maximum of 16 key/value pairs. This includes, but is not limited to the following well known keys: * kubernetes.io/hostname: the value indicates the hostname of the node where the endpoint is located. This should match the corresponding node label. topology.kubernetes.io/zone: the value indicates the zone where the endpoint is located. This should match the corresponding node label. topology.kubernetes.io/region: the value indicates the region where the endpoint is located. This should match the corresponding node label. This field is deprecated and will be removed in future api versions.

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, hints: Optional[EndpointHints] = Optional.Absent, hostname: Optional[String] = Optional.Absent, nodeName: Optional[String] = Optional.Absent, targetRef: Optional[ObjectReference] = Optional.Absent, topology: Optional[Map[String, 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.

    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.

    topology

    topology contains arbitrary topology information associated with the endpoint. These key/value pairs must conform with the label format. https://kubernetes.io/docs/concepts/overview/working-with-objects/labels Topology may include a maximum of 16 key/value pairs. This includes, but is not limited to the following well known keys: * kubernetes.io/hostname: the value indicates the hostname of the node where the endpoint is located. This should match the corresponding node label. topology.kubernetes.io/zone: the value indicates the zone where the endpoint is located. This should match the corresponding node label. topology.kubernetes.io/region: the value indicates the region where the endpoint is located. This should match the corresponding node label. This field is deprecated and will be removed in future api versions.

Value Members

  1. val addresses: Vector[String]
  2. val conditions: Optional[EndpointConditions]
  3. 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.

  4. def getConditions: IO[K8sFailure, EndpointConditions]

    Gets conditions.

    Gets conditions.

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

  5. def getHints: IO[K8sFailure, EndpointHints]

    Gets hints.

    Gets hints.

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

  6. 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.

  7. 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.

  8. def getTargetRef: IO[K8sFailure, ObjectReference]

    Gets targetRef.

    Gets targetRef.

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

  9. def getTopology: IO[K8sFailure, Map[String, String]]

    topology contains arbitrary topology information associated with the endpoint.

    topology contains arbitrary topology information associated with the endpoint. These key/value pairs must conform with the label format. https://kubernetes.io/docs/concepts/overview/working-with-objects/labels Topology may include a maximum of 16 key/value pairs. This includes, but is not limited to the following well known keys: * kubernetes.io/hostname: the value indicates the hostname of the node where the endpoint is located. This should match the corresponding node label. topology.kubernetes.io/zone: the value indicates the zone where the endpoint is located. This should match the corresponding node label. topology.kubernetes.io/region: the value indicates the region where the endpoint is located. This should match the corresponding node label. This field is deprecated and will be removed in future api versions.

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

  10. val hints: Optional[EndpointHints]
  11. val hostname: Optional[String]
  12. val nodeName: Optional[String]
  13. val targetRef: Optional[ObjectReference]
  14. val topology: Optional[Map[String, String]]