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.
Index ¶
- func Build(ctx context.Context, containerFiles []string, options entities.BuildOptions) (*entities.BuildReport, error)
- func Diff(ctx context.Context, nameOrID string, options *DiffOptions) ([]archive.Change, error)
- func Exists(ctx context.Context, nameOrID string, options *ExistsOptions) (bool, error)
- func Export(ctx context.Context, nameOrIDs []string, w io.Writer, options *ExportOptions) error
- func GetImage(ctx context.Context, nameOrID string, options *GetOptions) (*entities.ImageInspectReport, error)
- func History(ctx context.Context, nameOrID string, options *HistoryOptions) ([]*types.HistoryResponse, error)
- func Import(ctx context.Context, r io.Reader, options *ImportOptions) (*entities.ImageImportReport, error)
- func List(ctx context.Context, options *ListOptions) ([]*entities.ImageSummary, error)
- func Load(ctx context.Context, r io.Reader) (*entities.ImageLoadReport, error)
- func Prune(ctx context.Context, options *PruneOptions) ([]*reports.PruneReport, error)
- func Pull(ctx context.Context, rawImage string, options *PullOptions) ([]string, error)
- func Push(ctx context.Context, source string, destination string, options *PushOptions) error
- func Remove(ctx context.Context, images []string, options *RemoveOptions) (*entities.ImageRemoveReport, []error)
- func Scp(ctx context.Context, source, destination *string, options ScpOptions) (reports.ScpReport, error)
- func Search(ctx context.Context, term string, options *SearchOptions) ([]entities.ImageSearchReport, error)
- func Tag(ctx context.Context, nameOrID, tag, repo string, options *TagOptions) error
- func Tree(ctx context.Context, nameOrID string, options *TreeOptions) (*entities.ImageTreeReport, error)
- func Untag(ctx context.Context, nameOrID, tag, repo string, options *UntagOptions) error
- type BuildOptions
- type DiffOptions
- 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 ExistsOptions
- type ExportOptions
- func (o *ExportOptions) Changed(fieldName string) bool
- func (o *ExportOptions) GetCompress() bool
- func (o *ExportOptions) GetFormat() string
- func (o *ExportOptions) GetOciAcceptUncompressedLayers() bool
- func (o *ExportOptions) ToParams() (url.Values, error)
- func (o *ExportOptions) WithCompress(value bool) *ExportOptions
- func (o *ExportOptions) WithFormat(value string) *ExportOptions
- func (o *ExportOptions) WithOciAcceptUncompressedLayers(value bool) *ExportOptions
- type GetOptions
- type HistoryOptions
- type ImportOptions
- func (o *ImportOptions) Changed(fieldName string) bool
- func (o *ImportOptions) GetArchitecture() string
- func (o *ImportOptions) GetChanges() []string
- func (o *ImportOptions) GetMessage() string
- func (o *ImportOptions) GetOS() string
- func (o *ImportOptions) GetReference() string
- func (o *ImportOptions) GetURL() string
- func (o *ImportOptions) GetVariant() string
- func (o *ImportOptions) ToParams() (url.Values, error)
- func (o *ImportOptions) WithArchitecture(value string) *ImportOptions
- func (o *ImportOptions) WithChanges(value []string) *ImportOptions
- func (o *ImportOptions) WithMessage(value string) *ImportOptions
- func (o *ImportOptions) WithOS(value string) *ImportOptions
- func (o *ImportOptions) WithReference(value string) *ImportOptions
- func (o *ImportOptions) WithURL(value string) *ImportOptions
- func (o *ImportOptions) WithVariant(value string) *ImportOptions
- type ListOptions
- func (o *ListOptions) Changed(fieldName string) bool
- func (o *ListOptions) GetAll() bool
- func (o *ListOptions) GetFilters() map[string][]string
- func (o *ListOptions) ToParams() (url.Values, error)
- func (o *ListOptions) WithAll(value bool) *ListOptions
- func (o *ListOptions) WithFilters(value map[string][]string) *ListOptions
- type LoadOptions
- type PruneOptions
- func (o *PruneOptions) Changed(fieldName string) bool
- func (o *PruneOptions) GetAll() bool
- func (o *PruneOptions) GetExternal() bool
- func (o *PruneOptions) GetFilters() map[string][]string
- func (o *PruneOptions) ToParams() (url.Values, error)
- func (o *PruneOptions) WithAll(value bool) *PruneOptions
- func (o *PruneOptions) WithExternal(value bool) *PruneOptions
- func (o *PruneOptions) WithFilters(value map[string][]string) *PruneOptions
- type PullOptions
- func (o *PullOptions) Changed(fieldName string) bool
- func (o *PullOptions) GetAllTags() bool
- func (o *PullOptions) GetArch() string
- func (o *PullOptions) GetAuthfile() string
- func (o *PullOptions) GetOS() string
- func (o *PullOptions) GetPassword() string
- func (o *PullOptions) GetPolicy() string
- func (o *PullOptions) GetProgressWriter() io.Writer
- func (o *PullOptions) GetQuiet() bool
- func (o *PullOptions) GetSkipTLSVerify() bool
- func (o *PullOptions) GetUsername() string
- func (o *PullOptions) GetVariant() string
- func (o *PullOptions) ToParams() (url.Values, error)
- func (o *PullOptions) WithAllTags(value bool) *PullOptions
- func (o *PullOptions) WithArch(value string) *PullOptions
- func (o *PullOptions) WithAuthfile(value string) *PullOptions
- func (o *PullOptions) WithOS(value string) *PullOptions
- func (o *PullOptions) WithPassword(value string) *PullOptions
- func (o *PullOptions) WithPolicy(value string) *PullOptions
- func (o *PullOptions) WithProgressWriter(value io.Writer) *PullOptions
- func (o *PullOptions) WithQuiet(value bool) *PullOptions
- func (o *PullOptions) WithSkipTLSVerify(value bool) *PullOptions
- func (o *PullOptions) WithUsername(value string) *PullOptions
- func (o *PullOptions) WithVariant(value string) *PullOptions
- type PushOptions
- func (o *PushOptions) Changed(fieldName string) bool
- func (o *PushOptions) GetAll() bool
- func (o *PushOptions) GetAuthfile() string
- func (o *PushOptions) GetCompress() bool
- func (o *PushOptions) GetCompressionFormat() string
- func (o *PushOptions) GetFormat() string
- func (o *PushOptions) GetPassword() string
- func (o *PushOptions) GetProgressWriter() io.Writer
- func (o *PushOptions) GetQuiet() bool
- func (o *PushOptions) GetRemoveSignatures() bool
- func (o *PushOptions) GetSkipTLSVerify() bool
- func (o *PushOptions) GetUsername() string
- func (o *PushOptions) ToParams() (url.Values, error)
- func (o *PushOptions) WithAll(value bool) *PushOptions
- func (o *PushOptions) WithAuthfile(value string) *PushOptions
- func (o *PushOptions) WithCompress(value bool) *PushOptions
- func (o *PushOptions) WithCompressionFormat(value string) *PushOptions
- func (o *PushOptions) WithFormat(value string) *PushOptions
- func (o *PushOptions) WithPassword(value string) *PushOptions
- func (o *PushOptions) WithProgressWriter(value io.Writer) *PushOptions
- func (o *PushOptions) WithQuiet(value bool) *PushOptions
- func (o *PushOptions) WithRemoveSignatures(value bool) *PushOptions
- func (o *PushOptions) WithSkipTLSVerify(value bool) *PushOptions
- func (o *PushOptions) WithUsername(value string) *PushOptions
- type RemoveOptions
- func (o *RemoveOptions) Changed(fieldName string) bool
- func (o *RemoveOptions) GetAll() bool
- func (o *RemoveOptions) GetForce() bool
- func (o *RemoveOptions) GetIgnore() bool
- func (o *RemoveOptions) GetLookupManifest() bool
- func (o *RemoveOptions) GetNoPrune() bool
- func (o *RemoveOptions) ToParams() (url.Values, error)
- func (o *RemoveOptions) WithAll(value bool) *RemoveOptions
- func (o *RemoveOptions) WithForce(value bool) *RemoveOptions
- func (o *RemoveOptions) WithIgnore(value bool) *RemoveOptions
- func (o *RemoveOptions) WithLookupManifest(value bool) *RemoveOptions
- func (o *RemoveOptions) WithNoPrune(value bool) *RemoveOptions
- type ScpOptions
- type SearchOptions
- func (o *SearchOptions) Changed(fieldName string) bool
- func (o *SearchOptions) GetAuthfile() string
- func (o *SearchOptions) GetFilters() map[string][]string
- func (o *SearchOptions) GetLimit() int
- func (o *SearchOptions) GetListTags() bool
- func (o *SearchOptions) GetSkipTLSVerify() bool
- func (o *SearchOptions) ToParams() (url.Values, error)
- func (o *SearchOptions) WithAuthfile(value string) *SearchOptions
- func (o *SearchOptions) WithFilters(value map[string][]string) *SearchOptions
- func (o *SearchOptions) WithLimit(value int) *SearchOptions
- func (o *SearchOptions) WithListTags(value bool) *SearchOptions
- func (o *SearchOptions) WithSkipTLSVerify(value bool) *SearchOptions
- type TagOptions
- type TreeOptions
- type UntagOptions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Build ¶
func Build(ctx context.Context, containerFiles []string, options entities.BuildOptions) (*entities.BuildReport, error)
Build creates an image using a containerfile reference
func Exists ¶
Exists a lightweight way to determine if an image exists in local storage. It returns a boolean response.
func Export ¶
Export saves images from local storage as a tarball or image archive. The optional format parameter is used to change the format of the output.
func GetImage ¶
func GetImage(ctx context.Context, nameOrID string, options *GetOptions) (*entities.ImageInspectReport, error)
Get performs an image inspect. To have the on-disk size of the image calculated, you can use the optional size parameter.
func History ¶
func History(ctx context.Context, nameOrID string, options *HistoryOptions) ([]*types.HistoryResponse, error)
History returns the parent layers of an image.
func Import ¶
func Import(ctx context.Context, r io.Reader, options *ImportOptions) (*entities.ImageImportReport, error)
Import adds the given image to the local image store. This can be done by file and the given reader or via the url parameter. Additional metadata can be associated with the image by using the changes and message parameters. The image can also be tagged given a reference. One of url OR r must be provided.
func List ¶
func List(ctx context.Context, options *ListOptions) ([]*entities.ImageSummary, error)
List returns a list of images in local storage. The all boolean and filters parameters are optional ways to alter the image query.
func Prune ¶
func Prune(ctx context.Context, options *PruneOptions) ([]*reports.PruneReport, error)
Prune removes unused images from local storage. The optional filters can be used to further define which images should be pruned.
func Pull ¶
Pull is the binding for libpod's v2 endpoints for pulling images. Note that `rawImage` must be a reference to a registry (i.e., of docker transport or be normalized to one). Other transports are rejected as they do not make sense in a remote context. Progress reported on stderr
func Push ¶
Push is the binding for libpod's endpoints for push images. Note that `source` must be a referring to an image in the remote's container storage. The destination must be a reference to a registry (i.e., of docker transport or be normalized to one). Other transports are rejected as they do not make sense in a remote context.
func Remove ¶
func Remove(ctx context.Context, images []string, options *RemoveOptions) (*entities.ImageRemoveReport, []error)
Remove removes one or more images from the local storage. Use optional force option to remove an image, even if it's used by containers.
func Search ¶
func Search(ctx context.Context, term string, options *SearchOptions) ([]entities.ImageSearchReport, error)
Search is the binding for libpod's v2 endpoints for Search images.
func Tag ¶
func Tag(ctx context.Context, nameOrID, tag, repo string, options *TagOptions) error
Tag adds an additional name to locally-stored image. Both the tag and repo parameters are required.
func Tree ¶
func Tree(ctx context.Context, nameOrID string, options *TreeOptions) (*entities.ImageTreeReport, error)
Tree retrieves a "tree" based representation of the given image
Types ¶
type BuildOptions ¶
type BuildOptions struct {
buildahDefine.BuildOptions
}
BuildOptions are optional options for building images
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 image diffs
func (*DiffOptions) Changed ¶
func (o *DiffOptions) Changed(fieldName string) bool
Changed returns true if named field has been set
func (*DiffOptions) GetDiffType ¶
func (o *DiffOptions) GetDiffType() string
GetDiffType returns value of field DiffType
func (*DiffOptions) GetParent ¶
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 ¶
func (o *DiffOptions) WithDiffType(value string) *DiffOptions
WithDiffType set field DiffType to given value
func (*DiffOptions) WithParent ¶
func (o *DiffOptions) WithParent(value string) *DiffOptions
WithParent set field Parent to given value
type ExistsOptions ¶
type ExistsOptions struct { }
ExistsOptions are optional options for checking if an image exists
func (*ExistsOptions) Changed ¶
func (o *ExistsOptions) Changed(fieldName string) bool
Changed returns true if named field has been set
type ExportOptions ¶
type ExportOptions struct { // Compress the image Compress *bool // Format of the output Format *string // Accept uncompressed layers when copying OCI images. OciAcceptUncompressedLayers *bool }
ExportOptions are optional options for exporting images
func (*ExportOptions) Changed ¶
func (o *ExportOptions) Changed(fieldName string) bool
Changed returns true if named field has been set
func (*ExportOptions) GetCompress ¶
func (o *ExportOptions) GetCompress() bool
GetCompress returns value of field Compress
func (*ExportOptions) GetFormat ¶
func (o *ExportOptions) GetFormat() string
GetFormat returns value of field Format
func (*ExportOptions) GetOciAcceptUncompressedLayers ¶
func (o *ExportOptions) GetOciAcceptUncompressedLayers() bool
GetOciAcceptUncompressedLayers returns value of field OciAcceptUncompressedLayers
func (*ExportOptions) ToParams ¶
func (o *ExportOptions) ToParams() (url.Values, error)
ToParams formats struct fields to be passed to API service
func (*ExportOptions) WithCompress ¶
func (o *ExportOptions) WithCompress(value bool) *ExportOptions
WithCompress set field Compress to given value
func (*ExportOptions) WithFormat ¶
func (o *ExportOptions) WithFormat(value string) *ExportOptions
WithFormat set field Format to given value
func (*ExportOptions) WithOciAcceptUncompressedLayers ¶
func (o *ExportOptions) WithOciAcceptUncompressedLayers(value bool) *ExportOptions
WithOciAcceptUncompressedLayers set field OciAcceptUncompressedLayers to given value
type GetOptions ¶
type GetOptions struct { // Size computes the amount of storage the image consumes Size *bool }
GetOptions are optional options for inspecting an image
func (*GetOptions) Changed ¶
func (o *GetOptions) Changed(fieldName string) bool
Changed returns true if named field has been set
func (*GetOptions) GetSize ¶
func (o *GetOptions) GetSize() bool
GetSize returns value of field Size
func (*GetOptions) ToParams ¶
func (o *GetOptions) ToParams() (url.Values, error)
ToParams formats struct fields to be passed to API service
func (*GetOptions) WithSize ¶
func (o *GetOptions) WithSize(value bool) *GetOptions
WithSize set field Size to given value
type HistoryOptions ¶
type HistoryOptions struct { }
HistoryOptions are optional options image history
func (*HistoryOptions) Changed ¶
func (o *HistoryOptions) Changed(fieldName string) bool
Changed returns true if named field has been set
type ImportOptions ¶
type ImportOptions struct { // Changes to be applied to the image Changes *[]string // Message to be applied to the image Message *string // Reference is a tag to be applied to the image Reference *string // Url to option image to import. Cannot be used with the reader URL *string // OS for the imported image OS *string // Architecture for the imported image Architecture *string // Variant for the imported image Variant *string }
ImportOptions are optional options for importing images
func (*ImportOptions) Changed ¶
func (o *ImportOptions) Changed(fieldName string) bool
Changed returns true if named field has been set
func (*ImportOptions) GetArchitecture ¶ added in v4.1.0
func (o *ImportOptions) GetArchitecture() string
GetArchitecture returns value of field Architecture
func (*ImportOptions) GetChanges ¶
func (o *ImportOptions) GetChanges() []string
GetChanges returns value of field Changes
func (*ImportOptions) GetMessage ¶
func (o *ImportOptions) GetMessage() string
GetMessage returns value of field Message
func (*ImportOptions) GetOS ¶ added in v4.1.0
func (o *ImportOptions) GetOS() string
GetOS returns value of field OS
func (*ImportOptions) GetReference ¶
func (o *ImportOptions) GetReference() string
GetReference returns value of field Reference
func (*ImportOptions) GetURL ¶
func (o *ImportOptions) GetURL() string
GetURL returns value of field URL
func (*ImportOptions) GetVariant ¶ added in v4.1.0
func (o *ImportOptions) GetVariant() string
GetVariant returns value of field Variant
func (*ImportOptions) ToParams ¶
func (o *ImportOptions) ToParams() (url.Values, error)
ToParams formats struct fields to be passed to API service
func (*ImportOptions) WithArchitecture ¶ added in v4.1.0
func (o *ImportOptions) WithArchitecture(value string) *ImportOptions
WithArchitecture set field Architecture to given value
func (*ImportOptions) WithChanges ¶
func (o *ImportOptions) WithChanges(value []string) *ImportOptions
WithChanges set field Changes to given value
func (*ImportOptions) WithMessage ¶
func (o *ImportOptions) WithMessage(value string) *ImportOptions
WithMessage set field Message to given value
func (*ImportOptions) WithOS ¶ added in v4.1.0
func (o *ImportOptions) WithOS(value string) *ImportOptions
WithOS set field OS to given value
func (*ImportOptions) WithReference ¶
func (o *ImportOptions) WithReference(value string) *ImportOptions
WithReference set field Reference to given value
func (*ImportOptions) WithURL ¶
func (o *ImportOptions) WithURL(value string) *ImportOptions
WithURL set field URL to given value
func (*ImportOptions) WithVariant ¶ added in v4.1.0
func (o *ImportOptions) WithVariant(value string) *ImportOptions
WithVariant set field Variant to given value
type ListOptions ¶
type ListOptions struct { // All lists all image in the image store including dangling images All *bool // filters that can be used to get a more specific list of images Filters map[string][]string }
ListOptions are optional options for listing images
func (*ListOptions) Changed ¶
func (o *ListOptions) Changed(fieldName string) bool
Changed returns true if named field has been set
func (*ListOptions) GetFilters ¶
func (o *ListOptions) GetFilters() map[string][]string
GetFilters returns value of field Filters
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) WithFilters ¶
func (o *ListOptions) WithFilters(value map[string][]string) *ListOptions
WithFilters set field Filters to given value
type LoadOptions ¶
type LoadOptions struct { // Reference is the name of the loaded image Reference *string }
LoadOptions are optional options for loading an image
func (*LoadOptions) Changed ¶
func (o *LoadOptions) Changed(fieldName string) bool
Changed returns true if named field has been set
func (*LoadOptions) GetReference ¶
func (o *LoadOptions) GetReference() string
GetReference returns value of field Reference
func (*LoadOptions) ToParams ¶
func (o *LoadOptions) ToParams() (url.Values, error)
ToParams formats struct fields to be passed to API service
func (*LoadOptions) WithReference ¶
func (o *LoadOptions) WithReference(value string) *LoadOptions
WithReference set field Reference to given value
type PruneOptions ¶
type PruneOptions struct { // Prune all images All *bool // Prune images even when they're used by external containers External *bool // Filters to apply when pruning images Filters map[string][]string }
PruneOptions are optional options for pruning images
func (*PruneOptions) Changed ¶
func (o *PruneOptions) Changed(fieldName string) bool
Changed returns true if named field has been set
func (*PruneOptions) GetAll ¶
func (o *PruneOptions) GetAll() bool
GetAll returns value of field All
func (*PruneOptions) GetExternal ¶
func (o *PruneOptions) GetExternal() bool
GetExternal returns value of field External
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) WithAll ¶
func (o *PruneOptions) WithAll(value bool) *PruneOptions
WithAll set field All to given value
func (*PruneOptions) WithExternal ¶
func (o *PruneOptions) WithExternal(value bool) *PruneOptions
WithExternal set field External to given value
func (*PruneOptions) WithFilters ¶
func (o *PruneOptions) WithFilters(value map[string][]string) *PruneOptions
WithFilters set field Filters to given value
type PullOptions ¶
type PullOptions struct { // AllTags can be specified to pull all tags of an image. Note // that this only works if the image does not include a tag. AllTags *bool // Arch will overwrite the local architecture for image pulls. Arch *string // Authfile is the path to the authentication file. Ignored for remote // calls. Authfile *string // OS will overwrite the local operating system (OS) for image // pulls. OS *string // Policy is the pull policy. Supported values are "missing", "never", // "newer", "always". An empty string defaults to "always". Policy *string // Password for authenticating against the registry. Password *string // ProgressWriter is a writer where pull progress are sent. ProgressWriter *io.Writer `schema:"-"` // Quiet can be specified to suppress pull progress when pulling. Ignored // for remote calls. Quiet *bool // SkipTLSVerify to skip HTTPS and certificate verification. SkipTLSVerify *bool `schema:"-"` // Username for authenticating against the registry. Username *string // Variant will overwrite the local variant for image pulls. Variant *string }
PullOptions are optional options for pulling images
func (*PullOptions) Changed ¶
func (o *PullOptions) Changed(fieldName string) bool
Changed returns true if named field has been set
func (*PullOptions) GetAllTags ¶
func (o *PullOptions) GetAllTags() bool
GetAllTags returns value of field AllTags
func (*PullOptions) GetArch ¶
func (o *PullOptions) GetArch() string
GetArch returns value of field Arch
func (*PullOptions) GetAuthfile ¶
func (o *PullOptions) GetAuthfile() string
GetAuthfile returns value of field Authfile
func (*PullOptions) GetPassword ¶
func (o *PullOptions) GetPassword() string
GetPassword returns value of field Password
func (*PullOptions) GetPolicy ¶
func (o *PullOptions) GetPolicy() string
GetPolicy returns value of field Policy
func (*PullOptions) GetProgressWriter ¶ added in v4.3.0
func (o *PullOptions) GetProgressWriter() io.Writer
GetProgressWriter returns value of field ProgressWriter
func (*PullOptions) GetQuiet ¶
func (o *PullOptions) GetQuiet() bool
GetQuiet returns value of field Quiet
func (*PullOptions) GetSkipTLSVerify ¶
func (o *PullOptions) GetSkipTLSVerify() bool
GetSkipTLSVerify returns value of field SkipTLSVerify
func (*PullOptions) GetUsername ¶
func (o *PullOptions) GetUsername() string
GetUsername returns value of field Username
func (*PullOptions) GetVariant ¶
func (o *PullOptions) GetVariant() string
GetVariant returns value of field Variant
func (*PullOptions) ToParams ¶
func (o *PullOptions) ToParams() (url.Values, error)
ToParams formats struct fields to be passed to API service
func (*PullOptions) WithAllTags ¶
func (o *PullOptions) WithAllTags(value bool) *PullOptions
WithAllTags set field AllTags to given value
func (*PullOptions) WithArch ¶
func (o *PullOptions) WithArch(value string) *PullOptions
WithArch set field Arch to given value
func (*PullOptions) WithAuthfile ¶
func (o *PullOptions) WithAuthfile(value string) *PullOptions
WithAuthfile set field Authfile to given value
func (*PullOptions) WithOS ¶
func (o *PullOptions) WithOS(value string) *PullOptions
WithOS set field OS to given value
func (*PullOptions) WithPassword ¶
func (o *PullOptions) WithPassword(value string) *PullOptions
WithPassword set field Password to given value
func (*PullOptions) WithPolicy ¶
func (o *PullOptions) WithPolicy(value string) *PullOptions
WithPolicy set field Policy to given value
func (*PullOptions) WithProgressWriter ¶ added in v4.3.0
func (o *PullOptions) WithProgressWriter(value io.Writer) *PullOptions
WithProgressWriter set field ProgressWriter to given value
func (*PullOptions) WithQuiet ¶
func (o *PullOptions) WithQuiet(value bool) *PullOptions
WithQuiet set field Quiet to given value
func (*PullOptions) WithSkipTLSVerify ¶
func (o *PullOptions) WithSkipTLSVerify(value bool) *PullOptions
WithSkipTLSVerify set field SkipTLSVerify to given value
func (*PullOptions) WithUsername ¶
func (o *PullOptions) WithUsername(value string) *PullOptions
WithUsername set field Username to given value
func (*PullOptions) WithVariant ¶
func (o *PullOptions) WithVariant(value string) *PullOptions
WithVariant set field Variant to given value
type PushOptions ¶
type PushOptions struct { // All indicates whether to push all images related to the image list All *bool // Authfile is the path to the authentication file. Ignored for remote // calls. Authfile *string // Compress tarball image layers when pushing to a directory using the 'dir' transport. Compress *bool // CompressionFormat is the format to use for the compression of the blobs CompressionFormat *string // Manifest type of the pushed image Format *string // Password for authenticating against the registry. Password *string // ProgressWriter is a writer where push progress are sent. // Since API handler for image push is quiet by default, WithQuiet(false) is necessary for // the writer to receive progress messages. ProgressWriter *io.Writer `schema:"-"` // SkipTLSVerify to skip HTTPS and certificate verification. SkipTLSVerify *bool `schema:"-"` // RemoveSignatures Discard any pre-existing signatures in the image. RemoveSignatures *bool // Username for authenticating against the registry. Username *string // Quiet can be specified to suppress progress when pushing. Quiet *bool }
PushOptions are optional options for importing images
func (*PushOptions) Changed ¶
func (o *PushOptions) Changed(fieldName string) bool
Changed returns true if named field has been set
func (*PushOptions) GetAuthfile ¶
func (o *PushOptions) GetAuthfile() string
GetAuthfile returns value of field Authfile
func (*PushOptions) GetCompress ¶
func (o *PushOptions) GetCompress() bool
GetCompress returns value of field Compress
func (*PushOptions) GetCompressionFormat ¶ added in v4.3.0
func (o *PushOptions) GetCompressionFormat() string
GetCompressionFormat returns value of field CompressionFormat
func (*PushOptions) GetFormat ¶
func (o *PushOptions) GetFormat() string
GetFormat returns value of field Format
func (*PushOptions) GetPassword ¶
func (o *PushOptions) GetPassword() string
GetPassword returns value of field Password
func (*PushOptions) GetProgressWriter ¶ added in v4.3.0
func (o *PushOptions) GetProgressWriter() io.Writer
GetProgressWriter returns value of field ProgressWriter
func (*PushOptions) GetQuiet ¶ added in v4.2.0
func (o *PushOptions) GetQuiet() bool
GetQuiet returns value of field Quiet
func (*PushOptions) GetRemoveSignatures ¶ added in v4.2.0
func (o *PushOptions) GetRemoveSignatures() bool
GetRemoveSignatures returns value of field RemoveSignatures
func (*PushOptions) GetSkipTLSVerify ¶
func (o *PushOptions) GetSkipTLSVerify() bool
GetSkipTLSVerify returns value of field SkipTLSVerify
func (*PushOptions) GetUsername ¶
func (o *PushOptions) GetUsername() string
GetUsername returns value of field Username
func (*PushOptions) ToParams ¶
func (o *PushOptions) ToParams() (url.Values, error)
ToParams formats struct fields to be passed to API service
func (*PushOptions) WithAll ¶
func (o *PushOptions) WithAll(value bool) *PushOptions
WithAll set field All to given value
func (*PushOptions) WithAuthfile ¶
func (o *PushOptions) WithAuthfile(value string) *PushOptions
WithAuthfile set field Authfile to given value
func (*PushOptions) WithCompress ¶
func (o *PushOptions) WithCompress(value bool) *PushOptions
WithCompress set field Compress to given value
func (*PushOptions) WithCompressionFormat ¶ added in v4.3.0
func (o *PushOptions) WithCompressionFormat(value string) *PushOptions
WithCompressionFormat set field CompressionFormat to given value
func (*PushOptions) WithFormat ¶
func (o *PushOptions) WithFormat(value string) *PushOptions
WithFormat set field Format to given value
func (*PushOptions) WithPassword ¶
func (o *PushOptions) WithPassword(value string) *PushOptions
WithPassword set field Password to given value
func (*PushOptions) WithProgressWriter ¶ added in v4.3.0
func (o *PushOptions) WithProgressWriter(value io.Writer) *PushOptions
WithProgressWriter set field ProgressWriter to given value
func (*PushOptions) WithQuiet ¶ added in v4.2.0
func (o *PushOptions) WithQuiet(value bool) *PushOptions
WithQuiet set field Quiet to given value
func (*PushOptions) WithRemoveSignatures ¶ added in v4.2.0
func (o *PushOptions) WithRemoveSignatures(value bool) *PushOptions
WithRemoveSignatures set field RemoveSignatures to given value
func (*PushOptions) WithSkipTLSVerify ¶
func (o *PushOptions) WithSkipTLSVerify(value bool) *PushOptions
WithSkipTLSVerify set field SkipTLSVerify to given value
func (*PushOptions) WithUsername ¶
func (o *PushOptions) WithUsername(value string) *PushOptions
WithUsername set field Username to given value
type RemoveOptions ¶
type RemoveOptions struct { // All removes all images All *bool // Forces removes all containers based on the image Force *bool // Ignore if a specified image does not exist and do not throw an error. Ignore *bool // Confirms if given name is a manifest list and removes it, otherwise returns error. LookupManifest *bool // Does not remove dangling parent images NoPrune *bool }
RemoveOptions are optional options for image removal
func (*RemoveOptions) Changed ¶
func (o *RemoveOptions) Changed(fieldName string) bool
Changed returns true if named field has been set
func (*RemoveOptions) GetAll ¶
func (o *RemoveOptions) GetAll() bool
GetAll returns value of field All
func (*RemoveOptions) GetForce ¶
func (o *RemoveOptions) GetForce() bool
GetForce returns value of field Force
func (*RemoveOptions) GetIgnore ¶ added in v4.1.0
func (o *RemoveOptions) GetIgnore() bool
GetIgnore returns value of field Ignore
func (*RemoveOptions) GetLookupManifest ¶ added in v4.2.0
func (o *RemoveOptions) GetLookupManifest() bool
GetLookupManifest returns value of field LookupManifest
func (*RemoveOptions) GetNoPrune ¶ added in v4.3.0
func (o *RemoveOptions) GetNoPrune() bool
GetNoPrune returns value of field NoPrune
func (*RemoveOptions) ToParams ¶
func (o *RemoveOptions) ToParams() (url.Values, error)
ToParams formats struct fields to be passed to API service
func (*RemoveOptions) WithAll ¶
func (o *RemoveOptions) WithAll(value bool) *RemoveOptions
WithAll set field All to given value
func (*RemoveOptions) WithForce ¶
func (o *RemoveOptions) WithForce(value bool) *RemoveOptions
WithForce set field Force to given value
func (*RemoveOptions) WithIgnore ¶ added in v4.1.0
func (o *RemoveOptions) WithIgnore(value bool) *RemoveOptions
WithIgnore set field Ignore to given value
func (*RemoveOptions) WithLookupManifest ¶ added in v4.2.0
func (o *RemoveOptions) WithLookupManifest(value bool) *RemoveOptions
WithLookupManifest set field LookupManifest to given value
func (*RemoveOptions) WithNoPrune ¶ added in v4.3.0
func (o *RemoveOptions) WithNoPrune(value bool) *RemoveOptions
WithNoPrune set field NoPrune to given value
type ScpOptions ¶ added in v4.2.0
type SearchOptions ¶
type SearchOptions struct { // Authfile is the path to the authentication file. Ignored for remote // calls. Authfile *string // Filters for the search results. Filters map[string][]string // Limit the number of results. Limit *int // SkipTLSVerify to skip HTTPS and certificate verification. SkipTLSVerify *bool `schema:"-"` // ListTags search the available tags of the repository ListTags *bool }
SearchOptions are optional options for searching images on registries
func (*SearchOptions) Changed ¶
func (o *SearchOptions) Changed(fieldName string) bool
Changed returns true if named field has been set
func (*SearchOptions) GetAuthfile ¶
func (o *SearchOptions) GetAuthfile() string
GetAuthfile returns value of field Authfile
func (*SearchOptions) GetFilters ¶
func (o *SearchOptions) GetFilters() map[string][]string
GetFilters returns value of field Filters
func (*SearchOptions) GetLimit ¶
func (o *SearchOptions) GetLimit() int
GetLimit returns value of field Limit
func (*SearchOptions) GetListTags ¶
func (o *SearchOptions) GetListTags() bool
GetListTags returns value of field ListTags
func (*SearchOptions) GetSkipTLSVerify ¶
func (o *SearchOptions) GetSkipTLSVerify() bool
GetSkipTLSVerify returns value of field SkipTLSVerify
func (*SearchOptions) ToParams ¶
func (o *SearchOptions) ToParams() (url.Values, error)
ToParams formats struct fields to be passed to API service
func (*SearchOptions) WithAuthfile ¶
func (o *SearchOptions) WithAuthfile(value string) *SearchOptions
WithAuthfile set field Authfile to given value
func (*SearchOptions) WithFilters ¶
func (o *SearchOptions) WithFilters(value map[string][]string) *SearchOptions
WithFilters set field Filters to given value
func (*SearchOptions) WithLimit ¶
func (o *SearchOptions) WithLimit(value int) *SearchOptions
WithLimit set field Limit to given value
func (*SearchOptions) WithListTags ¶
func (o *SearchOptions) WithListTags(value bool) *SearchOptions
WithListTags set field ListTags to given value
func (*SearchOptions) WithSkipTLSVerify ¶
func (o *SearchOptions) WithSkipTLSVerify(value bool) *SearchOptions
WithSkipTLSVerify set field SkipTLSVerify to given value
type TagOptions ¶
type TagOptions struct { }
TagOptions are optional options for tagging images
func (*TagOptions) Changed ¶
func (o *TagOptions) Changed(fieldName string) bool
Changed returns true if named field has been set
type TreeOptions ¶
type TreeOptions struct { // WhatRequires ... WhatRequires *bool }
TreeOptions are optional options for a tree-based representation of the image
func (*TreeOptions) Changed ¶
func (o *TreeOptions) Changed(fieldName string) bool
Changed returns true if named field has been set
func (*TreeOptions) GetWhatRequires ¶
func (o *TreeOptions) GetWhatRequires() bool
GetWhatRequires returns value of field WhatRequires
func (*TreeOptions) ToParams ¶
func (o *TreeOptions) ToParams() (url.Values, error)
ToParams formats struct fields to be passed to API service
func (*TreeOptions) WithWhatRequires ¶
func (o *TreeOptions) WithWhatRequires(value bool) *TreeOptions
WithWhatRequires set field WhatRequires to given value
type UntagOptions ¶
type UntagOptions struct { }
UntagOptions are optional options for untagging images
func (*UntagOptions) Changed ¶
func (o *UntagOptions) Changed(fieldName string) bool
Changed returns true if named field has been set
Source Files ¶
- build.go
- build_unix.go
- diff.go
- images.go
- pull.go
- push.go
- rm.go
- types.go
- types_diff_options.go
- types_exists_options.go
- types_export_options.go
- types_get_options.go
- types_history_options.go
- types_import_options.go
- types_list_options.go
- types_load_options.go
- types_prune_options.go
- types_pull_options.go
- types_push_options.go
- types_remove_options.go
- types_scp_options.go
- types_search_options.go
- types_tag_options.go
- types_tree_options.go
- types_untag_options.go