ImageArgs class

The set of arguments for Image. The set of arguments for Image.

Constructors

ImageArgs({Input<List<String>>? addHosts, Input<Map<String, String>>? buildArgs, Input<bool>? buildOnPreview, Input<BuilderConfig>? builder, Input<List<CacheFrom>>? cacheFrom, Input<List<CacheTo>>? cacheTo, Input<BuildContext>? context, Input<Dockerfile>? dockerfile, Input<bool>? exec, Input<List<Export>>? exports, Input<List<String>>? ignoreSecretsInDiffCalculation, Input<Map<String, String>>? labels, Input<bool>? load, Input<NetworkMode>? network, Input<bool>? noCache, Input<List<Platform>>? platforms, Input<bool>? pull, required Input<bool> push, Input<List<Registry>>? registries, Input<Map<String, String>>? secrets, Input<List<SSH>>? ssh, Input<List<String>>? tags, Input<String>? target})
Creates a new ImageArgs. addHosts Custom host:ip mappings to use during the build. buildArgs ARG names and values to set during the build. buildOnPreview Setting this to false will always skip image builds during previews, builder Builder configuration. cacheFrom Cache export configuration. cacheTo Cache import configuration. context Build context settings. Defaults to the current directory. dockerfile Dockerfile settings. exec Use exec mode to build this image. exports Controls where images are persisted after building. ignoreSecretsInDiffCalculation A list of secret names to ignore when calculating diffs. labels Attach arbitrary key/value metadata to the image. load When true the build will automatically include a docker export. network Set the network mode for RUN instructions. Defaults to default. noCache Do not import cache manifests when building the image. platforms Set target platform(s) for the build. Defaults to the host's platform. pull Always pull referenced images. push When true the build will automatically include a registry export. registries Registry credentials. Required if reading or exporting to private secrets A mapping of secret names to their corresponding values. ssh SSH agent socket or keys to expose to the build. tags Name and optionally a tag (format: name:tag). target Set the target build stage(s) to build.
const
ImageArgs.fromMap(Map<String, dynamic> map)
factory

Properties

addHosts → Input<List<String>>?
Custom host:ip mappings to use during the build.
final
buildArgs → Input<Map<String, String>>?
ARG names and values to set during the build.
final
builder → Input<BuilderConfig>?
Builder configuration.
final
buildOnPreview → Input<bool>?
Setting this to false will always skip image builds during previews, and setting it to true will always build images during previews.
final
cacheFrom → Input<List<CacheFrom>>?
Cache export configuration.
final
cacheTo → Input<List<CacheTo>>?
Cache import configuration.
final
context → Input<BuildContext>?
Build context settings. Defaults to the current directory.
final
dockerfile → Input<Dockerfile>?
Dockerfile settings.
final
exec → Input<bool>?
Use exec mode to build this image.
final
exports → Input<List<Export>>?
Controls where images are persisted after building.
final
hashCode → int
The hash code for this object.
no setterinherited
ignoreSecretsInDiffCalculation → Input<List<String>>?
A list of secret names to ignore when calculating diffs.
final
labels → Input<Map<String, String>>?
Attach arbitrary key/value metadata to the image.
final
load → Input<bool>?
When true the build will automatically include a docker export.
final
network → Input<NetworkMode>?
Set the network mode for RUN instructions. Defaults to default.
final
noCache → Input<bool>?
Do not import cache manifests when building the image.
final
platforms → Input<List<Platform>>?
Set target platform(s) for the build. Defaults to the host's platform.
final
pull → Input<bool>?
Always pull referenced images.
final
push → Input<bool>
When true the build will automatically include a registry export.
final
registries → Input<List<Registry>>?
Registry credentials. Required if reading or exporting to private repositories.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
secrets → Input<Map<String, String>>?
A mapping of secret names to their corresponding values.
final
ssh → Input<List<SSH>>?
SSH agent socket or keys to expose to the build.
final
tags → Input<List<String>>?
Name and optionally a tag (format: name:tag).
final
target → Input<String>?
Set the target build stage(s) to build.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited