Class DockerTaskStep

java.lang.Object
com.azure.resourcemanager.containerregistry.models.TaskStepProperties
com.azure.resourcemanager.containerregistry.models.DockerTaskStep
All Implemented Interfaces:
com.azure.json.JsonSerializable<TaskStepProperties>
public final class DockerTaskStep extends TaskStepProperties
The Docker build step.

  • Constructor Details

    • DockerTaskStep

      public DockerTaskStep()
      Creates an instance of DockerTaskStep class.

  • Method Details

    • type

      public StepType type()
      Get the type property: The type of the step.
      Overrides:
      type in class TaskStepProperties
      Returns:
      the type value.

    • imageNames

      public List<String> imageNames()
      Get the imageNames property: The fully qualified image names including the repository and tag.
      Returns:
      the imageNames value.

    • withImageNames

      public DockerTaskStep 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 DockerTaskStep object itself.

    • 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.

    • withIsPushEnabled

      public DockerTaskStep 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 DockerTaskStep object itself.

    • 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.

    • withNoCache

      public DockerTaskStep 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 DockerTaskStep object itself.

    • dockerFilePath

      public String dockerFilePath()
      Get the dockerFilePath property: The Docker file path relative to the source context.
      Returns:
      the dockerFilePath value.

    • withDockerFilePath

      public DockerTaskStep 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 DockerTaskStep object itself.

    • target

      public String target()
      Get the target property: The name of the target build stage for the docker build.
      Returns:
      the target value.

    • withTarget

      public DockerTaskStep 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 DockerTaskStep object itself.

    • 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.

    • withArguments

      public DockerTaskStep 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 DockerTaskStep object itself.

    • withContextPath

      public DockerTaskStep withContextPath(String contextPath)
      Set the contextPath property: The URL(absolute or relative) of the source context for the task step.
      Overrides:
      withContextPath in class TaskStepProperties
      Parameters:
      contextPath - the contextPath value to set.
      Returns:
      the TaskStepProperties object itself.

    • withContextAccessToken

      public DockerTaskStep 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:
      withContextAccessToken in class TaskStepProperties
      Parameters:
      contextAccessToken - the contextAccessToken value to set.
      Returns:
      the TaskStepProperties object itself.

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class TaskStepProperties
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<TaskStepProperties>
      Overrides:
      toJson in class TaskStepProperties
      Throws:
      IOException

    • fromJson

      public static DockerTaskStep fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of DockerTaskStep from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of DockerTaskStep if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the DockerTaskStep.