DataStreamTemplate

Represents metadata about the data stream that a user adds to a data kit.

Version 

Introduced in API version 53.0.

Supported SOAP API Calls 

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Special Access Rules 

• You need permission to access this object.

Fields 

DataSourceBundleDefinitionId 

• Type: reference

• Required: No

• Properties: Filter, Group, Sort

• Description: The ID of the DataSourceBundleDefinition, which refers to the data stream bundle to which a data stream template belongs.

This field is a relationship field.

• Relationship name: DataSourceBundleDefinition
• Relationship type: relationship
• Refers to: DataSourceBundleDefinition

DataSourceObjectId 

• Type: reference

• Required: No

• Properties: Filter, Group, Sort

• Description: The ID of the DataSourceObject, which represents the object from where the data was sourced.

This field is a relationship field.

• Relationship name: DataSourceObject
• Relationship type: relationship
• Refers to: DataSourceObject

DeveloperName 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: Unique name for the data stream template. Identical value to FullName.

FilterCriteria 

• Type: textarea

• Required: No

• Properties: Nillable

• Introduced: API version 52.0

• Description: Describes the filter applied to the data stream before the information is sent to .

FullName 

• Type: string

• Required: No

• Properties: Create, Group, Nillable

• Introduced: API version 53.0

• Description: The full name of the associated metadata object in Metadata API.

FullRefreshIntervalDays 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Introduced: API version 64.0

• Possible values:

  • NONE — None

  • DAYS_10 — 10 Days

  • DAYS_25 — 25 Days

  • DAYS_50 — 50 Days

Language 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

• Description: Languages supported in the deployment.

