Class TaskRunRequest


  • public final class TaskRunRequest
    extends RunRequest
    The parameters for a task run request.
    • Constructor Detail

      • TaskRunRequest

        public TaskRunRequest()
    • Method Detail

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