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

Class AmazonRedshiftSource

  • public final class AmazonRedshiftSource
extends TabularSource
    A copy activity source for Amazon Redshift Source.

    • Constructor Detail

      • AmazonRedshiftSource

        public AmazonRedshiftSource()

    • Method Detail

      • getQuery

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

      • setQuery

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

      • getRedshiftUnloadSettings

        public RedshiftUnloadSettings getRedshiftUnloadSettings()
        Get the redshiftUnloadSettings property: The Amazon S3 settings needed for the interim Amazon S3 when copying from Amazon Redshift with unload. With this, data from Amazon Redshift source will be unloaded into S3 first and then copied into the targeted sink from the interim S3.
        Returns:
        the redshiftUnloadSettings value.

      • setRedshiftUnloadSettings

        public AmazonRedshiftSource setRedshiftUnloadSettings​(RedshiftUnloadSettings redshiftUnloadSettings)
        Set the redshiftUnloadSettings property: The Amazon S3 settings needed for the interim Amazon S3 when copying from Amazon Redshift with unload. With this, data from Amazon Redshift source will be unloaded into S3 first and then copied into the targeted sink from the interim S3.
        Parameters:
        redshiftUnloadSettings - the redshiftUnloadSettings value to set.
        Returns:
        the AmazonRedshiftSource object itself.

      • setQueryTimeout

        public AmazonRedshiftSource setQueryTimeout​(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:
        setQueryTimeout in class TabularSource
        Parameters:
        queryTimeout - the queryTimeout value to set.
        Returns:
        the TabularSource object itself.

      • setAdditionalColumns

        public AmazonRedshiftSource setAdditionalColumns​(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:
        setAdditionalColumns in class TabularSource
        Parameters:
        additionalColumns - the additionalColumns value to set.
        Returns:
        the TabularSource object itself.

      • setSourceRetryCount

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

      • setSourceRetryWait

        public AmazonRedshiftSource setSourceRetryWait​(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:
        setSourceRetryWait in class TabularSource
        Parameters:
        sourceRetryWait - the sourceRetryWait value to set.
        Returns:
        the CopySource object itself.

      • setMaxConcurrentConnections

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