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

Parent Type 

This type extends Metadata and inherits its fields.

File Suffix and Directory Location 

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

Version 

Introduced in API version 50.0.

Special Access Rules 

You need the Salesforce CustomizeApplication permission to access this object.

Fields 

areHeadersIncludedInFile 

• Type: boolean
• Required: No
• Description: If true, headers are included in the file if this is a single file stream.

bulkIngest 

• Type: boolean
• Required: No
• Description: If true, files are aggregated before data is ingested if the file names contain a wildcard. For example, profiles*.csv.

creationType 

• Type: DefinitionCreationType (enumeration of type string)
• Required: Yes

dataConnector 

• Type: string
• Required: Yes
• Description: Required. Describe whether this data stream definition was created by a customer or by an internal system.

dataConnectorType 

• Type: string (enumeration of type string)
• Required: No
• Description: The ingestion data source.
• Possible values:
  • ACCOUNTENGAGEMENT
  • AwsS3
  • AzureBlob
  • BIG_QUERY
  • CuratedEntity
  • DataCloud
  • ExternalPlatform
  • GoogleCloudStorage
  • IngestApi
  • REDSHIFT
  • SalesforceCommerceCloud
  • SalesforceDotCom
  • SalesforceInteractionStudio
  • SalesforceMarketingCloud
  • SFTP
  • Snowflake
  • StreamingApp
  • UPLOAD

dataExtensionIdentifier 

• Type: string
• Required: No
• Description: For a Marketing Cloud data extension, the unique identifier.

dataExtractField 

• Type: string
• Required: No
• Description: Name of the transport field that’s used when the extract method is CDC.

dataExtractMethods 

• Type: DataImportDataExtractMethods (enumeration of type string)
• Required: No
• Description: Describes how to identify the data to be extracted. Valid values include:
• Possible values:
  • DATETIME_CDC
  • FULL_REFRESH
  • NUMERIC_CDC
  • BINARY_CDC — (reserved for future use)

dataPlatDataSetBundle 

• Type: string
• Required: No
• Description: Identifies which data set bundle this definition was created from. Useful in cases where the same item can be configured across data connections.

dataPlatformDataSet 

• Type: string
• Required: No
• Description: The description is provided by the developer.

dataPlatformDataSetItemName 

• Type: string
• Required: No
• Description: Name of the Data Platform Set Item.

dataSource 

• Type: string
• Required: Yes
• Description: 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.

definitionCreationType 

• Type: string (enumeration of type string)

• Required: Yes

• Description: Required. Enum tracks the source of an object or field creation.

  Valid values available in API version 62.0 and later are:

  Valid values available in API version 67.0 and later are:

• Possible values:

  • Custom
  • Standard
  • ADG
  • Calculated_Insight
  • CG_Audience
  • Chunk
  • Directory_Table
  • External
  • Semantic
  • Transform
  • Vector_Embedding
  • Ad_Audience_Insights
  • Auxiliary
  • Clean_Room
  • Deletion_Records
  • Problem_Records

description 

• Type: string
• Required: No
• Description: Required. A description of the data stream definition.

fileNameWildcard 

• Type: string
• Required: No
• Description: File or wildcard (*) used when finding files.

internalOrganization 

• Type: string
• Required: No
• Description: The name of the internal organization.

isLimitedToNewFiles 

• Type: boolean
• Required: No
• Description: If true, file retrieval is limited to new files.

isMissingFileFailure 

• Type: boolean
• Required: No
• Description: If true, treat the case of missing files as a failure.

masterLabel 

• Type: string
• Required: Yes
• Description: Required. UI label for this data stream definition.

mktDataLakeObject 

• Type: string
• Required: Yes
• Description: Required. Reference to the landing entity (target) where data will be stored.

mktDataTranObject 

• Type: string
• Required: No
• Description: Reference to the object that’s used to transport information from the source to a landing entity (target).

parameters 

• Type: MktDataConnectionSrcParam[]
• Required: No

MktDataConnectionSrcParam Type 

Parent Type 

This type extends Metadata and inherits its fields.

Fields 

paramName 

• Type: string
• Required: Yes

value 

• Type: string
• Required: Yes