Deadline Standalone Python Reference  10.2.1.1
Tasks.Tasks Class Reference

Public Member Functions

def CompleteJobTask (self, jobId, taskId)
 
def CompleteJobTasks (self, jobId, taskIds=None)
 
def FailJobTask (self, jobId, taskId)
 
def FailJobTasks (self, jobId, taskIds=None)
 
def GetJobTask (self, jobId, taskId)
 
def GetJobTaskIds (self, id)
 
def GetJobTasks (self, id)
 
def PendJobTask (self, jobId, taskId)
 
def PendJobTasks (self, jobId, taskIds)
 
def ReleasePendingJobTask (self, jobId, taskId)
 
def ReleasePendingJobTasks (self, jobId, taskIds)
 
def RequeueJobTask (self, jobId, taskId)
 
def RequeueJobTasks (self, jobId, taskIds=None)
 
def ResumeFailedJobTask (self, jobId, taskId)
 
def ResumeFailedJobTasks (self, jobId, taskIds)
 
def ResumeJobTask (self, jobId, taskId)
 
def ResumeJobTasks (self, jobId, taskIds=None)
 
def SuspendJobTask (self, jobId, taskId)
 
def SuspendJobTasks (self, jobId, taskIds=None)
 

Detailed Description

    Class used by DeadlineCon to send Task requests. 
    Stores the address of the Web Service for use in sending requests.

Member Function Documentation

◆ CompleteJobTask()

def Tasks.Tasks.CompleteJobTask (   self,
  jobId,
  taskId 
)
 Complete a Task.
    Input:  jobId: The Job ID.
            taskId: The Task ID.
    Returns: Success message.

◆ CompleteJobTasks()

def Tasks.Tasks.CompleteJobTasks (   self,
  jobId,
  taskIds = None 
)
 Complete multiple Tasks for a single Job.
    Input:  jobId: The Job ID.
            taskIds: The list of Task IDs.
    Returns: Success message.

◆ FailJobTask()

def Tasks.Tasks.FailJobTask (   self,
  jobId,
  taskId 
)
 Fail a Task.
    Input:  jobId: The Job ID.
            taskId: The Task ID.
    Returns: Success message.

◆ FailJobTasks()

def Tasks.Tasks.FailJobTasks (   self,
  jobId,
  taskIds = None 
)
 Fail multiple Tasks for a single Job.
    Input:  jobId: The Job ID.
            taskIds: The list of Task IDs.
    Returns: Success message.

◆ GetJobTask()

def Tasks.Tasks.GetJobTask (   self,
  jobId,
  taskId 
)
 Gets a specific Job Task.
    Input:  jobId: The Job ID.
            taskId: The Task ID.
    Returns: The Job's Task.

◆ GetJobTaskIds()

def Tasks.Tasks.GetJobTaskIds (   self,
  id 
)
 Gets the IDs of the Job's Tasks.
    Input:  id: The Job ID.
    Returns: The list of IDs.

◆ GetJobTasks()

def Tasks.Tasks.GetJobTasks (   self,
  id 
)
 Gets the Tasks for a Job.
    Input:  id: The Job ID.
    Returns: The Job's Task collection.

◆ PendJobTask()

def Tasks.Tasks.PendJobTask (   self,
  jobId,
  taskId 
)
 Pend a Task.
    Input:  jobId: The Job ID.
            taskId: The Task ID.
    Returns: Success message.

◆ PendJobTasks()

def Tasks.Tasks.PendJobTasks (   self,
  jobId,
  taskIds 
)
 Pend multiple Tasks for a single Job.
    Input:  jobId: The Job ID.
            taskIds: The Task IDs.
    Returns: Success message.

◆ ReleasePendingJobTask()

def Tasks.Tasks.ReleasePendingJobTask (   self,
  jobId,
  taskId 
)
 Release a pending Task.
    Input:  jobId: The Job ID.
            taskId: The Task ID.
    Returns: Success message.

◆ ReleasePendingJobTasks()

def Tasks.Tasks.ReleasePendingJobTasks (   self,
  jobId,
  taskIds 
)
 Release multiple pending Tasks for a single Job.
    Input:  jobId: The Job ID.
            taskIds: The Task IDs.
    Returns: Success message.

◆ RequeueJobTask()

def Tasks.Tasks.RequeueJobTask (   self,
  jobId,
  taskId 
)
 Requeues a Task.
    Input:  jobId: The Job ID.
            taskId: The Task ID.
    Returns: Success message.

◆ RequeueJobTasks()

def Tasks.Tasks.RequeueJobTasks (   self,
  jobId,
  taskIds = None 
)
 Requeues multiple Tasks for a single Job.
    Input:  jobId: The Job ID.
            taskIds: The list of Task IDs, if not supplied requeues all tasks for the job.
    Returns: Success message.

◆ ResumeFailedJobTask()

def Tasks.Tasks.ResumeFailedJobTask (   self,
  jobId,
  taskId 
)
 Resume a failed Task.
    Input:  jobId: The Job ID.
            taskId: The Task ID.
    Returns: Success message.

◆ ResumeFailedJobTasks()

def Tasks.Tasks.ResumeFailedJobTasks (   self,
  jobId,
  taskIds 
)
 Resume multiple failed Tasks for a single Job.
    Input:  jobId: The Job ID.
            taskIds: The list of Task IDs.
    Returns: Success message.

◆ ResumeJobTask()

def Tasks.Tasks.ResumeJobTask (   self,
  jobId,
  taskId 
)
 Resume a suspended Task.
    Input:  jobId: The Job ID.
            taskId: The Task ID.
    Returns: Success message.

◆ ResumeJobTasks()

def Tasks.Tasks.ResumeJobTasks (   self,
  jobId,
  taskIds = None 
)
 Resume multiple suspended Tasks for a single Job.
    Input:  jobId: The Job ID.
            taskIds: The list of Task IDs.
    Returns: Success message.

◆ SuspendJobTask()

def Tasks.Tasks.SuspendJobTask (   self,
  jobId,
  taskId 
)
 Suspend a Task.
    Input:  jobId: The Job ID.
            taskId: The Task ID.
    Returns: Success message.

◆ SuspendJobTasks()

def Tasks.Tasks.SuspendJobTasks (   self,
  jobId,
  taskIds = None 
)
 Suspend multiple Tasks for a single Job.
    Input:  jobId: The Job ID.
            taskIds: The list of Task IDs.
    Returns: Success message.