Package com.azure.analytics.synapse.artifacts.models

Class SalesforceLinkedService

  • public class SalesforceLinkedService
extends LinkedService
    Linked service for Salesforce.

    • Constructor Detail

      • SalesforceLinkedService

        public SalesforceLinkedService()

    • Method Detail

      • getEnvironmentUrl

        public Object getEnvironmentUrl()
        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.

      • setEnvironmentUrl

        public SalesforceLinkedService setEnvironmentUrl​(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.

      • getUsername

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

      • setUsername

        public SalesforceLinkedService setUsername​(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.

      • getPassword

        public SecretBase getPassword()
        Get the password property: The password for Basic authentication of the Salesforce instance.
        Returns:
        the password value.

      • setPassword

        public SalesforceLinkedService setPassword​(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.

      • getSecurityToken

        public SecretBase getSecurityToken()
        Get the securityToken property: The security token is optional to remotely access Salesforce instance.
        Returns:
        the securityToken value.

      • setSecurityToken

        public SalesforceLinkedService setSecurityToken​(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.

      • getApiVersion

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

      • setApiVersion

        public SalesforceLinkedService setApiVersion​(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.

      • getEncryptedCredential

        public Object getEncryptedCredential()
        Get the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).
        Returns:
        the encryptedCredential value.

      • setEncryptedCredential

        public SalesforceLinkedService setEncryptedCredential​(Object encryptedCredential)
        Set the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).
        Parameters:
        encryptedCredential - the encryptedCredential value to set.
        Returns:
        the SalesforceLinkedService object itself.

      • setDescription

        public SalesforceLinkedService setDescription​(String description)
        Set the description property: Linked service description.
        Overrides:
        setDescription in class LinkedService
        Parameters:
        description - the description value to set.
        Returns:
        the LinkedService object itself.

      • setAnnotations

        public SalesforceLinkedService setAnnotations​(List<Object> annotations)
        Set the annotations property: List of tags that can be used for describing the linked service.
        Overrides:
        setAnnotations in class LinkedService
        Parameters:
        annotations - the annotations value to set.
        Returns:
        the LinkedService object itself.