Module Values.CreateJobRequestSource

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.

Sourcetype nonrec t = {
  1. farmId : FarmId.t;
    (*

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

    *)
  2. queueId : QueueId.t;
    (*

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

    *)
  3. clientToken : ClientToken.t option;
    (*

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

    *)
  4. template : JobTemplate.t option;
    (*

    The job template to use for this job.

    *)
  5. templateType : JobTemplateType.t option;
    (*

    The file type for the job template.

    *)
  6. priority : JobPriority.t;
    (*

    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.

    *)
  7. parameters : JobParameters.t option;
    (*

    The parameters for the job.

    *)
  8. attachments : Attachments.t option;
    (*

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

    *)
  9. storageProfileId : StorageProfileId.t option;
    (*

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

    *)
  10. targetTaskRunStatus : CreateJobTargetTaskRunStatus.t option;
    (*

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

    *)
  11. maxFailedTasksCount : MaxFailedTasksCount.t option;
    (*

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

    *)
  12. maxRetriesPerTask : MaxRetriesPerTask.t option;
    (*

    The maximum number of retries for each task.

    *)
  13. maxWorkerCount : MaxWorkerCount.t option;
    (*

    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.

    *)
  14. sourceJobId : JobId.t option;
    (*

    The job ID for the source job.

    *)
  15. nameOverride : JobName.t option;
    (*

    A custom name to override the job name derived from the job template.

    *)
  16. descriptionOverride : JobDescriptionOverride.t option;
    (*

    A custom description to override the job description derived from the job template.

    *)
  17. tags : Tags.t option;
    (*

    The tags to add to your job. Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

    *)
}
Sourceval context_ : string
Sourceval make : ?clientToken:??? -> ?template:??? -> ?templateType:??? -> ?parameters:??? -> ?attachments:??? -> ?storageProfileId:??? -> ?targetTaskRunStatus:??? -> ?maxFailedTasksCount:??? -> ?maxRetriesPerTask:??? -> ?maxWorkerCount:??? -> ?sourceJobId:??? -> ?nameOverride:??? -> ?descriptionOverride:??? -> ?tags:??? -> farmId:FarmId.t -> queueId:QueueId.t -> priority:JobPriority.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `Integer of JobPriority.t | `Map of ([> `String of JobParametersKeyString.t ] * [> `String of String_.t | `Structure of (string * [> `String of IntString.t ]) list ]) list | `String of FarmId.t | `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Enum of string | `List of [> `String of OutputRelativeDirectoriesListMemberString.t ] list | `String of FileSystemLocationName.t ]) list ] list ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t