host

Documentation

Index

• func GetOpts(opt ...Option) (options, error)
• func Register(subtype subtypes.Subtype, prefixes ...string) error
• func SubtypeFromId(id string) subtypes.Subtype
• func SubtypeFromType(t string) subtypes.Subtype
• type Catalog
• type DnsName
  • func NewDnsName(ctx context.Context, hostId string, name string) (*DnsName, error)
  • func (c *DnsName) Clone() *DnsName
  • func (c *DnsName) SetTableName(n string)
  • func (c *DnsName) TableName() string
• type Endpoint
• type Host
• type IpAddress
  • func NewIpAddress(ctx context.Context, hostId string, address string) (*IpAddress, error)
  • func (c *IpAddress) Clone() *IpAddress
  • func (c *IpAddress) SetTableName(n string)
  • func (c *IpAddress) TableName() string
• type Option
  • func WithLimit(l int) Option
  • func WithOrderByCreateTime(ascending bool) Option
• type PreferredEndpoint
  • func AllocPreferredEndpoint() *PreferredEndpoint
  • func NewPreferredEndpoint(ctx context.Context, hostSetId string, priority uint32, condition string) (*PreferredEndpoint, error)
  • func (c *PreferredEndpoint) Clone() *PreferredEndpoint
  • func (c *PreferredEndpoint) SetTableName(n string)
  • func (c *PreferredEndpoint) TableName() string
• type Set

Functions

func GetOpts

func GetOpts(opt ...Option) (options, error)

GetOpts - iterate the inbound Options and return a struct

func Register

func Register(subtype subtypes.Subtype, prefixes ...string) error

Register registers all the prefixes for a provided Subtype. Register returns an error if the subtype has already been registered or if any of the prefixes are associated with another subtype.

func SubtypeFromId

func SubtypeFromId(id string) subtypes.Subtype

SubtypeFromId returns the Subtype from the provided id if the id's prefix was registered with a Subtype. Otherwise Unknown is returned.

func SubtypeFromType

func SubtypeFromType(t string) subtypes.Subtype

SubtypeFromType returns the Subtype from the provided string or if no Subtype was registered with that string Unknown is returned.

Types

type Catalog

type Catalog interface {
	boundary.Resource
	GetScopeId() string
}

Catalog contains the common methods across all the different types of host catalogs.

type DnsName

type DnsName struct {
	*store.DnsName
	// contains filtered or unexported fields
}

func NewDnsName

func NewDnsName(ctx context.Context, hostId string, name string) (*DnsName, error)

func (*DnsName) Clone

func (c *DnsName) Clone() *DnsName

Clone an DnsName

func (*DnsName) SetTableName

func (c *DnsName) SetTableName(n string)

SetTableName sets the table name.

func (*DnsName) TableName

func (c *DnsName) TableName() string

TableName returns the table name.

type Endpoint

type Endpoint struct {
	HostId  string
	SetId   string
	Address string
}

Endpoint is a struct which identifies an address provided by a host and selected as the priority address by the specified host set.

type Host

type Host interface {
	boundary.Resource
	GetCatalogId() string
	GetAddress() string
	GetIpAddresses() []string
	GetDnsNames() []string
}

Host contains the common methods across all the different types of hosts.

type IpAddress

type IpAddress struct {
	*store.IpAddress
	// contains filtered or unexported fields
}

func NewIpAddress

func NewIpAddress(ctx context.Context, hostId string, address string) (*IpAddress, error)

func (*IpAddress) Clone

func (c *IpAddress) Clone() *IpAddress

Clone an IpAddress

func (*IpAddress) SetTableName

func (c *IpAddress) SetTableName(n string)

SetTableName sets the table name.

func (*IpAddress) TableName

func (c *IpAddress) TableName() string

TableName returns the table name.

type Option

type Option func(*options) error

Option - how Options are passed as arguments.

func WithLimit

func WithLimit(l int) Option

WithLimit provides an option to provide a limit. Intentionally allowing negative integers. If WithLimit < 0, then unlimited results are returned. If WithLimit == 0, then default limits are used for results.

func WithOrderByCreateTime

func WithOrderByCreateTime(ascending bool) Option

WithOrderByCreateTime provides an option to specify ordering by the CreateTime field.

type PreferredEndpoint

type PreferredEndpoint struct {
	*store.PreferredEndpoint
	// contains filtered or unexported fields
}

PreferredEndpoint defines an endpoint condition for a host set. PreferredEndpoints are value objects of an HostSet, therefore there's no need for oplog metadata, since only the HostSet will have metadata because it's the root aggregate.

func AllocPreferredEndpoint

func AllocPreferredEndpoint() *PreferredEndpoint

AllocPreferredEndpoint makes an empty one in-memory

func NewPreferredEndpoint

func NewPreferredEndpoint(ctx context.Context, hostSetId string, priority uint32, condition string) (*PreferredEndpoint, error)

NewPreferredEndpoint creates a new in memory preferred endpoint assigned to a HostSet. It supports no options.

func (*PreferredEndpoint) Clone

func (c *PreferredEndpoint) Clone() *PreferredEndpoint

Clone a PreferredEndpoint

func (*PreferredEndpoint) SetTableName

func (c *PreferredEndpoint) SetTableName(n string)

SetTableName sets the table name.

func (*PreferredEndpoint) TableName

func (c *PreferredEndpoint) TableName() string

TableName returns the table name.

type Set

type Set interface {
	boundary.Resource
	GetCatalogId() string
}

Set contains the common methods across all the different types of host sets.