ExportProperties interface
The properties of the export.
- Extends
Properties
| schedule | Has schedule information for the export. |
Inherited Properties
| compression |
Allow customers to select compress data for exports. This setting will enable destination file compression scheme at runtime. By default set to None. Gzip is for csv and snappy for parquet. |
| data |
Allow customers to select overwrite data(OverwritePreviousReport) for exports. This setting will enable overwrite data for the same month in customer storage account. By default set to CreateNewReport. |
| definition | Has the definition for the export. |
| delivery |
Has delivery information for the export. |
| export |
The export description set by customer at time of export creation/update. |
| format | The format of the export being delivered. |
| next |
If the export has an active schedule, provides an estimate of the next run time. |
| partition |
If set to true, exported data will be partitioned by size and placed in a blob directory together with a manifest file. |
| run |
If requested, has the most recent run history for the export. |
| system |
The export suspension reason if export is in SystemSuspended state. This is not populated currently. |
Property Details
schedule
Inherited Property Details
compressionMode
Allow customers to select compress data for exports. This setting will enable destination file compression scheme at runtime. By default set to None. Gzip is for csv and snappy for parquet.
compressionMode?: string
Property Value
string
Inherited From CommonExportProperties.compressionMode
dataOverwriteBehavior
Allow customers to select overwrite data(OverwritePreviousReport) for exports. This setting will enable overwrite data for the same month in customer storage account. By default set to CreateNewReport.
dataOverwriteBehavior?: string
Property Value
string
Inherited From CommonExportProperties.dataOverwriteBehavior
definition
Has the definition for the export.
definition: ExportDefinition
Property Value
Inherited From CommonExportProperties.definition
deliveryInfo
Has delivery information for the export.
deliveryInfo: ExportDeliveryInfo
Property Value
Inherited From CommonExportProperties.deliveryInfo
exportDescription
The export description set by customer at time of export creation/update.
exportDescription?: string
Property Value
string
Inherited From CommonExportProperties.exportDescription
format
The format of the export being delivered.
format?: string
Property Value
string
Inherited From CommonExportProperties.format
nextRunTimeEstimate
If the export has an active schedule, provides an estimate of the next run time.
nextRunTimeEstimate?: Date
Property Value
Date
Inherited From CommonExportProperties.nextRunTimeEstimate
partitionData
If set to true, exported data will be partitioned by size and placed in a blob directory together with a manifest file.
partitionData?: boolean
Property Value
boolean
Inherited From CommonExportProperties.partitionData
runHistory
If requested, has the most recent run history for the export.
runHistory?: ExportExecutionListResult
Property Value
Inherited From CommonExportProperties.runHistory
systemSuspensionContext
The export suspension reason if export is in SystemSuspended state. This is not populated currently.
systemSuspensionContext?: ExportSuspensionContext
Property Value
Inherited From CommonExportProperties.systemSuspensionContext