• Possible values:

  • en_US — English

  • de — German

  • es — Spanish

  • fr — French

  • it — Italian

  • ja — Japanese

  • sv — Swedish

  • ko — Korean

  • zh_TW — Chinese (Traditional)

  • zh_CN — Chinese (Simplified)

  • pt_BR — Portuguese (Brazil)

  • nl_NL — Dutch

  • da — Danish

  • th — Thai

  • fi — Finnish

  • ru — Russian

  • es_MX — Spanish (Mexico)

  • no — Norwegian

  • af — af — Afrikaans

  • am — am — Amharic

  • ar — ar — Arabic

  • ar_AE — ar_AE — Arabic (United Arab Emirates)

  • ar_BH — ar_BH — Arabic (Bahrain)

  • ar_DZ — ar_DZ — Arabic (Algeria)

  • ar_EG — ar_EG — Arabic (Egypt)

  • ar_IQ — ar_IQ — Arabic (Iraq)

  • ar_JO — ar_JO — Arabic (Jordan)

  • ar_KW — ar_KW — Arabic (Kuwait)

  • ar_LB — ar_LB — Arabic (Lebanon)

  • ar_LY — ar_LY — Arabic (Libya)

  • ar_MA — ar_MA — Arabic (Morocco)

  • ar_OM — ar_OM — Arabic (Oman)

  • ar_QA — ar_QA — Arabic (Qatar)

  • ar_SA — ar_SA — Arabic (Saudi Arabia)

  • ar_SD — ar_SD — Arabic (Sudan)

  • ar_SY — ar_SY — Arabic (Syria)

  • ar_TN — ar_TN — Arabic (Tunisia)

  • ar_YE — ar_YE — Arabic (Yemen)

  • bg — bg — Bulgarian

  • bn — bn — Bengali

  • bs — bs — Bosnian

  • ca — ca — Catalan

  • cac — cac — Chuj

  • cak — cak — Kaqchikel

  • cs — cs — Czech

  • cy — cy — Welsh

  • de_AT — de_AT — German (Austria)

  • de_BE — de_BE — German (Belgium)

  • de_CH — de_CH — German (Switzerland)

  • de_LI — de_LI — German (Liechtenstein)

  • de_LU — de_LU — German (Luxembourg)

  • el — el — Greek

  • el_CY — el_CY — Greek (Cyprus)

  • en_AD — en_AD — English (Andorra)

  • en_AE — en_AE — English (United Arab Emirates)

  • en_AG — en_AG — English (Antigua and Barbuda)

  • en_AL — en_AL — English (Albania)

  • en_AT — en_AT — English (Austria)

  • en_AU — en_AU — English (Australian)

  • en_BA — en_BA — English (Bosnia and Herzegovina)

  • en_BB — en_BB — English (Barbados)

  • en_BE — en_BE — English (Belgium)

  • en_BG — en_BG — English (Bulgaria)

  • en_BS — en_BS — English (Bahamas)

  • en_BZ — en_BZ — English (Belize)

  • en_CA — en_CA — English (Canadian)

  • en_CH — en_CH — English (Switzerland)

  • en_CY — en_CY — English (Cyprus)

  • en_CZ — en_CZ — English (Czechia)

  • en_DE — en_DE — English (Germany)

  • en_DK — en_DK — English (Denmark)

  • en_DM — en_DM — English (Dominica)

  • en_EE — en_EE — English (Estonia)

  • en_ES — en_ES — English (Spain)

  • en_FI — en_FI — English (Finland)

  • en_FR — en_FR — English (France)

  • en_GB — en_GB — English (UK)

  • en_GD — en_GD — English (Grenada)

  • en_GI — en_GI — English (Gibraltar)

  • en_GR — en_GR — English (Greece)

  • en_GY — en_GY — English (Guyana)

  • en_HK — en_HK — English (Hong Kong)

  • en_HR — en_HR — English (Croatia)

  • en_HU — en_HU — English (Hungary)

  • en_IE — en_IE — English (Ireland)

  • en_IL — en_IL — English (Israel)

  • en_IN — en_IN — English (Indian)

  • en_IS — en_IS — English (Iceland)

  • en_IT — en_IT — English (Italy)

  • en_JM — en_JM — English (Jamaica)

  • en_JP — en_JP — English (Japan)

  • en_KN — en_KN — English (St. Kitts and Nevis)

  • en_KR — en_KR — English (South Korea)

  • en_LC — en_LC — English (St. Lucia)

  • en_LI — en_LI — English (Liechtenstein)

  • en_LT — en_LT — English (Lithuania)

  • en_LU — en_LU — English (Luxembourg)

  • en_LV — en_LV — English (Latvia)

  • en_MC — en_MC — English (Monaco)

  • en_ME — en_ME — English (Montenegro)

  • en_MK — en_MK — English (North Macedonia)

  • en_MT — en_MT — English (Malta)

  • en_MY — en_MY — English (Malaysian)

  • en_NL — en_NL — English (Netherlands)

  • en_NO — en_NO — English (Norway)

  • en_NZ — en_NZ — English (New Zealand)

  • en_PH — en_PH — English (Phillipines)

  • en_PL — en_PL — English (Poland)

  • en_PT — en_PT — English (Portugal)

  • en_RO — en_RO — English (Romania)

  • en_RS — en_RS — English (Serbia)

  • en_SE — en_SE — English (Sweden)

  • en_SG — en_SG — English (Singapore)

  • en_SI — en_SI — English (Slovenia)

  • en_SK — en_SK — English (Slovakia)

  • en_TH — en_TH — English (Thailand)

  • en_TR — en_TR — English (Turkey)

  • en_TT — en_TT — English (Trinidad and Tobago)

  • en_TW — en_TW — English (Taiwan)

  • en_VC — en_VC — English (St. Vincent and the Grenadines)

  • en_ZA — en_ZA — English (South Africa)

  • eo — eo — Esperanto (Pseudo)

  • es_AD — es_AD — Spanish (Andorra)

  • es_AR — es_AR — Spanish (Argentina)

  • es_BO — es_BO — Spanish (Bolivia)

  • es_CL — es_CL — Spanish (Chile)

  • es_CO — es_CO — Spanish (Colombia)

  • es_CR — es_CR — Spanish (Costa Rica)

  • es_DO — es_DO — Spanish (Dominican Republic)

  • es_EC — es_EC — Spanish (Ecuador)

  • es_GT — es_GT — Spanish (Guatemala)

  • es_HN — es_HN — Spanish (Honduras)

  • es_NI — es_NI — Spanish (Nicaragua)

  • es_PA — es_PA — Spanish (Panama)

  • es_PE — es_PE — Spanish (Peru)

  • es_PR — es_PR — Spanish (Puerto Rico)

  • es_PY — es_PY — Spanish (Paraguay)

  • es_SV — es_SV — Spanish (El Salvador)

  • es_US — es_US — Spanish (United States)

  • es_UY — es_UY — Spanish (Uruguay)

  • es_VE — es_VE — Spanish (Venezuela)

  • et — et — Estonian

  • eu — eu — Basque

  • fa — fa — Farsi

  • fr_BE — fr_BE — French (Belgium)

  • fr_CA — fr_CA — French (Canadian)

  • fr_CH — fr_CH — French (Switzerland)

  • fr_HT — fr_HT — French (Haiti)

  • fr_LU — fr_LU — French (Luxembourg)

  • fr_MA — fr_MA — French (Morocco)

  • ga — ga — Irish

  • gu — gu — Gujarati

  • haw — haw — Hawaiian

  • hi — hi — Hindi

  • hmn — hmn — Hmong

  • hr — hr — Croatian

  • ht — ht — Haitian Creole

  • hu — hu — Hungarian

  • hy — hy — Armenian

  • in — in — Indonesian

  • is — is — Icelandic

  • it_CH — it_CH — Italian (Switzerland)

  • iw — iw — Hebrew

  • iw_EO — iw_EO — Esperanto RTL (Pseudo)

  • ji — ji — Yiddish

  • ka — ka — Georgian

  • kk — kk — Kazakh

  • kl — kl — Greenlandic

  • km — km — Khmer

  • kn — kn — Kannada

  • lb — lb — Luxembourgish

  • lt — lt — Lithuanian

  • lv — lv — Latvian

  • mi — mi — Te reo

  • mk — mk — Macedonian

  • ml — ml — Malayalam

  • mr — mr — Marathi

  • ms — ms — Malay

  • mt — mt — Maltese

  • my — my — Burmese

  • nl_BE — nl_BE — Dutch (Belgium)

  • nl_SR — nl_SR — Dutch (Suriname)

  • pa — pa — Punjabi

  • pl — pl — Polish

  • pt_PT — pt_PT — Portuguese (European)

  • quc — quc — Kiche

  • rm — rm — Romansh

  • ro — ro — Romanian

  • ro_MD — ro_MD — Romanian (Moldova)

  • ru_AM — ru_AM — Russian (Armenia)

  • ru_BY — ru_BY — Russian (Belarus)

  • ru_KG — ru_KG — Russian (Kyrgyzstan)

  • ru_KZ — ru_KZ — Russian (Kazakhstan)

  • ru_LT — ru_LT — Russian (Lithuania)

  • ru_MD — ru_MD — Russian (Moldova)

  • ru_PL — ru_PL — Russian (Poland)

  • ru_UA — ru_UA — Russian (Ukraine)

  • sh — sh — Serbian (Latin)

  • sh_ME — sh_ME — Montenegrin

  • sk — sk — Slovak

  • sl — sl — Slovene

  • sm — sm — Samoan

  • sq — sq — Albanian

  • sr — sr — Serbian (Cyrillic)

  • sv_FI — sv_FI — Swedish (Finland)

  • sw — sw — Swahili

  • ta — ta — Tamil

  • te — te — Telugu

  • tl — tl — Tagalog

  • tr — tr — Turkish

  • uk — uk — Ukrainian

  • ur — ur — Urdu

  • vi — vi — Vietnamese

  • xh — xh — Xhosa

  • zh_HK — zh_HK — Chinese (Hong Kong)

  • zh_MY — zh_MY — Chinese (Malaysia)

  • zh_SG — zh_SG — Chinese (Singapore)

  • zu — zu — Zulu

