com.github.dockerjava.api.command

Interface RemoveImageCmd

All Superinterfaces:

AutoCloseable, Closeable, DockerCmd<Void>, SyncDockerCmd<Void>

public interface RemoveImageCmd
extends SyncDockerCmd<Void>

Remove an image, deleting any tags it might have.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RemoveImageCmd.Exec

Method Summary

Modifier and Type	Method and Description
Void	exec()
String	getImageId()
Boolean	hasForceEnabled()
Boolean	hasNoPruneEnabled()
RemoveImageCmd	withForce(Boolean force) force parameter to force delete of an image, even if it's tagged in multiple repositories
RemoveImageCmd	withImageId(String imageId)
RemoveImageCmd	withNoPrune(Boolean noPrune) noprune parameter to prevent the deletion of parent images

Methods inherited from interface com.github.dockerjava.api.command.DockerCmd

close

Method Detail

getImageId

@CheckForNull
String getImageId()

hasForceEnabled

@CheckForNull
Boolean hasForceEnabled()

hasNoPruneEnabled

@CheckForNull
Boolean hasNoPruneEnabled()

withImageId

RemoveImageCmd withImageId(@Nonnull
                           String imageId)

withForce

RemoveImageCmd withForce(Boolean force)

force parameter to force delete of an image, even if it's tagged in multiple repositories

withNoPrune

RemoveImageCmd withNoPrune(Boolean noPrune)

noprune parameter to prevent the deletion of parent images

exec

Void exec()
   throws NotFoundException

Specified by:

exec in interface SyncDockerCmd<Void>

Throws:

NotFoundException - No such image