Options
All
  • Public
  • Public/Protected
  • All
Menu

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

schema

io.k8s.api.discovery.v1.Endpoint

Hierarchy

  • Endpoint

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.v1.Endpoint#addresses

Optional Readonly conditions

conditions: EndpointConditions

conditions contains information about the current status of the endpoint.

schema

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

Optional Readonly deprecatedTopology

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.

schema

io.k8s.api.discovery.v1.Endpoint#deprecatedTopology

Type declaration

  • [key: string]: string

Optional Readonly hints

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

schema

io.k8s.api.discovery.v1.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.v1.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.v1.Endpoint#nodeName

Optional Readonly targetRef

targetRef: ObjectReference

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

schema

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

Optional Readonly zone

zone: string

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

schema

io.k8s.api.discovery.v1.Endpoint#zone

Generated using TypeDoc