client

Documentation

Index

• type Client
  • func New(ctx *cli.Context) *Client
  • func NewFromEndpoint(endpoint string) *Client
  • func (c *Client) CARExport(ctx context.Context) (*car.CarReader, func() error, error)
  • func (c *Client) Close() error
  • func (c *Client) Complete(ctx context.Context, worker string) error
  • func (c *Client) CreateRetrievalTask(ctx context.Context, retrievalTask tasks.RetrievalTask) (tasks.Task, error)
  • func (c *Client) CreateStorageTask(ctx context.Context, storageTask tasks.StorageTask) (tasks.Task, error)
  • func (c *Client) DeleteTask(ctx context.Context, uuid string) error
  • func (c *Client) Drain(ctx context.Context, worker string) error
  • func (c *Client) GetTask(ctx context.Context, uuid string) (tasks.Task, error)
  • func (c *Client) ListTasks(ctx context.Context) ([]tasks.Task, error)
  • func (c *Client) PopTask(ctx context.Context, r tasks.PopTask) (tasks.Task, error)
  • func (c *Client) ResetWorker(ctx context.Context, worker string) error
  • func (c *Client) UpdateTask(ctx context.Context, uuid string, r tasks.UpdateTask) (tasks.Task, error)
• type ErrRequestFailed
  • func (e ErrRequestFailed) Error() string

Types

type Client

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

Client is the API client that performs all operations against the dealbot controller.

func New

func New(ctx *cli.Context) *Client

New initializes a new API client

func NewFromEndpoint

func NewFromEndpoint(endpoint string) *Client

NewFromEndpoint returns an API client at the given endpoint

func (*Client) CARExport

func (c *Client) CARExport(ctx context.Context) (*car.CarReader, func() error, error)

func (*Client) Close

func (c *Client) Close() error

Close the transport used by the client

func (*Client) Complete

func (c *Client) Complete(ctx context.Context, worker string) error

func (*Client) CreateRetrievalTask

func (c *Client) CreateRetrievalTask(ctx context.Context, retrievalTask tasks.RetrievalTask) (tasks.Task, error)

func (*Client) CreateStorageTask

func (c *Client) CreateStorageTask(ctx context.Context, storageTask tasks.StorageTask) (tasks.Task, error)

func (*Client) DeleteTask

func (c *Client) DeleteTask(ctx context.Context, uuid string) error

func (*Client) Drain

func (c *Client) Drain(ctx context.Context, worker string) error

func (*Client) GetTask

func (c *Client) GetTask(ctx context.Context, uuid string) (tasks.Task, error)

func (*Client) ListTasks

func (c *Client) ListTasks(ctx context.Context) ([]tasks.Task, error)

func (*Client) PopTask

func (c *Client) PopTask(ctx context.Context, r tasks.PopTask) (tasks.Task, error)

PopTask requests a Task from the controller.

The PopTask request specifies the initial status to set the task to, the identity of client requesting and assigned the task, and any tagged tasks that are begin requested.

If the request specifies no tags, then this selects any task. If the request specifies tags, then this selects any task with a tag matching one of the tags in the request, or any untagged task.

func (*Client) ResetWorker

func (c *Client) ResetWorker(ctx context.Context, worker string) error

func (*Client) UpdateTask

func (c *Client) UpdateTask(ctx context.Context, uuid string, r tasks.UpdateTask) (tasks.Task, error)

type ErrRequestFailed

type ErrRequestFailed struct {
	Code int
}

func (ErrRequestFailed) Error

func (e ErrRequestFailed) Error() string