v0

Documentation

Index

• type Credentials
• type DeleteResponse
• type ListResponse
• type Lookup
• type LookupResponse
• type Network
• type RegisterResponse
• type Registration
• type ServerAnnotation

Types

type Credentials

type Credentials struct {
	// ServiceAccountKey contains the base64 encoded service account key for use
	// by the node after registration.
	ServiceAccountKey string
}

Credentials contains public or private key data needed for node operations.

type DeleteResponse

type DeleteResponse struct {
	Error *v2.Error `json:",omitempty"`
}

DeleteResponse is returned by a delete request.

type ListResponse

type ListResponse struct {
	Error        *v2.Error                `json:",omitempty"`
	StaticConfig []discovery.StaticConfig `json:",omitempty"`
	Servers      []string                 `json:",omitempty"`
	Sites        []string                 `json:",omitempty"`
}

ListResponse is returned by a list request.

type Lookup

type Lookup struct {
	IATA string
}

Lookup is returned for a successful lookup request.

type LookupResponse

type LookupResponse struct {
	Error  *v2.Error `json:",omitempty"`
	Lookup *Lookup   `json:",omitempty"`
}

LookupResponse is returned by a lookup request.

type Network

type Network struct {
	IPv4 string
	IPv6 string
}

Network contains IPv4 and IPv6 addresses.

type RegisterResponse

type RegisterResponse struct {
	Error        *v2.Error     `json:",omitempty"`
	Registration *Registration `json:",omitempty"`
}

RegisterResponse is returned by a register request.

type Registration

type Registration struct {
	// Hostname is the dynamic DNS name. Hostname should be available immediately.
	Hostname string

	// Annotation is the metadata used by the uuid-annotator for all server annotations.
	Annotation *ServerAnnotation `json:",omitempty"`
	// Heartbeat is the registration message used by the heartbeat service to register with the Locate API.
	Heartbeat *v2.Registration `json:",omitempty"`

	// Credentials contains node key data.
	Credentials *Credentials `json:",omitempty"`
}

Registration is returned for a successful registration request.

type ServerAnnotation

type ServerAnnotation struct {
	Annotation annotator.ServerAnnotations
	Network    Network
	Type       string
}

ServerAnnotation is used by the uuid-annotator. From: https://github.com/m-lab/uuid-annotator/blob/main/siteannotator/server.go#L83-L90