Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateExportRequestDetails

Details of export request. Export is supported using three ways. First, when objectKeys are provided, export of those objects take place. Second, when filter are provided, all the objects based on the filter provided are exported. Third, when neither objectKeys nor filters are provided, we export all the design objects for the workspace.

Properties

Optional areReferencesIncluded

areReferencesIncluded: undefined | false | true

This field controls if the references will be exported along with the objects

bucketName

bucketName: string

Name of the Object Storage bucket where the object will be exported.

Optional fileName

fileName: undefined | string

Name of the exported zip file.

Optional filters

filters: Array<string>

Filters for exported objects

Optional isObjectOverwriteEnabled

isObjectOverwriteEnabled: undefined | false | true

Flag to control whether to overwrite the object if it is already present at the provided object storage location.

Optional objectKeys

objectKeys: Array<string>

Field is used to specify which object keys to export

Optional objectStorageRegion

objectStorageRegion: undefined | string

Region of the object storage (if using object storage of different region)

Optional objectStorageTenancyId

objectStorageTenancyId: undefined | string

Optional parameter to point to object storage tenancy (if using Object Storage of different tenancy)

Functions

getDeserializedJsonObj

getJsonObj