java.lang.Object
com.azure.resourcemanager.containerregistry.models.TaskStepProperties
com.azure.resourcemanager.containerregistry.models.FileTaskStep
All Implemented Interfaces:
com.azure.json.JsonSerializable<TaskStepProperties>

public final class FileTaskStep extends TaskStepProperties
The properties of a task step.
  • Constructor Details

    • FileTaskStep

      public FileTaskStep()
      Creates an instance of FileTaskStep 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.
    • taskFilePath

      public String taskFilePath()
      Get the taskFilePath property: The task template/definition file path relative to the source context.
      Returns:
      the taskFilePath value.
    • withTaskFilePath

      public FileTaskStep withTaskFilePath(String taskFilePath)
      Set the taskFilePath property: The task template/definition file path relative to the source context.
      Parameters:
      taskFilePath - the taskFilePath value to set.
      Returns:
      the FileTaskStep object itself.
    • valuesFilePath

      public String valuesFilePath()
      Get the valuesFilePath property: The task values/parameters file path relative to the source context.
      Returns:
      the valuesFilePath value.
    • withValuesFilePath

      public FileTaskStep withValuesFilePath(String valuesFilePath)
      Set the valuesFilePath property: The task values/parameters file path relative to the source context.
      Parameters:
      valuesFilePath - the valuesFilePath value to set.
      Returns:
      the FileTaskStep object itself.
    • values

      public List<SetValue> values()
      Get the values property: The collection of overridable values that can be passed when running a task.
      Returns:
      the values value.
    • withValues

      public FileTaskStep withValues(List<SetValue> values)
      Set the values property: The collection of overridable values that can be passed when running a task.
      Parameters:
      values - the values value to set.
      Returns:
      the FileTaskStep object itself.
    • baseImageDependencies

      public List<BaseImageDependency> baseImageDependencies()
      Get the baseImageDependencies property: List of base image dependencies for a step.
      Overrides:
      baseImageDependencies in class TaskStepProperties
      Returns:
      the baseImageDependencies value.
    • withContextPath

      public FileTaskStep 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 FileTaskStep 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 FileTaskStep fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of FileTaskStep from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of FileTaskStep 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 FileTaskStep.