DataSourceBundleDefinition

Represents the bundle of streams that a user adds to a data kit.

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 

DataSourceBundleDefinition components have the suffix .dataSourceBundleDefinition and are stored in the dataSourceBundleDefinitions folder.

Version 

Introduced in API version 52.0.

Special Access Rules 

You need permission to access this object.

Fields 

bundleVersion 

  • Type: int
  • Required: No
  • Introduced: API version 63.0
  • Description: Indicates the version of the bundle.

dataPlatform 

  • Type: string
  • Required: Yes
  • Description: Required. Indicates the connector type that the streams in the bundle belong to.

description 

  • Type: string
  • Required: No
  • Introduced: API version 53.0
  • Description: A description of the associated data source bundle.

icon 

  • Type: string
  • Required: No
  • Introduced: API version 53.0
  • Description: The icon used in the deployment flow.

isMultiDeploymentSupported 

  • Type: boolean
  • Required: No
  • Description: Indicates if the bundle can be deployed multiple times or not. Default value is false.

masterLabel 

  • Type: string
  • Required: Yes
  • Description: Required. Indicates the name of the bundle.

Declarative Metadata Sample Definition 

The following is an example of a DataSourceBundleDefinition component.

1<?xml version="1.0" encoding="UTF-8"?>
2<DataSourceBundleDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
3    <dataPlatform>Salesforce_Sales_and_Service_Cloud</dataPlatform>
4    <isMultiDeploymentSupported>true</isMultiDeploymentSupported>
5    <bundleVersion>1</bundleVersion> 
6    <masterLabel>b2</masterLabel>
7</DataSourceBundleDefinition>

The following is an example package.xml that references the previous definition.

1<types>
2      <members>b2</members>
3      <name>DataSourceBundleDefinition</name>
4</types>

Wildcard Support in the Manifest File 

This metadata type supports 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.