DataStreamDefinition

Contains Data Ingestion information such as Connection, API and File retrieval settings.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

File Suffix and Directory Location

DataStreamDefinition components have the suffix dataStreamDefinition and are stored in the dataStreamDefinitions folder.

Version

DataStreamDefinition components are available in API version 50.0 and later.

Special Access Rules

You need the Salesforce CustomizeApplication permission to access this object.

Fields

Field Name	Field Type	Description
areHeadersIncludedInFile	boolean	Optional. If true, headers are included in file if this is a single file stream.
definitionCreationType	string	Required. Enum tracks the source of an object or field creation. Valid values include: `Standard` `Custom`
dataConnector	string	Optional. Describe whether this data stream definition was created by a customer or by an internal system.
dataConnectorType	DataConnectorType	Required. The type of source from where the data is being ingested (MC, S3, or file upload).
dataExtractField	string	Optional: Name of the transport field that is to be used when the Extract Method is CDC.
dataExtractMethods	DataImportDataExtractMethods	Optional. Describe how to identify the data to be extracted. FULL_REFRESH, NUMERIC_CDC, or DATETIME_CDC
dataPlatDataSetBundle	string	Optional. Allows easy identification of which Data Set Bundle this was created from. Useful in cases where the same item can be configured across Data Connections.
dataPlatformDataSet	string	Optional. The description is provided by the developer.
dataPlatformDataSetItemName	string	Optional. Name of the Data Platform Set Item.
dataSource	string	Required: Reference to the Data Source from which the data originated, such as the name of a CRM Org. Example: MC Enterprise.
description	string	Required. A description of the Data Stream Definition.
isLimitedToNewFiles	boolean	Optional. If true, file retrieval is limited to new files.
isMissingFileFailure	boolean	Optional. If true, treat the case of missing files as a failure.
masterLabel	string	Required. UI label for this Data Stream Definition.
mktDataLakeObject	string	Required. Reference to the Landing Entity (target) where data will be stored.

DataConnectorType

This is an enum subtype for DataStreamDefinition.

Field Name	Field Type	Description
dataConnectorType	string	Required. List of supported Data Connectors: `SalesforceMarketingCloud` `MobileApp` `SalesforceDotCom` `AmazonS3`

DataImportDataExtractMethods

This is an enum subtype to DataStreamDefinition.

Field Name	Field Type	Description
dataImportDataExtractMethods	string	Required. Data Ingestion refresh options. Valid values include: `FULL_REFRESH` `NUMERIC_CDC` `DATETIME_CDC`

Metadata API Developer Guide