github.com/rish1988/moby@v25.0.2+incompatible/api/types/image/opts.go (about)

     1  package image
     2  
     3  import "github.com/docker/docker/api/types/filters"
     4  
     5  // ImportOptions holds information to import images from the client host.
     6  type ImportOptions struct {
     7  	Tag      string   // Tag is the name to tag this image with. This attribute is deprecated.
     8  	Message  string   // Message is the message to tag the image with
     9  	Changes  []string // Changes are the raw changes to apply to this image
    10  	Platform string   // Platform is the target platform of the image
    11  }
    12  
    13  // CreateOptions holds information to create images.
    14  type CreateOptions struct {
    15  	RegistryAuth string // RegistryAuth is the base64 encoded credentials for the registry.
    16  	Platform     string // Platform is the target platform of the image if it needs to be pulled from the registry.
    17  }
    18  
    19  // PullOptions holds information to pull images.
    20  type PullOptions struct {
    21  	All          bool
    22  	RegistryAuth string // RegistryAuth is the base64 encoded credentials for the registry
    23  
    24  	// PrivilegeFunc is a function that clients can supply to retry operations
    25  	// after getting an authorization error. This function returns the registry
    26  	// authentication header value in base64 encoded format, or an error if the
    27  	// privilege request fails.
    28  	//
    29  	// Also see [github.com/docker/docker/api/types.RequestPrivilegeFunc].
    30  	PrivilegeFunc func() (string, error)
    31  	Platform      string
    32  }
    33  
    34  // PushOptions holds information to push images.
    35  type PushOptions PullOptions
    36  
    37  // ListOptions holds parameters to list images with.
    38  type ListOptions struct {
    39  	// All controls whether all images in the graph are filtered, or just
    40  	// the heads.
    41  	All bool
    42  
    43  	// Filters is a JSON-encoded set of filter arguments.
    44  	Filters filters.Args
    45  
    46  	// SharedSize indicates whether the shared size of images should be computed.
    47  	SharedSize bool
    48  
    49  	// ContainerCount indicates whether container count should be computed.
    50  	ContainerCount bool
    51  }
    52  
    53  // RemoveOptions holds parameters to remove images.
    54  type RemoveOptions struct {
    55  	Force         bool
    56  	PruneChildren bool
    57  }