Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

config

package module

Go to main page

Versions in this module

v0

v0.2.0

Jul 14, 2026

Changes in this version

type Client

+ func (c *Client) ClearRegistry()

+ func (c *Client) ResolveServiceRegistryFirst(ctx context.Context, in ResolveInput) (ServiceRecord, error)

type Option

+ func WithRegistry(registryURL string) Option

+ type RegistryClient struct

+ BaseURL string

+ HTTPClient *http.Client

+ func NewRegistryClient(baseURL string) *RegistryClient

+ func (r *RegistryClient) Resolve(ctx context.Context, service, region string) (ServiceRecord, error)

v0.1.0

Jun 25, 2026

Changes in this version

+ var ErrConflict = errors.New("conflict")

+ var ErrForbidden = errors.New("forbidden")

+ var ErrInternal = errors.New("internal error")

+ var ErrNotFound = errors.New("not found")

+ var ErrUnauthorized = errors.New("unauthorized")

+ var ErrValidation = errors.New("validation failed")

+ type Client struct

+ func New(endpoint, token string, opts ...Option) *Client

+ func (c *Client) CreateRegion(ctx context.Context, in CreateRegionInput) (RegionDetail, error)

+ func (c *Client) DeleteRegion(ctx context.Context, in RegionIdInput) error

+ func (c *Client) DeregisterService(ctx context.Context, in DeregisterInput) error

+ func (c *Client) Endpoint() string

+ func (c *Client) GetRegionDetail(ctx context.Context, in RegionPathInput) (RegionDetail, error)

+ func (c *Client) GetZone(ctx context.Context) (ZoneOutput, error)

+ func (c *Client) HeartbeatService(ctx context.Context, in HeartbeatInput) error

+ func (c *Client) ListRegionServices(ctx context.Context, in RegionPathInput) (ServiceListOutput, error)

+ func (c *Client) ListRegions(ctx context.Context) (ListRegionsOutput, error)

+ func (c *Client) ListServiceRegions(ctx context.Context, in ServicePathInput) (ServiceListOutput, error)

+ func (c *Client) ListSubscriptions(ctx context.Context, in ListSubscriptionsInput) (SubscriptionsOutput, error)

+ func (c *Client) RegisterService(ctx context.Context, in ServiceRecord) (ServiceRecord, error)

+ func (c *Client) ResolveService(ctx context.Context, in ResolveInput) (ServiceRecord, error)

+ func (c *Client) Subscribe(ctx context.Context, in SubscribeInput) (Subscription, error)

+ func (c *Client) Unsubscribe(ctx context.Context, in SubscriptionIdInput) error

+ func (c *Client) UpdateServiceLifecycle(ctx context.Context, in UpdateLifecycleInput) error

+ type CreateRegionInput struct

+ Description string

+ Id string

+ Name string

+ type DeregisterInput struct

+ Vrn string

+ type ErrorEnvelope struct

+ Code string

+ Details map[string]any

+ Message string

+ RequestID string

+ Status int

+ TraceID string

+ func (e ErrorEnvelope) Error() string

+ type HeartbeatInput struct

+ Status string

+ Vrn string

+ type ListRegionsOutput struct

+ Regions []string

+ type ListSubscriptionsInput struct

+ Region string

+ Service string

+ type Option func(*Client)

+ func WithHTTPClient(h *http.Client) Option

+ func WithTimeout(d time.Duration) Option

+ type RegionDetail struct

+ CreatedAt string

+ Region string

+ ServiceCount int

+ Services []string

+ type RegionIdInput struct

+ Id string

+ type RegionPathInput struct

+ Region string

+ type ResolveInput struct

+ Region string

+ Service string

+ type ServiceListOutput struct

+ Count int

+ Services []*ServiceRecord

+ type ServicePathInput struct

+ Service string

+ type ServiceRecord struct

+ CustomProperties map[string]interface{}

+ DnsName string

+ Endpoint string

+ Env string

+ HealthCheckUrl string

+ LastHeartbeat string

+ Meta map[string]string

+ Region string

+ RegisteredAt string

+ Scope string

+ Service string

+ Status string

+ Vrn string

+ type SubscribeInput struct

+ Region string

+ Service string

+ SubscriberVrn string

+ type Subscription struct

+ CreatedAt string

+ Id string

+ Region string

+ Service string

+ SubscriberVrn string

+ type SubscriptionIdInput struct

+ Id string

+ type SubscriptionsOutput struct

+ Subscriptions []*Subscription

+ type UpdateLifecycleInput struct

+ Reason string

+ Status string

+ Vrn string

+ type ZoneOutput struct

+ Body string