Interface JobsApiJobsRetrieveDatasetRequest

Request parameters for jobsRetrieveDataset operation in JobsApi.

Export

JobsApiJobsRetrieveDatasetRequest

Hierarchy

  • JobsApiJobsRetrieveDatasetRequest

Properties

action? cloudStorageId? filename? format id location? useDefaultLocation?

Properties

Optional Readonly action

action?: "download"

Used to start downloading process after annotation file had been created

Memberof

JobsApiJobsRetrieveDataset

Optional Readonly cloudStorageId

cloudStorageId?: number

Storage id

Memberof

JobsApiJobsRetrieveDataset

Optional Readonly filename

filename?: string

Desired output file name

Memberof

JobsApiJobsRetrieveDataset

Readonly format

format: string

Desired output format name You can get the list of supported formats at: /server/annotation/formats

Memberof

JobsApiJobsRetrieveDataset

Readonly id

id: number

A unique integer value identifying this job.

Memberof

JobsApiJobsRetrieveDataset

Optional Readonly location

location?: JobsRetrieveDatasetLocationEnum

Where need to save downloaded dataset

Memberof

JobsApiJobsRetrieveDataset

Optional Readonly useDefaultLocation

useDefaultLocation?: boolean

Use the location that was configured in the task to export dataset

Memberof

JobsApiJobsRetrieveDataset

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc