Apex Reference Guide
jNote: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
ConnectApi.EgressPropertiesInput
Represents the input details for egress properties of the activation target.
| Property | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| childFolder | String | Path of the child folder. The child folder is created in the parent directory for copying activation files. | Optional | 60.0 |
| customFilename | String | Custom name of the output file. Either customFilename or predeterminedFilename must be present. | Optional | 60.0 |
| fileNameType | EgressFileNameTypeEnum |
Type of egress file name.
|
Required | 60.0 |
| filenameDateSuffixFormat | String | Date suffix format for the output file name. Use the format yyyy-MM-dd-HH-mm-ss or yyyy-MM-dd-HH-mm-ss-SSS. | Required | 60.0 |
| isSubfolderCreationEnabled | Boolean | Indicates whether subfolder creation is enabled (true) or not (false). If true, a custom subfolder is created. The default is false. | Optional | 60.0 |
| outputCompressionFormat | CompressionFormatEnum |
Compression format for the output file.
|
Required | 60.0 |
| outputDelimiter | FileDelimiterEnum |
Field delimiter for the output file.
|
Required | 60.0 |
| outputFormat | String | Output format for the activation target. | Required | 60.0 |
| outputMaxFileSizeMegaBytes | Long | Maximum size of the output file in megabytes from 1 through 500. | Required | 60.0 |
| outputMaxRecordsPerFile | Long | Maximum number of records in the output file from 1 through 100000. | Required | 60.0 |
| predeterminedFilename | PreDeterminedFileNameEnum |
Predetermined name of the output file. Either customFilename or predeterminedFilename must be present.
|
Optional | 60.0 |