Struct JobGraphBuilder

Source

pub struct JobGraphBuilder { /* private fields */ }

Expand description

Builder for branched CloudConvert job graphs.

JobGraphBuilder is usually used through JobCreateRequest::graph. Each task method appends one task and returns a TaskName handle that can be passed to later graph methods.

use cloudconvert_sdk::{FileExtension, JobCreateRequest};

let request = JobCreateRequest::graph(|job| {
    let imported = job.import_url("https://example.test/input.docx");
    let pdf = job.convert(&imported, FileExtension::Pdf);
    let png = job.convert(&imported, FileExtension::Png);
    job.export_url(vec![&pdf, &png]);
})
.build();

let payload = serde_json::to_value(request).unwrap();
assert_eq!(payload["tasks"]["export-url"]["input"], serde_json::json!(["convert", "convert-2"]));

Implementations§

Source §

impl JobGraphBuilder

Source

pub fn new() -> Self

Creates an empty graph builder.

Prefer JobCreateRequest::graph when the graph can be configured in a single closure.

Source

pub fn tag(&mut self, tag: impl Into<String>) -> &mut Self

Sets an optional job tag.

Source

pub fn webhook_url(&mut self, webhook_url: impl Into<String>) -> &mut Self

Sets the webhook URL CloudConvert should call for this job.

Source

pub fn redirect(&mut self, redirect: bool) -> &mut Self

Sets whether CloudConvert should redirect on synchronous job completion.

Source

pub fn option( &mut self, key: impl Into<String>, value: impl Into<Value>, ) -> &mut Self

Adds a custom top-level job field.

Source

pub fn add_task(&mut self, task: impl Into<TaskRequest>) -> TaskName

Adds a task with a generated task name and returns that name as a handle.

Source

pub fn add_named_task( &mut self, name: impl Into<String>, task: impl Into<TaskRequest>, ) -> TaskName

Adds a task with an explicit task name and returns that name as a handle.

Source

pub fn import_url(&mut self, url: impl Into<String>) -> TaskName

Adds an import/url task.

Source

pub fn import_url_with<F>( &mut self, url: impl Into<String>, configure: F, ) -> TaskName
where F: FnOnce(ImportUrlTask) -> ImportUrlTask,

Adds and configures an import/url task.

Source

pub fn import_upload(&mut self) -> TaskName

Adds an import/upload task.

Source

pub fn import_upload_with<F>(&mut self, configure: F) -> TaskName
where F: FnOnce(ImportUploadTask) -> ImportUploadTask,

Adds and configures an import/upload task.

Source

pub fn import_base64( &mut self, file: impl Into<String>, filename: impl Into<String>, ) -> TaskName

Adds an import/base64 task.

Source

pub fn import_raw( &mut self, file: impl Into<String>, filename: impl Into<String>, ) -> TaskName

Adds an import/raw task.

Source

pub fn import_s3( &mut self, bucket: impl Into<String>, region: impl Into<String>, access_key_id: impl Into<String>, secret_access_key: impl Into<String>, ) -> TaskName

Adds an import/s3 task.

Source

pub fn import_s3_with<F>( &mut self, bucket: impl Into<String>, region: impl Into<String>, access_key_id: impl Into<String>, secret_access_key: impl Into<String>, configure: F, ) -> TaskName
where F: FnOnce(S3ImportTask) -> S3ImportTask,

Adds and configures an import/s3 task.

Source

pub fn import_azure_blob( &mut self, storage_account: impl Into<String>, container: impl Into<String>, ) -> TaskName

Adds an import/azure/blob task.

Source

pub fn import_azure_blob_with<F>( &mut self, storage_account: impl Into<String>, container: impl Into<String>, configure: F, ) -> TaskName
where F: FnOnce(AzureBlobImportTask) -> AzureBlobImportTask,

Adds and configures an import/azure/blob task.

Source

pub fn import_google_cloud_storage( &mut self, project_id: impl Into<String>, bucket: impl Into<String>, client_email: impl Into<String>, private_key: impl Into<String>, ) -> TaskName

Adds an import/google-cloud-storage task.

Source

pub fn import_google_cloud_storage_with<F>( &mut self, project_id: impl Into<String>, bucket: impl Into<String>, client_email: impl Into<String>, private_key: impl Into<String>, configure: F, ) -> TaskName
where F: FnOnce(GoogleCloudStorageImportTask) -> GoogleCloudStorageImportTask,

Adds and configures an import/google-cloud-storage task.

Source

pub fn import_openstack( &mut self, auth_url: impl Into<String>, username: impl Into<String>, password: impl Into<String>, region: impl Into<String>, container: impl Into<String>, ) -> TaskName

Adds an import/openstack task.

Source

pub fn import_openstack_with<F>( &mut self, auth_url: impl Into<String>, username: impl Into<String>, password: impl Into<String>, region: impl Into<String>, container: impl Into<String>, configure: F, ) -> TaskName
where F: FnOnce(OpenStackImportTask) -> OpenStackImportTask,

