endpoint

Documentation

Index

• Constants
• type Endpoint
  • func NewEndpoint(dnsName, target, recordType string) *Endpoint
  • func NewEndpointWithTTL(dnsName, target, recordType string, ttl TTL) *Endpoint
  • func (e *Endpoint) MergeLabels(labels map[string]string)
  • func (e *Endpoint) String() string
• type TTL
  • func (ttl TTL) IsConfigured() bool

Constants

const (
	// OwnerLabelKey is the name of the label that defines the owner of an Endpoint.
	OwnerLabelKey = "owner"
	// RecordTypeA is a RecordType enum value
	RecordTypeA = "A"
	// RecordTypeCNAME is a RecordType enum value
	RecordTypeCNAME = "CNAME"
	// RecordTypeTXT is a RecordType enum value
	RecordTypeTXT = "TXT"
)

Types

type Endpoint

type Endpoint struct {
	// The hostname of the DNS record
	DNSName string
	// The target the DNS record points to
	Target string
	// RecordType type of record, e.g. CNAME, A, TXT etc
	RecordType string
	// TTL for the record
	RecordTTL TTL
	// Labels stores labels defined for the Endpoint
	Labels map[string]string
}

Endpoint is a high-level way of a connection between a service and an IP

func NewEndpoint

func NewEndpoint(dnsName, target, recordType string) *Endpoint

NewEndpoint initialization method to be used to create an endpoint

func NewEndpointWithTTL

func NewEndpointWithTTL(dnsName, target, recordType string, ttl TTL) *Endpoint

NewEndpointWithTTL initialization method to be used to create an endpoint with a TTL struct

func (*Endpoint) MergeLabels

func (e *Endpoint) MergeLabels(labels map[string]string)

MergeLabels adds keys to labels if not defined for the endpoint

func (*Endpoint) String

func (e *Endpoint) String() string

type TTL

type TTL int64

TTL is a structure defining the TTL of a DNS record

func (TTL) IsConfigured

func (ttl TTL) IsConfigured() bool

IsConfigured returns true if TTL is configured, false otherwise