Class AmazonRedshiftSource


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

    • AmazonRedshiftSource

      public AmazonRedshiftSource()
      Creates an instance of AmazonRedshiftSource class.
  • Method Details

    • query

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

      public AmazonRedshiftSource 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 AmazonRedshiftSource object itself.
    • redshiftUnloadSettings

      public RedshiftUnloadSettings redshiftUnloadSettings()
      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.
    • withRedshiftUnloadSettings

      public AmazonRedshiftSource withRedshiftUnloadSettings(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.
    • withQueryTimeout

      public AmazonRedshiftSource 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 AmazonRedshiftSource 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 AmazonRedshiftSource 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 AmazonRedshiftSource 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 AmazonRedshiftSource 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 AmazonRedshiftSource 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.
    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class TabularSource
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.