Versions in this module Expand all Collapse all v4 v4.1.2 Jun 10, 2022 v4.1.1 Jun 10, 2022 Changes in this version + var ErrLostSync = errors.New("lost synchronization with multiplexed stream") + func Attach(ctx context.Context, nameOrID string, stdin io.Reader, stdout io.Writer, ...) error + func Checkpoint(ctx context.Context, nameOrID string, options *CheckpointOptions) (*entities.CheckpointReport, error) + func Commit(ctx context.Context, nameOrID string, options *CommitOptions) (entities.IDResponse, error) + func ContainerInit(ctx context.Context, nameOrID string, options *InitOptions) error + func CopyFromArchive(ctx context.Context, nameOrID string, path string, reader io.Reader) (entities.ContainerCopyFunc, error) + func CopyFromArchiveWithOptions(ctx context.Context, nameOrID string, path string, reader io.Reader, ...) (entities.ContainerCopyFunc, error) + func CopyToArchive(ctx context.Context, nameOrID string, path string, writer io.Writer) (entities.ContainerCopyFunc, error) + func CreateWithSpec(ctx context.Context, s *specgen.SpecGenerator, options *CreateOptions) (entities.ContainerCreateResponse, error) + func DemuxFrame(r io.Reader, buffer []byte, length int) (frame []byte, err error) + func DemuxHeader(r io.Reader, buffer []byte) (fd, sz int, err error) + func Diff(ctx context.Context, nameOrID string, options *DiffOptions) ([]archive.Change, error) + func ExecCreate(ctx context.Context, nameOrID string, config *handlers.ExecCreateConfig) (string, error) + func ExecInspect(ctx context.Context, sessionID string, options *ExecInspectOptions) (*define.InspectExecSession, error) + func ExecStart(ctx context.Context, sessionID string, options *ExecStartOptions) error + func ExecStartAndAttach(ctx context.Context, sessionID string, options *ExecStartAndAttachOptions) error + func Exists(ctx context.Context, nameOrID string, options *ExistsOptions) (bool, error) + func Export(ctx context.Context, nameOrID string, w io.Writer, options *ExportOptions) error + func GetMountedContainerPaths(ctx context.Context, options *MountedContainerPathsOptions) (map[string]string, error) + func Inspect(ctx context.Context, nameOrID string, options *InspectOptions) (*define.InspectContainerData, error) + func Kill(ctx context.Context, nameOrID string, options *KillOptions) error + func List(ctx context.Context, options *ListOptions) ([]entities.ListContainer, error) + func Logs(ctx context.Context, nameOrID string, options *LogOptions, ...) error + func Mount(ctx context.Context, nameOrID string, options *MountOptions) (string, error) + func Pause(ctx context.Context, nameOrID string, options *PauseOptions) error + func Prune(ctx context.Context, options *PruneOptions) ([]*reports.PruneReport, error) + func Remove(ctx context.Context, nameOrID string, options *RemoveOptions) ([]*reports.RmReport, error) + func Rename(ctx context.Context, nameOrID string, options *RenameOptions) error + func ResizeContainerTTY(ctx context.Context, nameOrID string, options *ResizeTTYOptions) error + func ResizeExecTTY(ctx context.Context, nameOrID string, options *ResizeExecTTYOptions) error + func Restart(ctx context.Context, nameOrID string, options *RestartOptions) error + func Restore(ctx context.Context, nameOrID string, options *RestoreOptions) (*entities.RestoreReport, error) + func RunHealthCheck(ctx context.Context, nameOrID string, options *HealthCheckOptions) (*define.HealthCheckResults, error) + func ShouldRestart(ctx context.Context, nameOrID string, options *ShouldRestartOptions) (bool, error) + func Start(ctx context.Context, nameOrID string, options *StartOptions) error + func Stat(ctx context.Context, nameOrID string, path string) (*entities.ContainerStatReport, error) + func Stats(ctx context.Context, containers []string, options *StatsOptions) (chan entities.ContainerStatsReport, error) + func Stop(ctx context.Context, nameOrID string, options *StopOptions) error + func Top(ctx context.Context, nameOrID string, options *TopOptions) ([]string, error) + func Unmount(ctx context.Context, nameOrID string, options *UnmountOptions) error + func Unpause(ctx context.Context, nameOrID string, options *UnpauseOptions) error + func Wait(ctx context.Context, nameOrID string, options *WaitOptions) (int32, error) + type AttachOptions struct + DetachKeys *string + Logs *bool + Stream *bool + func (o *AttachOptions) Changed(fieldName string) bool + func (o *AttachOptions) GetDetachKeys() string + func (o *AttachOptions) GetLogs() bool + func (o *AttachOptions) GetStream() bool + func (o *AttachOptions) ToParams() (url.Values, error) + func (o *AttachOptions) WithDetachKeys(value string) *AttachOptions + func (o *AttachOptions) WithLogs(value bool) *AttachOptions + func (o *AttachOptions) WithStream(value bool) *AttachOptions + type CheckpointOptions struct + CreateImage *string + Export *string + FileLocks *bool + IgnoreRootfs *bool + Keep *bool + LeaveRunning *bool + PreCheckpoint *bool + PrintStats *bool + TCPEstablished *bool + WithPrevious *bool + func (o *CheckpointOptions) Changed(fieldName string) bool + func (o *CheckpointOptions) GetCreateImage() string + func (o *CheckpointOptions) GetExport() string + func (o *CheckpointOptions) GetFileLocks() bool + func (o *CheckpointOptions) GetIgnoreRootfs() bool + func (o *CheckpointOptions) GetKeep() bool + func (o *CheckpointOptions) GetLeaveRunning() bool + func (o *CheckpointOptions) GetPreCheckpoint() bool + func (o *CheckpointOptions) GetPrintStats() bool + func (o *CheckpointOptions) GetTCPEstablished() bool + func (o *CheckpointOptions) GetWithPrevious() bool + func (o *CheckpointOptions) ToParams() (url.Values, error) + func (o *CheckpointOptions) WithCreateImage(value string) *CheckpointOptions + func (o *CheckpointOptions) WithExport(value string) *CheckpointOptions + func (o *CheckpointOptions) WithFileLocks(value bool) *CheckpointOptions + func (o *CheckpointOptions) WithIgnoreRootfs(value bool) *CheckpointOptions + func (o *CheckpointOptions) WithKeep(value bool) *CheckpointOptions + func (o *CheckpointOptions) WithLeaveRunning(value bool) *CheckpointOptions + func (o *CheckpointOptions) WithPreCheckpoint(value bool) *CheckpointOptions + func (o *CheckpointOptions) WithPrintStats(value bool) *CheckpointOptions + func (o *CheckpointOptions) WithTCPEstablished(value bool) *CheckpointOptions + func (o *CheckpointOptions) WithWithPrevious(value bool) *CheckpointOptions + type CloseWriter interface + CloseWrite func() error + type CommitOptions struct + Author *string + Changes []string + Comment *string + Format *string + Pause *bool + Repo *string + Squash *bool + Tag *string + func (o *CommitOptions) Changed(fieldName string) bool + func (o *CommitOptions) GetAuthor() string + func (o *CommitOptions) GetChanges() []string + func (o *CommitOptions) GetComment() string + func (o *CommitOptions) GetFormat() string + func (o *CommitOptions) GetPause() bool + func (o *CommitOptions) GetRepo() string + func (o *CommitOptions) GetSquash() bool + func (o *CommitOptions) GetTag() string + func (o *CommitOptions) ToParams() (url.Values, error) + func (o *CommitOptions) WithAuthor(value string) *CommitOptions + func (o *CommitOptions) WithChanges(value []string) *CommitOptions + func (o *CommitOptions) WithComment(value string) *CommitOptions + func (o *CommitOptions) WithFormat(value string) *CommitOptions + func (o *CommitOptions) WithPause(value bool) *CommitOptions + func (o *CommitOptions) WithRepo(value string) *CommitOptions + func (o *CommitOptions) WithSquash(value bool) *CommitOptions + func (o *CommitOptions) WithTag(value string) *CommitOptions + type CopyOptions struct + Chown *bool + Rename map[string]string + func (o *CopyOptions) Changed(fieldName string) bool + func (o *CopyOptions) GetChown() bool + func (o *CopyOptions) GetRename() map[string]string + func (o *CopyOptions) ToParams() (url.Values, error) + func (o *CopyOptions) WithChown(value bool) *CopyOptions + func (o *CopyOptions) WithRename(value map[string]string) *CopyOptions + type CreateOptions struct + func (o *CreateOptions) Changed(fieldName string) bool + func (o *CreateOptions) ToParams() (url.Values, error) + type DiffOptions struct + DiffType *string + Parent *string + func (o *DiffOptions) Changed(fieldName string) bool + func (o *DiffOptions) GetDiffType() string + func (o *DiffOptions) GetParent() string + func (o *DiffOptions) ToParams() (url.Values, error) + func (o *DiffOptions) WithDiffType(value string) *DiffOptions + func (o *DiffOptions) WithParent(value string) *DiffOptions + type ExecInspectOptions struct + func (o *ExecInspectOptions) Changed(fieldName string) bool + func (o *ExecInspectOptions) ToParams() (url.Values, error) + type ExecStartAndAttachOptions struct + AttachError *bool + AttachInput *bool + AttachOutput *bool + ErrorStream *io.WriteCloser + InputStream *bufio.Reader + OutputStream *io.WriteCloser + func (o *ExecStartAndAttachOptions) Changed(fieldName string) bool + func (o *ExecStartAndAttachOptions) GetAttachError() bool + func (o *ExecStartAndAttachOptions) GetAttachInput() bool + func (o *ExecStartAndAttachOptions) GetAttachOutput() bool + func (o *ExecStartAndAttachOptions) GetErrorStream() io.WriteCloser + func (o *ExecStartAndAttachOptions) GetInputStream() bufio.Reader + func (o *ExecStartAndAttachOptions) GetOutputStream() io.WriteCloser + func (o *ExecStartAndAttachOptions) ToParams() (url.Values, error) + func (o *ExecStartAndAttachOptions) WithAttachError(value bool) *ExecStartAndAttachOptions + func (o *ExecStartAndAttachOptions) WithAttachInput(value bool) *ExecStartAndAttachOptions + func (o *ExecStartAndAttachOptions) WithAttachOutput(value bool) *ExecStartAndAttachOptions + func (o *ExecStartAndAttachOptions) WithErrorStream(value io.WriteCloser) *ExecStartAndAttachOptions + func (o *ExecStartAndAttachOptions) WithInputStream(value bufio.Reader) *ExecStartAndAttachOptions + func (o *ExecStartAndAttachOptions) WithOutputStream(value io.WriteCloser) *ExecStartAndAttachOptions + type ExecStartOptions struct + func (o *ExecStartOptions) Changed(fieldName string) bool + func (o *ExecStartOptions) ToParams() (url.Values, error) + type ExistsOptions struct + External *bool + func (o *ExistsOptions) Changed(fieldName string) bool + func (o *ExistsOptions) GetExternal() bool + func (o *ExistsOptions) ToParams() (url.Values, error) + func (o *ExistsOptions) WithExternal(value bool) *ExistsOptions + type ExportOptions struct + func (o *ExportOptions) Changed(fieldName string) bool + func (o *ExportOptions) ToParams() (url.Values, error) + type HealthCheckOptions struct + func (o *HealthCheckOptions) Changed(fieldName string) bool + func (o *HealthCheckOptions) ToParams() (url.Values, error) + type InitOptions struct + func (o *InitOptions) Changed(fieldName string) bool + func (o *InitOptions) ToParams() (url.Values, error) + type InspectOptions struct + Size *bool + func (o *InspectOptions) Changed(fieldName string) bool + func (o *InspectOptions) GetSize() bool + func (o *InspectOptions) ToParams() (url.Values, error) + func (o *InspectOptions) WithSize(value bool) *InspectOptions + type KillOptions struct + Signal *string + func (o *KillOptions) Changed(fieldName string) bool + func (o *KillOptions) GetSignal() string + func (o *KillOptions) ToParams() (url.Values, error) + func (o *KillOptions) WithSignal(value string) *KillOptions + type ListOptions struct + All *bool + External *bool + Filters map[string][]string + Last *int + Namespace *bool + Size *bool + Sync *bool + func (o *ListOptions) Changed(fieldName string) bool + func (o *ListOptions) GetAll() bool + func (o *ListOptions) GetExternal() bool + func (o *ListOptions) GetFilters() map[string][]string + func (o *ListOptions) GetLast() int + func (o *ListOptions) GetNamespace() bool + func (o *ListOptions) GetSize() bool + func (o *ListOptions) GetSync() bool + func (o *ListOptions) ToParams() (url.Values, error) + func (o *ListOptions) WithAll(value bool) *ListOptions + func (o *ListOptions) WithExternal(value bool) *ListOptions + func (o *ListOptions) WithFilters(value map[string][]string) *ListOptions + func (o *ListOptions) WithLast(value int) *ListOptions + func (o *ListOptions) WithNamespace(value bool) *ListOptions + func (o *ListOptions) WithSize(value bool) *ListOptions + func (o *ListOptions) WithSync(value bool) *ListOptions + type LogOptions struct + Follow *bool + Since *string + Stderr *bool + Stdout *bool + Tail *string + Timestamps *bool + Until *string + func (o *LogOptions) Changed(fieldName string) bool + func (o *LogOptions) GetFollow() bool + func (o *LogOptions) GetSince() string + func (o *LogOptions) GetStderr() bool + func (o *LogOptions) GetStdout() bool + func (o *LogOptions) GetTail() string + func (o *LogOptions) GetTimestamps() bool + func (o *LogOptions) GetUntil() string + func (o *LogOptions) ToParams() (url.Values, error) + func (o *LogOptions) WithFollow(value bool) *LogOptions + func (o *LogOptions) WithSince(value string) *LogOptions + func (o *LogOptions) WithStderr(value bool) *LogOptions + func (o *LogOptions) WithStdout(value bool) *LogOptions + func (o *LogOptions) WithTail(value string) *LogOptions + func (o *LogOptions) WithTimestamps(value bool) *LogOptions + func (o *LogOptions) WithUntil(value string) *LogOptions + type MountOptions struct + func (o *MountOptions) Changed(fieldName string) bool + func (o *MountOptions) ToParams() (url.Values, error) + type MountedContainerPathsOptions struct + func (o *MountedContainerPathsOptions) Changed(fieldName string) bool + func (o *MountedContainerPathsOptions) ToParams() (url.Values, error) + type PauseOptions struct + func (o *PauseOptions) Changed(fieldName string) bool + func (o *PauseOptions) ToParams() (url.Values, error) + type PruneOptions struct + Filters map[string][]string + func (o *PruneOptions) Changed(fieldName string) bool + func (o *PruneOptions) GetFilters() map[string][]string + func (o *PruneOptions) ToParams() (url.Values, error) + func (o *PruneOptions) WithFilters(value map[string][]string) *PruneOptions + type RemoveOptions struct + Depend *bool + Force *bool + Ignore *bool + Timeout *uint + Volumes *bool + func (o *RemoveOptions) Changed(fieldName string) bool + func (o *RemoveOptions) GetDepend() bool + func (o *RemoveOptions) GetForce() bool + func (o *RemoveOptions) GetIgnore() bool + func (o *RemoveOptions) GetTimeout() uint + func (o *RemoveOptions) GetVolumes() bool + func (o *RemoveOptions) ToParams() (url.Values, error) + func (o *RemoveOptions) WithDepend(value bool) *RemoveOptions + func (o *RemoveOptions) WithForce(value bool) *RemoveOptions + func (o *RemoveOptions) WithIgnore(value bool) *RemoveOptions + func (o *RemoveOptions) WithTimeout(value uint) *RemoveOptions + func (o *RemoveOptions) WithVolumes(value bool) *RemoveOptions + type RenameOptions struct + Name *string + func (o *RenameOptions) Changed(fieldName string) bool + func (o *RenameOptions) GetName() string + func (o *RenameOptions) ToParams() (url.Values, error) + func (o *RenameOptions) WithName(value string) *RenameOptions + type ResizeExecTTYOptions struct + Height *int + Width *int + func (o *ResizeExecTTYOptions) Changed(fieldName string) bool + func (o *ResizeExecTTYOptions) GetHeight() int + func (o *ResizeExecTTYOptions) GetWidth() int + func (o *ResizeExecTTYOptions) ToParams() (url.Values, error) + func (o *ResizeExecTTYOptions) WithHeight(value int) *ResizeExecTTYOptions + func (o *ResizeExecTTYOptions) WithWidth(value int) *ResizeExecTTYOptions + type ResizeTTYOptions struct + Height *int + Running *bool + Width *int + func (o *ResizeTTYOptions) Changed(fieldName string) bool + func (o *ResizeTTYOptions) GetHeight() int + func (o *ResizeTTYOptions) GetRunning() bool + func (o *ResizeTTYOptions) GetWidth() int + func (o *ResizeTTYOptions) ToParams() (url.Values, error) + func (o *ResizeTTYOptions) WithHeight(value int) *ResizeTTYOptions + func (o *ResizeTTYOptions) WithRunning(value bool) *ResizeTTYOptions + func (o *ResizeTTYOptions) WithWidth(value int) *ResizeTTYOptions + type RestartOptions struct + Timeout *int + func (o *RestartOptions) Changed(fieldName string) bool + func (o *RestartOptions) GetTimeout() int + func (o *RestartOptions) ToParams() (url.Values, error) + func (o *RestartOptions) WithTimeout(value int) *RestartOptions + type RestoreOptions struct + FileLocks *bool + IgnoreRootfs *bool + IgnoreStaticIP *bool + IgnoreStaticMAC *bool + IgnoreVolumes *bool + ImportAchive *string + ImportArchive *string + Keep *bool + Name *string + Pod *string + PrintStats *bool + PublishPorts []string + TCPEstablished *bool + func (o *RestoreOptions) Changed(fieldName string) bool + func (o *RestoreOptions) GetFileLocks() bool + func (o *RestoreOptions) GetIgnoreRootfs() bool + func (o *RestoreOptions) GetIgnoreStaticIP() bool + func (o *RestoreOptions) GetIgnoreStaticMAC() bool + func (o *RestoreOptions) GetIgnoreVolumes() bool + func (o *RestoreOptions) GetImportAchive() string + func (o *RestoreOptions) GetImportArchive() string + func (o *RestoreOptions) GetKeep() bool + func (o *RestoreOptions) GetName() string + func (o *RestoreOptions) GetPod() string + func (o *RestoreOptions) GetPrintStats() bool + func (o *RestoreOptions) GetPublishPorts() []string + func (o *RestoreOptions) GetTCPEstablished() bool + func (o *RestoreOptions) ToParams() (url.Values, error) + func (o *RestoreOptions) WithFileLocks(value bool) *RestoreOptions + func (o *RestoreOptions) WithIgnoreRootfs(value bool) *RestoreOptions + func (o *RestoreOptions) WithIgnoreStaticIP(value bool) *RestoreOptions + func (o *RestoreOptions) WithIgnoreStaticMAC(value bool) *RestoreOptions + func (o *RestoreOptions) WithIgnoreVolumes(value bool) *RestoreOptions + func (o *RestoreOptions) WithImportAchive(value string) *RestoreOptions + func (o *RestoreOptions) WithImportArchive(value string) *RestoreOptions + func (o *RestoreOptions) WithKeep(value bool) *RestoreOptions + func (o *RestoreOptions) WithName(value string) *RestoreOptions + func (o *RestoreOptions) WithPod(value string) *RestoreOptions + func (o *RestoreOptions) WithPrintStats(value bool) *RestoreOptions + func (o *RestoreOptions) WithPublishPorts(value []string) *RestoreOptions + func (o *RestoreOptions) WithTCPEstablished(value bool) *RestoreOptions + type ShouldRestartOptions struct + func (o *ShouldRestartOptions) Changed(fieldName string) bool + func (o *ShouldRestartOptions) ToParams() (url.Values, error) + type StartOptions struct + DetachKeys *string + Recursive *bool + func (o *StartOptions) Changed(fieldName string) bool + func (o *StartOptions) GetDetachKeys() string + func (o *StartOptions) GetRecursive() bool + func (o *StartOptions) ToParams() (url.Values, error) + func (o *StartOptions) WithDetachKeys(value string) *StartOptions + func (o *StartOptions) WithRecursive(value bool) *StartOptions + type StatsOptions struct + Interval *int + Stream *bool + func (o *StatsOptions) Changed(fieldName string) bool + func (o *StatsOptions) GetInterval() int + func (o *StatsOptions) GetStream() bool + func (o *StatsOptions) ToParams() (url.Values, error) + func (o *StatsOptions) WithInterval(value int) *StatsOptions + func (o *StatsOptions) WithStream(value bool) *StatsOptions + type StopOptions struct + Ignore *bool + Timeout *uint + func (o *StopOptions) Changed(fieldName string) bool + func (o *StopOptions) GetIgnore() bool + func (o *StopOptions) GetTimeout() uint + func (o *StopOptions) ToParams() (url.Values, error) + func (o *StopOptions) WithIgnore(value bool) *StopOptions + func (o *StopOptions) WithTimeout(value uint) *StopOptions + type TopOptions struct + Descriptors *[]string + func (o *TopOptions) Changed(fieldName string) bool + func (o *TopOptions) GetDescriptors() []string + func (o *TopOptions) ToParams() (url.Values, error) + func (o *TopOptions) WithDescriptors(value []string) *TopOptions + type UnmountOptions struct + func (o *UnmountOptions) Changed(fieldName string) bool + func (o *UnmountOptions) ToParams() (url.Values, error) + type UnpauseOptions struct + func (o *UnpauseOptions) Changed(fieldName string) bool + func (o *UnpauseOptions) ToParams() (url.Values, error) + type WaitOptions struct + Condition []define.ContainerStatus + Interval *string + func (o *WaitOptions) Changed(fieldName string) bool + func (o *WaitOptions) GetCondition() []define.ContainerStatus + func (o *WaitOptions) GetInterval() string + func (o *WaitOptions) ToParams() (url.Values, error) + func (o *WaitOptions) WithCondition(value []define.ContainerStatus) *WaitOptions + func (o *WaitOptions) WithInterval(value string) *WaitOptions
Go to main page