client

package module

v0.15.1 Latest Latest Go to latest Published: May 8, 2024 License: Apache-2.0 Imports: 12 Imported by: 7

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

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

func New(httpClient base_client.HTTPClient, baseUrl string) *Client

func (c *Client) AddImage(ctx context.Context, img string) (jobId string, err error)

func (c *Client) CancelJob(ctx context.Context, id string) error

func (c *Client) ContainerExec(ctx context.Context, id string, exeConf model.ExecConfig) (jobId string, err error)

func (c *Client) CreateContainer(ctx context.Context, container model.Container) (id string, err error)

func (c *Client) CreateNetwork(ctx context.Context, net model.Network) (string, error)

func (c *Client) CreateVolume(ctx context.Context, vol model.Volume) (string, error)

func (c *Client) GetContainer(ctx context.Context, id string) (model.Container, error)

func (c *Client) GetContainerLog(ctx context.Context, id string, logOptions model.LogFilter) (io.ReadCloser, error)

func (c *Client) GetContainers(ctx context.Context, filter model.ContainerFilter) ([]model.Container, error)

func (c *Client) GetImage(ctx context.Context, id string) (model.Image, error)

func (c *Client) GetImages(ctx context.Context, filter model.ImageFilter) ([]model.Image, error)

func (c *Client) GetJob(ctx context.Context, id string) (job_hdl_lib.Job, error)

func (c *Client) GetJobs(ctx context.Context, filter job_hdl_lib.JobFilter) ([]job_hdl_lib.Job, error)

func (c *Client) GetNetwork(ctx context.Context, id string) (model.Network, error)

func (c *Client) GetNetworks(ctx context.Context) ([]model.Network, error)

func (c *Client) GetSrvInfo(ctx context.Context) srv_info_lib.SrvInfo

func (c *Client) GetVolume(ctx context.Context, id string) (model.Volume, error)

func (c *Client) GetVolumes(ctx context.Context, filter model.VolumeFilter) ([]model.Volume, error)

func (c *Client) RemoveContainer(ctx context.Context, id string, force bool) error

func (c *Client) RemoveImage(ctx context.Context, id string) error

func (c *Client) RemoveNetwork(ctx context.Context, id string) error

func (c *Client) RemoveVolume(ctx context.Context, id string, force bool) error

func (c *Client) RestartContainer(ctx context.Context, id string) (jobId string, err error)

func (c *Client) StartContainer(ctx context.Context, id string) error

func (c *Client) StopContainer(ctx context.Context, id string) (jobId string, err error)