DockerBuildRequest Class

Package:

com.microsoft.azure.management.containerregistry

Maven Artifact:

com.microsoft.azure:azure-mgmt-containerregistry:1.41.4

• java.lang.Object
• • com.microsoft.azure.management.containerregistry.RunRequest
  • • com.microsoft.azure.management.containerregistry.DockerBuildRequest

public class DockerBuildRequest
extends RunRequest

The parameters for a docker quick build.

Constructor Summary

Constructor	Description
DockerBuildRequest()

Method Summary

Modifier and Type	Method and Description
AgentProperties	agentConfiguration() Get the machine configuration of the run agent.
java.util.List<Argument>	arguments() Get the collection of override arguments to be used when executing the run.
java.lang.String	dockerFilePath() Get the Docker file path relative to the source location.
java.util.List<java.lang.String>	imageNames() Get the fully qualified image names including the repository and tag.
java.lang.Boolean	isPushEnabled() Get the value of this property indicates whether the image built should be pushed to the registry or not.
java.lang.Boolean	noCache() Get the value of this property indicates whether the image cache is enabled or not.
PlatformProperties	platform() Get the platform properties against which the run has to happen.
java.lang.String	sourceLocation() Get the URL(absolute or relative) of the source context.
java.lang.Integer	timeout() Get run timeout in seconds.
DockerBuildRequest	withAgentConfiguration(AgentProperties agentConfiguration) Set the machine configuration of the run agent.
DockerBuildRequest	withArguments(List<Argument> arguments) Set the collection of override arguments to be used when executing the run.
DockerBuildRequest	withDockerFilePath(String dockerFilePath) Set the Docker file path relative to the source location.
DockerBuildRequest	withImageNames(List<String> imageNames) Set the fully qualified image names including the repository and tag.
DockerBuildRequest	withIsPushEnabled(Boolean isPushEnabled) Set the value of this property indicates whether the image built should be pushed to the registry or not.
DockerBuildRequest	withNoCache(Boolean noCache) Set the value of this property indicates whether the image cache is enabled or not.
DockerBuildRequest	withPlatform(PlatformProperties platform) Set the platform properties against which the run has to happen.
DockerBuildRequest	withSourceLocation(String sourceLocation) Set the URL(absolute or relative) of the source context.
DockerBuildRequest	withTimeout(Integer timeout) Set run timeout in seconds.

Methods inherited from RunRequest

isArchiveEnabled withIsArchiveEnabled

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

DockerBuildRequest

public DockerBuildRequest()

Method Details

agentConfiguration

public AgentProperties agentConfiguration()

Get the machine configuration of the run agent.

Returns:

the agentConfiguration value

arguments

public List arguments()

Get the collection of override arguments to be used when executing the run.

Returns:

the arguments value

dockerFilePath

public String dockerFilePath()

Get the Docker file path relative to the source location.

Returns:

the dockerFilePath value

imageNames

public List imageNames()

Get the fully qualified image names including the repository and tag.

Returns:

the imageNames value

isPushEnabled

public Boolean isPushEnabled()

Get the value of this property indicates whether the image built should be pushed to the registry or not.

Returns:

the isPushEnabled value

noCache

public Boolean noCache()

Get the value of this property indicates whether the image cache is enabled or not.

Returns:

the noCache value

platform

public PlatformProperties platform()

Get the platform properties against which the run has to happen.

Returns:

the platform value

sourceLocation

public String sourceLocation()

Get the URL(absolute or relative) of the source context. It can be an URL to a tar or git repoistory. If it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API.

Returns:

the sourceLocation value

timeout

public Integer timeout()

Get run timeout in seconds.

Returns:

the timeout value

withAgentConfiguration

public DockerBuildRequest withAgentConfiguration(AgentProperties agentConfiguration)

Set the machine configuration of the run agent.

Parameters:

agentConfiguration - the agentConfiguration value to set

Returns:

the DockerBuildRequest object itself.

withArguments

public DockerBuildRequest withArguments(List arguments)

Set the collection of override arguments to be used when executing the run.

Parameters:

arguments - the arguments value to set

Returns:

the DockerBuildRequest object itself.

withDockerFilePath

public DockerBuildRequest withDockerFilePath(String dockerFilePath)

Set the Docker file path relative to the source location.

Parameters:

dockerFilePath - the dockerFilePath value to set

Returns:

the DockerBuildRequest object itself.

withImageNames

public DockerBuildRequest withImageNames(List imageNames)

Set the fully qualified image names including the repository and tag.

Parameters:

imageNames - the imageNames value to set

Returns:

the DockerBuildRequest object itself.

withIsPushEnabled

public DockerBuildRequest withIsPushEnabled(Boolean isPushEnabled)

Set the value of this property indicates whether the image built should be pushed to the registry or not.

Parameters:

isPushEnabled - the isPushEnabled value to set

Returns:

the DockerBuildRequest object itself.

withNoCache

public DockerBuildRequest withNoCache(Boolean noCache)

Set the value of this property indicates whether the image cache is enabled or not.

Parameters:

noCache - the noCache value to set

Returns:

the DockerBuildRequest object itself.

withPlatform

public DockerBuildRequest withPlatform(PlatformProperties platform)

Set the platform properties against which the run has to happen.

Parameters:

platform - the platform value to set

Returns:

the DockerBuildRequest object itself.

withSourceLocation

public DockerBuildRequest withSourceLocation(String sourceLocation)

Set the URL(absolute or relative) of the source context. It can be an URL to a tar or git repoistory. If it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API.

Parameters:

sourceLocation - the sourceLocation value to set

Returns:

the DockerBuildRequest object itself.

withTimeout

public DockerBuildRequest withTimeout(Integer timeout)

Set run timeout in seconds.

Parameters:

timeout - the timeout value to set

Returns:

the DockerBuildRequest object itself.