DockerBuildStepUpdateParameters Class

Package:

com.azure.resourcemanager.containerregistry.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-containerregistry:2.55.1

• java.lang.Object
• • com.azure.resourcemanager.containerregistry.models.TaskStepUpdateParameters
  • • com.azure.resourcemanager.containerregistry.models.DockerBuildStepUpdateParameters

public final class DockerBuildStepUpdateParameters
extends TaskStepUpdateParameters

The properties for updating a docker build step.

Constructor Summary

Constructor	Description
DockerBuildStepUpdateParameters()	Creates an instance of DockerBuildStepUpdateParameters class.

Method Summary

Modifier and Type	Method and Description
List<Argument>	arguments() Get the arguments property: The collection of override arguments to be used when executing this build step.
String	dockerFilePath() Get the dockerFilePath property: The Docker file path relative to the source context.
static DockerBuildStepUpdateParameters	fromJson(JsonReader jsonReader) Reads an instance of DockerBuildStepUpdateParameters from the JsonReader.
List<String>	imageNames() Get the imageNames property: The fully qualified image names including the repository and tag.
Boolean	isPushEnabled() Get the isPushEnabled property: The value of this property indicates whether the image built should be pushed to the registry or not.
Boolean	noCache() Get the noCache property: The value of this property indicates whether the image cache is enabled or not.
String	target() Get the target property: The name of the target build stage for the docker build.
JsonWriter	toJson(JsonWriter jsonWriter)
StepType	type() Get the type property: The type of the step.
void	validate() Validates the instance.
DockerBuildStepUpdateParameters	withArguments(List<Argument> arguments) Set the arguments property: The collection of override arguments to be used when executing this build step.
DockerBuildStepUpdateParameters	withContextAccessToken(String contextAccessToken) Set the contextAccessToken property: The token (git PAT or SAS token of storage account blob) associated with the context for a step.
DockerBuildStepUpdateParameters	withContextPath(String contextPath) Set the contextPath property: The URL(absolute or relative) of the source context for the task step.
DockerBuildStepUpdateParameters	withDockerFilePath(String dockerFilePath) Set the dockerFilePath property: The Docker file path relative to the source context.
DockerBuildStepUpdateParameters	withImageNames(List<String> imageNames) Set the imageNames property: The fully qualified image names including the repository and tag.
DockerBuildStepUpdateParameters	withIsPushEnabled(Boolean isPushEnabled) Set the isPushEnabled property: The value of this property indicates whether the image built should be pushed to the registry or not.
DockerBuildStepUpdateParameters	withNoCache(Boolean noCache) Set the noCache property: The value of this property indicates whether the image cache is enabled or not.
DockerBuildStepUpdateParameters	withTarget(String target) Set the target property: The name of the target build stage for the docker build.

Methods inherited from TaskStepUpdateParameters

contextAccessToken contextPath fromJson toJson type validate withContextAccessToken withContextPath

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DockerBuildStepUpdateParameters

public DockerBuildStepUpdateParameters()

Creates an instance of DockerBuildStepUpdateParameters class.

Method Details

arguments

public List<Argument> arguments()

Get the arguments property: The collection of override arguments to be used when executing this build step.

Returns:

the arguments value.

dockerFilePath

public String dockerFilePath()

Get the dockerFilePath property: The Docker file path relative to the source context.

Returns:

the dockerFilePath value.

fromJson

public static DockerBuildStepUpdateParameters fromJson(JsonReader jsonReader)

Reads an instance of DockerBuildStepUpdateParameters from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DockerBuildStepUpdateParameters if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the DockerBuildStepUpdateParameters.

imageNames

public List<String> imageNames()

Get the imageNames property: The fully qualified image names including the repository and tag.

Returns:

the imageNames value.

isPushEnabled

public Boolean isPushEnabled()

Get the isPushEnabled property: 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 noCache property: The value of this property indicates whether the image cache is enabled or not.

Returns:

the noCache value.

target

public String target()

Get the target property: The name of the target build stage for the docker build.

Returns:

the target value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

DockerBuildStepUpdateParameters.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public StepType type()

Get the type property: The type of the step.

Overrides:

DockerBuildStepUpdateParameters.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

DockerBuildStepUpdateParameters.validate()

withArguments

public DockerBuildStepUpdateParameters withArguments(List<Argument> arguments)

Set the arguments property: The collection of override arguments to be used when executing this build step.

Parameters:

arguments - the arguments value to set.

Returns:

the DockerBuildStepUpdateParameters object itself.

withContextAccessToken

public DockerBuildStepUpdateParameters withContextAccessToken(String contextAccessToken)

Set the contextAccessToken property: The token (git PAT or SAS token of storage account blob) associated with the context for a step.

Overrides:

DockerBuildStepUpdateParameters.withContextAccessToken(String contextAccessToken)

Parameters:

contextAccessToken

withContextPath

public DockerBuildStepUpdateParameters withContextPath(String contextPath)

Set the contextPath property: The URL(absolute or relative) of the source context for the task step.

Overrides:

DockerBuildStepUpdateParameters.withContextPath(String contextPath)

Parameters:

contextPath

withDockerFilePath

public DockerBuildStepUpdateParameters withDockerFilePath(String dockerFilePath)

Set the dockerFilePath property: The Docker file path relative to the source context.

Parameters:

dockerFilePath - the dockerFilePath value to set.

Returns:

the DockerBuildStepUpdateParameters object itself.

withImageNames

public DockerBuildStepUpdateParameters withImageNames(List<String> imageNames)

Set the imageNames property: The fully qualified image names including the repository and tag.

Parameters:

imageNames - the imageNames value to set.

Returns:

the DockerBuildStepUpdateParameters object itself.

withIsPushEnabled

public DockerBuildStepUpdateParameters withIsPushEnabled(Boolean isPushEnabled)

Set the isPushEnabled property: 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 DockerBuildStepUpdateParameters object itself.

withNoCache

public DockerBuildStepUpdateParameters withNoCache(Boolean noCache)

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

Parameters:

noCache - the noCache value to set.

Returns:

the DockerBuildStepUpdateParameters object itself.

withTarget

public DockerBuildStepUpdateParameters withTarget(String target)

Set the target property: The name of the target build stage for the docker build.

Parameters:

target - the target value to set.

Returns:

the DockerBuildStepUpdateParameters object itself.