IBatchHubServiceBatchJobCreate Method |
Creates a batch job definition.
Namespace:
PDTec.IceNet.Domain.BatchHub.Service.Interface
Assembly:
PDTec.IceNet.Domain.BatchHub (in PDTec.IceNet.Domain.BatchHub.dll) Version: 7.2.0.0 (7.2.7583.15464)
Syntax ServiceResult BatchJobCreate(
string queueName,
long lane,
string description,
BatchJobPriority priority,
string submittedBy,
BatchJobPropertyInfo[] properties,
BatchJobTablePropertyRowInfo[] tablePropertyRows,
string[] dependencies,
BatchJobAttachmentCreateInfo[] attachments,
bool deferSubmit,
out BatchJobInfo job
)
Parameters
- queueName
- Type: SystemString
The queue name. - lane
- Type: SystemInt64
The lane number. Set the lane number to 0 if the queue does not have multiple lanes. - description
- Type: SystemString
The job description. - priority
- Type: PDTec.IceNet.Domain.BatchHub.Service.InterfaceBatchJobPriority
The job priority. - submittedBy
- Type: SystemString
The user that has submitted the batch job. If the job is created inactive (deferred submit) this parameter defines the user that created the job. - properties
- Type: PDTec.IceNet.Domain.BatchHub.Service.InterfaceBatchJobPropertyInfo
A list of property values to be set. Request a property template to get all available properties for the queue. - tablePropertyRows
- Type: PDTec.IceNet.Domain.BatchHub.Service.InterfaceBatchJobTablePropertyRowInfo
A list of table property rows to be set. Request a property row template to get all available properties for the queue. - dependencies
- Type: SystemString
The IDs of jobs that must be completed successfully before this job can be processed. - attachments
- Type: PDTec.IceNet.Domain.BatchHub.Service.InterfaceBatchJobAttachmentCreateInfo
The attachments (binary content) to be added to the batch job. - deferSubmit
- Type: SystemBoolean
Prevent job from being immediately submitted when created. - job
- Type: PDTec.IceNet.Domain.BatchHub.Service.InterfaceBatchJobInfo
The created batch job.
Return Value
Type:
ServiceResultThe service result status information.
See Also