org.mule.modules.salesforce.analytics.internal.operation

Class SalesforceAnalyticsOperations

java.lang.Object

org.mule.connectors.commons.template.operation.ConnectorOperations<SalesforceAnalyticsConfig,SalesforceAnalyticsConnection,Service>

org.mule.modules.salesforce.analytics.internal.operation.AnalyticsOperations<SalesforceAnalyticsService>

org.mule.modules.salesforce.analytics.internal.operation.SalesforceAnalyticsOperations

@Throws(value=AnalyticsErrorTypeProvider.class)
public class SalesforceAnalyticsOperations
extends AnalyticsOperations<SalesforceAnalyticsService>

Constructor Summary

Constructors

Constructor and Description
SalesforceAnalyticsOperations()

Method Summary

Modifier and Type	Method and Description
String	createDataSet(SalesforceAnalyticsConfig config, SalesforceAnalyticsConnection connection, String type, DataSet dataSetInfo) Creates a new data set into Salesforce Analytics Cloud system and returns the identifier of created data set within Salesforce Analytics Cloud system.
void	deleteDataSet(SalesforceAnalyticsConfig config, SalesforceAnalyticsConnection connection, String dataSetId) Deletes specified data set from Salesforce Analytics Cloud system
void	startDataProcessing(SalesforceAnalyticsConfig config, SalesforceAnalyticsConnection connection, String dataSetId) Tells to Salesforce Analytics Cloud system to start processing the records uploaded so far into given data set
org.mule.runtime.api.bulk.BulkOperationResult<Map<String,String>>	uploadExternalData(SalesforceAnalyticsConfig config, SalesforceAnalyticsConnection connection, String dataSetId, List<Map<String,Object>> records) Inserts given records into data set with given id from Salesforce Analytics Cloud system.
String	uploadExternalDataIntoNewDataSetAndStartProcessing(SalesforceAnalyticsConfig config, SalesforceAnalyticsConnection connection, String type, DataSet dataSetInfo, List<Map<String,Object>> records) Creates data set uploads data into it and tells to Salesforce Analytics Cloud system to start processing uploaded data.

Methods inherited from class org.mule.modules.salesforce.analytics.internal.operation.AnalyticsOperations

newExecutionBuilder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SalesforceAnalyticsOperations

public SalesforceAnalyticsOperations()

Method Detail

createDataSet

@MediaType(value="*/*")
public String createDataSet(@Config
                                                    SalesforceAnalyticsConfig config,
                                                    @Connection
                                                    SalesforceAnalyticsConnection connection,
                                                    @Path(type=FILE)
                                                    String type,
                                                    @ParameterGroup(name="DataSet info")
                                                    DataSet dataSetInfo)

Creates a new data set into Salesforce Analytics Cloud system and returns the identifier of created data set within Salesforce Analytics Cloud system.

Parameters:

config - config to be used with the operation

connection - object holding connection details

type - represents the type of the DataSet to be created

dataSetInfo - containing: operation - indicates which operation to use when you’re loading data into the DataSet. description - data set description label - data set label dataSetName - data set name edgemartContainer - The name of the app that contains the dataset.

• If the name is omitted when you’re creating a dataset, the name of the user’s private app is used.
• If the name is omitted for an existing dataset, the system resolves the app name.
• If the name is specified for an existing dataset, the name is required to match the name of the current app that contains the dataset.

notificationSent - Indicates when to send notifications about the upload. Picklist values are:

• ALWAYS - Always send notifications.
• NEVER - Never send notifications.
• FAILURES - Send notifications if the upload process failed. The API name is Failures.
• WARNINGS - Send notifications if warnings or errors occurred during the upload. The API name is Warnings.

notificationEmail - The email address to send notifications to. Can be up to 255 characters and can contain only one email address. Defaults to the current user’s email address.

Returns:

identifier of created data set

uploadExternalData

public org.mule.runtime.api.bulk.BulkOperationResult<Map<String,String>> uploadExternalData(@Config
                                                                                            SalesforceAnalyticsConfig config,
                                                                                            @Connection
                                                                                            SalesforceAnalyticsConnection connection,
                                                                                            @MetadataKeyId(value=SalesforceAnalyticsMetadataResolver.class)
                                                                                            String dataSetId,
                                                                                            @Content @TypeResolver(value=SalesforceAnalyticsMetadataResolver.class)
                                                                                            List<Map<String,Object>> records)

Inserts given records into data set with given id from Salesforce Analytics Cloud system.

Parameters:

config - config to be used with the operation

connection - object holding connection details

records - list of records to be inserted

dataSetId - identifier of data set within Salesforce Analytics Cloud system

Returns:

list of record process summary of each record

startDataProcessing

public void startDataProcessing(@Config
                                SalesforceAnalyticsConfig config,
                                @Connection
                                SalesforceAnalyticsConnection connection,
                                @MetadataKeyId(value=SalesforceAnalyticsMetadataResolver.class)
                                String dataSetId)

Tells to Salesforce Analytics Cloud system to start processing the records uploaded so far into given data set

Parameters:

config - config to be used with the operation

connection - object holding connection details

dataSetId - identifier of data set to be processed

uploadExternalDataIntoNewDataSetAndStartProcessing

@MediaType(value="*/*")
public String uploadExternalDataIntoNewDataSetAndStartProcessing(@Config
                                                                                         SalesforceAnalyticsConfig config,
                                                                                         @Connection
                                                                                         SalesforceAnalyticsConnection connection,
                                                                                         @Path(type=FILE)
                                                                                         String type,
                                                                                         @ParameterGroup(name="DataSet info")
                                                                                         DataSet dataSetInfo,
                                                                                         @Content
                                                                                         List<Map<String,Object>> records)

Creates data set uploads data into it and tells to Salesforce Analytics Cloud system to start processing uploaded data.

Parameters:

config - config to be used with the operation

connection - object holding connection details

records - list of records to be inserted

type - type of the records to be inserted. This is automatically computed based on metadata extracted from file provided with configuration element

dataSetInfo - containing: operation - indicates which operation to use when you’re loading data into the DataSet. description - data set description label - data set label dataSetName - data set name edgemartContainer - The name of the app that contains the dataset.

• If the name is omitted when you’re creating a dataset, the name of the user’s private app is used.
• If the name is omitted for an existing dataset, the system resolves the app name.
• If the name is specified for an existing dataset, the name is required to match the name of the current app that contains the dataset.

notificationSent - Indicates when to send notifications about the upload. Picklist values are:

• ALWAYS - Always send notifications.
• NEVER - Never send notifications.
• FAILURES - Send notifications if the upload process failed. The API name is Failures.
• WARNINGS - Send notifications if warnings or errors occurred during the upload. The API name is Warnings.

notificationEmail - The email address to send notifications to. Can be up to 255 characters and can contain only one email address. Defaults to the current user’s email address.

Returns:

identifier of create data set

deleteDataSet

public void deleteDataSet(@Config
                          SalesforceAnalyticsConfig config,
                          @Connection
                          SalesforceAnalyticsConnection connection,
                          @MetadataKeyId(value=SalesforceAnalyticsMetadataResolver.class)
                          String dataSetId)

Deletes specified data set from Salesforce Analytics Cloud system

Parameters:

config - config to be used with the operation

connection - object holding connection details

dataSetId - - identifier of data set to be deleted