manifests

package
v4.7.0 Latest Latest
Warning

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

 Go to latest Published: Sep 27, 2023 License: Apache-2.0 Imports: 20 Imported by: 0

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.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Add 

func Add(ctx context.Context, name string, options *AddOptions) (string, error)

Add adds a manifest to a given manifest list. Additional options for the manifest can also be specified. The ID of the new manifest list is returned as a string

func Annotate 

func Annotate(ctx context.Context, name string, images []string, options *ModifyOptions) (string, error)

Annotate modifies the given manifest list using options and the optional list of images

As of 4.0.0

func Create 

func Create(ctx context.Context, name string, images []string, options *CreateOptions) (string, error)

Create creates a manifest for the given name. Optional images to be associated with the new manifest can also be specified. The all boolean specifies to add all entries of a list if the name provided is a manifest list. The ID of the new manifest list is returned as a string.

func Delete added in v4.2.0 

func Delete(ctx context.Context, name string) (*entities.ManifestRemoveReport, error)

Delete removes specified manifest from local storage.

func Exists 

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

Exists returns true if a given manifest list exists

func Inspect 

func Inspect(ctx context.Context, name string, options *InspectOptions) (*manifest.Schema2List, error)

Inspect returns a manifest list for a given name.

func InspectListData added in v4.4.0 

func InspectListData(ctx context.Context, name string, options *InspectOptions) (*define.ManifestListData, error)

InspectListData returns a manifest list for a given name. Contains exclusive field like `annotations` which is only present in OCI spec and not in docker image spec.

func Modify 

func Modify(ctx context.Context, name string, images []string, options *ModifyOptions) (string, error)

Modify modifies the given manifest list using options and the optional list of images

func Push 

func Push(ctx context.Context, name, destination string, options *images.PushOptions) (string, error)

Push takes a manifest list and pushes to a destination. If the destination is not specified, the name will be used instead. If the optional all boolean is specified, all images specified in the list will be pushed as well.

func Remove 

func Remove(ctx context.Context, name, digest string, _ *RemoveOptions) (string, error)

Remove deletes a manifest entry from a manifest list. Both name and the digest to be removed are mandatory inputs. The ID of the new manifest list is returned as a string.

Types

type AddOptions 

type AddOptions struct {
	All           *bool
	Annotation    map[string]string
	Arch          *string
	Features      []string
	Images        []string
	OS            *string
	OSVersion     *string
	Variant       *string
	Authfile      *string
	Password      *string
	Username      *string
	SkipTLSVerify *bool `schema:"-"`
}

AddOptions are optional options for adding manifest lists

func (*AddOptions) Changed 

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

Changed returns true if named field has been set

func (*AddOptions) GetAll 

func (o *AddOptions) GetAll() bool

GetAll returns value of field All

func (*AddOptions) GetAnnotation 

func (o *AddOptions) GetAnnotation() map[string]string

GetAnnotation returns value of field Annotation

func (*AddOptions) GetArch 

func (o *AddOptions) GetArch() string

GetArch returns value of field Arch

func (*AddOptions) GetAuthfile added in v4.1.0 

func (o *AddOptions) GetAuthfile() string

GetAuthfile returns value of field Authfile

func (*AddOptions) GetFeatures 

func (o *AddOptions) GetFeatures() []string

GetFeatures returns value of field Features

func (*AddOptions) GetImages 

func (o *AddOptions) GetImages() []string

GetImages returns value of field Images

func (*AddOptions) GetOS 

func (o *AddOptions) GetOS() string

GetOS returns value of field OS

func (*AddOptions) GetOSVersion 

func (o *AddOptions) GetOSVersion() string

GetOSVersion returns value of field OSVersion

func (*AddOptions) GetPassword added in v4.1.0 

func (o *AddOptions) GetPassword() string

GetPassword returns value of field Password

func (*AddOptions) GetSkipTLSVerify added in v4.1.0 

func (o *AddOptions) GetSkipTLSVerify() bool

GetSkipTLSVerify returns value of field SkipTLSVerify

func (*AddOptions) GetUsername added in v4.1.0 

func (o *AddOptions) GetUsername() string

GetUsername returns value of field Username

func (*AddOptions) GetVariant 

func (o *AddOptions) GetVariant() string

GetVariant returns value of field Variant

func (*AddOptions) ToParams 

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

ToParams formats struct fields to be passed to API service

func (*AddOptions) WithAll 

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

WithAll set field All to given value

func (*AddOptions) WithAnnotation 

func (o *AddOptions) WithAnnotation(value map[string]string) *AddOptions

WithAnnotation set field Annotation to given value

func (*AddOptions) WithArch 

func (o *AddOptions) WithArch(value string) *AddOptions

WithArch set field Arch to given value

func (*AddOptions) WithAuthfile added in v4.1.0 

func (o *AddOptions) WithAuthfile(value string) *AddOptions

