Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EndpointV1Beta1

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

schema

io.k8s.api.discovery.v1beta1.Endpoint

Hierarchy

  • EndpointV1Beta1

Index

Properties

Readonly addresses

addresses: string[]

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.

schema

io.k8s.api.discovery.v1beta1.Endpoint#addresses

Optional Readonly conditions

conditions contains information about the current status of the endpoint.

schema

io.k8s.api.discovery.v1beta1.Endpoint#conditions

Optional Readonly hints

hints contains information associated with how an endpoint should be consumed.

schema

io.k8s.api.discovery.v1beta1.Endpoint#hints

Optional Readonly hostname

hostname: string

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.

schema

io.k8s.api.discovery.v1beta1.Endpoint#hostname

Optional Readonly nodeName

nodeName: string

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.

schema

io.k8s.api.discovery.v1beta1.Endpoint#nodeName

Optional Readonly targetRef

targetRef: ObjectReference

targetRef is a reference to a Kubernetes object that represents this endpoint.

schema

io.k8s.api.discovery.v1beta1.Endpoint#targetRef

Optional Readonly topology

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

io.k8s.api.discovery.v1beta1.Endpoint#topology

Type declaration

  • [key: string]: string

Generated using TypeDoc