client

Documentation

Index

• type Client
  • func NewClient(url string) *Client
  • func (c *Client) GetResource(state, module, name string) (st storage.Resource, err error)
  • func (c *Client) GetState(name string, serial int) (st storage.State, err error)
  • func (c *Client) ListStateSerials(name string) (coll storage.StateCollection, err error)
  • func (c *Client) ListStates() (states storage.StateCollection, err error)

Types

type Client

type Client struct {
	URL string
	// contains filtered or unexported fields
}

Client is a TerraDB client.

func NewClient

func NewClient(url string) *Client

NewClient returns a new TerraDB client from its URL.

func (*Client) GetResource

func (c *Client) GetResource(state, module, name string) (st storage.Resource, err error)

GetResource returns a TerraDB resource from its state, module and name.

func (*Client) GetState

func (c *Client) GetState(name string, serial int) (st storage.State, err error)

GetState returns a TerraDB state from its name and serial. Use 0 as serial to return the latest version of the state.

func (*Client) ListStateSerials

func (c *Client) ListStateSerials(name string) (coll storage.StateCollection, err error)

ListStateSerials lists all state serials and last_modified times for a given name.

func (*Client) ListStates

func (c *Client) ListStates() (states storage.StateCollection, err error)

ListStates lists all state names in TerraDB.