WithAuthfile set field Authfile to given value

func (*AddOptions) WithFeatures 

func (o *AddOptions) WithFeatures(value []string) *AddOptions

WithFeatures set field Features to given value

func (*AddOptions) WithImages 

func (o *AddOptions) WithImages(value []string) *AddOptions

WithImages set field Images to given value

func (*AddOptions) WithOS 

func (o *AddOptions) WithOS(value string) *AddOptions

WithOS set field OS to given value

func (*AddOptions) WithOSVersion 

func (o *AddOptions) WithOSVersion(value string) *AddOptions

WithOSVersion set field OSVersion to given value

func (*AddOptions) WithPassword added in v4.1.0 

func (o *AddOptions) WithPassword(value string) *AddOptions

WithPassword set field Password to given value

func (*AddOptions) WithSkipTLSVerify added in v4.1.0 

func (o *AddOptions) WithSkipTLSVerify(value bool) *AddOptions

WithSkipTLSVerify set field SkipTLSVerify to given value

func (*AddOptions) WithUsername added in v4.1.0 

func (o *AddOptions) WithUsername(value string) *AddOptions

WithUsername set field Username to given value

func (*AddOptions) WithVariant 

func (o *AddOptions) WithVariant(value string) *AddOptions

WithVariant set field Variant to given value

type CreateOptions 

type CreateOptions struct {
	All   *bool
	Amend *bool
}

CreateOptions are optional options for creating manifests

func (*CreateOptions) Changed 

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

Changed returns true if named field has been set

func (*CreateOptions) GetAll 

func (o *CreateOptions) GetAll() bool

GetAll returns value of field All

func (*CreateOptions) GetAmend added in v4.3.0 

func (o *CreateOptions) GetAmend() bool

GetAmend returns value of field Amend

func (*CreateOptions) ToParams 

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

ToParams formats struct fields to be passed to API service

func (*CreateOptions) WithAll 

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

WithAll set field All to given value

func (*CreateOptions) WithAmend added in v4.3.0 

func (o *CreateOptions) WithAmend(value bool) *CreateOptions

WithAmend set field Amend to given value

type ExistsOptions 

type ExistsOptions struct {
}

ExistsOptions are optional options for checking if a manifest list exists

func (*ExistsOptions) Changed 

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

Changed returns true if named field has been set

func (*ExistsOptions) ToParams 

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

ToParams formats struct fields to be passed to API service

type InspectOptions 

type InspectOptions struct {
	// Authfile - path to an authentication file.
	Authfile *string
	// SkipTLSVerify - skip https and certificate validation when
	// contacting container registries.
	SkipTLSVerify *bool
}

InspectOptions are optional options for inspecting manifests

func (*InspectOptions) Changed 

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

Changed returns true if named field has been set

func (*InspectOptions) GetAuthfile added in v4.6.0 

func (o *InspectOptions) GetAuthfile() string

GetAuthfile returns value of field Authfile

func (*InspectOptions) GetSkipTLSVerify added in v4.4.0 

func (o *InspectOptions) GetSkipTLSVerify() bool

GetSkipTLSVerify returns value of field SkipTLSVerify

func (*InspectOptions) ToParams 

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

ToParams formats struct fields to be passed to API service

func (*InspectOptions) WithAuthfile added in v4.6.0 

func (o *InspectOptions) WithAuthfile(value string) *InspectOptions

WithAuthfile set field Authfile to given value

func (*InspectOptions) WithSkipTLSVerify added in v4.4.0 

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

WithSkipTLSVerify set field SkipTLSVerify to given value

type ModifyOptions 

type ModifyOptions struct {
	// Operation values are "update", "remove" and "annotate". This allows the service to
	//   efficiently perform each update on a manifest list.
	Operation   *string
	All         *bool             // All when true, operate on all images in a manifest list that may be included in Images
	Annotations map[string]string // Annotations to add to manifest list
	Arch        *string           // Arch overrides the architecture for the image
	Features    []string          // Feature list for the image
	Images      []string          // Images is an optional list of images to add/remove to/from manifest list depending on operation
	OS          *string           // OS overrides the operating system for the image
	// OS features for the image
	OSFeatures []string `json:"os_features" schema:"os_features"`
	// OSVersion overrides the operating system for the image
	OSVersion     *string `json:"os_version" schema:"os_version"`
	Variant       *string // Variant overrides the operating system variant for the image
	Authfile      *string
	Password      *string
	Username      *string
	SkipTLSVerify *bool `schema:"-"`
}

ModifyOptions are optional options for modifying manifest lists

func (*ModifyOptions) Changed 

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

Changed returns true if named field has been set

func (*ModifyOptions) GetAll 

func (o *ModifyOptions) GetAll() bool

GetAll returns value of all when true, operate on all images in a manifest list that may be included in Images

func (*ModifyOptions) GetAnnotations 

