client: create option-structs for all client-methods

Various methods of the client do not use an options-struct; this means that
adding, removing, or changing an argument results in a breaking change in
the function's signature.

While first steps are made towards using functional options, we should take
the intermediate step of creating option-structs for all methods; option-
structs allow adding new fields without breaking backward compatibility.

This effort won't be a waste of effort if we move to functional options, as
the option structs can be reused as part of that implementation.

Example:

Taking a random example of a client function that needs updating; the
client.ContainersPrune method accepts a single filters.Args option
as argument:

ContainersPrune(ctx context.Context, pruneFilters filters.Args) (container.PruneReport, error)

We should change this to use a struct containing the current option(s), similar
to (e.g.) client.NetworkListOptions;

// NetworkListOptions holds parameters to filter the list of networks with.
type NetworkListOptions struct {
	Filters filters.Args
}

While it may currently be overkill for a single option, it will allow expanding
options, or deprecating options without breaking compatibility (we should still
try to get rid of the filters options though, but that's separate topic)

Checklist

• checkpoint_create.go
  • CheckpointCreate(ctx context.Context, containerID string, options CheckpointCreateOptions) error
• checkpoint_delete.go
  • CheckpointDelete(ctx context.Context, containerID string, options CheckpointDeleteOptions) error
• checkpoint_list.go
  • CheckpointList(ctx context.Context, container string, options CheckpointListOptions) ([]checkpoint.Summary, error) client/checkpoint_list: Wrap result in a struct #51050
• build_cancel.go
  • BuildCancel(ctx context.Context, id string) error client/build_*: Add options struct, wrap result #51076
• build_prune.go
  • BuildCachePrune(ctx context.Context, opts BuildCachePruneOptions) (*build.CachePruneReport, error) client/build_*: Add options struct, wrap result #51076
• config_create.go
  • ConfigCreate(ctx context.Context, config swarm.ConfigSpec) (swarm.ConfigCreateResponse, error) client/config: Wrap results and options #51078
• config_inspect.go
  • ConfigInspectWithRaw(ctx context.Context, id string) (swarm.Config, []byte, error) client/config: Wrap results and options #51078
• config_list.go
  • ConfigList(ctx context.Context, options ConfigListOptions) ([]swarm.Config, error) client/config: Wrap results and options #51078
• config_remove.go
  • ConfigRemove(ctx context.Context, id string) error client/config: Wrap results and options #51078
• config_update.go
  • ConfigUpdate(ctx context.Context, id string, version swarm.Version, config swarm.ConfigSpec) error client/config: Wrap results and options #51078
• container_attach.go
  • ContainerAttach(ctx context.Context, containerID string, options ContainerAttachOptions) (HijackedResponse, error) client_(attach,commit,create,diff): Wrap result and options #51278
• container_commit.go
  • ContainerCommit(ctx context.Context, containerID string, options ContainerCommitOptions) (container.CommitResponse, error) client_(attach,commit,create,diff): Wrap result and options #51278
• container_copy.go
  • ContainerStatPath(ctx context.Context, containerID, path string) (container.PathStat, error) client/container_copy: Wrap options and result struct #51328
  • CopyToContainer(ctx context.Context, containerID, dstPath string, content io.Reader, options CopyToContainerOptions) error client/container_copy: Wrap options and result struct #51328
  • CopyFromContainer(ctx context.Context, containerID, srcPath string) (io.ReadCloser, container.PathStat, error) client/container_copy: Wrap options and result struct #51328
• container_create.go
  • ContainerCreate(ctx context.Context, config *container.Config, hostConfig *container.HostConfig, networkingConfig *network.NetworkingConfig, platform *ocispec.Platform, containerName string) (container.CreateResponse, error) client_(attach,commit,create,diff): Wrap result and options #51278
• container_diff.go
  • ContainerDiff(ctx context.Context, containerID string) ([]container.FilesystemChange, error) client_(attach,commit,create,diff): Wrap result and options #51278
• container_exec.go
  • ContainerExecCreate(ctx context.Context, containerID string, options ExecCreateOptions) (container.ExecCreateResponse, error) github.com/client/container_exec: Wrap options and result #51262
  • ContainerExecStart(ctx context.Context, execID string, config ExecStartOptions) error github.com/client/container_exec: Wrap options and result #51262
  • ContainerExecAttach(ctx context.Context, execID string, config ExecAttachOptions) (HijackedResponse, error) github.com/client/container_exec: Wrap options and result #51262
  • ContainerExecInspect(ctx context.Context, execID string) (ExecInspect, error) github.com/client/container_exec: Wrap options and result #51262
• container_export.go @austinvazquez - client: refactor ContainerExport to wrap options/result structs #51316
  • ContainerExport(ctx context.Context, containerID string) (io.ReadCloser, error)
• container_inspect.go client: merge ContainerInspectWithRaw with ContainerInspect #51290
  • ContainerInspect(ctx context.Context, containerID string) (container.InspectResponse, error)
  • ContainerInspectWithRaw(ctx context.Context, containerID string, getSize bool) (container.InspectResponse, []byte, error)
• container_kill.go
  • ContainerKill(ctx context.Context, containerID, signal string) error client: add option and output structs for various container methods #51308
• container_list.go @austinvazquez - client: refactor ContainerList to wrap result #51314
  • ContainerList(ctx context.Context, options ContainerListOptions) ([]container.Summary, error)
• container_logs.go @austinvazquez - client: refactor ContainerLogs to wrap result #51317
  • ContainerLogs(ctx context.Context, containerID string, options ContainerLogsOptions) (io.ReadCloser, error)
• container_pause.go
  • ContainerPause(ctx context.Context, containerID string) error client: add option and output structs for various container methods #51308
• container_prune.go
  • ContainersPrune(ctx context.Context, pruneFilters filters.Args) (container.PruneReport, error) client: rewrite prune functions to use option structs and result #51200
• container_remove.go
  • ContainerRemove(ctx context.Context, containerID string, options ContainerRemoveOptions) error client: add option and output structs for various container methods #51308
• container_rename.go @austinvazquez - client: refactor ContainerRename to wrap options/result structs #51315
  • ContainerRename(ctx context.Context, containerID, newContainerName string) error
• container_resize.go
  • ContainerResize(ctx context.Context, containerID string, options ContainerResizeOptions) error client: add option and output structs for various container methods #51308
  • ContainerExecResize(ctx context.Context, execID string, options ContainerResizeOptions) error github.com/client/container_exec: Wrap options and result #51262
• container_restart.go
  • ContainerRestart(ctx context.Context, containerID string, options ContainerStopOptions) error client: add option and output structs for various container methods #51308
• container_start.go
  • ContainerStart(ctx context.Context, containerID string, options ContainerStartOptions) error client: add option and output structs for various container methods #51308
• container_stats.go client: ContainerStats: add option, output-structs, remove ContainerStatsOneShot #51293
  • ContainerStats(ctx context.Context, containerID string, stream bool) (StatsResponseReader, error)
  • ContainerStatsOneShot(ctx context.Context, containerID string) (StatsResponseReader, error)
• container_stop.go
  • ContainerStop(ctx context.Context, containerID string, options ContainerStopOptions) error client: add option and output structs for various container methods #51308
• container_top.go @austinvazquez - client: refactor ContainerTop to wrap options and results #51313
  • ContainerTop(ctx context.Context, containerID string, arguments []string) (container.TopResponse, error)
• container_unpause.go
  • ContainerUnpause(ctx context.Context, containerID string) error client: add option and output structs for various container methods #51308
• container_update.go
  • ContainerUpdate(ctx context.Context, containerID string, updateConfig container.UpdateConfig) (container.UpdateResponse, error) client/container_update: Wrap options and result #51326
• container_wait.go @austinvazquez - client: refactor ContainerWait to use client defined options/results structs #51312
  • ContainerWait(ctx context.Context, containerID string, condition container.WaitCondition) (<-chan container.WaitResponse, <-chan error)
• distribution_inspect.go
  • DistributionInspect(ctx context.Context, imageRef, encodedRegistryAuth string) (registry.DistributionInspect, error) client/distribution_inspect: Wrap options and result #51264
• image_build.go
  • ImageBuild(ctx context.Context, buildContext io.Reader, options ImageBuildOptions) (ImageBuildResponse, error) client/image: Wrap result and options in structs #51227
• image_create.go
  • ImageCreate(ctx context.Context, parentReference string, options ImageCreateOptions) (io.ReadCloser, error) client/image: Wrap result and options in structs #51227
• image_history.go
  • ImageHistory(ctx context.Context, imageID string, historyOpts ...ImageHistoryOption) ([]image.HistoryResponseItem, error) client/image_(inspect,history,load,save): Wrap return values #51236
• image_import.go
  • ImageImport(ctx context.Context, source ImageImportSource, ref string, options ImageImportOptions) (io.ReadCloser, error) client/image: Wrap result and options in structs #51227
• image_inspect.go
  • ImageInspect(ctx context.Context, imageID string, inspectOpts ...ImageInspectOption) (image.InspectResponse, error) client/image_(inspect,history,load,save): Wrap return values #51236
• image_list.go
  • ImageList(ctx context.Context, options ImageListOptions) ([]image.Summary, error) client/image: Wrap result and options in structs #51227
• image_load.go
  • ImageLoad(ctx context.Context, input io.Reader, loadOpts ...ImageLoadOption) (LoadResponse, error) client/image_(inspect,history,load,save): Wrap return values #51236
• image_prune.go
  • ImagesPrune(ctx context.Context, pruneFilters filters.Args) (image.PruneReport, error) client: rewrite prune functions to use option structs and result #51200
• image_pull.go
  • ImagePull(ctx context.Context, refStr string, options ImagePullOptions) (io.ReadCloser, error) introduce ImagePullResponse with helper method to manage JSONMessage stream decoding #50935
• image_push.go
  • ImagePush(ctx context.Context, image string, options ImagePushOptions) (io.ReadCloser, error) introduce ImagePushResponse #51148
• image_remove.go
  • ImageRemove(ctx context.Context, imageID string, options ImageRemoveOptions) ([]image.DeleteResponse, error) client/image: Wrap result and options in structs #51227
• image_save.go
  • ImageSave(ctx context.Context, imageIDs []string, saveOpts ...ImageSaveOption) (io.ReadCloser, error) client/image_(inspect,history,load,save): Wrap return values #51236
• image_search.go
  • ImageSearch(ctx context.Context, term string, options ImageSearchOptions) ([]registry.SearchResult, error) client/image: Wrap result and options in structs #51227
• image_tag.go
  • ImageTag(ctx context.Context, source, target string) error client/image: Wrap result and options in structs #51227
• login.go - @austinvazquez client: refactor Events, Info, RegistryLogin #51320
  • RegistryLogin(ctx context.Context, auth registry.AuthConfig) (registry.AuthenticateOKBody, error)
• network_connect.go @austinvazquez - client: refactor NetworkConnect, NetworkDisconnect, NetworkRemove #51325
  • NetworkConnect(ctx context.Context, networkID, containerID string, config *network.EndpointSettings) error
• network_create.go @austinvazquez - client: refactor create network api implementation to define options/result struct #51269
  • NetworkCreate(ctx context.Context, name string, options NetworkCreateOptions) (network.CreateResponse, error)
• network_disconnect.go @austinvazquez - client: refactor NetworkConnect, NetworkDisconnect, NetworkRemove #51325
  • NetworkDisconnect(ctx context.Context, networkID, containerID string, force bool) error
• network_inspect.go client: NetworkInspect, NetworkList: wrap output structs, and remove NetworkInspectWithRaw #51245
  • NetworkInspect(ctx context.Context, networkID string, options NetworkInspectOptions) (network.Inspect, error)
  • NetworkInspectWithRaw(ctx context.Context, networkID string, options NetworkInspectOptions) (network.Inspect, []byte, error)
• network_list.go client: NetworkInspect, NetworkList: wrap output structs, and remove NetworkInspectWithRaw #51245
  • NetworkList(ctx context.Context, options NetworkListOptions) ([]network.Summary, error)
• network_prune.go
  • NetworksPrune(ctx context.Context, pruneFilters filters.Args) (network.PruneReport, error) client: rewrite prune functions to use option structs and result #51200
• network_remove.go @austinvazquez - client: refactor NetworkConnect, NetworkDisconnect, NetworkRemove #51325
  • NetworkRemove(ctx context.Context, networkID string) error
• node_inspect.go
  • NodeInspectWithRaw(ctx context.Context, nodeID string) (swarm.Node, []byte, error) client/node: Wrap options and output #51260
• node_list.go
  • NodeList(ctx context.Context, options NodeListOptions) ([]swarm.Node, error) client/node: Wrap options and output #51260
• node_remove.go
  • NodeRemove(ctx context.Context, nodeID string, options NodeRemoveOptions) error client/node: Wrap options and output #51260
• node_update.go
  • NodeUpdate(ctx context.Context, nodeID string, version swarm.Version, node swarm.NodeSpec) error client/node: Wrap options and output #51260
• ping.go - api/types: move Ping and swarm.Status to client #51258
  • Ping(ctx context.Context) (types.Ping, error)
• plugin_create.go @austinvazquez - client: refactor plugin api client functions to define options/result… #51256
  • PluginCreate(ctx context.Context, createContext io.Reader, createOptions PluginCreateOptions) error
• plugin_disable.go @austinvazquez - client: refactor plugin api client functions to define options/result… #51256
  • PluginDisable(ctx context.Context, name string, options PluginDisableOptions) error
• plugin_enable.go @austinvazquez - client: refactor plugin api client functions to define options/result… #51256
  • PluginEnable(ctx context.Context, name string, options PluginEnableOptions) error
• plugin_inspect.go client: PluginInspectWithRaw: refactor and rename to PluginInspect #51254
  • PluginInspectWithRaw(ctx context.Context, name string) (*plugin.Plugin, []byte, error)
• plugin_install.go @austinvazquez - client: refactor plugin api client functions to define options/result… #51256
  • PluginInstall(ctx context.Context, name string, options PluginInstallOptions) (_ io.ReadCloser, retErr error)
• plugin_list.go
  • PluginList(ctx context.Context, filter filters.Args) (plugin.ListResponse, error) client: Client.PluginList: add options-struct #51207
• plugin_push.go @austinvazquez - client: refactor plugin api client functions to define options/result… #51256
  • PluginPush(ctx context.Context, name string, registryAuth string) (io.ReadCloser, error)
• plugin_remove.go @austinvazquez - client: refactor plugin api client functions to define options/result… #51256
  • PluginRemove(ctx context.Context, name string, options PluginRemoveOptions) error
• plugin_set.go @austinvazquez - client: refactor plugin api client functions to define options/result… #51256
  • PluginSet(ctx context.Context, name string, args []string) error
• plugin_upgrade.go @austinvazquez - client: refactor plugin api client functions to define options/result… #51256
  • PluginUpgrade(ctx context.Context, name string, options PluginInstallOptions) (io.ReadCloser, error)
• secret_create.go client/secrets: Wrap results and options #51251
  • SecretCreate(ctx context.Context, secret swarm.SecretSpec) (swarm.SecretCreateResponse, error)
• secret_inspect.go client/secrets: Wrap results and options #51251
  • SecretInspectWithRaw(ctx context.Context, id string) (swarm.Secret, []byte, error)
• secret_list.go client/secrets: Wrap results and options #51251
  • SecretList(ctx context.Context, options SecretListOptions) ([]swarm.Secret, error)
• secret_remove.go client/secrets: Wrap results and options #51251
  • SecretRemove(ctx context.Context, id string) error
• secret_update.go client/secrets: Wrap results and options #51251
  • SecretUpdate(ctx context.Context, id string, version swarm.Version, secret swarm.SecretSpec) error
• service_create.go @austinvazquez - client: refactor service api client functions for defined options/res… #51252
  • ServiceCreate(ctx context.Context, service swarm.ServiceSpec, options ServiceCreateOptions) (swarm.ServiceCreateResponse, error)
• service_inspect.go @austinvazquez - client: refactor service api client functions for defined options/res… #51252
  • ServiceInspectWithRaw(ctx context.Context, serviceID string, opts ServiceInspectOptions) (swarm.Service, []byte, error)
• service_list.go @austinvazquez - client: refactor service api client functions for defined options/res… #51252, client: rename ServiceListResult.Services to ServiceListResult.Items #51273
  • ServiceList(ctx context.Context, options ServiceListOptions) ([]swarm.Service, error)
• service_logs.go @austinvazquez - client: refactor service api client functions for defined options/res… #51252
  • ServiceLogs(ctx context.Context, serviceID string, options ContainerLogsOptions) (io.ReadCloser, error)
• service_remove.go @austinvazquez - client: refactor service api client functions for defined options/res… #51252
  • ServiceRemove(ctx context.Context, serviceID string) error
• service_update.go @austinvazquez - client: refactor service api client functions for defined options/res… #51252
  • ServiceUpdate(ctx context.Context, serviceID string, version swarm.Version, service swarm.ServiceSpec, options ServiceUpdateOptions) (swarm.ServiceUpdateResponse, error)
• swarm_get_unlock_key.go @austinvazquez - client: refactor swarm api functions to wrap params/responses #51244
  • SwarmGetUnlockKey(ctx context.Context) (swarm.UnlockKeyResponse, error)
• swarm_init.go @austinvazquez - client: refactor swarm api functions to wrap params/responses #51244
  • SwarmInit(ctx context.Context, req swarm.InitRequest) (string, error)
• swarm_inspect.go @austinvazquez - client: refactor swarm api functions to wrap params/responses #51244
  • SwarmInspect(ctx context.Context) (swarm.Swarm, error)
• swarm_join.go @austinvazquez - client: refactor swarm api functions to wrap params/responses #51244
  • SwarmJoin(ctx context.Context, req swarm.JoinRequest) error
• swarm_leave.go @austinvazquez - client: refactor swarm api functions to wrap params/responses #51244
  • SwarmLeave(ctx context.Context, force bool) error
• swarm_unlock.go @austinvazquez - client: refactor swarm api functions to wrap params/responses #51244
  • SwarmUnlock(ctx context.Context, req swarm.UnlockRequest) error
• swarm_update.go @austinvazquez - client: refactor swarm api functions to wrap params/responses #51244
  • SwarmUpdate(ctx context.Context, version swarm.Version, swarm swarm.Spec, flags SwarmUpdateFlags) error
• system_disk_usage.go @austinvazquez - api/types/system: deprecate DiskUsage.* fields and add type specific fields #51235
  • DiskUsage(ctx context.Context, options DiskUsageOptions) (system.DiskUsage, error)
• system_events.go @austinvazquez - client: refactor Events, Info, RegistryLogin #51320
  • Events(ctx context.Context, options EventsListOptions) (<-chan events.Message, <-chan error)
• system_info.go @austinvazquez - client: refactor Events, Info, RegistryLogin #51320
  • Info(ctx context.Context) (system.Info, error)
• task_inspect.go @austinvazquez - client: refactor task responses #51234
  • TaskInspectWithRaw(ctx context.Context, taskID string) (swarm.Task, []byte, error)
• task_list.go @austinvazquez - client: refactor task responses #51234
  • TaskList(ctx context.Context, options TaskListOptions) ([]swarm.Task, error)
• task_logs.go @austinvazquez - client: refactor task responses #51234
  • TaskLogs(ctx context.Context, taskID string, options ContainerLogsOptions) (io.ReadCloser, error)
• version.go @austinvazquez - client: refactor ServerVersion to return ServerVersionResult #51233
  • ServerVersion(ctx context.Context) (types.Version, error)
• volume_create.go
  • VolumeCreate(ctx context.Context, options volume.CreateOptions) (volume.Volume, error) api/types/volume: move CreateOptions to client.VolumeCreateOptions #51211
• volume_inspect.go
  • VolumeInspect(ctx context.Context, volumeID string) (volume.Volume, error) client/volume: refactor volume options and responses #51210
  • VolumeInspectWithRaw(ctx context.Context, volumeID string) (volume.Volume, []byte, error) client/volume: refactor volume options and responses #51210 client: remove VolumeInspectWithRaw, merge with VolumeInspect #51247
• volume_list.go
  • VolumeList(ctx context.Context, options VolumeListOptions) (volume.ListResponse, error) client/volume: refactor volume options and responses #51210
• volume_prune.go
  • VolumesPrune(ctx context.Context, pruneFilters filters.Args) (volume.PruneReport, error) client: rewrite prune functions to use option structs and result #51200
• volume_remove.go
  • VolumeRemove(ctx context.Context, volumeID string, force bool) error client/volume: refactor volume options and responses #51210
• volume_update.go #51206
  • VolumeUpdate(ctx context.Context, volumeID string, version swarm.Version, options volume.UpdateOptions) error