Documentation ¶
Index ¶
- Variables
- 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) (handlers.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 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) 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
- 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
- func (o *CheckpointOptions) Changed(fieldName string) bool
- func (o *CheckpointOptions) GetExport() string
- func (o *CheckpointOptions) GetIgnoreRootfs() bool
- func (o *CheckpointOptions) GetKeep() bool
- func (o *CheckpointOptions) GetLeaveRunning() bool
- func (o *CheckpointOptions) GetTCPEstablished() bool
- func (o *CheckpointOptions) ToParams() (url.Values, error)
- func (o *CheckpointOptions) WithExport(value string) *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) WithTCPEstablished(value bool) *CheckpointOptions
- type CommitOptions
- 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) 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) WithTag(value string) *CommitOptions
- type CreateOptions
- type DiffOptions
- type ExecInspectOptions
- type ExecStartAndAttachOptions
- 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
- type ExistsOptions
- type ExportOptions
- type HealthCheckOptions
- type InitOptions
- type InspectOptions
- type KillOptions
- type ListOptions
- 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
- 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
- type MountedContainerPathsOptions
- type PauseOptions
- type PruneOptions
- type RemoveOptions
- func (o *RemoveOptions) Changed(fieldName string) bool
- func (o *RemoveOptions) GetForce() bool
- func (o *RemoveOptions) GetIgnore() bool
- func (o *RemoveOptions) GetVolumes() bool
- func (o *RemoveOptions) ToParams() (url.Values, error)
- func (o *RemoveOptions) WithForce(value bool) *RemoveOptions
- func (o *RemoveOptions) WithIgnore(value bool) *RemoveOptions
- func (o *RemoveOptions) WithVolumes(value bool) *RemoveOptions
- type RenameOptions
- type ResizeExecTTYOptions
- 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
- 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
- type RestoreOptions
- func (o *RestoreOptions) Changed(fieldName string) bool
- func (o *RestoreOptions) GetIgnoreRootfs() bool
- func (o *RestoreOptions) GetIgnoreStaticIP() bool
- func (o *RestoreOptions) GetIgnoreStaticMAC() bool
- func (o *RestoreOptions) GetImportAchive() string
- func (o *RestoreOptions) GetKeep() bool
- func (o *RestoreOptions) GetName() string
- func (o *RestoreOptions) GetTCPEstablished() bool
- func (o *RestoreOptions) ToParams() (url.Values, error)
- func (o *RestoreOptions) WithIgnoreRootfs(value bool) *RestoreOptions
- func (o *RestoreOptions) WithIgnoreStaticIP(value bool) *RestoreOptions
- func (o *RestoreOptions) WithIgnoreStaticMAC(value bool) *RestoreOptions
- func (o *RestoreOptions) WithImportAchive(value string) *RestoreOptions
- func (o *RestoreOptions) WithKeep(value bool) *RestoreOptions
- func (o *RestoreOptions) WithName(value string) *RestoreOptions
- func (o *RestoreOptions) WithTCPEstablished(value bool) *RestoreOptions
- type ShouldRestartOptions
- type StartOptions
- type StatsOptions
- type StopOptions
- 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
- type UnmountOptions
- type UnpauseOptions
- type WaitOptions
- 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
Constants ¶
This section is empty.
Variables ¶
var (
ErrLostSync = errors.New("lost synchronization with multiplexed stream")
)
Functions ¶
func Attach ¶
func Attach(ctx context.Context, nameOrID string, stdin io.Reader, stdout io.Writer, stderr io.Writer, attachReady chan bool, options *AttachOptions) error
Attach attaches to a running container
func Checkpoint ¶
func Checkpoint(ctx context.Context, nameOrID string, options *CheckpointOptions) (*entities.CheckpointReport, error)
Checkpoint checkpoints the given container (identified by nameOrID). All additional options are options and allow for more fine grained control of the checkpoint process.
func Commit ¶
func Commit(ctx context.Context, nameOrID string, options *CommitOptions) (handlers.IDResponse, error)
Commit creates a container image from a container. The container is defined by nameOrID. Use the CommitOptions for finer grain control on characteristics of the resulting image.
func ContainerInit ¶
func ContainerInit(ctx context.Context, nameOrID string, options *InitOptions) error
ContainerInit takes a created container and executes all of the preparations to run the container except it will not start or attach to the container
func CopyFromArchive ¶
func CopyToArchive ¶
func CreateWithSpec ¶
func CreateWithSpec(ctx context.Context, s *specgen.SpecGenerator, options *CreateOptions) (entities.ContainerCreateResponse, error)
func DemuxFrame ¶
DemuxFrame reads contents for frame from server multiplexed stdin/stdout/stderr/2nd error channel
func DemuxHeader ¶
DemuxHeader reads header for stream from server multiplexed stdin/stdout/stderr/2nd error channel
func ExecCreate ¶
func ExecCreate(ctx context.Context, nameOrID string, config *handlers.ExecCreateConfig) (string, error)
ExecCreate creates a new exec session in an existing container. The exec session will not be started; that is done with ExecStart. Returns ID of new exec session, or an error if one occurred.
func ExecInspect ¶
func ExecInspect(ctx context.Context, sessionID string, options *ExecInspectOptions) (*define.InspectExecSession, error)
ExecInspect inspects an existing exec session, returning detailed information about it.
func ExecStart ¶
func ExecStart(ctx context.Context, sessionID string, options *ExecStartOptions) error
ExecStart starts (but does not attach to) a given exec session.
func ExecStartAndAttach ¶
func ExecStartAndAttach(ctx context.Context, sessionID string, options *ExecStartAndAttachOptions) error
ExecStartAndAttach starts and attaches to a given exec session.
func Exists ¶
Exists is a quick, light-weight way to determine if a given container exists in local storage. The nameOrID can be a container name or a partial/full ID.
func Export ¶
Export creates a tarball of the given name or ID of a container. It requires an io.Writer be provided to write the tarball.
func GetMountedContainerPaths ¶
func GetMountedContainerPaths(ctx context.Context, options *MountedContainerPathsOptions) (map[string]string, error)
GetMountedContainerPaths returns a map of mounted containers and their mount locations.
func Inspect ¶
func Inspect(ctx context.Context, nameOrID string, options *InspectOptions) (*define.InspectContainerData, error)
Inspect returns low level information about a Container. The nameOrID can be a container name or a partial/full ID. The size bool determines whether the size of the container's root filesystem should be calculated. Calculating the size of a container requires extra work from the filesystem and is therefore slower.
func Kill ¶
func Kill(ctx context.Context, nameOrID string, options *KillOptions) error
Kill sends a given signal to a given container. The signal should be the string representation of a signal like 'SIGKILL'. The nameOrID can be a container name or a partial/full ID
func List ¶
func List(ctx context.Context, options *ListOptions) ([]entities.ListContainer, error)
List obtains a list of containers in local storage. All parameters to this method are optional. The filters are used to determine which containers are listed. The last parameter indicates to only return the most recent number of containers. The pod and size booleans indicate that pod information and rootfs size information should also be included. Finally, the sync bool synchronizes the OCI runtime and container state.
func Logs ¶
func Logs(ctx context.Context, nameOrID string, options *LogOptions, stdoutChan, stderrChan chan string) error
Logs obtains a container's logs given the options provided. The logs are then sent to the stdout|stderr channels as strings.
func Mount ¶
Mount mounts an existing container to the filesystem. It returns the path of the mounted container in string format.
func Pause ¶
func Pause(ctx context.Context, nameOrID string, options *PauseOptions) error
Pause pauses a given container. The nameOrID can be a container name or a partial/full ID.
func Prune ¶
func Prune(ctx context.Context, options *PruneOptions) ([]*reports.PruneReport, error)
Prune removes stopped and exited containers from local storage. The optional filters can be used for more granular selection of containers. The main error returned indicates if there were runtime errors like finding containers. Errors specific to the removal of a container are in the PruneContainerResponse structure.
func Remove ¶
func Remove(ctx context.Context, nameOrID string, options *RemoveOptions) error
Remove removes a container from local storage. The force bool designates that the container should be removed forcibly (example, even it is running). The volumes bool dictates that a container's volumes should also be removed. The All option indicates that all containers should be removed The Ignore option indicates that if a container did not exist, ignore the error
func Rename ¶
func Rename(ctx context.Context, nameOrID string, options *RenameOptions) error
Rename an existing container.
func ResizeContainerTTY ¶
func ResizeContainerTTY(ctx context.Context, nameOrID string, options *ResizeTTYOptions) error
ResizeContainerTTY sets container's TTY height and width in characters
func ResizeExecTTY ¶
func ResizeExecTTY(ctx context.Context, nameOrID string, options *ResizeExecTTYOptions) error
ResizeExecTTY sets session's TTY height and width in characters
func Restart ¶
func Restart(ctx context.Context, nameOrID string, options *RestartOptions) error
Restart restarts a running container. The nameOrID can be a container name or a partial/full ID. The optional timeout specifies the number of seconds to wait for the running container to stop before killing it.
func Restore ¶
func Restore(ctx context.Context, nameOrID string, options *RestoreOptions) (*entities.RestoreReport, error)
Restore restores a checkpointed container to running. The container is identified by the nameOrID option. All additional options are optional and allow finer control of the restore process.
func RunHealthCheck ¶
func RunHealthCheck(ctx context.Context, nameOrID string, options *HealthCheckOptions) (*define.HealthCheckResults, error)
RunHealthCheck executes the container's healthcheck and returns the health status of the container.
func ShouldRestart ¶
func Start ¶
func Start(ctx context.Context, nameOrID string, options *StartOptions) error
Start starts a non-running container.The nameOrID can be a container name or a partial/full ID. The optional parameter for detach keys are to override the default detach key sequence.
func Stat ¶
Stat checks if the specified path is on the container. Note that the stat report may be set even in case of an error. This happens when the path resolves to symlink pointing to a non-existent path.
func Stats ¶
func Stats(ctx context.Context, containers []string, options *StatsOptions) (chan entities.ContainerStatsReport, error)
func Stop ¶
func Stop(ctx context.Context, nameOrID string, options *StopOptions) error
Stop stops a running container. The timeout is optional. The nameOrID can be a container name or a partial/full ID
func Top ¶
Top gathers statistics about the running processes in a container. The nameOrID can be a container name or a partial/full ID. The descriptors allow for specifying which data to collect from the process.
func Unmount ¶
func Unmount(ctx context.Context, nameOrID string, options *UnmountOptions) error
Unmount unmounts a container from the filesystem. The container must not be running or the unmount will fail.
func Unpause ¶
func Unpause(ctx context.Context, nameOrID string, options *UnpauseOptions) error
Unpause resumes the given paused container. The nameOrID can be a container name or a partial/full ID.
Types ¶
type AttachOptions ¶
AttachOptions are optional options for attaching to containers
func (*AttachOptions) WithDetachKeys ¶
func (o *AttachOptions) WithDetachKeys(value string) *AttachOptions
WithDetachKeys
func (*AttachOptions) WithLogs ¶
func (o *AttachOptions) WithLogs(value bool) *AttachOptions
WithLogs
func (*AttachOptions) WithStream ¶
func (o *AttachOptions) WithStream(value bool) *AttachOptions
WithStream
type CheckpointOptions ¶
type CheckpointOptions struct { Export *string IgnoreRootfs *bool Keep *bool LeaveRunning *bool TCPEstablished *bool }
CheckpointOptions are optional options for checkpointing containers
func (*CheckpointOptions) Changed ¶
func (o *CheckpointOptions) Changed(fieldName string) bool
Changed
func (*CheckpointOptions) GetIgnoreRootfs ¶
func (o *CheckpointOptions) GetIgnoreRootfs() bool
GetIgnoreRootfs
func (*CheckpointOptions) GetLeaveRunning ¶
func (o *CheckpointOptions) GetLeaveRunning() bool
GetLeaveRunning
func (*CheckpointOptions) GetTCPEstablished ¶
func (o *CheckpointOptions) GetTCPEstablished() bool
GetTCPEstablished
func (*CheckpointOptions) ToParams ¶
func (o *CheckpointOptions) ToParams() (url.Values, error)
ToParams
func (*CheckpointOptions) WithExport ¶
func (o *CheckpointOptions) WithExport(value string) *CheckpointOptions
WithExport
func (*CheckpointOptions) WithIgnoreRootfs ¶
func (o *CheckpointOptions) WithIgnoreRootfs(value bool) *CheckpointOptions
WithIgnoreRootfs
func (*CheckpointOptions) WithKeep ¶
func (o *CheckpointOptions) WithKeep(value bool) *CheckpointOptions
WithKeep
func (*CheckpointOptions) WithLeaveRunning ¶
func (o *CheckpointOptions) WithLeaveRunning(value bool) *CheckpointOptions
WithLeaveRunning
func (*CheckpointOptions) WithTCPEstablished ¶
func (o *CheckpointOptions) WithTCPEstablished(value bool) *CheckpointOptions
WithTCPEstablished
type CommitOptions ¶
type CommitOptions struct { Author *string Changes []string Comment *string Format *string Pause *bool Repo *string Tag *string }
CommitOptions describe details about the resulting committed image as defined by repo and tag. None of these options are required.
func (*CommitOptions) WithAuthor ¶
func (o *CommitOptions) WithAuthor(value string) *CommitOptions
WithAuthor
func (*CommitOptions) WithChanges ¶
func (o *CommitOptions) WithChanges(value []string) *CommitOptions
WithChanges
func (*CommitOptions) WithComment ¶
func (o *CommitOptions) WithComment(value string) *CommitOptions
WithComment
func (*CommitOptions) WithFormat ¶
func (o *CommitOptions) WithFormat(value string) *CommitOptions
WithFormat
func (*CommitOptions) WithPause ¶
func (o *CommitOptions) WithPause(value bool) *CommitOptions
WithPause
func (*CommitOptions) WithRepo ¶
func (o *CommitOptions) WithRepo(value string) *CommitOptions
WithRepo
func (*CommitOptions) WithTag ¶
func (o *CommitOptions) WithTag(value string) *CommitOptions
WithTag
type CreateOptions ¶
type CreateOptions struct{}
CreateOptions are optional options for creating containers
type DiffOptions ¶
type DiffOptions struct{}
DiffOptions are optional options for creating containers
type ExecInspectOptions ¶
type ExecInspectOptions struct{}
ExecInspectOptions are optional options for inspecting exec sessions
func (*ExecInspectOptions) Changed ¶
func (o *ExecInspectOptions) Changed(fieldName string) bool
Changed
type ExecStartAndAttachOptions ¶
type ExecStartAndAttachOptions struct { // OutputStream will be attached to container's STDOUT OutputStream *io.WriteCloser // ErrorStream will be attached to container's STDERR ErrorStream *io.WriteCloser // InputStream will be attached to container's STDIN InputStream *bufio.Reader // AttachOutput is whether to attach to STDOUT // If false, stdout will not be attached AttachOutput *bool // AttachError is whether to attach to STDERR // If false, stdout will not be attached AttachError *bool // AttachInput is whether to attach to STDIN // If false, stdout will not be attached AttachInput *bool }
ExecStartAndAttachOptions are optional options for resizing container ExecTTYs
func (*ExecStartAndAttachOptions) Changed ¶
func (o *ExecStartAndAttachOptions) Changed(fieldName string) bool
Changed
func (*ExecStartAndAttachOptions) GetAttachError ¶
func (o *ExecStartAndAttachOptions) GetAttachError() bool
GetAttachError
func (*ExecStartAndAttachOptions) GetAttachInput ¶
func (o *ExecStartAndAttachOptions) GetAttachInput() bool
GetAttachInput
func (*ExecStartAndAttachOptions) GetAttachOutput ¶
func (o *ExecStartAndAttachOptions) GetAttachOutput() bool
GetAttachOutput
func (*ExecStartAndAttachOptions) GetErrorStream ¶
func (o *ExecStartAndAttachOptions) GetErrorStream() io.WriteCloser
GetErrorStream
func (*ExecStartAndAttachOptions) GetInputStream ¶
func (o *ExecStartAndAttachOptions) GetInputStream() bufio.Reader
GetInputStream
func (*ExecStartAndAttachOptions) GetOutputStream ¶
func (o *ExecStartAndAttachOptions) GetOutputStream() io.WriteCloser
GetOutputStream
func (*ExecStartAndAttachOptions) ToParams ¶
func (o *ExecStartAndAttachOptions) ToParams() (url.Values, error)
ToParams
func (*ExecStartAndAttachOptions) WithAttachError ¶
func (o *ExecStartAndAttachOptions) WithAttachError(value bool) *ExecStartAndAttachOptions
WithAttachError
func (*ExecStartAndAttachOptions) WithAttachInput ¶
func (o *ExecStartAndAttachOptions) WithAttachInput(value bool) *ExecStartAndAttachOptions
WithAttachInput
func (*ExecStartAndAttachOptions) WithAttachOutput ¶
func (o *ExecStartAndAttachOptions) WithAttachOutput(value bool) *ExecStartAndAttachOptions
WithAttachOutput
func (*ExecStartAndAttachOptions) WithErrorStream ¶
func (o *ExecStartAndAttachOptions) WithErrorStream(value io.WriteCloser) *ExecStartAndAttachOptions
WithErrorStream
func (*ExecStartAndAttachOptions) WithInputStream ¶
func (o *ExecStartAndAttachOptions) WithInputStream(value bufio.Reader) *ExecStartAndAttachOptions
WithInputStream
func (*ExecStartAndAttachOptions) WithOutputStream ¶
func (o *ExecStartAndAttachOptions) WithOutputStream(value io.WriteCloser) *ExecStartAndAttachOptions
WithOutputStream
type ExecStartOptions ¶
type ExecStartOptions struct{}
ExecStartOptions are optional options for starting exec sessions
func (*ExecStartOptions) Changed ¶
func (o *ExecStartOptions) Changed(fieldName string) bool
Changed
type ExistsOptions ¶
type ExistsOptions struct { // External checks for containers created outside of Podman External *bool }
ExistsOptions are optional options for checking if a container exists
func (*ExistsOptions) WithExternal ¶
func (o *ExistsOptions) WithExternal(value bool) *ExistsOptions
WithExternal
type ExportOptions ¶
type ExportOptions struct{}
ExportOptions are optional options for exporting containers
type HealthCheckOptions ¶
type HealthCheckOptions struct{}
HealthCheckOptions are optional options for checking the health of a container
func (*HealthCheckOptions) Changed ¶
func (o *HealthCheckOptions) Changed(fieldName string) bool
Changed
type InitOptions ¶
type InitOptions struct{}
InitOptions are optional options for initing containers
type InspectOptions ¶
type InspectOptions struct {
Size *bool
}
InspectOptions are optional options for inspecting containers
func (*InspectOptions) WithSize ¶
func (o *InspectOptions) WithSize(value bool) *InspectOptions
WithSize
type KillOptions ¶
type KillOptions struct {
Signal *string
}
KillOptions are optional options for killing containers
func (*KillOptions) WithSignal ¶
func (o *KillOptions) WithSignal(value string) *KillOptions
WithSignal
type ListOptions ¶
type ListOptions struct { All *bool External *bool Filters map[string][]string Last *int Namespace *bool Size *bool Sync *bool }
ListOptions are optional options for listing containers
func (*ListOptions) WithExternal ¶
func (o *ListOptions) WithExternal(value bool) *ListOptions
WithExternal
func (*ListOptions) WithFilters ¶
func (o *ListOptions) WithFilters(value map[string][]string) *ListOptions
WithFilters
func (*ListOptions) WithNamespace ¶
func (o *ListOptions) WithNamespace(value bool) *ListOptions
WithNamespace
type LogOptions ¶
type LogOptions struct { Follow *bool Since *string Stderr *bool Stdout *bool Tail *string Timestamps *bool Until *string }
LogOptions describe finer control of log content or how the content is formatted.
func (*LogOptions) WithTimestamps ¶
func (o *LogOptions) WithTimestamps(value bool) *LogOptions
WithTimestamps
type MountOptions ¶
type MountOptions struct{}
MountOptions are optional options for mounting containers
type MountedContainerPathsOptions ¶
type MountedContainerPathsOptions struct{}
MountedContainerPathsOptions are optional options for getting container mount paths
func (*MountedContainerPathsOptions) Changed ¶
func (o *MountedContainerPathsOptions) Changed(fieldName string) bool
Changed
type PauseOptions ¶
type PauseOptions struct{}
PauseOptions are optional options for pausing containers
type PruneOptions ¶
PruneOptions are optional options for pruning containers
func (*PruneOptions) GetFilters ¶
func (o *PruneOptions) GetFilters() map[string][]string
GetFilters
func (*PruneOptions) WithFilters ¶
func (o *PruneOptions) WithFilters(value map[string][]string) *PruneOptions
WithFilters
type RemoveOptions ¶
RemoveOptions are optional options for removing containers
func (*RemoveOptions) WithForce ¶
func (o *RemoveOptions) WithForce(value bool) *RemoveOptions
WithForce
func (*RemoveOptions) WithIgnore ¶
func (o *RemoveOptions) WithIgnore(value bool) *RemoveOptions
WithIgnore
func (*RemoveOptions) WithVolumes ¶
func (o *RemoveOptions) WithVolumes(value bool) *RemoveOptions
WithVolumes
type RenameOptions ¶
type RenameOptions struct {
Name *string
}
RenameOptions are options for renaming containers. The Name field is required.
func (*RenameOptions) WithName ¶
func (o *RenameOptions) WithName(value string) *RenameOptions
WithName
type ResizeExecTTYOptions ¶
ResizeExecTTYOptions are optional options for resizing container ExecTTYs
func (*ResizeExecTTYOptions) Changed ¶
func (o *ResizeExecTTYOptions) Changed(fieldName string) bool
Changed
func (*ResizeExecTTYOptions) ToParams ¶
func (o *ResizeExecTTYOptions) ToParams() (url.Values, error)
ToParams
func (*ResizeExecTTYOptions) WithHeight ¶
func (o *ResizeExecTTYOptions) WithHeight(value int) *ResizeExecTTYOptions
WithHeight
func (*ResizeExecTTYOptions) WithWidth ¶
func (o *ResizeExecTTYOptions) WithWidth(value int) *ResizeExecTTYOptions
WithWidth
type ResizeTTYOptions ¶
ResizeTTYOptions are optional options for resizing container TTYs
func (*ResizeTTYOptions) Changed ¶
func (o *ResizeTTYOptions) Changed(fieldName string) bool
Changed
func (*ResizeTTYOptions) GetRunning ¶ added in v3.1.0
func (o *ResizeTTYOptions) GetRunning() bool
GetRunning
func (*ResizeTTYOptions) ToParams ¶
func (o *ResizeTTYOptions) ToParams() (url.Values, error)
ToParams
func (*ResizeTTYOptions) WithHeight ¶
func (o *ResizeTTYOptions) WithHeight(value int) *ResizeTTYOptions
WithHeight
func (*ResizeTTYOptions) WithRunning ¶ added in v3.1.0
func (o *ResizeTTYOptions) WithRunning(value bool) *ResizeTTYOptions
WithRunning
func (*ResizeTTYOptions) WithWidth ¶
func (o *ResizeTTYOptions) WithWidth(value int) *ResizeTTYOptions
WithWidth
type RestartOptions ¶
type RestartOptions struct {
Timeout *int
}
RestartOptions are optional options for restarting containers
func (*RestartOptions) WithTimeout ¶
func (o *RestartOptions) WithTimeout(value int) *RestartOptions
WithTimeout
type RestoreOptions ¶
type RestoreOptions struct { IgnoreRootfs *bool IgnoreStaticIP *bool IgnoreStaticMAC *bool ImportAchive *string Keep *bool Name *string TCPEstablished *bool }
RestoreOptions are optional options for restoring containers
func (*RestoreOptions) GetIgnoreRootfs ¶
func (o *RestoreOptions) GetIgnoreRootfs() bool
GetIgnoreRootfs
func (*RestoreOptions) GetIgnoreStaticIP ¶
func (o *RestoreOptions) GetIgnoreStaticIP() bool
GetIgnoreStaticIP
func (*RestoreOptions) GetIgnoreStaticMAC ¶
func (o *RestoreOptions) GetIgnoreStaticMAC() bool
GetIgnoreStaticMAC
func (*RestoreOptions) GetImportAchive ¶
func (o *RestoreOptions) GetImportAchive() string
GetImportAchive
func (*RestoreOptions) GetTCPEstablished ¶
func (o *RestoreOptions) GetTCPEstablished() bool
GetTCPEstablished
func (*RestoreOptions) WithIgnoreRootfs ¶
func (o *RestoreOptions) WithIgnoreRootfs(value bool) *RestoreOptions
WithIgnoreRootfs
func (*RestoreOptions) WithIgnoreStaticIP ¶
func (o *RestoreOptions) WithIgnoreStaticIP(value bool) *RestoreOptions
WithIgnoreStaticIP
func (*RestoreOptions) WithIgnoreStaticMAC ¶
func (o *RestoreOptions) WithIgnoreStaticMAC(value bool) *RestoreOptions
WithIgnoreStaticMAC
func (*RestoreOptions) WithImportAchive ¶
func (o *RestoreOptions) WithImportAchive(value string) *RestoreOptions
WithImportAchive
func (*RestoreOptions) WithKeep ¶
func (o *RestoreOptions) WithKeep(value bool) *RestoreOptions
WithKeep
func (*RestoreOptions) WithName ¶
func (o *RestoreOptions) WithName(value string) *RestoreOptions
WithName
func (*RestoreOptions) WithTCPEstablished ¶
func (o *RestoreOptions) WithTCPEstablished(value bool) *RestoreOptions
WithTCPEstablished
type ShouldRestartOptions ¶
type ShouldRestartOptions struct{}
ShouldRestartOptions
func (*ShouldRestartOptions) Changed ¶
func (o *ShouldRestartOptions) Changed(fieldName string) bool
Changed
type StartOptions ¶
type StartOptions struct {
DetachKeys *string
}
StartOptions are optional options for starting containers
func (*StartOptions) WithDetachKeys ¶
func (o *StartOptions) WithDetachKeys(value string) *StartOptions
WithDetachKeys
type StatsOptions ¶
type StatsOptions struct {
Stream *bool
}
StatsOptions are optional options for getting stats on containers
func (*StatsOptions) WithStream ¶
func (o *StatsOptions) WithStream(value bool) *StatsOptions
WithStream
type StopOptions ¶
StopOptions are optional options for stopping containers
func (*StopOptions) WithIgnore ¶
func (o *StopOptions) WithIgnore(value bool) *StopOptions
WithIgnore
func (*StopOptions) WithTimeout ¶
func (o *StopOptions) WithTimeout(value uint) *StopOptions
WithTimeout
type TopOptions ¶
type TopOptions struct {
Descriptors *[]string
}
TopOptions are optional options for getting running processes in containers
func (*TopOptions) WithDescriptors ¶
func (o *TopOptions) WithDescriptors(value []string) *TopOptions
WithDescriptors
type UnmountOptions ¶
type UnmountOptions struct{}
UnmountOptions are optional options for unmounting containers
type UnpauseOptions ¶
type UnpauseOptions struct{}
UnpauseOptions are optional options for unpausing containers
type WaitOptions ¶
type WaitOptions struct { Condition []define.ContainerStatus Interval *string }
WaitOptions are optional options for waiting on containers
func (*WaitOptions) GetCondition ¶
func (o *WaitOptions) GetCondition() []define.ContainerStatus
GetCondition
func (*WaitOptions) WithCondition ¶
func (o *WaitOptions) WithCondition(value []define.ContainerStatus) *WaitOptions
WithCondition
func (*WaitOptions) WithInterval ¶
func (o *WaitOptions) WithInterval(value string) *WaitOptions
WithInterval
Source Files ¶
- archive.go
- attach.go
- checkpoint.go
- commit.go
- containers.go
- create.go
- diff.go
- exec.go
- healthcheck.go
- logs.go
- mount.go
- rename.go
- types.go
- types_attach_options.go
- types_checkpoint_options.go
- types_commit_options.go
- types_create_options.go
- types_diff_options.go
- types_execinspect_options.go
- types_execstart_options.go
- types_execstartandattach_options.go
- types_exists_options.go
- types_export_options.go
- types_healthcheck_options.go
- types_init_options.go
- types_inspect_options.go
- types_kill_options.go
- types_list_options.go
- types_log_options.go
- types_mount_options.go
- types_mountedcontainerpaths_options.go
- types_pause_options.go
- types_prune_options.go
- types_remove_options.go
- types_rename_options.go
- types_resizeexectty_options.go
- types_resizetty_options.go
- types_restart_options.go
- types_restore_options.go
- types_shouldrestart_options.go
- types_start_options.go
- types_stats_options.go
- types_stop_options.go
- types_top_options.go
- types_unmount_options.go
- types_unpause_options.go
- types_wait_options.go