com.github.dockerjava.api.command.RemoveImageCmd Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of docker-java Show documentation

Java API Client for Docker

There is a newer version: 3.4.1

package com.github.dockerjava.api.command;

import com.github.dockerjava.api.NotFoundException;

/**
*
* Remove an image, deleting any tags it might have.
*
*/
public interface RemoveImageCmd extends DockerCmd{

	public String getImageId();

	public boolean hasForceEnabled();

	public boolean hasNoPruneEnabled();

	public RemoveImageCmd withImageId(String imageId);
	
	/**
	 * force delete of an image, even if it's tagged in multiple repositories
	 */
	public RemoveImageCmd withForce();

	/**
	 * force parameter to force delete of an image, even if it's tagged in multiple repositories
	 */
	public RemoveImageCmd withForce(boolean force);

	/**
	 * prevent the deletion of parent images
	 */
	public RemoveImageCmd withNoPrune();
	
	/**
	 * noprune parameter to prevent the deletion of parent images
	 * 
	 */
	public RemoveImageCmd withNoPrune(boolean noPrune);

	/**
	 * @throws NotFoundException No such image
	 */
	@Override
	public Void exec() throws NotFoundException;
	
	public static interface Exec extends DockerCmdExec {
	}

}