SalesforceLinkedService Class

public final class SalesforceLinkedService
extends LinkedService

Linked service for Salesforce.

Constructor Summary

Constructor Description
SalesforceLinkedService()

Creates an instance of SalesforceLinkedService class.

Method Summary

Modifier and Type Method and Description
Object apiVersion()

Get the apiVersion property: The Salesforce API version used in ADF.

String encryptedCredential()

Get the encryptedCredential property: The encrypted credential used for authentication.

Object environmentUrl()

Get the environmentUrl property: The URL of Salesforce instance.

SecretBase password()

Get the password property: The password for Basic authentication of the Salesforce instance.

SecretBase securityToken()

Get the securityToken property: The security token is optional to remotely access Salesforce instance.

String type()

Get the type property: Type of linked service.

Object username()

Get the username property: The username for Basic authentication of the Salesforce instance.

void validate()

Validates the instance.

SalesforceLinkedService withAnnotations(List<Object> annotations)

Set the annotations property: List of tags that can be used for describing the linked service.

SalesforceLinkedService withApiVersion(Object apiVersion)

Set the apiVersion property: The Salesforce API version used in ADF.

SalesforceLinkedService withConnectVia(IntegrationRuntimeReference connectVia)

Set the connectVia property: The integration runtime reference.

SalesforceLinkedService withDescription(String description)

Set the description property: Linked service description.

SalesforceLinkedService withEncryptedCredential(String encryptedCredential)

Set the encryptedCredential property: The encrypted credential used for authentication.

SalesforceLinkedService withEnvironmentUrl(Object environmentUrl)

Set the environmentUrl property: The URL of Salesforce instance.

SalesforceLinkedService withParameters(Map<String,ParameterSpecification> parameters)

Set the parameters property: Parameters for linked service.

SalesforceLinkedService withPassword(SecretBase password)

Set the password property: The password for Basic authentication of the Salesforce instance.

SalesforceLinkedService withSecurityToken(SecretBase securityToken)

Set the securityToken property: The security token is optional to remotely access Salesforce instance.

SalesforceLinkedService withUsername(Object username)

Set the username property: The username for Basic authentication of the Salesforce instance.

Methods inherited from LinkedService

Methods inherited from java.lang.Object

Constructor Details

SalesforceLinkedService

public SalesforceLinkedService()

Creates an instance of SalesforceLinkedService class.

Method Details

apiVersion

public Object apiVersion()

Get the apiVersion property: The Salesforce API version used in ADF. Type: string (or Expression with resultType string).

Returns:

the apiVersion value.

encryptedCredential

public String encryptedCredential()

Get the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.

Returns:

the encryptedCredential value.

environmentUrl

public Object environmentUrl()

Get the environmentUrl property: The URL of Salesforce instance. Default is 'https://login.salesforce.com'. To copy data from sandbox, specify 'https://test.salesforce.com'. To copy data from custom domain, specify, for example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string).

Returns:

the environmentUrl value.

password

public SecretBase password()

Get the password property: The password for Basic authentication of the Salesforce instance.

Returns:

the password value.

securityToken

public SecretBase securityToken()

Get the securityToken property: The security token is optional to remotely access Salesforce instance.

Returns:

the securityToken value.

type

public String type()

Get the type property: Type of linked service.

Overrides:

SalesforceLinkedService.type()

Returns:

the type value.

username

public Object username()

Get the username property: The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string).

Returns:

the username value.

validate

public void validate()

Validates the instance.

Overrides:

SalesforceLinkedService.validate()

withAnnotations

public SalesforceLinkedService withAnnotations(List annotations)

Set the annotations property: List of tags that can be used for describing the linked service.

Overrides:

SalesforceLinkedService.withAnnotations(List<Object> annotations)

Parameters:

annotations

withApiVersion

public SalesforceLinkedService withApiVersion(Object apiVersion)

Set the apiVersion property: The Salesforce API version used in ADF. Type: string (or Expression with resultType string).

Parameters:

apiVersion - the apiVersion value to set.

Returns:

the SalesforceLinkedService object itself.

withConnectVia

public SalesforceLinkedService withConnectVia(IntegrationRuntimeReference connectVia)

Set the connectVia property: The integration runtime reference.

Overrides:

SalesforceLinkedService.withConnectVia(IntegrationRuntimeReference connectVia)

Parameters:

connectVia

withDescription

public SalesforceLinkedService withDescription(String description)

Set the description property: Linked service description.

Overrides:

SalesforceLinkedService.withDescription(String description)

Parameters:

description

withEncryptedCredential

public SalesforceLinkedService withEncryptedCredential(String encryptedCredential)

Set the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.

Parameters:

encryptedCredential - the encryptedCredential value to set.

Returns:

the SalesforceLinkedService object itself.

withEnvironmentUrl

public SalesforceLinkedService withEnvironmentUrl(Object environmentUrl)

Set the environmentUrl property: The URL of Salesforce instance. Default is 'https://login.salesforce.com'. To copy data from sandbox, specify 'https://test.salesforce.com'. To copy data from custom domain, specify, for example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string).

Parameters:

environmentUrl - the environmentUrl value to set.

Returns:

the SalesforceLinkedService object itself.

withParameters

public SalesforceLinkedService withParameters(Map parameters)

Set the parameters property: Parameters for linked service.

Overrides:

SalesforceLinkedService.withParameters(Map<String,ParameterSpecification> parameters)

Parameters:

parameters

withPassword

public SalesforceLinkedService withPassword(SecretBase password)

Set the password property: The password for Basic authentication of the Salesforce instance.

Parameters:

password - the password value to set.

Returns:

the SalesforceLinkedService object itself.

withSecurityToken

public SalesforceLinkedService withSecurityToken(SecretBase securityToken)

Set the securityToken property: The security token is optional to remotely access Salesforce instance.

Parameters:

securityToken - the securityToken value to set.

Returns:

the SalesforceLinkedService object itself.

withUsername

public SalesforceLinkedService withUsername(Object username)

Set the username property: The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string).

Parameters:

username - the username value to set.

Returns:

the SalesforceLinkedService object itself.

Applies to