Package org.cdk8s.plus24.k8s

Interface EndpointV1Beta1

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EndpointV1Beta1.Jsii$Proxy

@Generated(value="jsii-pacmak/1.72.0 (build 4b8828b)",
           date="2022-12-15T15:42:36.529Z")
@Stability(Stable)
public interface EndpointV1Beta1
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	EndpointV1Beta1.Builder	A builder for EndpointV1Beta1
static class	EndpointV1Beta1.Jsii$Proxy	An implementation for EndpointV1Beta1

Method Summary

Modifier and Type	Method	Description
static EndpointV1Beta1.Builder	builder()
List<String>	getAddresses()	addresses of this endpoint.
default EndpointConditionsV1Beta1	getConditions()	conditions contains information about the current status of the endpoint.
default EndpointHintsV1Beta1	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 Map<String,String>	getTopology()	topology contains arbitrary topology information associated with the endpoint.

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 EndpointConditionsV1Beta1 getConditions()

conditions contains information about the current status of the endpoint.

getHints

@Stability(Stable)
@Nullable
default EndpointHintsV1Beta1 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. This field can be enabled with the EndpointSliceNodeName feature gate.

getTargetRef

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

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

getTopology

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

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.

builder

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

Returns:

a EndpointV1Beta1.Builder of EndpointV1Beta1