search

Documentation

Overview

Package search implements API functions residing under /search. This path contains methods to search VMs.

Index

• type API
  • func NewAPI(c client.Client) API
• type VM

Types

type API

type API interface {
	ByName(ctx context.Context, name string) ([]VM, error)
}

API contains methods for VM searching.

func NewAPI

func NewAPI(c client.Client) API

NewAPI creates a new search API instance with the given client.

type VM

type VM struct {
	Name            string `json:"name"`
	Identifier      string `json:"identifier"`
	LocationCode    string `json:"location_code"`
	LocationCountry string `json:"location_country"`
	LocationName    string `json:"location_name"`
	PrimaryIPv4     string `json:"ip_v4_primary"`
	PrimaryIPv6     string `json:"ip_v6_primary"`
	OSName          string `json:"os_name"`
	OSFamily        string `json:"os_family"`
	Tags            string `json:"tags"`
}

VM is a single VM and its metatadata.