Package org.cdk8s.plus25.k8s

Interface Endpoint

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

Endpoint.Jsii$Proxy

@Generated(value="jsii-pacmak/1.88.0 (build eaabd08)",
           date="2023-09-11T06:17:58.512Z")
@Stability(Stable)
public interface Endpoint
extends software.amazon.jsii.JsiiSerializable

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Endpoint.Builder	A builder for Endpoint
static class	Endpoint.Jsii$Proxy	An implementation for Endpoint

Method Summary

Modifier and Type	Method	Description
static Endpoint.Builder	builder()
List<String>	getAddresses()	addresses of this endpoint.
default EndpointConditions	getConditions()	conditions contains information about the current status of the endpoint.
default Map<String,String>	getDeprecatedTopology()	deprecatedTopology contains topology information part of the v1beta1 API.
default EndpointHints	getHints()	hints contains information associated with how an endpoint should be consumed.
default String	getHostname()	hostname of this endpoint.
default String	getNodeName()	nodeName represents the name of the Node hosting this endpoint.
default ObjectReference	getTargetRef()	targetRef is a reference to a Kubernetes object that represents this endpoint.
default String	getZone()	zone is the name of the Zone this endpoint exists in.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAddresses

@Stability(Stable)
@NotNull
List<String> getAddresses()

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. These are all assumed to be fungible and clients may choose to only use the first element. Refer to: https://issue.k8s.io/106267

getConditions

@Stability(Stable)
@Nullable
default EndpointConditions getConditions()

conditions contains information about the current status of the endpoint.

getDeprecatedTopology

@Stability(Stable)
@Nullable
default Map<String,String> getDeprecatedTopology()

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.

getHints

@Stability(Stable)
@Nullable
default EndpointHints getHints()

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

getHostname

@Stability(Stable)
@Nullable
default String getHostname()

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.

getNodeName

@Stability(Stable)
@Nullable
default String getNodeName()

nodeName represents the name of the Node hosting this endpoint.

This can be used to determine endpoints local to a Node.

getTargetRef

@Stability(Stable)
@Nullable
default ObjectReference getTargetRef()

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

getZone

@Stability(Stable)
@Nullable
default String getZone()

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

builder

@Stability(Stable)
static Endpoint.Builder builder()

Returns:

a Endpoint.Builder of Endpoint