Skip to content

/AWS1/IF_TBD=>CREATEJOB()

About CreateJob

Creates a job. A job is a set of instructions that Deadline Cloud uses to schedule and run work on available workers. For more information, see Deadline Cloud jobs.

Method Signature

METHODS /AWS1/IF_TBD~CREATEJOB
  IMPORTING
    !IV_FARMID TYPE /AWS1/TBDFARMID OPTIONAL
    !IV_QUEUEID TYPE /AWS1/TBDQUEUEID OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/TBDCLIENTTOKEN OPTIONAL
    !IV_TEMPLATE TYPE /AWS1/TBDJOBTEMPLATE OPTIONAL
    !IV_TEMPLATETYPE TYPE /AWS1/TBDJOBTEMPLATETYPE OPTIONAL
    !IV_PRIORITY TYPE /AWS1/TBDJOBPRIORITY OPTIONAL
    !IT_PARAMETERS TYPE /AWS1/CL_TBDJOBPARAMETER=>TT_JOBPARAMETERS OPTIONAL
    !IO_ATTACHMENTS TYPE REF TO /AWS1/CL_TBDATTACHMENTS OPTIONAL
    !IV_STORAGEPROFILEID TYPE /AWS1/TBDSTORAGEPROFILEID OPTIONAL
    !IV_TARGETTASKRUNSTATUS TYPE /AWS1/TBDCREJOBTGTTASKRUNSTAT OPTIONAL
    !IV_MAXFAILEDTASKSCOUNT TYPE /AWS1/TBDMAXFAILEDTASKSCOUNT OPTIONAL
    !IV_MAXRETRIESPERTASK TYPE /AWS1/TBDMAXRETRIESPERTASK OPTIONAL
    !IV_MAXWORKERCOUNT TYPE /AWS1/TBDMAXWORKERCOUNT OPTIONAL
    !IV_SOURCEJOBID TYPE /AWS1/TBDJOBID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_tbdcreatejobresponse
  RAISING
    /AWS1/CX_TBDACCESSDENIEDEX
    /AWS1/CX_TBDINTERNALSERVERER00
    /AWS1/CX_TBDRESOURCENOTFOUNDEX
    /AWS1/CX_TBDSERVICEQUOTAEXCDEX
    /AWS1/CX_TBDTHROTTLINGEX
    /AWS1/CX_TBDVALIDATIONEX
    /AWS1/CX_TBDCLIENTEXC
    /AWS1/CX_TBDSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_farmid TYPE /AWS1/TBDFARMID /AWS1/TBDFARMID

The farm ID of the farm to connect to the job.

iv_queueid TYPE /AWS1/TBDQUEUEID /AWS1/TBDQUEUEID

The ID of the queue that the job is submitted to.

iv_priority TYPE /AWS1/TBDJOBPRIORITY /AWS1/TBDJOBPRIORITY

The priority of the job. The highest priority (first scheduled) is 100. When two jobs have the same priority, the oldest job is scheduled first.

Optional arguments:

iv_clienttoken TYPE /AWS1/TBDCLIENTTOKEN /AWS1/TBDCLIENTTOKEN

The unique token which the server uses to recognize retries of the same request.

iv_template TYPE /AWS1/TBDJOBTEMPLATE /AWS1/TBDJOBTEMPLATE

The job template to use for this job.

iv_templatetype TYPE /AWS1/TBDJOBTEMPLATETYPE /AWS1/TBDJOBTEMPLATETYPE

The file type for the job template.

it_parameters TYPE /AWS1/CL_TBDJOBPARAMETER=>TT_JOBPARAMETERS TT_JOBPARAMETERS

The parameters for the job.

io_attachments TYPE REF TO /AWS1/CL_TBDATTACHMENTS /AWS1/CL_TBDATTACHMENTS

The attachments for the job. Attach files required for the job to run to a render job.

iv_storageprofileid TYPE /AWS1/TBDSTORAGEPROFILEID /AWS1/TBDSTORAGEPROFILEID

The storage profile ID for the storage profile to connect to the job.

iv_targettaskrunstatus TYPE /AWS1/TBDCREJOBTGTTASKRUNSTAT /AWS1/TBDCREJOBTGTTASKRUNSTAT

The initial job status when it is created. Jobs that are created with a SUSPENDED status will not run until manually requeued.

iv_maxfailedtaskscount TYPE /AWS1/TBDMAXFAILEDTASKSCOUNT /AWS1/TBDMAXFAILEDTASKSCOUNT

The number of task failures before the job stops running and is marked as FAILED.

iv_maxretriespertask TYPE /AWS1/TBDMAXRETRIESPERTASK /AWS1/TBDMAXRETRIESPERTASK

The maximum number of retries for each task.

iv_maxworkercount TYPE /AWS1/TBDMAXWORKERCOUNT /AWS1/TBDMAXWORKERCOUNT

The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.

You can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.

If you don't specify the maxWorkerCount, Deadline Cloud won't throttle the number of workers used to process the job.

iv_sourcejobid TYPE /AWS1/TBDJOBID /AWS1/TBDJOBID

The job ID for the source job.

RETURNING

oo_output TYPE REF TO /aws1/cl_tbdcreatejobresponse /AWS1/CL_TBDCREATEJOBRESPONSE

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->createjob(
  io_attachments = new /aws1/cl_tbdattachments(
    it_manifests = VALUE /aws1/cl_tbdmanifestproperties=>tt_manifestpropertieslist(
      (
        new /aws1/cl_tbdmanifestproperties(
          it_outputrelativedirectories = VALUE /aws1/cl_tbdoutrelativedirec00=>tt_outrelativedirectorieslist(
            ( new /aws1/cl_tbdoutrelativedirec00( |string| ) )
          )
          iv_filesystemlocationname = |string|
          iv_inputmanifesthash = |string|
          iv_inputmanifestpath = |string|
          iv_rootpath = |string|
          iv_rootpathformat = |string|
        )
      )
    )
    iv_filesystem = |string|
  )
  it_parameters = VALUE /aws1/cl_tbdjobparameter=>tt_jobparameters(
    (
      VALUE /aws1/cl_tbdjobparameter=>ts_jobparameters_maprow(
        value = new /aws1/cl_tbdjobparameter(
          iv_float = |string|
          iv_int = |string|
          iv_path = |string|
          iv_string = |string|
        )
        key = |string|
      )
    )
  )
  iv_clienttoken = |string|
  iv_farmid = |string|
  iv_maxfailedtaskscount = 123
  iv_maxretriespertask = 123
  iv_maxworkercount = 123
  iv_priority = 123
  iv_queueid = |string|
  iv_sourcejobid = |string|
  iv_storageprofileid = |string|
  iv_targettaskrunstatus = |string|
  iv_template = |string|
  iv_templatetype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_jobid = lo_result->get_jobid( ).
ENDIF.