StreamingAppDataConnector

Represents the connection information specific to Web and Mobile Connectors.

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 

StreamingAppDataConnector components have the suffix .streamingAppDataConnector and are stored in the streamingAppDataConnectors folder.

Version 

Introduced in API version 55.0.

Special Access Rules 

There are no additional access requirements that are specific to this type.

Fields 

alias 

  • Type: string
  • Required: No

appIdentifier 

  • Type: string

  • Required: Yes

  • Description: Required.

    The unique app identifier (UUID).

connectorParameters 

  • Type: StreamingAppDataCnctrParm[]
  • Required: No

dataConnectorType 

  • Type: DataConnectorType (enumeration of type string)

  • Required: Yes

  • Description: Required.

    The value of the field is restricted to SteamingApp.

  • Possible values:

    • DataCloud
    • StreamingApp

isProtected 

  • Type: boolean
  • Required: No
  • Description: An auto-generated value that doesn’t impact the behavior of the metadata type.

masterLabel 

  • Type: string

  • Required: Yes

  • Description: Required.

    The display name of the connector.

streamingAppDataConnectorType 

  • Type: StreamingAppDataConnectorType (enumeration of type string)

  • Required: Yes

  • Description: Required.

    The type of connector.

  • Possible values:

    • MobileApp
    • WebApp

Declarative Metadata Sample Definition 

The following is an example of a StreamingAppDataConnector component.

1<?xml version="1.0" encoding="UTF-8"?>
2<StreamingAppDataConnector xmlns="http://soap.sforce.com/2006/04/metadata">
3    <appIdentifier>61826b62-6b90-49ff-8259</appIdentifier>
4    <dataConnectorType>StreamingApp</dataConnectorType>
5    <masterLabel>My Web Application</masterLabel>
6    <streamingAppDataConnectorType>WebApp</streamingAppDataConnectorType>
7</StreamingAppDataConnector>

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

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <fullName>MyPackage</fullName>
4    <namespacePrefix>ns1</namespacePrefix>
5    <types>
6        <members>My_Web_Application_Behavioral_Events_F4DA8759</members>
7        <name>DataStreamDefinition</name>
8    </types>
9    <types>
10        <members>My_Web_Application_61826b62_6b90_49ff_8259</members>
11        <name>ExternalDataConnector</name>
12    </types>
13    <types>
14        <members>My_Web_Application_61826b62_6b90_49ff_8259</members>
15        <name>StreamingAppDataConnector</name>
16    </types>
17    <version>55.0</version>
18</Package>

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.