DataStreamTemplate

Represents the datastream that a user adds to a datakit.

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 the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

DataStreamTemplate components have the suffix .dataStreamTemplate and are stored in the dataStreamTemplates folder.

Version

DataStreamTemplate components are available in API version 53.0 and later.

Special Access Rules

You need the Salesforce Customize Application permission to access this metadata type.

Fields

Field Name Description
dataConnectionSourceParameters
Field Type
DataConnectionParamTmpl[]
Description
Input representation for the data connection source parameters.
dataSourceBundleDefinition
Field Type
string
Description
Required. Reference to the bundle to which this template belongs.
dataSourceObject
Field Type
string
Description
Required. Reference to the Data Source Objects (DSOs). A DSO represents the object from where the data was sourced
filterCriteria
Field Type
string
Description
Filter applied to the data stream before the information is sent to Data Cloud.
masterLabel
Field Type
string
Description
Required. Name assigned to the data stream template.
objectCategory
Field Type
string
Description
Required. Category of the Data Model Object (DMO).
refreshDayOfMonth
Field Type
int
Description
The duration of the day of the month after which the data stream must be refreshed.
refreshDayOfWeek
Field Type
int
Description
The duration of the day of the week after which the data stream must be refreshed.
refreshFrequency
Field Type
DataImportRefreshFrequency (enumeration of type string)
Description
The frequency with which the datastream must be refreshed. Possible values are:
  • Batch
  • NONE
  • MINUTES_15
  • MINUTES_30
  • MINUTES_5
  • HOURLY
  • DAILY
  • WEEKLY
  • MONTHLY
  • NOT_APPLICABLE
  • STREAMING
refreshHours
Field Type
string
Description
The duration after which the datastream must be refreshed.
refreshMode
Field Type
DataImportRefreshMode (enumeration of type string)
Description
The mode of refresh. Possible values are:
  • FULL_REFRESH
  • UPSERT
  • INCREMENTAL
  • REPLACE
  • NEAR_REAL_TIME_INCREMENTAL
  • STREAMING

Wildcard Support in the Manifest File

This metadata type doesn’t support the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.