RemoteImageState class

Input properties used for looking up and filtering RemoteImage resources.

Constructors

RemoteImageState({Input<RemoteImageBuild?>? build, Input<bool?>? forceRemove, Input<String?>? imageId, Input<bool?>? keepLocally, Input<String?>? name, Input<String?>? platform, Input<List<String>?>? pullTriggers, Input<String?>? repoDigest, Input<Map<String, String>?>? triggers})
Creates a new RemoteImageState. build Configuration to build an image. Requires the Use containerd for pulling and storing images option to be disabled in the Docker Host(https://github.com/kreuzwerker/terraform-provider-docker/issues/534). Please see docker build command reference too. forceRemove If true, then the image is removed forcibly when the resource is destroyed. imageId The ID of the image (as seen when executing docker inspect on the image). Can be used to reference the image via its ID in other resources. keepLocally If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation. name The name of the Docker image, including any tags or SHA256 repo digests. platform The platform to use when pulling the image. Defaults to the platform of the current machine. pullTriggers List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the dockerregistryimage. repoDigest The image sha256 digest in the form of repo[:tag]@sha256:&lt;hash&gt;. This may not be populated when building an image, because it is read from the local Docker client and so may be available only when the image was either pulled from the repo or pushed to the repo (perhaps using docker.RegistryImage) in a previous run. triggers A map of arbitrary strings that, when changed, will force the docker.RemoteImage resource to be replaced. This can be used to rebuild an image when contents of source code folders change
const
RemoteImageState.fromMap(Map<String, dynamic> map)
factory

Properties

build → Input<RemoteImageBuild?>?
Configuration to build an image. Requires the Use containerd for pulling and storing images option to be disabled in the Docker Host(https://github.com/kreuzwerker/terraform-provider-docker/issues/534). Please see docker build command reference too.
final
forceRemove → Input<bool?>?
If true, then the image is removed forcibly when the resource is destroyed.
final
hashCode → int
The hash code for this object.
no setterinherited
imageId → Input<String?>?
The ID of the image (as seen when executing docker inspect on the image). Can be used to reference the image via its ID in other resources.
final
keepLocally → Input<bool?>?
If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation.
final
name → Input<String?>?
The name of the Docker image, including any tags or SHA256 repo digests.
final
platform → Input<String?>?
The platform to use when pulling the image. Defaults to the platform of the current machine.
final
pullTriggers → Input<List<String>?>?
List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the dockerregistryimage.
final
repoDigest → Input<String?>?
The image sha256 digest in the form of repo[:tag]@sha256:&lt;hash&gt;. This may not be populated when building an image, because it is read from the local Docker client and so may be available only when the image was either pulled from the repo or pushed to the repo (perhaps using docker.RegistryImage) in a previous run.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
triggers → Input<Map<String, String>?>?
A map of arbitrary strings that, when changed, will force the docker.RemoteImage resource to be replaced. This can be used to rebuild an image when contents of source code folders change
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