Class Remove.RemoveImage
- java.lang.Object
-
- com.oracle.bedrock.runtime.docker.commands.AbstractDockerCommand<C>
-
- com.oracle.bedrock.runtime.docker.commands.CommandWithArgumentList<R>
-
- com.oracle.bedrock.runtime.docker.commands.Remove<Remove.RemoveImage>
-
- com.oracle.bedrock.runtime.docker.commands.Remove.RemoveImage
-
- All Implemented Interfaces:
com.oracle.bedrock.runtime.MetaClass<com.oracle.bedrock.runtime.Application>
public static class Remove.RemoveImage extends Remove<Remove.RemoveImage>
A representation of a Docker command to remove an image.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.oracle.bedrock.runtime.docker.commands.Remove
Remove.RemoveContainer, Remove.RemoveImage, Remove.RemoveLink
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Remove.RemoveImageforce()Force removal of the image (equates to the --force argument).Remove.RemoveImageforce(boolean force)Force removal of the image (equates to the --force argument).Remove.RemoveImagenoPrune()Do not delete untagged parents (equates to the --no-prune argument).Remove.RemoveImagenoPrune(boolean noPrune)Do not delete untagged parents (equates to the --no-prune argument).protected Remove.RemoveImagewithCommandArguments(List<com.oracle.bedrock.runtime.options.Argument> images, com.oracle.bedrock.runtime.options.Argument... args)Obtain a copy of thisCommandWithArgumentListwith the addition of the specified command argumentsArguments.protected Remove.RemoveImagewithoutCommandArguments(List<com.oracle.bedrock.runtime.options.Argument> names, com.oracle.bedrock.runtime.options.Argument... args)Obtain a copy of thisCommandWithArgumentListwithout the the specified command argumentsArguments.-
Methods inherited from class com.oracle.bedrock.runtime.docker.commands.Remove
containers, containers, images, images, link
-
Methods inherited from class com.oracle.bedrock.runtime.docker.commands.CommandWithArgumentList
onLaunch, withCommandArguments, withoutCommandArguments
-
Methods inherited from class com.oracle.bedrock.runtime.docker.commands.AbstractDockerCommand
getCommandArguments, getImplementationClass, getTimeout, onLaunched, onLaunching, timeoutAfter, timeoutAfter
-
-
-
-
Method Detail
-
force
public Remove.RemoveImage force()
Force removal of the image (equates to the --force argument).- Returns:
- a new
Remove.RemoveImageinstance that is the same as this instance with the --force option applied
-
force
public Remove.RemoveImage force(boolean force)
Force removal of the image (equates to the --force argument).- Parameters:
force- true to add the--forceoption or false to remove the--forceoption- Returns:
- a new
Remove.RemoveImageinstance that is the same as this instance with the --force option applied
-
noPrune
public Remove.RemoveImage noPrune()
Do not delete untagged parents (equates to the --no-prune argument).- Returns:
- a new
Remove.RemoveImageinstance that is the same as this instance with the --no-prune option applied
-
noPrune
public Remove.RemoveImage noPrune(boolean noPrune)
Do not delete untagged parents (equates to the --no-prune argument).- Parameters:
noPrune- true to add the--no-pruneoption or false to remove the--no-pruneoption- Returns:
- a new
Remove.RemoveImageinstance that is the same as this instance with the --no-prune option applied
-
withCommandArguments
protected Remove.RemoveImage withCommandArguments(List<com.oracle.bedrock.runtime.options.Argument> images, com.oracle.bedrock.runtime.options.Argument... args)
Description copied from class:CommandWithArgumentListObtain a copy of thisCommandWithArgumentListwith the addition of the specified command argumentsArguments.- Specified by:
withCommandArgumentsin classCommandWithArgumentList<Remove.RemoveImage>- Parameters:
images- theListofArgumentsthat appear at the end of the command lineargs- the new command to add- Returns:
- a copy of this
CommandWithArgumentListwith the addition of the specified command argumentsArguments
-
withoutCommandArguments
protected Remove.RemoveImage withoutCommandArguments(List<com.oracle.bedrock.runtime.options.Argument> names, com.oracle.bedrock.runtime.options.Argument... args)
Description copied from class:CommandWithArgumentListObtain a copy of thisCommandWithArgumentListwithout the the specified command argumentsArguments.- Specified by:
withoutCommandArgumentsin classCommandWithArgumentList<Remove.RemoveImage>- Parameters:
names- theListofArgumentsthat appear at the end of the command lineargs- the new command to add- Returns:
- a copy of this
CommandWithArgumentListwithout the specified command argumentsArguments
-
-