AmazonRedshiftSource Class

public final class AmazonRedshiftSource
extends TabularSource

A copy activity source for Amazon Redshift Source.

Constructor Summary

Constructor Description
AmazonRedshiftSource()

Creates an instance of AmazonRedshiftSource class.

Method Summary

Modifier and Type Method and Description
Object query()

Get the query property: Database query.

RedshiftUnloadSettings redshiftUnloadSettings()

Get the redshiftUnloadSettings property: The Amazon S3 settings needed for the interim Amazon S3 when copying from Amazon Redshift with unload.

String type()

Get the type property: Copy source type.

void validate()

Validates the instance.

AmazonRedshiftSource withAdditionalColumns(Object additionalColumns)

Set the additionalColumns property: Specifies the additional columns to be added to source data.

AmazonRedshiftSource withDisableMetricsCollection(Object disableMetricsCollection)

Set the disableMetricsCollection property: If true, disable data store metrics collection.

AmazonRedshiftSource withMaxConcurrentConnections(Object maxConcurrentConnections)

Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store.

AmazonRedshiftSource withQuery(Object query)

Set the query property: Database query.

AmazonRedshiftSource withQueryTimeout(Object queryTimeout)

Set the queryTimeout property: Query timeout.

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.

AmazonRedshiftSource withSourceRetryCount(Object sourceRetryCount)

Set the sourceRetryCount property: Source retry count.

AmazonRedshiftSource withSourceRetryWait(Object sourceRetryWait)

Set the sourceRetryWait property: Source retry wait.

Methods inherited from CopySource

Methods inherited from TabularSource

Methods inherited from java.lang.Object

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.

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.

type

public String type()

Get the type property: Copy source type.

Overrides:

AmazonRedshiftSource.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

AmazonRedshiftSource.validate()

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:

AmazonRedshiftSource.withAdditionalColumns(Object additionalColumns)

Parameters:

additionalColumns

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:

AmazonRedshiftSource.withDisableMetricsCollection(Object disableMetricsCollection)

Parameters:

disableMetricsCollection

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:

AmazonRedshiftSource.withMaxConcurrentConnections(Object maxConcurrentConnections)

Parameters:

maxConcurrentConnections

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.

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:

AmazonRedshiftSource.withQueryTimeout(Object queryTimeout)

Parameters:

queryTimeout

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.

withSourceRetryCount

public AmazonRedshiftSource withSourceRetryCount(Object sourceRetryCount)

Set the sourceRetryCount property: Source retry count. Type: integer (or Expression with resultType integer).

Overrides:

AmazonRedshiftSource.withSourceRetryCount(Object sourceRetryCount)

Parameters:

sourceRetryCount

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:

AmazonRedshiftSource.withSourceRetryWait(Object sourceRetryWait)

Parameters:

sourceRetryWait

Applies to