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.
Index ¶
- func Add(ctx context.Context, artifactName string, blobName string, ...) (*entitiesTypes.ArtifactAddReport, error)
- func Extract(ctx context.Context, artifactName string, target string, ...) error
- func Inspect(ctx context.Context, nameOrID string, _ *InspectOptions) (*types.ArtifactInspectReport, error)
- func List(ctx context.Context, _ *ListOptions) ([]*entities.ArtifactListReport, error)
- func Pull(ctx context.Context, name string, options *PullOptions) (*entities.ArtifactPullReport, error)
- func Push(ctx context.Context, name string, options *PushOptions) (*entities.ArtifactPushReport, error)
- func Remove(ctx context.Context, nameOrID string, options *RemoveOptions) (*entities.ArtifactRemoveReport, error)
- type AddOptions
- func (o *AddOptions) Changed(fieldName string) bool
- func (o *AddOptions) GetAnnotations() []string
- func (o *AddOptions) GetAppend() bool
- func (o *AddOptions) GetArtifactMIMEType() string
- func (o *AddOptions) GetFileMIMEType() string
- func (o *AddOptions) GetReplace() bool
- func (o *AddOptions) ToParams() (url.Values, error)
- func (o *AddOptions) WithAnnotations(value []string) *AddOptions
- func (o *AddOptions) WithAppend(value bool) *AddOptions
- func (o *AddOptions) WithArtifactMIMEType(value string) *AddOptions
- func (o *AddOptions) WithFileMIMEType(value string) *AddOptions
- func (o *AddOptions) WithReplace(value bool) *AddOptions
- type ExtractOptions
- func (o *ExtractOptions) Changed(fieldName string) bool
- func (o *ExtractOptions) GetDigest() string
- func (o *ExtractOptions) GetExcludeTitle() bool
- func (o *ExtractOptions) GetTitle() string
- func (o *ExtractOptions) ToParams() (url.Values, error)
- func (o *ExtractOptions) WithDigest(value string) *ExtractOptions
- func (o *ExtractOptions) WithExcludeTitle(value bool) *ExtractOptions
- func (o *ExtractOptions) WithTitle(value string) *ExtractOptions
- type InspectOptions
- type ListOptions
- type PullOptions
- func (o *PullOptions) Changed(fieldName string) bool
- func (o *PullOptions) GetAuthfile() string
- func (o *PullOptions) GetPassword() string
- func (o *PullOptions) GetProgressWriter() io.Writer
- func (o *PullOptions) GetQuiet() bool
- func (o *PullOptions) GetRetry() uint
- func (o *PullOptions) GetRetryDelay() string
- func (o *PullOptions) GetTlsVerify() bool
- func (o *PullOptions) GetUsername() string
- func (o *PullOptions) ToParams() (url.Values, error)
- func (o *PullOptions) WithAuthfile(value string) *PullOptions
- func (o *PullOptions) WithPassword(value string) *PullOptions
- func (o *PullOptions) WithProgressWriter(value io.Writer) *PullOptions
- func (o *PullOptions) WithQuiet(value bool) *PullOptions
- func (o *PullOptions) WithRetry(value uint) *PullOptions
- func (o *PullOptions) WithRetryDelay(value string) *PullOptions
- func (o *PullOptions) WithTlsVerify(value bool) *PullOptions
- func (o *PullOptions) WithUsername(value string) *PullOptions
- type PushOptions
- func (o *PushOptions) Changed(fieldName string) bool
- func (o *PushOptions) GetAuthfile() string
- func (o *PushOptions) GetPassword() string
- func (o *PushOptions) GetQuiet() bool
- func (o *PushOptions) GetRetry() uint
- func (o *PushOptions) GetRetryDelay() string
- func (o *PushOptions) GetTlsVerify() bool
- func (o *PushOptions) GetUsername() string
- func (o *PushOptions) ToParams() (url.Values, error)
- func (o *PushOptions) WithAuthfile(value string) *PushOptions
- func (o *PushOptions) WithPassword(value string) *PushOptions
- func (o *PushOptions) WithQuiet(value bool) *PushOptions
- func (o *PushOptions) WithRetry(value uint) *PushOptions
- func (o *PushOptions) WithRetryDelay(value string) *PushOptions
- func (o *PushOptions) WithTlsVerify(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) GetArtifacts() []string
- func (o *RemoveOptions) GetIgnore() bool
- func (o *RemoveOptions) ToParams() (url.Values, error)
- func (o *RemoveOptions) WithAll(value bool) *RemoveOptions
- func (o *RemoveOptions) WithArtifacts(value []string) *RemoveOptions
- func (o *RemoveOptions) WithIgnore(value bool) *RemoveOptions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Add ¶
func Add(ctx context.Context, artifactName string, blobName string, artifactBlob io.Reader, options *AddOptions) (*entitiesTypes.ArtifactAddReport, error)
func Inspect ¶
func Inspect(ctx context.Context, nameOrID string, _ *InspectOptions) (*types.ArtifactInspectReport, error)
func List ¶
func List(ctx context.Context, _ *ListOptions) ([]*entities.ArtifactListReport, error)
List returns a list of artifacts in local storage.
func Pull ¶
func Pull(ctx context.Context, name string, options *PullOptions) (*entities.ArtifactPullReport, error)
func Push ¶
func Push(ctx context.Context, name string, options *PushOptions) (*entities.ArtifactPushReport, error)
func Remove ¶
func Remove(ctx context.Context, nameOrID string, options *RemoveOptions) (*entities.ArtifactRemoveReport, error)
Remove removes an artifact from local storage. TODO (6.0): nameOrID parameter should be removed
Types ¶
type AddOptions ¶
type AddOptions struct {
Annotations []string
ArtifactMIMEType *string
Append *bool
FileMIMEType *string
Replace *bool
}
AddOptions are optional options for removing images
func (*AddOptions) Changed ¶
func (o *AddOptions) Changed(fieldName string) bool
Changed returns true if named field has been set
func (*AddOptions) GetAnnotations ¶
func (o *AddOptions) GetAnnotations() []string
GetAnnotations returns value of field Annotations
func (*AddOptions) GetAppend ¶
func (o *AddOptions) GetAppend() bool
GetAppend returns value of field Append
func (*AddOptions) GetArtifactMIMEType ¶
func (o *AddOptions) GetArtifactMIMEType() string
GetArtifactMIMEType returns value of field ArtifactMIMEType
func (*AddOptions) GetFileMIMEType ¶
func (o *AddOptions) GetFileMIMEType() string
GetFileMIMEType returns value of field FileMIMEType
func (*AddOptions) GetReplace ¶ added in v5.7.0
func (o *AddOptions) GetReplace() bool
GetReplace returns value of field Replace
func (*AddOptions) ToParams ¶
func (o *AddOptions) ToParams() (url.Values, error)
ToParams formats struct fields to be passed to API service
func (*AddOptions) WithAnnotations ¶
func (o *AddOptions) WithAnnotations(value []string) *AddOptions
WithAnnotations set field Annotations to given value
func (*AddOptions) WithAppend ¶
func (o *AddOptions) WithAppend(value bool) *AddOptions
WithAppend set field Append to given value
func (*AddOptions) WithArtifactMIMEType ¶
func (o *AddOptions) WithArtifactMIMEType(value string) *AddOptions
WithArtifactMIMEType set field ArtifactMIMEType to given value
func (*AddOptions) WithFileMIMEType ¶
func (o *AddOptions) WithFileMIMEType(value string) *AddOptions
WithFileMIMEType set field FileMIMEType to given value
func (*AddOptions) WithReplace ¶ added in v5.7.0
func (o *AddOptions) WithReplace(value bool) *AddOptions
WithReplace set field Replace to given value
type ExtractOptions ¶
type ExtractOptions struct {
// Title annotation value to extract only a single blob matching that name.
// Conflicts with Digest. Optional.
Title *string
// Digest of the blob to extract.
// Conflicts with Title. Optional.
Digest *string
// ExcludeTitle option allows single blobs to be exported
// with their title/filename empty. Optional.
// Default: False
ExcludeTitle *bool
}
ExtractOptions
func (*ExtractOptions) Changed ¶
func (o *ExtractOptions) Changed(fieldName string) bool
Changed returns true if named field has been set
func (*ExtractOptions) GetDigest ¶
func (o *ExtractOptions) GetDigest() string
GetDigest returns value of field Digest
func (*ExtractOptions) GetExcludeTitle ¶
func (o *ExtractOptions) GetExcludeTitle() bool
GetExcludeTitle returns value of field ExcludeTitle
func (*ExtractOptions) GetTitle ¶
func (o *ExtractOptions) GetTitle() string
GetTitle returns value of field Title
func (*ExtractOptions) ToParams ¶
func (o *ExtractOptions) ToParams() (url.Values, error)
ToParams formats struct fields to be passed to API service
func (*ExtractOptions) WithDigest ¶
func (o *ExtractOptions) WithDigest(value string) *ExtractOptions
WithDigest set field Digest to given value
func (*ExtractOptions) WithExcludeTitle ¶
func (o *ExtractOptions) WithExcludeTitle(value bool) *ExtractOptions
WithExcludeTitle set field ExcludeTitle to given value
func (*ExtractOptions) WithTitle ¶
func (o *ExtractOptions) WithTitle(value string) *ExtractOptions
WithTitle set field Title to given value
type InspectOptions ¶
type InspectOptions struct{}
InspectOptions
func (*InspectOptions) Changed ¶
func (o *InspectOptions) Changed(fieldName string) bool
Changed returns true if named field has been set
type ListOptions ¶
type ListOptions struct{}
ListOptions
func (*ListOptions) Changed ¶
func (o *ListOptions) Changed(fieldName string) bool
Changed returns true if named field has been set
type PullOptions ¶
type PullOptions struct {
// Authfile is the path to the authentication file.
Authfile *string `schema:"-"`
// Password for authenticating against the registry.
Password *string `schema:"-"`
// ProgressWriter is a writer where pull progress are sent.
ProgressWriter *io.Writer `schema:"-"`
// Quiet can be specified to suppress pull progress when pulling.
Quiet *bool
// Retry number of times to retry pull in case of failure
Retry *uint
// RetryDelay between retries in case of pull failures
RetryDelay *string
// SkipTLSVerify to skip HTTPS and certificate verification.
TlsVerify *bool
// Username for authenticating against the registry.
Username *string `schema:"-"`
}
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) 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) GetProgressWriter ¶
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) GetRetry ¶
func (o *PullOptions) GetRetry() uint
GetRetry returns value of field Retry
func (*PullOptions) GetRetryDelay ¶
func (o *PullOptions) GetRetryDelay() string
GetRetryDelay returns value of field RetryDelay
func (*PullOptions) GetTlsVerify ¶
func (o *PullOptions) GetTlsVerify() bool
GetTlsVerify returns value of field TlsVerify
func (*PullOptions) GetUsername ¶
func (o *PullOptions) GetUsername() string
GetUsername returns value of field Username
func (*PullOptions) ToParams ¶
func (o *PullOptions) ToParams() (url.Values, error)
ToParams formats struct fields to be passed to API service
func (*PullOptions) WithAuthfile ¶
func (o *PullOptions) WithAuthfile(value string) *PullOptions
WithAuthfile set field Authfile to given value
func (*PullOptions) WithPassword ¶
func (o *PullOptions) WithPassword(value string) *PullOptions
WithPassword set field Password to given value
func (*PullOptions) WithProgressWriter ¶
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) WithRetry ¶
func (o *PullOptions) WithRetry(value uint) *PullOptions
WithRetry set field Retry to given value
func (*PullOptions) WithRetryDelay ¶
func (o *PullOptions) WithRetryDelay(value string) *PullOptions
WithRetryDelay set field RetryDelay to given value
func (*PullOptions) WithTlsVerify ¶
func (o *PullOptions) WithTlsVerify(value bool) *PullOptions
WithTlsVerify set field TlsVerify to given value
func (*PullOptions) WithUsername ¶
func (o *PullOptions) WithUsername(value string) *PullOptions
WithUsername set field Username to given value
type PushOptions ¶
type PushOptions struct {
// Authfile is the path to the authentication file.
Authfile *string `schema:"-"`
// Password for authenticating against the registry.
Password *string `schema:"-"`
// Quiet can be specified to suppress pull progress when pulling.
Quiet *bool
// Retry number of times to retry pull in case of failure
Retry *uint
// RetryDelay between retries in case of pull failures
RetryDelay *string
// SkipTLSVerify to skip HTTPS and certificate verification.
TlsVerify *bool
// Username for authenticating against the registry.
Username *string `schema:"-"`
}
PushOptions are optional options for pushing 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) GetPassword ¶
func (o *PushOptions) GetPassword() string
GetPassword returns value of field Password
func (*PushOptions) GetQuiet ¶
func (o *PushOptions) GetQuiet() bool
GetQuiet returns value of field Quiet
func (*PushOptions) GetRetry ¶
func (o *PushOptions) GetRetry() uint
GetRetry returns value of field Retry
func (*PushOptions) GetRetryDelay ¶
func (o *PushOptions) GetRetryDelay() string
GetRetryDelay returns value of field RetryDelay
func (*PushOptions) GetTlsVerify ¶
func (o *PushOptions) GetTlsVerify() bool
GetTlsVerify returns value of field TlsVerify
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) WithAuthfile ¶
func (o *PushOptions) WithAuthfile(value string) *PushOptions
WithAuthfile set field Authfile to given value
func (*PushOptions) WithPassword ¶
func (o *PushOptions) WithPassword(value string) *PushOptions
WithPassword set field Password to given value
func (*PushOptions) WithQuiet ¶
func (o *PushOptions) WithQuiet(value bool) *PushOptions
WithQuiet set field Quiet to given value
func (*PushOptions) WithRetry ¶
func (o *PushOptions) WithRetry(value uint) *PushOptions
WithRetry set field Retry to given value
func (*PushOptions) WithRetryDelay ¶
func (o *PushOptions) WithRetryDelay(value string) *PushOptions
WithRetryDelay set field RetryDelay to given value
func (*PushOptions) WithTlsVerify ¶
func (o *PushOptions) WithTlsVerify(value bool) *PushOptions
WithTlsVerify set field TlsVerify 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 {
// Remove all artifacts
All *bool
// Artifacts is a list of Artifact IDs or names to remove
Artifacts []string
// Ignore errors if IDs or names are not defined
Ignore *bool
}
RemoveOptions are optional options for removing images
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) GetArtifacts ¶ added in v5.7.0
func (o *RemoveOptions) GetArtifacts() []string
GetArtifacts returns value of field Artifacts
func (*RemoveOptions) GetIgnore ¶ added in v5.7.0
func (o *RemoveOptions) GetIgnore() bool
GetIgnore returns value of field Ignore
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) WithArtifacts ¶ added in v5.7.0
func (o *RemoveOptions) WithArtifacts(value []string) *RemoveOptions
WithArtifacts set field Artifacts to given value
func (*RemoveOptions) WithIgnore ¶ added in v5.7.0
func (o *RemoveOptions) WithIgnore(value bool) *RemoveOptions
WithIgnore set field Ignore to given value