Click or drag to resize

IBatchHubService Methods

The IBatchHubService type exposes the following members.

Methods
  NameDescription
Public methodBatchHubCreateFileContent
Creates a file content record. Use the resulting URLs to upload the file content to the vault. Then use the file content UUID to add an attachment with the uploaded file content. The provided URLs are for immediate use and will expire within one day.
Public methodBatchHubGetVaults
Retrieves all available vaults.
Public methodBatchJobAddAttachment
Adds a named attachment to the job. If an attachment with the same name already exists, it will be replaced.
Public methodBatchJobAddDependencies
Adds dependencies to a job.
Public methodBatchJobAppendLog
Appends text to the batch job log.
Public methodBatchJobComplete
Declare job as completed by a batch worker.
Public methodBatchJobCreate
Creates a batch job definition.
Public methodBatchJobDeactivate
Deactivates a job.
Public methodBatchJobDelete
Deletes a batch job.
Public methodBatchJobGetAttachments
Gets information about the attachments of the job.
Public methodBatchJobGetAttachmentUrl
Retrieves the URL (HTTP/S GET) for a batch job attachment. This method fails if the attachment is not stored in an HTTP/S Vault.
Public methodBatchJobGetDetails
Retrieves detail information for a batch job.
Public methodBatchJobGetList
Retrieves a filtered list of jobs.
Public methodBatchJobGetProperties
Retrieves batch job property values.
Public methodBatchJobGetTableProperties
Retrieves batch job table property values.
Public methodBatchJobQuery
Performs a batch job (search) query with specified filter criteria and returns specified fields of the query result.
Public methodBatchJobReadAttachment
Retrieves the content of a batch job attachment.
Public methodBatchJobReadLog
Reads text from the batch job log.
Public methodBatchJobReceive
Receives job from queue to be processed by a batch worker.
Public methodBatchJobReprioritize
Reprioritizes a job.
Public methodBatchJobResubmit
Resubmits an already processed or completed job.
Public methodBatchJobSetDescription
Updates the description of a job.
Public methodBatchJobSetProperties
Sets batch job property values.
Public methodBatchJobSetTableProperties
Sets batch job property values.
Public methodBatchJobSubmit
Submits a batch job to the processing queue. Use this method to submit an inactive job that has been created with the 'deferred submit' option.
Public methodBatchJobSwitchLane
Switches a job to another lane.
Public methodBatchQueueGetList
Retrieves all available queues.
Public methodBatchQueueGetPropertyTemplate
Retrieves list of all properties available for the specified queue.
Public methodBatchQueueGetTablePropertyTemplateRow
Retrieves a template row that contains all table properties available for the specified queue.
Public methodBatchWorkerGetList
Retrieves the list of workers.
Public methodBatchWorkerNotify
Updates the LastActive timestamp of the worker. Use this method while processing a long-running batch job to keep the health status of the worker green.
Top
See Also