com.github.dockerjava.api.command

Interface RemoveImageCmd

All Superinterfaces:

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

All Known Implementing Classes:

RemoveImageCmdImpl

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

Methods

Modifier and Type	Method and Description
Void	exec()
String	getImageId()
boolean	hasForceEnabled()
boolean	hasNoPruneEnabled()
RemoveImageCmd	withForce() force delete of an image, even if it's tagged in multiple repositories
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() prevent the deletion of parent images
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

String getImageId()

hasForceEnabled

boolean hasForceEnabled()

hasNoPruneEnabled

boolean hasNoPruneEnabled()

withImageId

RemoveImageCmd withImageId(String imageId)

withForce

RemoveImageCmd withForce()

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

withForce

RemoveImageCmd withForce(boolean force)

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

withNoPrune

RemoveImageCmd withNoPrune()

prevent the deletion of parent images

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