func (o *ModifyOptions) GetAnnotations() map[string]string

GetAnnotations returns value of annotations to add to manifest list

func (*ModifyOptions) GetArch 

func (o *ModifyOptions) GetArch() string

GetArch returns value of arch overrides the architecture for the image

func (*ModifyOptions) GetAuthfile added in v4.1.0 

func (o *ModifyOptions) GetAuthfile() string

GetAuthfile returns value of field Authfile

func (*ModifyOptions) GetFeatures 

func (o *ModifyOptions) GetFeatures() []string

GetFeatures returns value of feature list for the image

func (*ModifyOptions) GetImages 

func (o *ModifyOptions) GetImages() []string

GetImages returns value of images is an optional list of images to add/remove to/from manifest list depending on operation

func (*ModifyOptions) GetOS 

func (o *ModifyOptions) GetOS() string

GetOS returns value of oS overrides the operating system for the image

func (*ModifyOptions) GetOSFeatures 

func (o *ModifyOptions) GetOSFeatures() []string

GetOSFeatures returns value of field OSFeatures

func (*ModifyOptions) GetOSVersion 

func (o *ModifyOptions) GetOSVersion() string

GetOSVersion returns value of field OSVersion

func (*ModifyOptions) GetOperation 

func (o *ModifyOptions) GetOperation() string

GetOperation returns value of field Operation

func (*ModifyOptions) GetPassword added in v4.1.0 

func (o *ModifyOptions) GetPassword() string

GetPassword returns value of field Password

func (*ModifyOptions) GetSkipTLSVerify added in v4.1.0 

func (o *ModifyOptions) GetSkipTLSVerify() bool

GetSkipTLSVerify returns value of field SkipTLSVerify

func (*ModifyOptions) GetUsername added in v4.1.0 

func (o *ModifyOptions) GetUsername() string

GetUsername returns value of field Username

func (*ModifyOptions) GetVariant 

func (o *ModifyOptions) GetVariant() string

GetVariant returns value of variant overrides the operating system variant for the image

func (*ModifyOptions) ToParams 

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

ToParams formats struct fields to be passed to API service

func (*ModifyOptions) WithAll 

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

WithAll set all when true, operate on all images in a manifest list that may be included in Images

func (*ModifyOptions) WithAnnotations 

func (o *ModifyOptions) WithAnnotations(value map[string]string) *ModifyOptions

WithAnnotations set annotations to add to manifest list

func (*ModifyOptions) WithArch 

func (o *ModifyOptions) WithArch(value string) *ModifyOptions

WithArch set arch overrides the architecture for the image

func (*ModifyOptions) WithAuthfile added in v4.1.0 

func (o *ModifyOptions) WithAuthfile(value string) *ModifyOptions

WithAuthfile set field Authfile to given value

func (*ModifyOptions) WithFeatures 

func (o *ModifyOptions) WithFeatures(value []string) *ModifyOptions

WithFeatures set feature list for the image

func (*ModifyOptions) WithImages 

func (o *ModifyOptions) WithImages(value []string) *ModifyOptions

WithImages set images is an optional list of images to add/remove to/from manifest list depending on operation

func (*ModifyOptions) WithOS 

func (o *ModifyOptions) WithOS(value string) *ModifyOptions

WithOS set oS overrides the operating system for the image

func (*ModifyOptions) WithOSFeatures 

func (o *ModifyOptions) WithOSFeatures(value []string) *ModifyOptions

WithOSFeatures set field OSFeatures to given value

func (*ModifyOptions) WithOSVersion 

func (o *ModifyOptions) WithOSVersion(value string) *ModifyOptions

WithOSVersion set field OSVersion to given value

func (*ModifyOptions) WithOperation 

func (o *ModifyOptions) WithOperation(value string) *ModifyOptions

WithOperation set field Operation to given value

func (*ModifyOptions) WithPassword added in v4.1.0 

func (o *ModifyOptions) WithPassword(value string) *ModifyOptions

WithPassword set field Password to given value

func (*ModifyOptions) WithSkipTLSVerify added in v4.1.0 

func (o *ModifyOptions) WithSkipTLSVerify(value bool) *ModifyOptions

WithSkipTLSVerify set field SkipTLSVerify to given value

func (*ModifyOptions) WithUsername added in v4.1.0 

func (o *ModifyOptions) WithUsername(value string) *ModifyOptions

WithUsername set field Username to given value

func (*ModifyOptions) WithVariant 

func (o *ModifyOptions) WithVariant(value string) *ModifyOptions

WithVariant set variant overrides the operating system variant for the image

type RemoveOptions 

type RemoveOptions struct {
}

RemoveOptions are optional options for removing manifest lists

func (*RemoveOptions) Changed 

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

Changed returns true if named field has been set

func (*RemoveOptions) ToParams 

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

ToParams formats struct fields to be passed to API service

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.