Documentation
¶
Overview ¶
Package types catalogs github.com/docker/compose/v5/pkg/api for wrapping by containerkit.
Code generated by go run ./tools/gencatalog; DO NOT EDIT.
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api
Each identifier keeps the exact upstream type name. Domain isolation lives in the import path (internal/compose/api/types), not in renamed aliases.
Index ¶
- Constants
- type AttachOptions
- type BuildOptions
- type Cascade
- type CommitOptions
- type Compose
- type ConfigOptions
- type ContainerEvent
- type ContainerEventListener
- type ContainerProcSummary
- type ContainerSummary
- type ContextInfo
- type CopyOptions
- type CreateOptions
- type DownOptions
- type Event
- type EventProcessor
- type EventStatus
- type EventsOptions
- type ExportOptions
- type GenerateOptions
- type ImageSummary
- type ImagesOptions
- type KillOptions
- type ListOptions
- type LoadListener
- type LogConsumer
- type LogOptions
- type OCIOptions
- type OCIVersion
- type PauseOptions
- type PortOptions
- type PortPublisher
- type PortPublishers
- type ProjectLoadOptions
- type PsOptions
- type PublishOptions
- type PullOptions
- type PushOptions
- type RemoveOptions
- type Resource
- type RestartOptions
- type RunOptions
- type ScaleOptions
- type ServiceStatus
- type Stack
- type StartOptions
- type StopOptions
- type UnsupportedAttribute
- type UpOptions
- type VizOptions
- type VolumesOptions
- type VolumesSummary
- type WaitOptions
- type WatchOptions
Constants ¶
const ( Working = composeapi.Working Done = composeapi.Done Warning = composeapi.Warning Error = composeapi.Error StatusCreating = composeapi.StatusCreating StatusCreated = composeapi.StatusCreated )
Event status values from the Compose runtime. They are constants, so the generated type catalog does not carry them.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AttachOptions ¶
type AttachOptions = composeapi.AttachOptions
AttachOptions wraps api.AttachOptions.
AttachOptions group options of the Attach API ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#AttachOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct References: github.com/compose-spec/compose-go/v2/types.Project Usecase: wrap the Compose runtime SDK (AttachOptions) used to build/up/down/ps/logs a project.
type BuildOptions ¶
type BuildOptions = composeapi.BuildOptions
BuildOptions wraps api.BuildOptions.
BuildOptions group options of the Build API ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#BuildOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct References: github.com/compose-spec/compose-go/v2/types.MappingWithEquals, github.com/compose-spec/compose-go/v2/types.SSHKey, io.Writer Usecase: wrap the Compose runtime SDK (BuildOptions) used to build/up/down/ps/logs a project.
type Cascade ¶
type Cascade = composeapi.Cascade
Cascade wraps api.Cascade.
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#Cascade GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: named:int Underlying: int Usecase: wrap the Compose runtime SDK (Cascade) used to build/up/down/ps/logs a project.
type CommitOptions ¶
type CommitOptions = composeapi.CommitOptions
CommitOptions wraps api.CommitOptions.
CommitOptions group options of the Commit API ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#CommitOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct References: github.com/docker/cli/opts.ListOpts Usecase: wrap the Compose runtime SDK (CommitOptions) used to build/up/down/ps/logs a project.
type Compose ¶
type Compose = composeapi.Compose
Compose wraps api.Compose.
Compose is the API interface one can use to programmatically use docker/compose in a third-party software Use [compose.NewComposeService] to get an actual instance
Methods act on the whole *types.Project they receive: to scope an operation to a subset of services, narrow the project itself before calling — at load time through ProjectLoadOptions.Services, or with types.Project.WithSelectedServices. The Services fields found on some option structs are not filters: they mark the services the user explicitly named, and only drive side concerns (recreation policy, log scoping) as documented on each field.
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#Compose GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: interface References: context.Context, github.com/compose-spec/compose-go/v2/types.Project Usecase: wrap the Compose runtime SDK (Compose) used to build/up/down/ps/logs a project.
type ConfigOptions ¶
type ConfigOptions = composeapi.ConfigOptions
ConfigOptions wraps api.ConfigOptions.
ConfigOptions group options of the Config API ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#ConfigOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct Usecase: wrap the Compose runtime SDK (ConfigOptions) used to build/up/down/ps/logs a project.
type ContainerEvent ¶
type ContainerEvent = composeapi.ContainerEvent
ContainerEvent wraps api.ContainerEvent.
ContainerEvent notify an event has been collected on source container implementing Service ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#ContainerEvent GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct Usecase: wrap the Compose runtime SDK (ContainerEvent) used to build/up/down/ps/logs a project.
type ContainerEventListener ¶
type ContainerEventListener = composeapi.ContainerEventListener
ContainerEventListener wraps api.ContainerEventListener.
ContainerEventListener is a callback to process ContainerEvent from services ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#ContainerEventListener GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: func Underlying: func(event ContainerEvent) Usecase: wrap the Compose runtime SDK (ContainerEventListener) used to build/up/down/ps/logs a project.
type ContainerProcSummary ¶
type ContainerProcSummary = composeapi.ContainerProcSummary
ContainerProcSummary wraps api.ContainerProcSummary.
ContainerProcSummary holds container processes top data ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#ContainerProcSummary GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct Usecase: wrap the Compose runtime SDK (ContainerProcSummary) used to build/up/down/ps/logs a project.
type ContainerSummary ¶
type ContainerSummary = composeapi.ContainerSummary
ContainerSummary wraps api.ContainerSummary.
ContainerSummary hold high-level description of a container ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#ContainerSummary GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct References: github.com/moby/moby/api/types/container.ContainerState, github.com/moby/moby/api/types/container.HealthStatus Usecase: wrap the Compose runtime SDK (ContainerSummary) used to build/up/down/ps/logs a project.
type ContextInfo ¶
type ContextInfo = composeapi.ContextInfo
ContextInfo wraps api.ContextInfo.
ContextInfo provides Docker context information for advanced scenarios ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#ContextInfo GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/context.go Kind: interface Usecase: wrap the Compose runtime SDK (ContextInfo) used to build/up/down/ps/logs a project.
type CopyOptions ¶
type CopyOptions = composeapi.CopyOptions
CopyOptions wraps api.CopyOptions.
CopyOptions group options of the cp API ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#CopyOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct Usecase: wrap the Compose runtime SDK (CopyOptions) used to build/up/down/ps/logs a project.
type CreateOptions ¶
type CreateOptions = composeapi.CreateOptions
CreateOptions wraps api.CreateOptions.
CreateOptions group options of the Create API ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#CreateOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct References: time.Duration Usecase: wrap the Compose runtime SDK (CreateOptions) used to build/up/down/ps/logs a project.
type DownOptions ¶
type DownOptions = composeapi.DownOptions
DownOptions wraps api.DownOptions.
DownOptions group options of the Down API ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#DownOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct References: github.com/compose-spec/compose-go/v2/types.Project, time.Duration Usecase: wrap the Compose runtime SDK (DownOptions) used to build/up/down/ps/logs a project.
type Event ¶
type Event = composeapi.Event
Event wraps api.Event.
Event is a container runtime event served by Events API ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#Event GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct References: time.Time Usecase: wrap the Compose runtime SDK (Event) used to build/up/down/ps/logs a project.
type EventProcessor ¶
type EventProcessor = composeapi.EventProcessor
EventProcessor wraps api.EventProcessor.
EventProcessor is notified about Compose operations and tasks ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#EventProcessor GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/event.go Kind: interface References: context.Context Usecase: wrap the Compose runtime SDK (EventProcessor) used to build/up/down/ps/logs a project.
type EventStatus ¶
type EventStatus = composeapi.EventStatus
EventStatus wraps api.EventStatus.
EventStatus indicates the status of an action ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#EventStatus GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/event.go Kind: named:int Underlying: int Usecase: wrap the Compose runtime SDK (EventStatus) used to build/up/down/ps/logs a project.
type EventsOptions ¶
type EventsOptions = composeapi.EventsOptions
EventsOptions wraps api.EventsOptions.
EventsOptions group options of the Events API ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#EventsOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct Usecase: wrap the Compose runtime SDK (EventsOptions) used to build/up/down/ps/logs a project.
type ExportOptions ¶
type ExportOptions = composeapi.ExportOptions
ExportOptions wraps api.ExportOptions.
ExportOptions group options of the Export API ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#ExportOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct Usecase: wrap the Compose runtime SDK (ExportOptions) used to build/up/down/ps/logs a project.
type GenerateOptions ¶
type GenerateOptions = composeapi.GenerateOptions
GenerateOptions wraps api.GenerateOptions.
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#GenerateOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct Usecase: wrap the Compose runtime SDK (GenerateOptions) used to build/up/down/ps/logs a project.
type ImageSummary ¶
type ImageSummary = composeapi.ImageSummary
ImageSummary wraps api.ImageSummary.
ImageSummary holds container image description ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#ImageSummary GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct References: github.com/containerd/platforms.Platform, time.Time Usecase: wrap the Compose runtime SDK (ImageSummary) used to build/up/down/ps/logs a project.
type ImagesOptions ¶
type ImagesOptions = composeapi.ImagesOptions
ImagesOptions wraps api.ImagesOptions.
ImagesOptions group options of the Images API ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#ImagesOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct Usecase: wrap the Compose runtime SDK (ImagesOptions) used to build/up/down/ps/logs a project.
type KillOptions ¶
type KillOptions = composeapi.KillOptions
KillOptions wraps api.KillOptions.
KillOptions group options of the Kill API ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#KillOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct References: github.com/compose-spec/compose-go/v2/types.Project Usecase: wrap the Compose runtime SDK (KillOptions) used to build/up/down/ps/logs a project.
type ListOptions ¶
type ListOptions = composeapi.ListOptions
ListOptions wraps api.ListOptions.
ListOptions group options of the ls API ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#ListOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct Usecase: wrap the Compose runtime SDK (ListOptions) used to build/up/down/ps/logs a project.
type LoadListener ¶
type LoadListener = composeapi.LoadListener
LoadListener wraps api.LoadListener.
LoadListener receives events during project loading. Events include:
- "extends": when a service extends another (metadata: service info)
- "include": when including external compose files (metadata: {"path": StringList})
Multiple listeners can be registered, and all will be notified of events.
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#LoadListener GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: func Underlying: func(event string, metadata map[string]any) Usecase: wrap the Compose runtime SDK (LoadListener) used to build/up/down/ps/logs a project.
type LogConsumer ¶
type LogConsumer = composeapi.LogConsumer
LogConsumer wraps api.LogConsumer.
LogConsumer is a callback to process log messages from services ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#LogConsumer GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: interface Usecase: wrap the Compose runtime SDK (LogConsumer) used to build/up/down/ps/logs a project.
type LogOptions ¶
type LogOptions = composeapi.LogOptions
LogOptions wraps api.LogOptions.
LogOptions defines optional parameters for the `Log` API ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#LogOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct References: github.com/compose-spec/compose-go/v2/types.Project Usecase: wrap the Compose runtime SDK (LogOptions) used to build/up/down/ps/logs a project.
type OCIOptions ¶
type OCIOptions = composeapi.OCIOptions
OCIOptions wraps api.OCIOptions.
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#OCIOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct Usecase: wrap the Compose runtime SDK (OCIOptions) used to build/up/down/ps/logs a project.
type OCIVersion ¶
type OCIVersion = composeapi.OCIVersion
OCIVersion wraps api.OCIVersion.
OCIVersion controls manifest generation to ensure compatibility with different registries.
Currently, this is not exposed as an option to the user – Compose uses OCI 1.0 mode automatically for ECR registries based on domain and OCI 1.1 for all other registries.
There are likely other popular registries that do not support the OCI 1.1 format, so it might make sense to expose this as a CLI flag or see if there's a way to generically probe the registry for support level.
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#OCIVersion GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: named:string Underlying: string Usecase: wrap the Compose runtime SDK (OCIVersion) used to build/up/down/ps/logs a project.
type PauseOptions ¶
type PauseOptions = composeapi.PauseOptions
PauseOptions wraps api.PauseOptions.
PauseOptions group options of the Pause API ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#PauseOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct References: github.com/compose-spec/compose-go/v2/types.Project Usecase: wrap the Compose runtime SDK (PauseOptions) used to build/up/down/ps/logs a project.
type PortOptions ¶
type PortOptions = composeapi.PortOptions
PortOptions wraps api.PortOptions.
PortOptions group options of the Port API ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#PortOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct Usecase: wrap the Compose runtime SDK (PortOptions) used to build/up/down/ps/logs a project.
type PortPublisher ¶
type PortPublisher = composeapi.PortPublisher
PortPublisher wraps api.PortPublisher.
PortPublisher hold status about published port ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#PortPublisher GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct Usecase: wrap the Compose runtime SDK (PortPublisher) used to build/up/down/ps/logs a project.
type PortPublishers ¶
type PortPublishers = composeapi.PortPublishers
PortPublishers wraps api.PortPublishers.
PortPublishers is a slice of PortPublisher ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#PortPublishers GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: slice Underlying: []PortPublisher Usecase: wrap the Compose runtime SDK (PortPublishers) used to build/up/down/ps/logs a project.
type ProjectLoadOptions ¶
type ProjectLoadOptions = composeapi.ProjectLoadOptions
ProjectLoadOptions wraps api.ProjectLoadOptions.
ProjectLoadOptions configures how a Compose project should be loaded ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#ProjectLoadOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct References: github.com/compose-spec/compose-go/v2/cli.ProjectOptionsFn Usecase: wrap the Compose runtime SDK (ProjectLoadOptions) used to build/up/down/ps/logs a project.
type PsOptions ¶
type PsOptions = composeapi.PsOptions
PsOptions wraps api.PsOptions.
PsOptions group options of the Ps API ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#PsOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct References: github.com/compose-spec/compose-go/v2/types.Project Usecase: wrap the Compose runtime SDK (PsOptions) used to build/up/down/ps/logs a project.
type PublishOptions ¶
type PublishOptions = composeapi.PublishOptions
PublishOptions wraps api.PublishOptions.
PublishOptions group options of the Publish API ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#PublishOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct Usecase: wrap the Compose runtime SDK (PublishOptions) used to build/up/down/ps/logs a project.
type PullOptions ¶
type PullOptions = composeapi.PullOptions
PullOptions wraps api.PullOptions.
PullOptions group options of the Pull API ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#PullOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct Usecase: wrap the Compose runtime SDK (PullOptions) used to build/up/down/ps/logs a project.
type PushOptions ¶
type PushOptions = composeapi.PushOptions
PushOptions wraps api.PushOptions.
PushOptions group options of the Push API ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#PushOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct Usecase: wrap the Compose runtime SDK (PushOptions) used to build/up/down/ps/logs a project.
type RemoveOptions ¶
type RemoveOptions = composeapi.RemoveOptions
RemoveOptions wraps api.RemoveOptions.
RemoveOptions group options of the Remove API ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#RemoveOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct References: github.com/compose-spec/compose-go/v2/types.Project Usecase: wrap the Compose runtime SDK (RemoveOptions) used to build/up/down/ps/logs a project.
type Resource ¶
type Resource = composeapi.Resource
Resource wraps api.Resource.
Resource represents status change and progress for a compose resource.
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#Resource GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/event.go Kind: struct Usecase: wrap the Compose runtime SDK (Resource) used to build/up/down/ps/logs a project.
type RestartOptions ¶
type RestartOptions = composeapi.RestartOptions
RestartOptions wraps api.RestartOptions.
RestartOptions group options of the Restart API ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#RestartOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct References: github.com/compose-spec/compose-go/v2/types.Project, time.Duration Usecase: wrap the Compose runtime SDK (RestartOptions) used to build/up/down/ps/logs a project.
type RunOptions ¶
type RunOptions = composeapi.RunOptions
RunOptions wraps api.RunOptions.
RunOptions group options of the Run API — and, for historical reasons, of the Exec API, which only honors the exec-relevant subset: Service, Index, Command, Environment, WorkingDir, User, Privileged, Interactive, Tty and Detach.
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#RunOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct References: github.com/compose-spec/compose-go/v2/types.Labels, github.com/compose-spec/compose-go/v2/types.Project Usecase: wrap the Compose runtime SDK (RunOptions) used to build/up/down/ps/logs a project.
type ScaleOptions ¶
type ScaleOptions = composeapi.ScaleOptions
ScaleOptions wraps api.ScaleOptions.
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#ScaleOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct Usecase: wrap the Compose runtime SDK (ScaleOptions) used to build/up/down/ps/logs a project.
type ServiceStatus ¶
type ServiceStatus = composeapi.ServiceStatus
ServiceStatus wraps api.ServiceStatus.
ServiceStatus hold status about a service ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#ServiceStatus GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct Usecase: wrap the Compose runtime SDK (ServiceStatus) used to build/up/down/ps/logs a project.
type Stack ¶
type Stack = composeapi.Stack
Stack wraps api.Stack.
Stack holds the name and state of a compose application/stack
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#Stack GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct Usecase: wrap the Compose runtime SDK (Stack) used to build/up/down/ps/logs a project.
type StartOptions ¶
type StartOptions = composeapi.StartOptions
StartOptions wraps api.StartOptions.
StartOptions group options of the Start API ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#StartOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct References: github.com/compose-spec/compose-go/v2/types.Project, time.Duration Usecase: wrap the Compose runtime SDK (StartOptions) used to build/up/down/ps/logs a project.
type StopOptions ¶
type StopOptions = composeapi.StopOptions
StopOptions wraps api.StopOptions.
StopOptions group options of the Stop API ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#StopOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct References: github.com/compose-spec/compose-go/v2/types.Project, time.Duration Usecase: wrap the Compose runtime SDK (StopOptions) used to build/up/down/ps/logs a project.
type UnsupportedAttribute ¶
type UnsupportedAttribute = composeapi.UnsupportedAttribute
UnsupportedAttribute wraps api.UnsupportedAttribute.
UnsupportedAttribute reports a compose-file attribute that is accepted by the schema but has no effect on this runtime outside Swarm mode.
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#UnsupportedAttribute GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct Usecase: wrap the Compose runtime SDK (UnsupportedAttribute) used to build/up/down/ps/logs a project.
type UpOptions ¶
type UpOptions = composeapi.UpOptions
UpOptions wraps api.UpOptions.
UpOptions group options of the Up API ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#UpOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct Usecase: wrap the Compose runtime SDK (UpOptions) used to build/up/down/ps/logs a project.
type VizOptions ¶
type VizOptions = composeapi.VizOptions
VizOptions wraps api.VizOptions.
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#VizOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct Usecase: wrap the Compose runtime SDK (VizOptions) used to build/up/down/ps/logs a project.
type VolumesOptions ¶
type VolumesOptions = composeapi.VolumesOptions
VolumesOptions wraps api.VolumesOptions.
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#VolumesOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct Usecase: wrap the Compose runtime SDK (VolumesOptions) used to build/up/down/ps/logs a project.
type VolumesSummary ¶
type VolumesSummary = composeapi.VolumesSummary
VolumesSummary wraps api.VolumesSummary.
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#VolumesSummary GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: named:volume.Volume Underlying: volume.Volume References: github.com/moby/moby/api/types/volume.Volume Usecase: wrap the Compose runtime SDK (VolumesSummary) used to build/up/down/ps/logs a project.
type WaitOptions ¶
type WaitOptions = composeapi.WaitOptions
WaitOptions wraps api.WaitOptions.
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#WaitOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct Usecase: wrap the Compose runtime SDK (WaitOptions) used to build/up/down/ps/logs a project.
type WatchOptions ¶
type WatchOptions = composeapi.WatchOptions
WatchOptions wraps api.WatchOptions.
WatchOptions group options of the Watch API ¶
Source: https://pkg.go.dev/github.com/docker/compose/v5/pkg/api#WatchOptions GitHub: https://github.com/docker/compose/blob/v5.6.1/pkg/api/api.go Kind: struct Usecase: wrap the Compose runtime SDK (WatchOptions) used to build/up/down/ps/logs a project.