ManageableState 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Description: Indicates the state of an entity in a package.

• Possible values:

  • beta — beta — Managed-Beta

  • deleted — deleted — Managed-Proposed-Deleted

  • deprecated — deprecated — Managed-Proposed-Deprecated

  • deprecatedEditable — deprecatedEditable — SecondGen-Installed-Deprecated

  • installed — installed — Managed-Installed

  • installedEditable — installedEditable — SecondGen-Installed-Editable

  • released — released — Managed-Released

  • unmanaged — unmanaged

MasterLabel 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: Indicates the name of the bundle.

Metadata 

• Type: complexvalue

• Required: No

• Properties: Create, Nillable, Update

• Introduced: API version 53.0

• Description: Describes additional information that’s necessary for the data stream template.

NamespacePrefix 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: Namespace prefix associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix.

ObjectCategoryId 

• Type: ID
• Required: No
• Properties: Filter, Group, Nillable, Sort

RefreshDayOfMonth 

• Type: int

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The duration of the day of the month after which the data stream template must be refreshed.

RefreshDayOfWeek 

• Type: int

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The duration of the day of the week after which the data stream must be refreshed.

RefreshFrequency 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Description: The frequency with which the data stream must be refreshed.

• Possible values:

  • NONE — None

  • MINUTES_5 — 5 Minutes

  • MINUTES_15 — 15 Minutes

  • MINUTES_30 — 30 Minutes

  • HOURLY — Hourly

  • EVERY_4_HOURS — Every 4 Hours

  • EVERY_12_HOURS — Every 12 Hours

  • DAILY — Daily

  • WEEKLY — Weekly

  • MONTHLY — Monthly

  • NOT_APPLICABLE — Not Applicable

  • BATCH — Batch

  • STREAMING — Streaming

RefreshHours 

• Type: multipicklist

• Required: No

• Properties: Filter, Nillable

• Description: The duration after which the data stream template must be refreshed.

RefreshMode 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Description: The mode of refresh.

• Possible values:

  • FULL_REFRESH — Full Refresh

  • UPSERT — Upsert

  • INCREMENTAL — Incremental

  • PARTIAL_UPDATE — Partial Update

  • REPLACE — Replace By Date

  • NEAR_REAL_TIME_INCREMENTAL — Near Real-time Incremental

  • NOT_APPLICABLE — Not Applicable

RefreshStartDate 

• Type: date

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 62.0

• Description: The date to retrieve data based on the refresh frequency data.

SourceObjectName 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 61.0

• Description: The name of the source object from which data is streamed.

StreamType 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Introduced: API version 58.0

• Description: The type of data stream.

• Possible values:

  • INGEST — Ingest

  • DIRECT_ACCESS — Direct Access

  • DIRECT_ACCESS_ACCELERATED — Direct Access (Accelerated)

StreamingAppDataConnectorType 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Introduced: API version 63.0

• Description: The connector app for data streaming.

• Possible values:

  • MobileApp — Mobile App

  • WebApp — Web App

  • ServerApp — Server App

TemplateVersion 

• Type: int

• Required: No

• Properties: Defaulted on create, Filter, Group, Nillable, Sort

• Introduced: API version 61.0

• Description: The version number of the template.