Skip to main content

ExtractFilesJob

A zip file extraction job.

type ExtractFilesJob implements Job {
  id: ID!
  createdAt: DateTime!
  updatedAt: DateTime!
  lockedAt: DateTime
  completedAt: DateTime
  namespaceId: ID!
  namespace: Namespace!
  completed: Boolean!
  locked: Boolean!
  success: Boolean
  log: LogID
  logViewerURL: URL
  errors: [JobError!]!
  webhook: URL
  source: SourceData!
  files: [FileExtractionRule!]!
  destinations: [DestinationData!]
}

Fields​

ExtractFilesJob.id ● ID! non-null scalar​

The ID of the audio encoding job, as an URI.

ExtractFilesJob.createdAt ● DateTime! non-null scalar​

The date and time at which the job was first created.

ExtractFilesJob.updatedAt ● DateTime! non-null scalar​

The date and time at which the job was last updated.

ExtractFilesJob.lockedAt ● DateTime scalar​

Date and time at which the job was last locked

ExtractFilesJob.completedAt ● DateTime scalar​

Date and time at which the job was completed.

ExtractFilesJob.namespaceId ● ID! non-null scalar​

The namespace that owns the job.

ExtractFilesJob.namespace ● Namespace! non-null object​

The namespace that owns the job.

ExtractFilesJob.completed ● Boolean! non-null scalar​

Whether the job as been completed or not.

ExtractFilesJob.locked ● Boolean! non-null scalar​

Whether the job is locked or not.

ExtractFilesJob.success ● Boolean scalar​

Whether the job as been succesfully completed or not.

ExtractFilesJob.log ● LogID scalar​

ID for logging events related to this job.

ExtractFilesJob.logViewerURL ● URL scalar​

Get an URL to view the log.

ExtractFilesJob.errors ● [JobError!]! non-null interface​

List of errors occured during the execution of the job.

ExtractFilesJob.webhook ● URL scalar​

The URL to post a notification to when the job has finished.

ExtractFilesJob.source ● SourceData! non-null object​

The zip file source.

ExtractFilesJob.files ● [FileExtractionRule!]! non-null object​

Specifies the rules of extraction. A file will only be extracted using the first rule it matches and the rules will be applied in the order they appear in the array.

ExtractFilesJob.destinations ● [DestinationData!] list object​

When the job is succesfully completed, the extracted data.

Interfaces​

Job interface​

A unit of work managed by the audio service.