Class TaskRunRequest

java.lang.Object
com.azure.resourcemanager.containerregistry.models.RunRequest
com.azure.resourcemanager.containerregistry.models.TaskRunRequest
All Implemented Interfaces:
com.azure.json.JsonSerializable<RunRequest>
public final class TaskRunRequest extends RunRequest
The parameters for a task run request.

  • Constructor Details

    • TaskRunRequest

      public TaskRunRequest()
      Creates an instance of TaskRunRequest class.

  • Method Details

    • type

      public String type()
      Get the type property: The type of the run request.
      Overrides:
      type in class RunRequest
      Returns:
      the type value.

    • taskId

      public String taskId()
      Get the taskId property: The resource ID of task against which run has to be queued.
      Returns:
      the taskId value.

    • withTaskId

      public TaskRunRequest withTaskId(String taskId)
      Set the taskId property: The resource ID of task against which run has to be queued.
      Parameters:
      taskId - the taskId value to set.
      Returns:
      the TaskRunRequest object itself.

    • overrideTaskStepProperties

      public OverrideTaskStepProperties overrideTaskStepProperties()
      Get the overrideTaskStepProperties property: Set of overridable parameters that can be passed when running a Task.
      Returns:
      the overrideTaskStepProperties value.

    • withOverrideTaskStepProperties

      public TaskRunRequest withOverrideTaskStepProperties(OverrideTaskStepProperties overrideTaskStepProperties)
      Set the overrideTaskStepProperties property: Set of overridable parameters that can be passed when running a Task.
      Parameters:
      overrideTaskStepProperties - the overrideTaskStepProperties value to set.
      Returns:
      the TaskRunRequest object itself.

    • withIsArchiveEnabled

      public TaskRunRequest withIsArchiveEnabled(Boolean isArchiveEnabled)
      Set the isArchiveEnabled property: The value that indicates whether archiving is enabled for the run or not.
      Overrides:
      withIsArchiveEnabled in class RunRequest
      Parameters:
      isArchiveEnabled - the isArchiveEnabled value to set.
      Returns:
      the RunRequest object itself.

    • withAgentPoolName

      public TaskRunRequest withAgentPoolName(String agentPoolName)
      Set the agentPoolName property: The dedicated agent pool for the run.
      Overrides:
      withAgentPoolName in class RunRequest
      Parameters:
      agentPoolName - the agentPoolName value to set.
      Returns:
      the RunRequest object itself.

    • withLogTemplate

      public TaskRunRequest withLogTemplate(String logTemplate)
      Set the logTemplate property: The template that describes the repository and tag information for run log artifact.
      Overrides:
      withLogTemplate in class RunRequest
      Parameters:
      logTemplate - the logTemplate value to set.
      Returns:
      the RunRequest object itself.

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class RunRequest
      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<RunRequest>
      Overrides:
      toJson in class RunRequest
      Throws:
      IOException

    • fromJson

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