Class SalesforceSource


  • public final class SalesforceSource
    extends TabularSource
    A copy activity Salesforce source.
    • Constructor Detail

      • SalesforceSource

        public SalesforceSource()
    • Method Detail

      • query

        public Object query()
        Get the query property: Database query. Type: string (or Expression with resultType string).
        Returns:
        the query value.
      • withQuery

        public SalesforceSource withQuery​(Object query)
        Set the query property: Database query. Type: string (or Expression with resultType string).
        Parameters:
        query - the query value to set.
        Returns:
        the SalesforceSource object itself.
      • readBehavior

        public SalesforceSourceReadBehavior readBehavior()
        Get the readBehavior property: The read behavior for the operation. Default is Query.
        Returns:
        the readBehavior value.
      • withReadBehavior

        public SalesforceSource withReadBehavior​(SalesforceSourceReadBehavior readBehavior)
        Set the readBehavior property: The read behavior for the operation. Default is Query.
        Parameters:
        readBehavior - the readBehavior value to set.
        Returns:
        the SalesforceSource object itself.
      • withQueryTimeout

        public SalesforceSource withQueryTimeout​(Object queryTimeout)
        Set the queryTimeout property: Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
        Overrides:
        withQueryTimeout in class TabularSource
        Parameters:
        queryTimeout - the queryTimeout value to set.
        Returns:
        the TabularSource object itself.
      • withAdditionalColumns

        public SalesforceSource withAdditionalColumns​(Object additionalColumns)
        Set the additionalColumns property: Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
        Overrides:
        withAdditionalColumns in class TabularSource
        Parameters:
        additionalColumns - the additionalColumns value to set.
        Returns:
        the TabularSource object itself.
      • withSourceRetryCount

        public SalesforceSource withSourceRetryCount​(Object sourceRetryCount)
        Set the sourceRetryCount property: Source retry count. Type: integer (or Expression with resultType integer).
        Overrides:
        withSourceRetryCount in class TabularSource
        Parameters:
        sourceRetryCount - the sourceRetryCount value to set.
        Returns:
        the CopySource object itself.
      • withSourceRetryWait

        public SalesforceSource withSourceRetryWait​(Object sourceRetryWait)
        Set the sourceRetryWait property: Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
        Overrides:
        withSourceRetryWait in class TabularSource
        Parameters:
        sourceRetryWait - the sourceRetryWait value to set.
        Returns:
        the CopySource object itself.
      • withMaxConcurrentConnections

        public SalesforceSource withMaxConcurrentConnections​(Object maxConcurrentConnections)
        Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
        Overrides:
        withMaxConcurrentConnections in class TabularSource
        Parameters:
        maxConcurrentConnections - the maxConcurrentConnections value to set.
        Returns:
        the CopySource object itself.
      • withDisableMetricsCollection

        public SalesforceSource withDisableMetricsCollection​(Object disableMetricsCollection)
        Set the disableMetricsCollection property: If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
        Overrides:
        withDisableMetricsCollection in class TabularSource
        Parameters:
        disableMetricsCollection - the disableMetricsCollection value to set.
        Returns:
        the CopySource object itself.