Adds and configures an import/openstack task.

Source

pub fn import_sftp( &mut self, host: impl Into<String>, username: impl Into<String>, ) -> TaskName

Adds an import/sftp task.

Source

pub fn import_sftp_with<F>( &mut self, host: impl Into<String>, username: impl Into<String>, configure: F, ) -> TaskName
where F: FnOnce(SftpImportTask) -> SftpImportTask,

Adds and configures an import/sftp task.

Source

pub fn convert( &mut self, input: impl Into<Input>, output_format: impl Into<String>, ) -> TaskName

Adds a convert task.

Source

pub fn convert_with<F>( &mut self, input: impl Into<Input>, output_format: impl Into<String>, configure: F, ) -> TaskName
where F: FnOnce(ConvertTask) -> ConvertTask,

Adds and configures a convert task.

Source

pub fn optimize(&mut self, input: impl Into<Input>) -> TaskName

Adds an optimize task.

Source

pub fn optimize_with<F>( &mut self, input: impl Into<Input>, configure: F, ) -> TaskName
where F: FnOnce(OptimizeTask) -> OptimizeTask,

Adds and configures an optimize task.

Source

pub fn watermark_text( &mut self, input: impl Into<Input>, text: impl Into<String>, ) -> TaskName

Adds a text watermark task.

Source

pub fn watermark_text_with<F>( &mut self, input: impl Into<Input>, text: impl Into<String>, configure: F, ) -> TaskName
where F: FnOnce(WatermarkTask) -> WatermarkTask,

Adds and configures a text watermark task.

Source

pub fn watermark_image( &mut self, input: impl Into<Input>, image_task_name: impl Into<String>, ) -> TaskName

Adds an image watermark task.

Source

pub fn watermark_image_with<F>( &mut self, input: impl Into<Input>, image_task_name: impl Into<String>, configure: F, ) -> TaskName
where F: FnOnce(WatermarkTask) -> WatermarkTask,

Adds and configures an image watermark task.

Source

pub fn capture_website( &mut self, url: impl Into<String>, output_format: impl Into<String>, ) -> TaskName

Adds a capture-website task.

Source

pub fn capture_website_with<F>( &mut self, url: impl Into<String>, output_format: impl Into<String>, configure: F, ) -> TaskName
where F: FnOnce(CaptureWebsiteTask) -> CaptureWebsiteTask,

Adds and configures a capture-website task.

Source

pub fn thumbnail( &mut self, input: impl Into<Input>, output_format: impl Into<String>, ) -> TaskName

Adds a thumbnail task.

Source

pub fn thumbnail_with<F>( &mut self, input: impl Into<Input>, output_format: impl Into<String>, configure: F, ) -> TaskName
where F: FnOnce(ThumbnailTask) -> ThumbnailTask,

Adds and configures a thumbnail task.

Source

pub fn metadata(&mut self, input: impl Into<Input>) -> TaskName

Adds a metadata task.

Source

pub fn metadata_with<F>( &mut self, input: impl Into<Input>, configure: F, ) -> TaskName
where F: FnOnce(MetadataTask) -> MetadataTask,

Adds and configures a metadata task.

Source

pub fn metadata_write(&mut self, input: impl Into<Input>) -> TaskName

Adds a metadata/write task.

Source

pub fn metadata_write_with<F>( &mut self, input: impl Into<Input>, configure: F, ) -> TaskName
where F: FnOnce(MetadataWriteTask) -> MetadataWriteTask,

Adds and configures a metadata/write task.

Source

pub fn merge( &mut self, input: impl Into<Input>, output_format: impl Into<String>, ) -> TaskName

Adds a merge task.

Source

pub fn merge_with<F>( &mut self, input: impl Into<Input>, output_format: impl Into<String>, configure: F, ) -> TaskName
where F: FnOnce(MergeTask) -> MergeTask,

Adds and configures a merge task.

Source

pub fn archive( &mut self, input: impl Into<Input>, output_format: impl Into<String>, ) -> TaskName

Adds an archive task.

Source

pub fn archive_with<F>( &mut self, input: impl Into<Input>, output_format: impl Into<String>, configure: F, ) -> TaskName
where F: FnOnce(ArchiveTask) -> ArchiveTask,

Adds and configures an archive task.

Source

pub fn command( &mut self, input: impl Into<Input>, engine: impl Into<String>, command: impl Into<String>, arguments: impl Into<String>, ) -> TaskName

Adds a command task.

Source

pub fn command_with<F>( &mut self, input: impl Into<Input>, engine: impl Into<String>, command: impl Into<String>, arguments: impl Into<String>, configure: F, ) -> TaskName
where F: FnOnce(CommandTask) -> CommandTask,

Adds and configures a command task.

Source