Struct JobCreateRequest 

pub struct JobCreateRequest { /* private fields */ }

Request body for POST /v2/jobs.

Use JobCreateRequest::linear for serial pipelines and JobCreateRequest::graph for branches or joins. Both builders generate the task names CloudConvert requires.

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"]["convert"]["input"], "import-url");

Implementations

impl JobCreateRequest

pub fn builder() -> JobBuilder

Starts a general-purpose job builder.

Prefer JobCreateRequest::linear for serial pipelines and JobCreateRequest::graph for branch or join jobs.

pub fn linear() -> JobBuilder

Starts a job builder for a serial task pipeline.

pub fn graph(configure: impl FnOnce(&mut JobGraphBuilder)) -> JobBuilder

Builds a job graph with task handles scoped to a closure.

Each graph method returns a TaskName that can be passed as the input for later tasks. The returned JobBuilder can still be used to set top-level job options before calling JobBuilder::build.

use cloudconvert_sdk::{FileExtension, JobCreateRequest};

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

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

pub fn tasks(&self) -> &BTreeMap<String, TaskRequest>

Returns the keyed task map that will be serialized as tasks.

pub fn tag(&self) -> Option<&str>

Returns the optional job tag.

pub fn webhook_url(&self) -> Option<&str>

Returns the optional webhook URL.

pub fn redirect(&self) -> Option<bool>

Returns whether CloudConvert should use redirect responses for the job.

pub fn extra(&self) -> &BTreeMap<String, Value>

Returns additional job fields set through JobBuilder::option.

Trait Implementations

impl Clone for JobCreateRequest

fn clone(&self) -> JobCreateRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for JobCreateRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for JobCreateRequest

fn default() -> JobCreateRequest

Returns the “default value” for a type.

impl From<JobBuilder> for JobCreateRequest

fn from(builder: JobBuilder) -> Self

Converts to this type from the input type.

impl From<JobGraphBuilder> for JobCreateRequest

fn from(builder: JobGraphBuilder) -> Self

Converts to this type from the input type.

impl Serialize for JobCreateRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.