containers

package
v3.4.7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 20, 2022 License: Apache-2.0 Imports: 31 Imported by: 14

Documentation

Overview

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Index

Constants

This section is empty.

Variables

View Source 
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 CopyFromArchive(ctx context.Context, nameOrID string, path string, reader io.Reader) (entities.ContainerCopyFunc, error)

func CopyFromArchiveWithOptions added in v3.3.0 

func CopyFromArchiveWithOptions(ctx context.Context, nameOrID string, path string, reader io.Reader, options *CopyOptions) (entities.ContainerCopyFunc, error)

CopyFromArchiveWithOptions copy files into container

FIXME: remove this function and make CopyFromArchive accept the option as the last parameter in podman 4.0

func CopyToArchive 

func CopyToArchive(ctx context.Context, nameOrID string, path string, writer io.Writer) (entities.ContainerCopyFunc, error)

CopyToArchive copy files from container

func CreateWithSpec 

func CreateWithSpec(ctx context.Context, s *specgen.SpecGenerator, options *CreateOptions) (entities.ContainerCreateResponse, error)

func DemuxFrame 

func DemuxFrame(r io.Reader, buffer []byte, length int) (frame []byte, err error)

DemuxFrame reads contents for frame from server multiplexed stdin/stdout/stderr/2nd error channel

func DemuxHeader 

func DemuxHeader(r io.Reader, buffer []byte) (fd, sz int, err error)

DemuxHeader reads header for stream from server multiplexed stdin/stdout/stderr/2nd error channel

func Diff 

func Diff(ctx context.Context, nameOrID string, options *DiffOptions) ([]archive.Change, error)

Diff provides the changes between two container layers

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 

func Exists(ctx context.Context, nameOrID string, options *ExistsOptions) (bool, error)

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 

func Export(ctx context.Context, nameOrID string, w io.Writer, options *ExportOptions) error

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 

func Mount(ctx context.Context, nameOrID string, options *MountOptions) (string, error)

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 ShouldRestart(ctx context.Context, nameOrID string, options *ShouldRestartOptions) (bool, error)

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 

func Stat(ctx context.Context, nameOrID string, path string) (*entities.ContainerStatReport, error)

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 

func Top(ctx context.Context, nameOrID string, options *TopOptions) ([]string, error)

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.

func Wait 

func Wait(ctx context.Context, nameOrID string, options *WaitOptions) (int32, error)

Wait blocks until the given container reaches a condition. If not provided, the condition will default to stopped. If the condition is stopped, an exit code for the container will be provided. The nameOrID can be a container name or a partial/full ID.

Types

type AttachOptions 

type AttachOptions struct {
	DetachKeys *string // Keys to detach from running container
	Logs       *bool   // Flag to return all logs from container when true
	Stream     *bool   // Flag only return container logs when false and Logs is true
}

AttachOptions are optional options for attaching to containers

func (*AttachOptions) Changed 

func (o *AttachOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*AttachOptions) GetDetachKeys 

func (o *AttachOptions) GetDetachKeys() string

GetDetachKeys returns value of keys to detach from running container

func (*AttachOptions) GetLogs 

func (o *AttachOptions) GetLogs() bool

GetLogs returns value of flag to return all logs from container when true

func (*AttachOptions) GetStream 

func (o *AttachOptions) GetStream() bool

GetStream returns value of flag only return container logs when false and Logs is true

func (*AttachOptions) ToParams 

