objectapi

Documentation

Index

• type Client
  • func NewClient(token string) (*Client, error)
  • func (c *Client) Create(ctx context.Context, key, value string, overwrite bool) error
  • func (c *Client) Delete(ctx context.Context, key string, force bool) (existed bool, err error)
  • func (c *Client) List(ctx context.Context) ([]Object, error)
• type Object

Types

type Client

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

Client is meant to model an SDK client for a theoretical object store API. Because we're only using it for demo purposes, it embeds a mock server with fixed data.

func NewClient

func NewClient(token string) (*Client, error)

NewClient is meant to model a constructor for the SDK client.

func (*Client) Create

func (c *Client) Create(ctx context.Context, key, value string, overwrite bool) error

Create is some bit of functionality.

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, key string, force bool) (existed bool, err error)

Delete is some bit of functionality.

func (*Client) List

func (c *Client) List(ctx context.Context) ([]Object, error)

List is some bit of functionality.

type Object

type Object struct {
	Key    string
	Value  string
	Access time.Time
}

Object is meant to be a domain object for a theoretical object store.