struct Kubernetes::Endpoint

Overview

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

Included Modules

Defined in:

generated/models/io_k8s_api_discovery_v1.cr

Constructors

Macro Summary

Instance Method Summary

Constructor Detail

def self.new(ctx : YAML::ParseContext, node : YAML::Nodes::Node) #

def self.new(pull : ::JSON::PullParser) #

def self.new(*, __pull_for_json_serializable pull : ::JSON::PullParser) #

def self.new(*, __context_for_yaml_serializable ctx : YAML::ParseContext, __node_for_yaml_serializable node : YAML::Nodes::Node) #

Macro Detail

macro field(name, type = nil, **options, &block) #

Helper macro for defining fields with automatic camelCase conversion


Instance Method Detail

def addresses : Array(String) | Nil #

addresses of this endpoint. For EndpointSlices of addressType "IPv4" or "IPv6", the values are IP addresses in canonical form. The syntax and semantics of other addressType values are not defined. This must contain at least one address but no more than 100. EndpointSlices generated by the EndpointSlice controller will always have exactly 1 address. No semantics are defined for additional addresses beyond the first, and kube-proxy does not look at them.


def addresses=(addresses : Array(String) | Nil) #

addresses of this endpoint. For EndpointSlices of addressType "IPv4" or "IPv6", the values are IP addresses in canonical form. The syntax and semantics of other addressType values are not defined. This must contain at least one address but no more than 100. EndpointSlices generated by the EndpointSlice controller will always have exactly 1 address. No semantics are defined for additional addresses beyond the first, and kube-proxy does not look at them.


def conditions : EndpointConditions | Nil #

conditions contains information about the current status of the endpoint.


def conditions=(conditions : EndpointConditions | Nil) #

conditions contains information about the current status of the endpoint.


def deprecated_topology : Hash(String, String) | Nil #

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.


def deprecated_topology=(deprecated_topology : Hash(String, String) | Nil) #

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.


def hints : EndpointHints | Nil #

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


def hints=(hints : EndpointHints | Nil) #

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


def hostname : String | Nil #

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.


def hostname=(hostname : String | Nil) #

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.


def node_name : String | Nil #

nodeName represents the name of the Node hosting this endpoint. This can be used to determine endpoints local to a Node.


def node_name=(node_name : String | Nil) #

nodeName represents the name of the Node hosting this endpoint. This can be used to determine endpoints local to a Node.


def target_ref : ObjectReference | Nil #

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


def target_ref=(target_ref : ObjectReference | Nil) #

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


def zone : String | Nil #

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


def zone=(zone : String | Nil) #

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