Class TaskProperties


  • public final class TaskProperties
    extends Object
    The properties of a task.
    • Constructor Detail

      • TaskProperties

        public TaskProperties()
    • Method Detail

      • provisioningState

        public ProvisioningState provisioningState()
        Get the provisioningState property: The provisioning state of the task.
        Returns:
        the provisioningState value.
      • creationDate

        public OffsetDateTime creationDate()
        Get the creationDate property: The creation date of task.
        Returns:
        the creationDate value.
      • status

        public TaskStatus status()
        Get the status property: The current status of task.
        Returns:
        the status value.
      • withStatus

        public TaskProperties withStatus​(TaskStatus status)
        Set the status property: The current status of task.
        Parameters:
        status - the status value to set.
        Returns:
        the TaskProperties object itself.
      • platform

        public PlatformProperties platform()
        Get the platform property: The platform properties against which the run has to happen.
        Returns:
        the platform value.
      • withPlatform

        public TaskProperties withPlatform​(PlatformProperties platform)
        Set the platform property: The platform properties against which the run has to happen.
        Parameters:
        platform - the platform value to set.
        Returns:
        the TaskProperties object itself.
      • agentConfiguration

        public AgentProperties agentConfiguration()
        Get the agentConfiguration property: The machine configuration of the run agent.
        Returns:
        the agentConfiguration value.
      • withAgentConfiguration

        public TaskProperties withAgentConfiguration​(AgentProperties agentConfiguration)
        Set the agentConfiguration property: The machine configuration of the run agent.
        Parameters:
        agentConfiguration - the agentConfiguration value to set.
        Returns:
        the TaskProperties object itself.
      • agentPoolName

        public String agentPoolName()
        Get the agentPoolName property: The dedicated agent pool for the task.
        Returns:
        the agentPoolName value.
      • withAgentPoolName

        public TaskProperties withAgentPoolName​(String agentPoolName)
        Set the agentPoolName property: The dedicated agent pool for the task.
        Parameters:
        agentPoolName - the agentPoolName value to set.
        Returns:
        the TaskProperties object itself.
      • timeout

        public Integer timeout()
        Get the timeout property: Run timeout in seconds.
        Returns:
        the timeout value.
      • withTimeout

        public TaskProperties withTimeout​(Integer timeout)
        Set the timeout property: Run timeout in seconds.
        Parameters:
        timeout - the timeout value to set.
        Returns:
        the TaskProperties object itself.
      • step

        public TaskStepProperties step()
        Get the step property: The properties of a task step.
        Returns:
        the step value.
      • withStep

        public TaskProperties withStep​(TaskStepProperties step)
        Set the step property: The properties of a task step.
        Parameters:
        step - the step value to set.
        Returns:
        the TaskProperties object itself.
      • trigger

        public TriggerProperties trigger()
        Get the trigger property: The properties that describe all triggers for the task.
        Returns:
        the trigger value.
      • withTrigger

        public TaskProperties withTrigger​(TriggerProperties trigger)
        Set the trigger property: The properties that describe all triggers for the task.
        Parameters:
        trigger - the trigger value to set.
        Returns:
        the TaskProperties object itself.
      • credentials

        public Credentials credentials()
        Get the credentials property: The properties that describes a set of credentials that will be used when this run is invoked.
        Returns:
        the credentials value.
      • withCredentials

        public TaskProperties withCredentials​(Credentials credentials)
        Set the credentials property: The properties that describes a set of credentials that will be used when this run is invoked.
        Parameters:
        credentials - the credentials value to set.
        Returns:
        the TaskProperties object itself.
      • logTemplate

        public String logTemplate()
        Get the logTemplate property: The template that describes the repository and tag information for run log artifact.
        Returns:
        the logTemplate value.
      • withLogTemplate

        public TaskProperties withLogTemplate​(String logTemplate)
        Set the logTemplate property: The template that describes the repository and tag information for run log artifact.
        Parameters:
        logTemplate - the logTemplate value to set.
        Returns:
        the TaskProperties object itself.
      • isSystemTask

        public Boolean isSystemTask()
        Get the isSystemTask property: The value of this property indicates whether the task resource is system task or not.
        Returns:
        the isSystemTask value.
      • withIsSystemTask

        public TaskProperties withIsSystemTask​(Boolean isSystemTask)
        Set the isSystemTask property: The value of this property indicates whether the task resource is system task or not.
        Parameters:
        isSystemTask - the isSystemTask value to set.
        Returns:
        the TaskProperties object itself.
      • validate

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