func (o *AttachOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

func (*AttachOptions) WithDetachKeys 

func (o *AttachOptions) WithDetachKeys(value string) *AttachOptions

WithDetachKeys set keys to detach from running container

func (*AttachOptions) WithLogs 

func (o *AttachOptions) WithLogs(value bool) *AttachOptions

WithLogs set flag to return all logs from container when true

func (*AttachOptions) WithStream 

func (o *AttachOptions) WithStream(value bool) *AttachOptions

WithStream set flag only return container logs when false and Logs is true

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 returns true if named field has been set

func (*CheckpointOptions) GetExport 

func (o *CheckpointOptions) GetExport() string

GetExport returns value of field Export

func (*CheckpointOptions) GetIgnoreRootfs 

func (o *CheckpointOptions) GetIgnoreRootfs() bool

GetIgnoreRootfs returns value of field IgnoreRootfs

func (*CheckpointOptions) GetKeep 

func (o *CheckpointOptions) GetKeep() bool

GetKeep returns value of field Keep

func (*CheckpointOptions) GetLeaveRunning 

func (o *CheckpointOptions) GetLeaveRunning() bool

GetLeaveRunning returns value of field LeaveRunning

func (*CheckpointOptions) GetTCPEstablished 

func (o *CheckpointOptions) GetTCPEstablished() bool

GetTCPEstablished returns value of field TCPEstablished

func (*CheckpointOptions) ToParams 

func (o *CheckpointOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

func (*CheckpointOptions) WithExport 

func (o *CheckpointOptions) WithExport(value string) *CheckpointOptions

WithExport set field Export to given value

func (*CheckpointOptions) WithIgnoreRootfs 

func (o *CheckpointOptions) WithIgnoreRootfs(value bool) *CheckpointOptions

WithIgnoreRootfs set field IgnoreRootfs to given value

func (*CheckpointOptions) WithKeep 

func (o *CheckpointOptions) WithKeep(value bool) *CheckpointOptions

WithKeep set field Keep to given value

func (*CheckpointOptions) WithLeaveRunning 

func (o *CheckpointOptions) WithLeaveRunning(value bool) *CheckpointOptions

WithLeaveRunning set field LeaveRunning to given value

func (*CheckpointOptions) WithTCPEstablished 

func (o *CheckpointOptions) WithTCPEstablished(value bool) *CheckpointOptions

WithTCPEstablished set field TCPEstablished to given value

type CloseWriter added in v3.3.0 

type CloseWriter interface {
	CloseWrite() error
}

The CloseWriter interface is used to determine whether we can do a one-sided close of a hijacked connection.

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) Changed 

func (o *CommitOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*CommitOptions) GetAuthor 

func (o *CommitOptions) GetAuthor() string

GetAuthor returns value of field Author

func (*CommitOptions) GetChanges 

func (o *CommitOptions) GetChanges() []string

GetChanges returns value of field Changes

func (*CommitOptions) GetComment 

func (o *CommitOptions) GetComment() string

GetComment returns value of field Comment

func (*CommitOptions) GetFormat 

func (o *CommitOptions) GetFormat() string

GetFormat returns value of field Format

func (*CommitOptions) GetPause 

func (o *CommitOptions) GetPause() bool

GetPause returns value of field Pause

func (*CommitOptions) GetRepo 

func (o *CommitOptions) GetRepo() string

GetRepo returns value of field Repo

func (*CommitOptions) GetTag 

func (o *CommitOptions) GetTag() string

GetTag returns value of field Tag

func (*CommitOptions) ToParams 

func (o *CommitOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

func (*CommitOptions) WithAuthor 

func (o *CommitOptions) WithAuthor(value string) *CommitOptions

WithAuthor set field Author to given value

func (*CommitOptions) WithChanges 

func (o *CommitOptions) WithChanges(value []string) *CommitOptions

WithChanges set field Changes to given value

func (*CommitOptions) WithComment 

func (o *CommitOptions) WithComment(value string) *CommitOptions

WithComment set field Comment to given value

func (*CommitOptions) WithFormat 

func (o *CommitOptions) WithFormat(value string) *CommitOptions

WithFormat set field Format to given value

func (*CommitOptions) WithPause 

func (o *CommitOptions) WithPause(value bool) *CommitOptions

WithPause set field Pause to given value

func (*CommitOptions) WithRepo 

func (o *CommitOptions) WithRepo(value string) *CommitOptions

WithRepo set field Repo to given value

func (*CommitOptions) WithTag 

func (o *CommitOptions) WithTag(value string) *CommitOptions

WithTag set field Tag to given value

type CopyOptions added in v3.3.0 

type CopyOptions struct {
	// If used with CopyFromArchive and set to true it will change ownership of files from the source tar archive
	// to the primary uid/gid of the target container.
	Chown *bool `schema:"copyUIDGID"`
	// Map to translate path names.
	Rename map[string]string
}

CopyOptions are options for copying to containers.

func (*CopyOptions) Changed added in v3.3.0 

func (o *CopyOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*CopyOptions) GetChown added in v3.3.0 

func (o *CopyOptions) GetChown() bool

GetChown returns value of field Chown

func (*CopyOptions) GetRename added in v3.3.0 

func (o *CopyOptions) GetRename() map[string]string

GetRename returns value of field Rename

func (*CopyOptions) ToParams added in v3.3.0 

func (o *CopyOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

func (*CopyOptions) WithChown added in v3.3.0 

func (o *CopyOptions) WithChown(value bool) *CopyOptions

WithChown set field Chown to given value

func (*CopyOptions) WithRename added in v3.3.0 

func (o *CopyOptions) WithRename(value map[string]string) *CopyOptions

WithRename set field Rename to given value

type CreateOptions 

type CreateOptions struct{}

CreateOptions are optional options for creating containers

func (*CreateOptions) Changed 

func (o *CreateOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*CreateOptions) ToParams 

func (o *CreateOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

type DiffOptions 

type DiffOptions struct {
	// By the default diff will compare against the parent layer. Change the Parent if you want to compare against something else.
	Parent *string
	// Change the type the backend should match. This can be set to "all", "container" or "image".
	DiffType *string
}

DiffOptions are optional options for creating containers

func (*DiffOptions) Changed 

func (o *DiffOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*DiffOptions) GetDiffType added in v3.3.0 

func (o *DiffOptions) GetDiffType() string

GetDiffType returns value of field DiffType

func (*DiffOptions) GetParent added in v3.3.0 

func (o *DiffOptions) GetParent() string

GetParent returns value of field Parent

func (*DiffOptions) ToParams 

func (o *DiffOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

func (*DiffOptions) WithDiffType added in v3.3.0 

func (o *DiffOptions) WithDiffType(value string) *DiffOptions

WithDiffType set field DiffType to given value

func (*DiffOptions) WithParent added in v3.3.0 

func (o *DiffOptions) WithParent(value string) *DiffOptions

WithParent set field Parent to given value

type ExecInspectOptions 

type ExecInspectOptions struct{}

ExecInspectOptions are optional options for inspecting exec sessions

func (*ExecInspectOptions) Changed 

func (o *ExecInspectOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*ExecInspectOptions) ToParams 

func (o *ExecInspectOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

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 returns true if named field has been set

func (*ExecStartAndAttachOptions) GetAttachError 

func (o *ExecStartAndAttachOptions) GetAttachError() bool

GetAttachError returns value of field AttachError

func (*ExecStartAndAttachOptions) GetAttachInput 

func (o *ExecStartAndAttachOptions) GetAttachInput() bool

GetAttachInput returns value of field AttachInput

func (*ExecStartAndAttachOptions) GetAttachOutput 

func (o *ExecStartAndAttachOptions) GetAttachOutput() bool

GetAttachOutput returns value of field AttachOutput

func (*ExecStartAndAttachOptions) GetErrorStream 

func (o *ExecStartAndAttachOptions) GetErrorStream() io.WriteCloser

GetErrorStream returns value of field ErrorStream

func (*ExecStartAndAttachOptions) GetInputStream 

func (o *ExecStartAndAttachOptions) GetInputStream() bufio.Reader

GetInputStream returns value of field InputStream

func (*ExecStartAndAttachOptions) GetOutputStream 

func (o *ExecStartAndAttachOptions) GetOutputStream() io.WriteCloser

GetOutputStream returns value of field OutputStream

func (*ExecStartAndAttachOptions) ToParams 

func (o *ExecStartAndAttachOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

func (*ExecStartAndAttachOptions) WithAttachError 

func (o *ExecStartAndAttachOptions) WithAttachError(value bool) *ExecStartAndAttachOptions

WithAttachError set field AttachError to given value

func (*ExecStartAndAttachOptions) WithAttachInput 

func (o *ExecStartAndAttachOptions) WithAttachInput(value bool) *ExecStartAndAttachOptions

WithAttachInput set field AttachInput to given value

func (*ExecStartAndAttachOptions) WithAttachOutput 

func (o *ExecStartAndAttachOptions) WithAttachOutput(value bool) *ExecStartAndAttachOptions

WithAttachOutput set field AttachOutput to given value

func (*ExecStartAndAttachOptions) WithErrorStream 

func (o *ExecStartAndAttachOptions) WithErrorStream(value io.WriteCloser) *ExecStartAndAttachOptions

WithErrorStream set field ErrorStream to given value

func (*ExecStartAndAttachOptions) WithInputStream 

func (o *ExecStartAndAttachOptions) WithInputStream(value bufio.Reader) *ExecStartAndAttachOptions

WithInputStream set field InputStream to given value

func (*ExecStartAndAttachOptions) WithOutputStream 

func (o *ExecStartAndAttachOptions) WithOutputStream(value io.WriteCloser) *ExecStartAndAttachOptions

WithOutputStream set field OutputStream to given value

type ExecStartOptions 

type ExecStartOptions struct{}

ExecStartOptions are optional options for starting exec sessions

func (*ExecStartOptions) Changed 

func (o *ExecStartOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*ExecStartOptions) ToParams 

func (o *ExecStartOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

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) Changed 

func (o *ExistsOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*ExistsOptions) GetExternal 

func (o *ExistsOptions) GetExternal() bool

GetExternal returns value of field External

func (*ExistsOptions) ToParams 

func (o *ExistsOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

func (*ExistsOptions) WithExternal 

func (o *ExistsOptions) WithExternal(value bool) *ExistsOptions

WithExternal set field External to given value

type ExportOptions 

type ExportOptions struct{}

ExportOptions are optional options for exporting containers

func (*ExportOptions) Changed 

func (o *ExportOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*ExportOptions) ToParams 

func (o *ExportOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

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 returns true if named field has been set

func (*HealthCheckOptions) ToParams 

func (o *HealthCheckOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

type InitOptions 

type InitOptions struct{}

InitOptions are optional options for initing containers

func (*InitOptions) Changed 

func (o *InitOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*InitOptions) ToParams 

func (o *InitOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

type InspectOptions 

type InspectOptions struct {
	Size *bool
}

InspectOptions are optional options for inspecting containers

func (*InspectOptions) Changed 

func (o *InspectOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*InspectOptions) GetSize 

func (o *InspectOptions) GetSize() bool

GetSize returns value of field Size

func (*InspectOptions) ToParams 

func (o *InspectOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

func (*InspectOptions) WithSize 

func (o *InspectOptions) WithSize(value bool) *InspectOptions

WithSize set field Size to given value

type KillOptions 

type KillOptions struct {
	Signal *string
}

KillOptions are optional options for killing containers

func (*KillOptions) Changed 

func (o *KillOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*KillOptions) GetSignal 

func (o *KillOptions) GetSignal() string

GetSignal returns value of field Signal

func (*KillOptions) ToParams 

func (o *KillOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

func (*KillOptions) WithSignal 

func (o *KillOptions) WithSignal(value string) *KillOptions

WithSignal set field Signal to given value

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) Changed 

func (o *ListOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*ListOptions) GetAll 

func (o *ListOptions) GetAll() bool

GetAll returns value of field All

func (*ListOptions) GetExternal 

func (o *ListOptions) GetExternal() bool

GetExternal returns value of field External

func (*ListOptions) GetFilters 

func (o *ListOptions) GetFilters() map[string][]string

GetFilters returns value of field Filters

func (*ListOptions) GetLast 

func (o *ListOptions) GetLast() int

GetLast returns value of field Last

func (*ListOptions) GetNamespace 

func (o *ListOptions) GetNamespace() bool

GetNamespace returns value of field Namespace

func (*ListOptions) GetSize 

func (o *ListOptions) GetSize() bool

GetSize returns value of field Size

func (*ListOptions) GetSync 

func (o *ListOptions) GetSync() bool

GetSync returns value of field Sync

func (*ListOptions) ToParams 

func (o *ListOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

func (*ListOptions) WithAll 

func (o *ListOptions) WithAll(value bool) *ListOptions

WithAll set field All to given value

func (*ListOptions) WithExternal 

func (o *ListOptions) WithExternal(value bool) *ListOptions

WithExternal set field External to given value

func (*ListOptions) WithFilters 

func (o *ListOptions) WithFilters(value map[string][]string) *ListOptions

WithFilters set field Filters to given value

func (*ListOptions) WithLast 

func (o *ListOptions) WithLast(value int) *ListOptions

WithLast set field Last to given value

func (*ListOptions) WithNamespace 

func (o *ListOptions) WithNamespace(value bool) *ListOptions

WithNamespace set field Namespace to given value

func (*ListOptions) WithSize 

func (o *ListOptions) WithSize(value bool) *ListOptions

WithSize set field Size to given value

func (*ListOptions) WithSync 

func (o *ListOptions) WithSync(value bool) *ListOptions

WithSync set field Sync to given value

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) Changed 

func (o *LogOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*LogOptions) GetFollow 

func (o *LogOptions) GetFollow() bool

GetFollow returns value of field Follow

func (*LogOptions) GetSince 

func (o *LogOptions) GetSince() string

GetSince returns value of field Since

func (*LogOptions) GetStderr 

func (o *LogOptions) GetStderr() bool

GetStderr returns value of field Stderr

func (*LogOptions) GetStdout 

func (o *LogOptions) GetStdout() bool

GetStdout returns value of field Stdout

func (*LogOptions) GetTail 

func (o *LogOptions) GetTail() string

GetTail returns value of field Tail

func (*LogOptions) GetTimestamps 

func (o *LogOptions) GetTimestamps() bool

GetTimestamps returns value of field Timestamps

func (*LogOptions) GetUntil 

func (o *LogOptions) GetUntil() string

GetUntil returns value of field Until

func (*LogOptions) ToParams 

func (o *LogOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

func (*LogOptions) WithFollow 

func (o *LogOptions) WithFollow(value bool) *LogOptions

WithFollow set field Follow to given value

func (*LogOptions) WithSince 

func (o *LogOptions) WithSince(value string) *LogOptions

WithSince set field Since to given value

func (*LogOptions) WithStderr 

func (o *LogOptions) WithStderr(value bool) *LogOptions

WithStderr set field Stderr to given value

func (*LogOptions) WithStdout 

func (o *LogOptions) WithStdout(value bool) *LogOptions

WithStdout set field Stdout to given value

func (*LogOptions) WithTail 

func (o *LogOptions) WithTail(value string) *LogOptions

WithTail set field Tail to given value

func (*LogOptions) WithTimestamps 

func (o *LogOptions) WithTimestamps(value bool) *LogOptions

WithTimestamps set field Timestamps to given value

func (*LogOptions) WithUntil 

func (o *LogOptions) WithUntil(value string) *LogOptions

WithUntil set field Until to given value

type MountOptions 

type MountOptions struct{}

MountOptions are optional options for mounting containers

func (*MountOptions) Changed 

func (o *MountOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*MountOptions) ToParams 

func (o *MountOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

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 returns true if named field has been set

func (*MountedContainerPathsOptions) ToParams 

func (o *MountedContainerPathsOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

type PauseOptions 

type PauseOptions struct{}

PauseOptions are optional options for pausing containers

func (*PauseOptions) Changed 

func (o *PauseOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*PauseOptions) ToParams 

func (o *PauseOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

type PruneOptions 

type PruneOptions struct {
	Filters map[string][]string
}

PruneOptions are optional options for pruning containers

func (*PruneOptions) Changed 

func (o *PruneOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*PruneOptions) GetFilters 

func (o *PruneOptions) GetFilters() map[string][]string

GetFilters returns value of field Filters

func (*PruneOptions) ToParams 

func (o *PruneOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

func (*PruneOptions) WithFilters 

func (o *PruneOptions) WithFilters(value map[string][]string) *PruneOptions

WithFilters set field Filters to given value

type RemoveOptions 

type RemoveOptions struct {
	Ignore  *bool
	Force   *bool
	Volumes *bool
}

RemoveOptions are optional options for removing containers

func (*RemoveOptions) Changed 

func (o *RemoveOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*RemoveOptions) GetForce 

func (o *RemoveOptions) GetForce() bool

GetForce returns value of field Force

func (*RemoveOptions) GetIgnore 

func (o *RemoveOptions) GetIgnore() bool

GetIgnore returns value of field Ignore

func (*RemoveOptions) GetVolumes 

func (o *RemoveOptions) GetVolumes() bool

GetVolumes returns value of field Volumes

func (*RemoveOptions) ToParams 

func (o *RemoveOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

func (*RemoveOptions) WithForce 

func (o *RemoveOptions) WithForce(value bool) *RemoveOptions

WithForce set field Force to given value

func (*RemoveOptions) WithIgnore 

func (o *RemoveOptions) WithIgnore(value bool) *RemoveOptions

WithIgnore set field Ignore to given value

func (*RemoveOptions) WithVolumes 

func (o *RemoveOptions) WithVolumes(value bool) *RemoveOptions

WithVolumes set field Volumes to given value

type RenameOptions 

type RenameOptions struct {
	Name *string
}

RenameOptions are options for renaming containers. The Name field is required.

func (*RenameOptions) Changed 

func (o *RenameOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*RenameOptions) GetName 

func (o *RenameOptions) GetName() string

GetName returns value of field Name

func (*RenameOptions) ToParams 

func (o *RenameOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

func (*RenameOptions) WithName 

func (o *RenameOptions) WithName(value string) *RenameOptions

WithName set field Name to given value

type ResizeExecTTYOptions 

type ResizeExecTTYOptions struct {
	Height *int
	Width  *int
}

ResizeExecTTYOptions are optional options for resizing container ExecTTYs

func (*ResizeExecTTYOptions) Changed 

func (o *ResizeExecTTYOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*ResizeExecTTYOptions) GetHeight 

func (o *ResizeExecTTYOptions) GetHeight() int

GetHeight returns value of field Height

func (*ResizeExecTTYOptions) GetWidth 

func (o *ResizeExecTTYOptions) GetWidth() int

GetWidth returns value of field Width

func (*ResizeExecTTYOptions) ToParams 

func (o *ResizeExecTTYOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

func (*ResizeExecTTYOptions) WithHeight 

func (o *ResizeExecTTYOptions) WithHeight(value int) *ResizeExecTTYOptions

WithHeight set field Height to given value

func (*ResizeExecTTYOptions) WithWidth 

func (o *ResizeExecTTYOptions) WithWidth(value int) *ResizeExecTTYOptions

WithWidth set field Width to given value

type ResizeTTYOptions 

type ResizeTTYOptions struct {
	Height  *int
	Width   *int
	Running *bool
}

ResizeTTYOptions are optional options for resizing container TTYs

func (*ResizeTTYOptions) Changed 

func (o *ResizeTTYOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*ResizeTTYOptions) GetHeight 

func (o *ResizeTTYOptions) GetHeight() int

GetHeight returns value of field Height

func (*ResizeTTYOptions) GetRunning added in v3.1.0 

func (o *ResizeTTYOptions) GetRunning() bool

GetRunning returns value of field Running

func (*ResizeTTYOptions) GetWidth 

func (o *ResizeTTYOptions) GetWidth() int

GetWidth returns value of field Width

func (*ResizeTTYOptions) ToParams 

func (o *ResizeTTYOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

func (*ResizeTTYOptions) WithHeight 

func (o *ResizeTTYOptions) WithHeight(value int) *ResizeTTYOptions

WithHeight set field Height to given value

func (*ResizeTTYOptions) WithRunning added in v3.1.0 

func (o *ResizeTTYOptions) WithRunning(value bool) *ResizeTTYOptions

WithRunning set field Running to given value

func (*ResizeTTYOptions) WithWidth 

func (o *ResizeTTYOptions) WithWidth(value int) *ResizeTTYOptions

WithWidth set field Width to given value

type RestartOptions 

type RestartOptions struct {
	Timeout *int
}

RestartOptions are optional options for restarting containers

func (*RestartOptions) Changed 

func (o *RestartOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*RestartOptions) GetTimeout 

func (o *RestartOptions) GetTimeout() int

GetTimeout returns value of field Timeout

func (*RestartOptions) ToParams 

func (o *RestartOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

func (*RestartOptions) WithTimeout 

func (o *RestartOptions) WithTimeout(value int) *RestartOptions

WithTimeout set field Timeout to given value

type RestoreOptions 

type RestoreOptions struct {
	IgnoreRootfs    *bool
	IgnoreStaticIP  *bool
	IgnoreStaticMAC *bool
	ImportAchive    *string
	Keep            *bool
	Name            *string
	TCPEstablished  *bool
	Pod             *string
}

RestoreOptions are optional options for restoring containers

func (*RestoreOptions) Changed 

func (o *RestoreOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*RestoreOptions) GetIgnoreRootfs 

func (o *RestoreOptions) GetIgnoreRootfs() bool

GetIgnoreRootfs returns value of field IgnoreRootfs

func (*RestoreOptions) GetIgnoreStaticIP 

func (o *RestoreOptions) GetIgnoreStaticIP() bool

GetIgnoreStaticIP returns value of field IgnoreStaticIP

func (*RestoreOptions) GetIgnoreStaticMAC 

func (o *RestoreOptions) GetIgnoreStaticMAC() bool

GetIgnoreStaticMAC returns value of field IgnoreStaticMAC

func (*RestoreOptions) GetImportAchive 

func (o *RestoreOptions) GetImportAchive() string

GetImportAchive returns value of field ImportAchive

func (*RestoreOptions) GetKeep 

func (o *RestoreOptions) GetKeep() bool

GetKeep returns value of field Keep

func (*RestoreOptions) GetName 

func (o *RestoreOptions) GetName() string

GetName returns value of field Name

func (*RestoreOptions) GetPod added in v3.3.0 

func (o *RestoreOptions) GetPod() string

GetPod returns value of field Pod

func (*RestoreOptions) GetTCPEstablished 

func (o *RestoreOptions) GetTCPEstablished() bool

GetTCPEstablished returns value of field TCPEstablished

func (*RestoreOptions) ToParams 

func (o *RestoreOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

func (*RestoreOptions) WithIgnoreRootfs 

func (o *RestoreOptions) WithIgnoreRootfs(value bool) *RestoreOptions

WithIgnoreRootfs set field IgnoreRootfs to given value

func (*RestoreOptions) WithIgnoreStaticIP 

func (o *RestoreOptions) WithIgnoreStaticIP(value bool) *RestoreOptions

WithIgnoreStaticIP set field IgnoreStaticIP to given value

func (*RestoreOptions) WithIgnoreStaticMAC 

func (o *RestoreOptions) WithIgnoreStaticMAC(value bool) *RestoreOptions

WithIgnoreStaticMAC set field IgnoreStaticMAC to given value

func (*RestoreOptions) WithImportAchive 

func (o *RestoreOptions) WithImportAchive(value string) *RestoreOptions

WithImportAchive set field ImportAchive to given value

func (*RestoreOptions) WithKeep 

func (o *RestoreOptions) WithKeep(value bool) *RestoreOptions

WithKeep set field Keep to given value

func (*RestoreOptions) WithName 

func (o *RestoreOptions) WithName(value string) *RestoreOptions

WithName set field Name to given value

func (*RestoreOptions) WithPod added in v3.3.0 

func (o *RestoreOptions) WithPod(value string) *RestoreOptions

WithPod set field Pod to given value

func (*RestoreOptions) WithTCPEstablished 

func (o *RestoreOptions) WithTCPEstablished(value bool) *RestoreOptions

WithTCPEstablished set field TCPEstablished to given value

type ShouldRestartOptions 

type ShouldRestartOptions struct{}

ShouldRestartOptions

func (*ShouldRestartOptions) Changed 

func (o *ShouldRestartOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*ShouldRestartOptions) ToParams 

func (o *ShouldRestartOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

type StartOptions 

type StartOptions struct {
	DetachKeys *string
	Recursive  *bool
}

StartOptions are optional options for starting containers

func (*StartOptions) Changed 

func (o *StartOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*StartOptions) GetDetachKeys 

func (o *StartOptions) GetDetachKeys() string

GetDetachKeys returns value of field DetachKeys

func (*StartOptions) GetRecursive added in v3.2.0 

func (o *StartOptions) GetRecursive() bool

GetRecursive returns value of field Recursive

func (*StartOptions) ToParams 

func (o *StartOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

func (*StartOptions) WithDetachKeys 

func (o *StartOptions) WithDetachKeys(value string) *StartOptions

WithDetachKeys set field DetachKeys to given value

func (*StartOptions) WithRecursive added in v3.2.0 

func (o *StartOptions) WithRecursive(value bool) *StartOptions

WithRecursive set field Recursive to given value

type StatsOptions 

type StatsOptions struct {
	Stream   *bool
	Interval *int
}

StatsOptions are optional options for getting stats on containers

func (*StatsOptions) Changed 

func (o *StatsOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*StatsOptions) GetInterval added in v3.4.0 

func (o *StatsOptions) GetInterval() int

GetInterval returns value of field Interval

func (*StatsOptions) GetStream 

func (o *StatsOptions) GetStream() bool

GetStream returns value of field Stream

func (*StatsOptions) ToParams 

func (o *StatsOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

func (*StatsOptions) WithInterval added in v3.4.0 

func (o *StatsOptions) WithInterval(value int) *StatsOptions

WithInterval set field Interval to given value

func (*StatsOptions) WithStream 

func (o *StatsOptions) WithStream(value bool) *StatsOptions

WithStream set field Stream to given value

type StopOptions 

type StopOptions struct {
	Ignore  *bool
	Timeout *uint
}

StopOptions are optional options for stopping containers

func (*StopOptions) Changed 

func (o *StopOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*StopOptions) GetIgnore 

func (o *StopOptions) GetIgnore() bool

GetIgnore returns value of field Ignore

func (*StopOptions) GetTimeout 

func (o *StopOptions) GetTimeout() uint

GetTimeout returns value of field Timeout

func (*StopOptions) ToParams 

func (o *StopOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

func (*StopOptions) WithIgnore 

func (o *StopOptions) WithIgnore(value bool) *StopOptions

WithIgnore set field Ignore to given value

func (*StopOptions) WithTimeout 

func (o *StopOptions) WithTimeout(value uint) *StopOptions

WithTimeout set field Timeout to given value

type TopOptions 

type TopOptions struct {
	Descriptors *[]string
}

TopOptions are optional options for getting running processes in containers

func (*TopOptions) Changed 

func (o *TopOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*TopOptions) GetDescriptors 

func (o *TopOptions) GetDescriptors() []string

GetDescriptors returns value of field Descriptors

func (*TopOptions) ToParams 

func (o *TopOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

func (*TopOptions) WithDescriptors 

func (o *TopOptions) WithDescriptors(value []string) *TopOptions

WithDescriptors set field Descriptors to given value

type UnmountOptions 

type UnmountOptions struct{}

UnmountOptions are optional options for unmounting containers

func (*UnmountOptions) Changed 

func (o *UnmountOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*UnmountOptions) ToParams 

func (o *UnmountOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

type UnpauseOptions 

type UnpauseOptions struct{}

UnpauseOptions are optional options for unpausing containers

func (*UnpauseOptions) Changed 

func (o *UnpauseOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*UnpauseOptions) ToParams 

func (o *UnpauseOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

type WaitOptions 

type WaitOptions struct {
	Condition []define.ContainerStatus
	Interval  *string
}

WaitOptions are optional options for waiting on containers

func (*WaitOptions) Changed 

func (o *WaitOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*WaitOptions) GetCondition 

func (o *WaitOptions) GetCondition() []define.ContainerStatus

GetCondition returns value of field Condition

func (*WaitOptions) GetInterval 

func (o *WaitOptions) GetInterval() string

GetInterval returns value of field Interval

func (*WaitOptions) ToParams 

func (o *WaitOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

func (*WaitOptions) WithCondition 

func (o *WaitOptions) WithCondition(value []define.ContainerStatus) *WaitOptions

WithCondition set field Condition to given value

func (*WaitOptions) WithInterval 

func (o *WaitOptions) WithInterval(value string) *WaitOptions

WithInterval set field Interval to given value

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.