Struct JobBuilder

Source

pub struct JobBuilder { /* private fields */ }

Expand description

Builder for serial JobCreateRequest pipelines.

For linear jobs, use the fluent task shorthands and let the SDK wire each task to the previous task.

use cloudconvert_sdk::{FileExtension, JobCreateRequest};

let request = JobCreateRequest::linear()
    .import_url("https://example.test/input.docx")
    .convert(FileExtension::Pdf)
    .export_url()
    .build();

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

Use *_with(...) methods when a task needs options. Use JobCreateRequest::graph when a later task needs a handle to a specific earlier task.

Implementations§

Source §

impl JobBuilder

Source

pub fn new() -> Self

Creates an empty job builder.

Source

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

Sets an optional job tag.

Source

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

Sets the webhook URL CloudConvert should call for this job.

Source

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

Sets whether CloudConvert should redirect on synchronous job completion.

Source

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

Adds a custom top-level job field.

Source

pub fn task(self, name: impl Into<String>, task: impl Into<TaskRequest>) -> Self

Adds a task with an explicit CloudConvert task name.

This keeps compatibility with CloudConvert’s keyed task object and with existing code that already depends on task names.

Source

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

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

Generated names are derived from the task operation, such as import-url, convert, or export-url. Duplicate operation names get numeric suffixes.

use cloudconvert_sdk::{ConvertTask, FileExtension, JobCreateRequest, TaskRequest};

let mut builder = JobCreateRequest::builder();
let import = builder.add_task(TaskRequest::import_url("https://example.test/input.docx"));
let convert = builder.add_task(ConvertTask::new(&import, FileExtension::Pdf));

assert_eq!(import.as_str(), "import-url");
assert_eq!(convert.as_str(), "convert");

Source

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

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

Source

pub fn import_url(self, url: impl Into<String>) -> Self

Appends an import/url task.

Source

pub fn import_upload(self) -> Self

Appends an import/upload task.

Source

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

Appends an import/base64 task.

Source

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

Appends an import/raw task.

Source

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

Appends an import/s3 task.

Source

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

Appends an import/azure/blob task.

Source

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

Appends an import/google-cloud-storage task.

Source

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

Appends an import/openstack task.

Source

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

Appends an import/sftp task.

Source

pub fn convert(self, output_format: impl Into<String>) -> Self

Appends a convert task using the previous task as input.

Source

pub fn convert_with_input_format( self, input_format: impl Into<String>, output_format: impl Into<String>, ) -> Self

Appends a convert task with an explicit input format.

Source

pub fn optimize(self) -> Self

Appends an optimize task using the previous task as input.

Source

pub fn watermark_text(self, text: impl Into<String>) -> Self

Appends a text watermark task using the previous task as input.

Source

pub fn watermark_image(self, image_task_name: impl Into<String>) -> Self

Appends an image watermark task using the previous task as input.

Source

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

Appends a capture-website task.

Source

pub fn thumbnail(self, output_format: impl Into<String>) -> Self

Appends a thumbnail task using the previous task as input.

Source

pub fn metadata(self) -> Self

Appends a metadata task using the previous task as input.

Source

pub fn metadata_write(self) -> Self

Appends a metadata/write task using the previous task as input.

Source

pub fn merge(self, output_format: impl Into<String>) -> Self

Appends a merge task using the previous task as input.

Source

pub fn archive(self, output_format: impl Into<String>) -> Self

Appends an archive task using the previous task as input.

Source

pub fn command( self, engine: impl Into<String>, command: impl Into<String>, arguments: impl Into<String>, ) -> Self

Appends a command task using the previous task as input.

Source