dart_docker library

Classes

Address
ApiClient
ApiKeyAuth
AuthConfig
Authentication
BuildCache
BuildCacheTypeEnum
Cache record type.
BuildCacheTypeEnumTypeTransformer
Transformation class that can encode an instance of BuildCacheTypeEnum to String, and decode dynamic data back to BuildCacheTypeEnum.
BuildInfo
BuildPruneResponse
ChangeType
Kind of change Can be one of: - 0: Modified ("C") - 1: Added ("A") - 2: Deleted ("D")
ChangeTypeTypeTransformer
Transformation class that can encode an instance of ChangeType to int, and decode dynamic data back to ChangeType.
ClusterInfo
ClusterVolume
ClusterVolumeInfo
ClusterVolumePublishStatusInner
ClusterVolumePublishStatusInnerStateEnum
The published state of the volume. * pending-publish The volume should be published to this node, but the call to the controller plugin to do so has not yet been successfully completed. * published The volume is published successfully to the node. * pending-node-unpublish The volume should be unpublished from the node, and the manager is awaiting confirmation from the worker that it has done so. * pending-controller-unpublish The volume is successfully unpublished from the node, but has not yet been successfully unpublished on the controller.
ClusterVolumePublishStatusInnerStateEnumTypeTransformer
Transformation class that can encode an instance of ClusterVolumePublishStatusInnerStateEnum to String, and decode dynamic data back to ClusterVolumePublishStatusInnerStateEnum.
ClusterVolumeSpec
ClusterVolumeSpecAccessMode
ClusterVolumeSpecAccessModeAccessibilityRequirements
ClusterVolumeSpecAccessModeAvailabilityEnum
The availability of the volume for use in tasks. - active The volume is fully available for scheduling on the cluster - pause No new workloads should use the volume, but existing workloads are not stopped. - drain All workloads using this volume should be stopped and rescheduled, and no new ones should be started.
ClusterVolumeSpecAccessModeAvailabilityEnumTypeTransformer
Transformation class that can encode an instance of ClusterVolumeSpecAccessModeAvailabilityEnum to String, and decode dynamic data back to ClusterVolumeSpecAccessModeAvailabilityEnum.
ClusterVolumeSpecAccessModeCapacityRange
ClusterVolumeSpecAccessModeScopeEnum
The set of nodes this volume can be used on at one time. - single The volume may only be scheduled to one node at a time. - multi the volume may be scheduled to any supported number of nodes at a time.
ClusterVolumeSpecAccessModeScopeEnumTypeTransformer
Transformation class that can encode an instance of ClusterVolumeSpecAccessModeScopeEnum to String, and decode dynamic data back to ClusterVolumeSpecAccessModeScopeEnum.
ClusterVolumeSpecAccessModeSecretsInner
ClusterVolumeSpecAccessModeSharingEnum
The number and way that different tasks can use this volume at one time. - none The volume may only be used by one task at a time. - readonly The volume may be used by any number of tasks, but they all must mount the volume as readonly - onewriter The volume may be used by any number of tasks, but only one may mount it as read/write. - all The volume may have any number of readers and writers.
ClusterVolumeSpecAccessModeSharingEnumTypeTransformer
Transformation class that can encode an instance of ClusterVolumeSpecAccessModeSharingEnum to String, and decode dynamic data back to ClusterVolumeSpecAccessModeSharingEnum.
Commit
Config
ConfigApi
ConfigCreateRequest
ConfigSpec
ContainerApi
ContainerConfig
ContainerCreateRequest
ContainerCreateResponse
ContainerInspectResponse
ContainerPruneResponse
ContainerState
ContainerStateStatusEnum
String representation of the container state. Can be one of "created", "running", "paused", "restarting", "removing", "exited", or "dead".
ContainerStateStatusEnumTypeTransformer
Transformation class that can encode an instance of ContainerStateStatusEnum to String, and decode dynamic data back to ContainerStateStatusEnum.
ContainerStatus
ContainerSummary
ContainerSummaryHostConfig
ContainerSummaryNetworkSettings
ContainerTopResponse
ContainerUpdateRequest
ContainerUpdateResponse
ContainerWaitExitError
ContainerWaitResponse
CreateImageInfo
DeserializationMessage
Primarily intended for use in an isolate.
DeviceMapping
DeviceRequest
DistributionApi
DistributionInspect
DockerSocketClient
Driver
EndpointIPAMConfig
EndpointPortConfig
EndpointPortConfigProtocolEnum
EndpointPortConfigProtocolEnumTypeTransformer
Transformation class that can encode an instance of EndpointPortConfigProtocolEnum to String, and decode dynamic data back to EndpointPortConfigProtocolEnum.
EndpointPortConfigPublishModeEnum
The mode in which port is published.
EndpointPortConfigPublishModeEnumTypeTransformer
Transformation class that can encode an instance of EndpointPortConfigPublishModeEnum to String, and decode dynamic data back to EndpointPortConfigPublishModeEnum.
EndpointSettings
EndpointSpec
EndpointSpecModeEnum
The mode of resolution to use for internal load balancing between tasks.
EndpointSpecModeEnumTypeTransformer
Transformation class that can encode an instance of EndpointSpecModeEnum to String, and decode dynamic data back to EndpointSpecModeEnum.
EngineDescription
EngineDescriptionPluginsInner
ErrorDetail
ErrorResponse
EventActor
EventMessage
EventMessageScopeEnum
Scope of the event. Engine events are local scope. Cluster (Swarm) events are swarm scope.
EventMessageScopeEnumTypeTransformer
Transformation class that can encode an instance of EventMessageScopeEnum to String, and decode dynamic data back to EventMessageScopeEnum.
EventMessageTypeEnum
The type of object emitting the event
EventMessageTypeEnumTypeTransformer
Transformation class that can encode an instance of EventMessageTypeEnum to String, and decode dynamic data back to EventMessageTypeEnum.
ExecApi
ExecConfig
ExecInspectResponse
ExecStartConfig
FilesystemChange
GenericResourcesInner
GenericResourcesInnerDiscreteResourceSpec
GenericResourcesInnerNamedResourceSpec
GraphDriverData
Health
HealthcheckResult
HealthConfig
HealthStatusEnum
Status is one of none, starting, healthy or unhealthy - "none" Indicates there is no healthcheck - "starting" Starting indicates that the container is not yet ready - "healthy" Healthy indicates that the container is running correctly - "unhealthy" Unhealthy indicates that the container has a problem
HealthStatusEnumTypeTransformer
Transformation class that can encode an instance of HealthStatusEnum to String, and decode dynamic data back to HealthStatusEnum.
HistoryResponseItem
HostConfig
HostConfigAllOfLogConfig
HostConfigAllOfLogConfigTypeEnum
HostConfigAllOfLogConfigTypeEnumTypeTransformer
Transformation class that can encode an instance of HostConfigAllOfLogConfigTypeEnum to String, and decode dynamic data back to HostConfigAllOfLogConfigTypeEnum.
HostConfigCgroupnsModeEnum
cgroup namespace mode for the container. Possible values are: - \"private\": the container runs in its own private cgroup namespace - \"host\": use the host system's cgroup namespace If not specified, the daemon default is used, which can either be \"private\" or \"host\", depending on daemon version, kernel support and configuration.
HostConfigCgroupnsModeEnumTypeTransformer
Transformation class that can encode an instance of HostConfigCgroupnsModeEnum to String, and decode dynamic data back to HostConfigCgroupnsModeEnum.
HostConfigIsolationEnum
Isolation technology of the container. (Windows only)
HostConfigIsolationEnumTypeTransformer
Transformation class that can encode an instance of HostConfigIsolationEnum to String, and decode dynamic data back to HostConfigIsolationEnum.
HttpBasicAuth
HttpBearerAuth
IdResponse
ImageApi
ImageDeleteResponseItem
ImageID
ImageInspect
ImageInspectMetadata
ImageInspectRootFS
ImagePruneResponse
ImageSearchResponseItem
ImageSummary
IndexInfo
IPAM
IPAMConfig
JoinTokens
Limit
LocalNodeState
Current local status of this node.
LocalNodeStateTypeTransformer
Transformation class that can encode an instance of LocalNodeState to String, and decode dynamic data back to LocalNodeState.
ManagerStatus
Mount
MountBindOptions
MountBindOptionsPropagationEnum
A propagation mode with the value [r]private, [r]shared, or [r]slave.
MountBindOptionsPropagationEnumTypeTransformer
Transformation class that can encode an instance of MountBindOptionsPropagationEnum to String, and decode dynamic data back to MountBindOptionsPropagationEnum.
MountPoint
MountPointTypeEnum
The mount type: - bind a mount of a file or directory from the host into the container. - volume a docker volume with the given Name. - tmpfs a tmpfs. - npipe a named pipe from the host into the container. - cluster a Swarm cluster volume
MountPointTypeEnumTypeTransformer
Transformation class that can encode an instance of MountPointTypeEnum to String, and decode dynamic data back to MountPointTypeEnum.
MountTmpfsOptions
MountTypeEnum
The mount type. Available types: - bind Mounts a file or directory from the host into the container. Must exist prior to creating the container. - volume Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are not removed when the container is removed. - tmpfs Create a tmpfs with the given options. The mount source cannot be specified for tmpfs. - npipe Mounts a named pipe from the host into the container. Must exist prior to creating the container. - cluster a Swarm cluster volume
MountTypeEnumTypeTransformer
Transformation class that can encode an instance of MountTypeEnum to String, and decode dynamic data back to MountTypeEnum.
MountVolumeOptions
MountVolumeOptionsDriverConfig
Network
NetworkApi
NetworkAttachmentConfig
NetworkConnectRequest
NetworkContainer
NetworkCreateRequest
NetworkCreateResponse
NetworkDisconnectRequest
NetworkingConfig
NetworkPruneResponse
NetworkSettings
Node
NodeApi
NodeDescription
NodeSpec
NodeSpecAvailabilityEnum
Availability of the node.
NodeSpecAvailabilityEnumTypeTransformer
Transformation class that can encode an instance of NodeSpecAvailabilityEnum to String, and decode dynamic data back to NodeSpecAvailabilityEnum.
NodeSpecRoleEnum
Role of the node.
NodeSpecRoleEnumTypeTransformer
Transformation class that can encode an instance of NodeSpecRoleEnum to String, and decode dynamic data back to NodeSpecRoleEnum.
NodeState
NodeState represents the state of a node.
NodeStateTypeTransformer
Transformation class that can encode an instance of NodeState to String, and decode dynamic data back to NodeState.
NodeStatus
OAuth
ObjectVersion
OCIDescriptor
OCIPlatform
PeerNode
Platform
Plugin
PluginApi
PluginConfig
PluginConfigArgs
PluginConfigInterface
PluginConfigInterfaceProtocolSchemeEnum
Protocol to use for clients connecting to the plugin.
PluginConfigInterfaceProtocolSchemeEnumTypeTransformer
Transformation class that can encode an instance of PluginConfigInterfaceProtocolSchemeEnum to String, and decode dynamic data back to PluginConfigInterfaceProtocolSchemeEnum.
PluginConfigLinux
PluginConfigNetwork
PluginConfigRootfs
PluginConfigUser
PluginDevice
PluginEnv
PluginInterfaceType
PluginMount
PluginPrivilege
PluginSettings
PluginsInfo
Port
PortBinding
PortStatus
PortTypeEnum
PortTypeEnumTypeTransformer
Transformation class that can encode an instance of PortTypeEnum to String, and decode dynamic data back to PortTypeEnum.
ProcessConfig
ProgressDetail
PushImageInfo
QueryParam
Reachability
Reachability represents the reachability of a node.
ReachabilityTypeTransformer
Transformation class that can encode an instance of Reachability to String, and decode dynamic data back to Reachability.
RegistryServiceConfig
ResourceObject
Resources
ResourcesBlkioWeightDeviceInner
ResourcesUlimitsInner
RestartPolicy
RestartPolicyNameEnum
  • Empty string means not to restart - no Do not automatically restart - always Always restart - unless-stopped Restart always except when the user has manually stopped the container - on-failure Restart only when the container exit code is non-zero
    • RestartPolicyNameEnumTypeTransformer
    Transformation class that can encode an instance of RestartPolicyNameEnum to String, and decode dynamic data back to RestartPolicyNameEnum.
    Runtime
    Secret
    SecretApi
    SecretCreateRequest
    SecretSpec
    Service
    ServiceApi
    ServiceCreateRequest
    ServiceCreateResponse
    ServiceEndpoint
    ServiceEndpointVirtualIPsInner
    ServiceJobStatus
    ServiceServiceStatus
    ServiceSpec
    ServiceSpecMode
    ServiceSpecModeReplicated
    ServiceSpecModeReplicatedJob
    ServiceSpecRollbackConfig
    ServiceSpecRollbackConfigFailureActionEnum
    Action to take if an rolled back task fails to run, or stops running during the rollback.
    ServiceSpecRollbackConfigFailureActionEnumTypeTransformer
    Transformation class that can encode an instance of ServiceSpecRollbackConfigFailureActionEnum to String, and decode dynamic data back to ServiceSpecRollbackConfigFailureActionEnum.
    ServiceSpecRollbackConfigOrderEnum
    The order of operations when rolling back a task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down.
    ServiceSpecRollbackConfigOrderEnumTypeTransformer
    Transformation class that can encode an instance of ServiceSpecRollbackConfigOrderEnum to String, and decode dynamic data back to ServiceSpecRollbackConfigOrderEnum.
    ServiceSpecUpdateConfig
    ServiceSpecUpdateConfigFailureActionEnum
    Action to take if an updated task fails to run, or stops running during the update.
    ServiceSpecUpdateConfigFailureActionEnumTypeTransformer
    Transformation class that can encode an instance of ServiceSpecUpdateConfigFailureActionEnum to String, and decode dynamic data back to ServiceSpecUpdateConfigFailureActionEnum.
    ServiceSpecUpdateConfigOrderEnum
    The order of operations when rolling out an updated task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down.
    ServiceSpecUpdateConfigOrderEnumTypeTransformer
    Transformation class that can encode an instance of ServiceSpecUpdateConfigOrderEnum to String, and decode dynamic data back to ServiceSpecUpdateConfigOrderEnum.
    ServiceUpdateRequest
    ServiceUpdateResponse
    ServiceUpdateStatus
    ServiceUpdateStatusStateEnum
    ServiceUpdateStatusStateEnumTypeTransformer
    Transformation class that can encode an instance of ServiceUpdateStatusStateEnum to String, and decode dynamic data back to ServiceUpdateStatusStateEnum.
    SessionApi
    Swarm
    SwarmApi
    SwarmInfo
    SwarmInitRequest
    SwarmJoinRequest
    SwarmSpec
    SwarmSpecCAConfig
    SwarmSpecCAConfigExternalCAsInner
    SwarmSpecCAConfigExternalCAsInnerProtocolEnum
    Protocol for communication with the external CA (currently only cfssl is supported).
    SwarmSpecCAConfigExternalCAsInnerProtocolEnumTypeTransformer
    Transformation class that can encode an instance of SwarmSpecCAConfigExternalCAsInnerProtocolEnum to String, and decode dynamic data back to SwarmSpecCAConfigExternalCAsInnerProtocolEnum.
    SwarmSpecDispatcher
    SwarmSpecEncryptionConfig
    SwarmSpecOrchestration
    SwarmSpecRaft
    SwarmSpecTaskDefaults
    SwarmSpecTaskDefaultsLogDriver
    SwarmUnlockRequest
    SystemApi
    SystemAuthResponse
    SystemDataUsageResponse
    SystemInfo
    SystemInfoCgroupDriverEnum
    The driver to use for managing cgroups.
    SystemInfoCgroupDriverEnumTypeTransformer
    Transformation class that can encode an instance of SystemInfoCgroupDriverEnum to String, and decode dynamic data back to SystemInfoCgroupDriverEnum.
    SystemInfoCgroupVersionEnum
    The version of the cgroup.
    SystemInfoCgroupVersionEnumTypeTransformer
    Transformation class that can encode an instance of SystemInfoCgroupVersionEnum to String, and decode dynamic data back to SystemInfoCgroupVersionEnum.
    SystemInfoDefaultAddressPoolsInner
    SystemInfoIsolationEnum
    Represents the isolation technology to use as a default for containers. The supported values are platform-specific. If no isolation value is specified on daemon start, on Windows client, the default is hyperv, and on Windows server, the default is process. This option is currently not used on other platforms.
    SystemInfoIsolationEnumTypeTransformer
    Transformation class that can encode an instance of SystemInfoIsolationEnum to String, and decode dynamic data back to SystemInfoIsolationEnum.
    SystemVersion
    SystemVersionComponentsInner
    SystemVersionPlatform
    Task
    TaskApi
    TaskSpec
    TaskSpecContainerSpec
    TaskSpecContainerSpecConfigsInner
    TaskSpecContainerSpecConfigsInnerFile
    TaskSpecContainerSpecDNSConfig
    TaskSpecContainerSpecIsolationEnum
    Isolation technology of the containers running the service. (Windows only)
    TaskSpecContainerSpecIsolationEnumTypeTransformer
    Transformation class that can encode an instance of TaskSpecContainerSpecIsolationEnum to String, and decode dynamic data back to TaskSpecContainerSpecIsolationEnum.
    TaskSpecContainerSpecPrivileges
    TaskSpecContainerSpecPrivilegesAppArmor
    TaskSpecContainerSpecPrivilegesAppArmorModeEnum
    TaskSpecContainerSpecPrivilegesAppArmorModeEnumTypeTransformer
    Transformation class that can encode an instance of TaskSpecContainerSpecPrivilegesAppArmorModeEnum to String, and decode dynamic data back to TaskSpecContainerSpecPrivilegesAppArmorModeEnum.
    TaskSpecContainerSpecPrivilegesCredentialSpec
    TaskSpecContainerSpecPrivilegesSeccomp
    TaskSpecContainerSpecPrivilegesSeccompModeEnum
    TaskSpecContainerSpecPrivilegesSeccompModeEnumTypeTransformer
    Transformation class that can encode an instance of TaskSpecContainerSpecPrivilegesSeccompModeEnum to String, and decode dynamic data back to TaskSpecContainerSpecPrivilegesSeccompModeEnum.
    TaskSpecContainerSpecPrivilegesSELinuxContext
    TaskSpecContainerSpecSecretsInner
    TaskSpecContainerSpecSecretsInnerFile
    TaskSpecLogDriver
    TaskSpecNetworkAttachmentSpec
    TaskSpecPlacement
    TaskSpecPlacementPreferencesInner
    TaskSpecPlacementPreferencesInnerSpread
    TaskSpecPluginSpec
    TaskSpecResources
    TaskSpecRestartPolicy
    TaskSpecRestartPolicyConditionEnum
    Condition for restart.
    TaskSpecRestartPolicyConditionEnumTypeTransformer
    Transformation class that can encode an instance of TaskSpecRestartPolicyConditionEnum to String, and decode dynamic data back to TaskSpecRestartPolicyConditionEnum.
    TaskState
    TaskStateTypeTransformer
    Transformation class that can encode an instance of TaskState to String, and decode dynamic data back to TaskState.
    TaskStatus
    ThrottleDevice
    TLSInfo
    UnlockKeyResponse
    Volume
    VolumeApi
    VolumeCreateOptions
    VolumeListResponse
    VolumePruneResponse
    VolumeScopeEnum
    The level at which the volume exists. Either global for cluster-wide, or local for machine level.
    VolumeScopeEnumTypeTransformer
    Transformation class that can encode an instance of VolumeScopeEnum to String, and decode dynamic data back to VolumeScopeEnum.
    VolumeUpdateRequest
    VolumeUsageData

    Properties

    defaultApiClient ↔ ApiClient
    An ApiClient instance that uses the default values obtained from the OpenAPI specification file.
    getter/setter pair

    Functions

    decodeAsync(DeserializationMessage message) → Future
    Primarily intended for use in an isolate.
    deserializeAsync(DeserializationMessage message) → Future
    Primarily intended for use in an isolate.
    mapCastOfType<K, V>(dynamic map, String key) → Map<K, V>?
    Returns a valid Map<K, V> found at the specified Map key, null otherwise.
    mapDateTime(dynamic map, String key, [String? pattern]) → DateTime?
    Returns a valid DateTime found at the specified Map key, null otherwise.
    mapValueOfType<T>(dynamic map, String key) → T?
    Returns a valid T value found at the specified Map key, null otherwise.
    parameterToString(dynamic value) → String
    Format the given parameter object into a String.
    serializeAsync(Object? value) → Future<String>
    Primarily intended for use in an isolate.

    Typedefs

    HttpBearerAuthProvider = String Function()

    Exceptions / Errors

    ApiException