--- schema_version: "1" id: f1e54187713f4b75b97e26f56b30b92c81f6cb11194e691919c4011f7c555c65 title: DataStreamDefinition collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_datastreamdefinition.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_datastreamdefinition.htm source_site: developer.salesforce.com content_type: documentation content_hash: 6eed59ccf2c250c12fbf0ecac2aee28c820a0b10d9c6ce4f5329b6f613789b60 description: Contains data ingestion information such as connection, API, and file retrieval settings. --- # DataStreamDefinition Contains data ingestion information such as connection, API, and file retrieval settings. ![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png) #### Important 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. ## 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 If true, headers are included in the file if this is a single file stream.
bulkIngest boolean If true, files are aggregated before data is ingested if the file names contain a wildcard. For example, profiles*.csv.
definitionCreationType string Required. Enum tracks the source of an object or field creation. Valid values are:
  • Custom
  • Standard

Valid values available in API version 62.0 and later are:

  • ADG
  • Calculated_Insight
  • CG_Audience
  • Chunk
  • Directory_Table
  • External
  • Semantic
  • Transform
  • Vector_Embedding

Valid values available in API version 67.0 and later are:

  • Ad_Audience_Insights
  • Auxiliary
  • Clean_Room
  • Deletion_Records
  • Problem_Records
dataConnector string Required. Describe whether this data stream definition was created by a customer or by an internal system.
dataConnectorType DataConnectorType (enumeration of type string) The ingestion data source. Valid values are:
  • ACCOUNTENGAGEMENT
  • AwsS3
  • AzureBlob
  • BIG_QUERY
  • CuratedEntity
  • DataCloud
  • ExternalPlatform
  • GoogleCloudStorage
  • IngestApi
  • REDSHIFT
  • SalesforceCommerceCloud
  • SalesforceDotCom
  • SalesforceInteractionStudio
  • SalesforceMarketingCloud
  • SFTP
  • Snowflake
  • StreamingApp
  • UPLOAD
dataExtensionIdentifier string For a Marketing Cloud data extension, the unique identifier.
dataExtractField string Name of the transport field that’s used when the extract method is CDC.
dataExtractMethods DataImportDataExtractMethods (enumeration of type string) Describes how to identify the data to be extracted. Valid values include:
  • DATETIME_CDC
  • FULL_REFRESH
  • NUMERIC_CDC
  • BINARY_CDC (reserved for future use)
dataPlatDataSetBundle string Identifies which data set bundle this definition was created from. Useful in cases where the same item can be configured across data connections.
dataPlatformDataSet string The description is provided by the developer.
dataPlatformDataSetItemName string Name of the Data Platform Set Item.
dataSource string Required. A reference to the data source from which the data originated. This is usually the API name or a unique system identifier, such as the enterprise ID (EID) of the customer in the format MC_<EID>. Example: MCEnterprise or MC_12345.
description string Required. A description of the data stream definition.
fileNameWildcard string File or wildcard (*) used when finding files.
internalOrganization string The name of the internal organization.
isLimitedToNewFiles boolean If true, file retrieval is limited to new files.
isMissingFileFailure boolean 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.
mktDataTranObject string Reference to the object that’s used to transport information from the source to a landing entity (target).