DockerClient.BuildParam (docker-client 5.0.2 API)

java.lang.Object
- com.spotify.docker.client.DockerClient.BuildParam

Enclosing interface:

DockerClient
```
public static class DockerClient.BuildParam
extends Object
```
Flags which can be passed to the build method.

Field Summary

Fields
Modifier and Type Field and Description

private String name

private String value

Fields
Modifier and Type	Field and Description
`private String`	`name`
`private String`	`value`

Constructor Summary

Constructors
Constructor and Description

BuildParam(String name, String value)

Constructors
Constructor and Description
`BuildParam(String name, String value)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DockerClient.BuildParam`	`create(String name, String value)` Create a custom parameter.
`boolean`	`equals(Object o)`
`static DockerClient.BuildParam`	`forceRm()` Always remove intermediate containers.
`int`	`hashCode()`
`String`	`name()` Parameter name.
`static DockerClient.BuildParam`	`noCache()` Do not use the cache when building the image.
`static DockerClient.BuildParam`	`pullNewerImage()` Always attempt to pull a newer version of the base image even if one exists locally.
`static DockerClient.BuildParam`	`quiet()` Suppress verbose build output.
`static DockerClient.BuildParam`	`rm()` Remove intermediate containers after a successful build.
`static DockerClient.BuildParam`	`rm(boolean rm)` Control whether to remove intermediate containers after a successful build.
`String`	`value()` Parameter value.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - name
```
private final String name
```
  - value
```
private final String value
```
- Constructor Detail
  - BuildParam
```
public BuildParam(String name,
                  String value)
```
- Method Detail
  - name
```
public String name()
```
    Parameter name.
    
    Returns:
    
    name of parameter
  - value
```
public String value()
```
    Parameter value.
    
    Returns:
    
    value of parameter
  - create
```
public static DockerClient.BuildParam create(String name,
                                             String value)
```
    Create a custom parameter.
    
    Parameters:
    
    name - custom name
    
    value - custom value
    
    Returns:
    
    BuildParam
  - quiet
```
public static DockerClient.BuildParam quiet()
```
    Suppress verbose build output.
    
    Returns:
    
    BuildParam
  - rm
```
public static DockerClient.BuildParam rm()
```
    Remove intermediate containers after a successful build.
    
    Returns:
    
    BuildParam
  - rm
```
public static DockerClient.BuildParam rm(boolean rm)
```
    Control whether to remove intermediate containers after a successful build.
    
    Parameters:
    
    rm - Whether to remove
    
    Returns:
    
    BuildParam
  - noCache
```
public static DockerClient.BuildParam noCache()
```
    Do not use the cache when building the image.
    
    Returns:
    
    BuildParam
  - forceRm
```
public static DockerClient.BuildParam forceRm()
```
    Always remove intermediate containers.
    
    Returns:
    
    BuildParam
  - pullNewerImage
```
public static DockerClient.BuildParam pullNewerImage()
```
    Always attempt to pull a newer version of the base image even if one exists locally.
    
    Returns:
    
    BuildParam
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class DockerClient.BuildParam

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

value

Constructor Detail

BuildParam

Method Detail

name

value

create

quiet

rm

rm

noCache

forceRm

pullNewerImage

equals

hashCode