RedshiftSettings (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.databasemigrationservice.model.RedshiftSettings

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RedshiftSettings
extends Object
implements Serializable, Cloneable, StructuredPojo

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

RedshiftSettings()

Constructors
Constructor and Description
`RedshiftSettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RedshiftSettings`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getAcceptAnyDate()` Allows any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error.
`String`	`getAfterConnectScript()` Code to run after connecting.
`String`	`getBucketFolder()` The location where the CSV files are stored before being uploaded to the S3 bucket.
`String`	`getBucketName()` The name of the S3 bucket you want to use
`Integer`	`getConnectionTimeout()` Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
`String`	`getDatabaseName()` The name of the Amazon Redshift data warehouse (service) you are working with.
`String`	`getDateFormat()` The date format you are using.
`Boolean`	`getEmptyAsNull()` Specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL.
`String`	`getEncryptionMode()` The type of server side encryption you want to use for your data.
`Integer`	`getFileTransferUploadStreams()` Specifies the number of threads used to upload a single file.
`Integer`	`getLoadTimeout()` Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you begin loading.
`Integer`	`getMaxFileSize()` Specifies the maximum size (in KB) of any CSV file used to transfer data to Amazon Redshift.
`String`	`getPassword()` The password for the user named in the username property.
`Integer`	`getPort()` The port number for Amazon Redshift.
`Boolean`	`getRemoveQuotes()` Removes surrounding quotation marks from strings in the incoming data.
`String`	`getReplaceChars()` Replaces invalid characters specified in `ReplaceInvalidChars`, substituting the specified value instead.
`String`	`getReplaceInvalidChars()` A list of chars you want to replace.
`String`	`getServerName()` The name of the Amazon Redshift cluster you are using.
`String`	`getServerSideEncryptionKmsKeyId()` If you are using SSE_KMS for the `EncryptionMode`, provide the KMS Key ID.
`String`	`getServiceAccessRoleArn()` The ARN of the role that has access to the Redshift service.
`String`	`getTimeFormat()` The time format you want to use.
`Boolean`	`getTrimBlanks()` Removes the trailing white space characters from a VARCHAR string.
`Boolean`	`getTruncateColumns()` Truncates data in columns to the appropriate number of characters, so that it fits in the column.
`String`	`getUsername()` An Amazon Redshift user name for a registered user.
`Integer`	`getWriteBufferSize()` The size of the write buffer to use in rows.
`int`	`hashCode()`
`Boolean`	`isAcceptAnyDate()` Allows any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error.
`Boolean`	`isEmptyAsNull()` Specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL.
`Boolean`	`isRemoveQuotes()` Removes surrounding quotation marks from strings in the incoming data.
`Boolean`	`isTrimBlanks()` Removes the trailing white space characters from a VARCHAR string.
`Boolean`	`isTruncateColumns()` Truncates data in columns to the appropriate number of characters, so that it fits in the column.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAcceptAnyDate(Boolean acceptAnyDate)` Allows any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error.
`void`	`setAfterConnectScript(String afterConnectScript)` Code to run after connecting.
`void`	`setBucketFolder(String bucketFolder)` The location where the CSV files are stored before being uploaded to the S3 bucket.
`void`	`setBucketName(String bucketName)` The name of the S3 bucket you want to use
`void`	`setConnectionTimeout(Integer connectionTimeout)` Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
`void`	`setDatabaseName(String databaseName)` The name of the Amazon Redshift data warehouse (service) you are working with.
`void`	`setDateFormat(String dateFormat)` The date format you are using.
`void`	`setEmptyAsNull(Boolean emptyAsNull)` Specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL.
`void`	`setEncryptionMode(String encryptionMode)` The type of server side encryption you want to use for your data.
`void`	`setFileTransferUploadStreams(Integer fileTransferUploadStreams)` Specifies the number of threads used to upload a single file.
`void`	`setLoadTimeout(Integer loadTimeout)` Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you begin loading.
`void`	`setMaxFileSize(Integer maxFileSize)` Specifies the maximum size (in KB) of any CSV file used to transfer data to Amazon Redshift.
`void`	`setPassword(String password)` The password for the user named in the username property.
`void`	`setPort(Integer port)` The port number for Amazon Redshift.
`void`	`setRemoveQuotes(Boolean removeQuotes)` Removes surrounding quotation marks from strings in the incoming data.
`void`	`setReplaceChars(String replaceChars)` Replaces invalid characters specified in `ReplaceInvalidChars`, substituting the specified value instead.
`void`	`setReplaceInvalidChars(String replaceInvalidChars)` A list of chars you want to replace.
`void`	`setServerName(String serverName)` The name of the Amazon Redshift cluster you are using.
`void`	`setServerSideEncryptionKmsKeyId(String serverSideEncryptionKmsKeyId)` If you are using SSE_KMS for the `EncryptionMode`, provide the KMS Key ID.
`void`	`setServiceAccessRoleArn(String serviceAccessRoleArn)` The ARN of the role that has access to the Redshift service.
`void`	`setTimeFormat(String timeFormat)` The time format you want to use.
`void`	`setTrimBlanks(Boolean trimBlanks)` Removes the trailing white space characters from a VARCHAR string.
`void`	`setTruncateColumns(Boolean truncateColumns)` Truncates data in columns to the appropriate number of characters, so that it fits in the column.
`void`	`setUsername(String username)` An Amazon Redshift user name for a registered user.
`void`	`setWriteBufferSize(Integer writeBufferSize)` The size of the write buffer to use in rows.
`String`	`toString()` Returns a string representation of this object.
`RedshiftSettings`	`withAcceptAnyDate(Boolean acceptAnyDate)` Allows any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error.
`RedshiftSettings`	`withAfterConnectScript(String afterConnectScript)` Code to run after connecting.
`RedshiftSettings`	`withBucketFolder(String bucketFolder)` The location where the CSV files are stored before being uploaded to the S3 bucket.
`RedshiftSettings`	`withBucketName(String bucketName)` The name of the S3 bucket you want to use
`RedshiftSettings`	`withConnectionTimeout(Integer connectionTimeout)` Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
`RedshiftSettings`	`withDatabaseName(String databaseName)` The name of the Amazon Redshift data warehouse (service) you are working with.
`RedshiftSettings`	`withDateFormat(String dateFormat)` The date format you are using.
`RedshiftSettings`	`withEmptyAsNull(Boolean emptyAsNull)` Specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL.
`RedshiftSettings`	`withEncryptionMode(EncryptionModeValue encryptionMode)` The type of server side encryption you want to use for your data.
`RedshiftSettings`	`withEncryptionMode(String encryptionMode)` The type of server side encryption you want to use for your data.
`RedshiftSettings`	`withFileTransferUploadStreams(Integer fileTransferUploadStreams)` Specifies the number of threads used to upload a single file.
`RedshiftSettings`	`withLoadTimeout(Integer loadTimeout)` Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you begin loading.
`RedshiftSettings`	`withMaxFileSize(Integer maxFileSize)` Specifies the maximum size (in KB) of any CSV file used to transfer data to Amazon Redshift.
`RedshiftSettings`	`withPassword(String password)` The password for the user named in the username property.
`RedshiftSettings`	`withPort(Integer port)` The port number for Amazon Redshift.
`RedshiftSettings`	`withRemoveQuotes(Boolean removeQuotes)` Removes surrounding quotation marks from strings in the incoming data.
`RedshiftSettings`	`withReplaceChars(String replaceChars)` Replaces invalid characters specified in `ReplaceInvalidChars`, substituting the specified value instead.
`RedshiftSettings`	`withReplaceInvalidChars(String replaceInvalidChars)` A list of chars you want to replace.
`RedshiftSettings`	`withServerName(String serverName)` The name of the Amazon Redshift cluster you are using.
`RedshiftSettings`	`withServerSideEncryptionKmsKeyId(String serverSideEncryptionKmsKeyId)` If you are using SSE_KMS for the `EncryptionMode`, provide the KMS Key ID.
`RedshiftSettings`	`withServiceAccessRoleArn(String serviceAccessRoleArn)` The ARN of the role that has access to the Redshift service.
`RedshiftSettings`	`withTimeFormat(String timeFormat)` The time format you want to use.
`RedshiftSettings`	`withTrimBlanks(Boolean trimBlanks)` Removes the trailing white space characters from a VARCHAR string.
`RedshiftSettings`	`withTruncateColumns(Boolean truncateColumns)` Truncates data in columns to the appropriate number of characters, so that it fits in the column.
`RedshiftSettings`	`withUsername(String username)` An Amazon Redshift user name for a registered user.
`RedshiftSettings`	`withWriteBufferSize(Integer writeBufferSize)` The size of the write buffer to use in rows.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RedshiftSettings
```
public RedshiftSettings()
```
- Method Detail
  - setAcceptAnyDate
```
public void setAcceptAnyDate(Boolean acceptAnyDate)
```
    Allows any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error. You can choose TRUE or FALSE (default).
    
    This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data does not match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field.
    
    Parameters:
    
    acceptAnyDate - Allows any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error. You can choose TRUE or FALSE (default).
    
    This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data does not match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field.
  - getAcceptAnyDate
```
public Boolean getAcceptAnyDate()
```
    Allows any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error. You can choose TRUE or FALSE (default).
    
    This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data does not match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field.
    
    Returns:
    
    Allows any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error. You can choose TRUE or FALSE (default).
    
    This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data does not match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field.
  - withAcceptAnyDate
```
public RedshiftSettings withAcceptAnyDate(Boolean acceptAnyDate)
```
    Allows any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error. You can choose TRUE or FALSE (default).
    
    This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data does not match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field.
    
    Parameters:
    
    acceptAnyDate - Allows any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error. You can choose TRUE or FALSE (default).
    
    This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data does not match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isAcceptAnyDate
```
public Boolean isAcceptAnyDate()
```
    Allows any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error. You can choose TRUE or FALSE (default).
    
    This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data does not match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field.
    
    Returns:
    
    Allows any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error. You can choose TRUE or FALSE (default).
    
    This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data does not match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field.
  - setAfterConnectScript
```
public void setAfterConnectScript(String afterConnectScript)
```
    Code to run after connecting. This should be the code, not a filename.
    
    Parameters:
    
    afterConnectScript - Code to run after connecting. This should be the code, not a filename.
  - getAfterConnectScript
```
public String getAfterConnectScript()
```
    Code to run after connecting. This should be the code, not a filename.
    
    Returns:
    
    Code to run after connecting. This should be the code, not a filename.
  - withAfterConnectScript
```
public RedshiftSettings withAfterConnectScript(String afterConnectScript)
```
    Code to run after connecting. This should be the code, not a filename.
    
    Parameters:
    
    afterConnectScript - Code to run after connecting. This should be the code, not a filename.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBucketFolder
```
public void setBucketFolder(String bucketFolder)
```
    The location where the CSV files are stored before being uploaded to the S3 bucket.
    
    Parameters:
    
    bucketFolder - The location where the CSV files are stored before being uploaded to the S3 bucket.
  - getBucketFolder
```
public String getBucketFolder()
```
    The location where the CSV files are stored before being uploaded to the S3 bucket.
    
    Returns:
    
    The location where the CSV files are stored before being uploaded to the S3 bucket.
  - withBucketFolder
```
public RedshiftSettings withBucketFolder(String bucketFolder)
```
    The location where the CSV files are stored before being uploaded to the S3 bucket.
    
    Parameters:
    
    bucketFolder - The location where the CSV files are stored before being uploaded to the S3 bucket.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBucketName
```
public void setBucketName(String bucketName)
```
    The name of the S3 bucket you want to use
    
    Parameters:
    
    bucketName - The name of the S3 bucket you want to use
  - getBucketName
```
public String getBucketName()
```
    The name of the S3 bucket you want to use
    
    Returns:
    
    The name of the S3 bucket you want to use
  - withBucketName
```
public RedshiftSettings withBucketName(String bucketName)
```
    The name of the S3 bucket you want to use
    
    Parameters:
    
    bucketName - The name of the S3 bucket you want to use
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConnectionTimeout
```
public void setConnectionTimeout(Integer connectionTimeout)
```
    Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
    
    Parameters:
    
    connectionTimeout - Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
  - getConnectionTimeout
```
public Integer getConnectionTimeout()
```
    Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
    
    Returns:
    
    Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
  - withConnectionTimeout
```
public RedshiftSettings withConnectionTimeout(Integer connectionTimeout)
```
    Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
    
    Parameters:
    
    connectionTimeout - Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDatabaseName
```
public void setDatabaseName(String databaseName)
```
    The name of the Amazon Redshift data warehouse (service) you are working with.
    
    Parameters:
    
    databaseName - The name of the Amazon Redshift data warehouse (service) you are working with.
  - getDatabaseName
```
public String getDatabaseName()
```
    The name of the Amazon Redshift data warehouse (service) you are working with.
    
    Returns:
    
    The name of the Amazon Redshift data warehouse (service) you are working with.
  - withDatabaseName
```
public RedshiftSettings withDatabaseName(String databaseName)
```
    The name of the Amazon Redshift data warehouse (service) you are working with.
    
    Parameters:
    
    databaseName - The name of the Amazon Redshift data warehouse (service) you are working with.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDateFormat
```
public void setDateFormat(String dateFormat)
```
    The date format you are using. Valid values are auto (case-sensitive), your date format string enclosed in quotes, or NULL. If this is left unset (NULL), it defaults to a format of 'YYYY-MM-DD'. Using auto recognizes most strings, even some that are not supported when you use a date format string.
    
    If your date and time values use formats different from each other, set this to auto.
    
    Parameters:
    
    dateFormat - The date format you are using. Valid values are auto (case-sensitive), your date format string enclosed in quotes, or NULL. If this is left unset (NULL), it defaults to a format of 'YYYY-MM-DD'. Using auto recognizes most strings, even some that are not supported when you use a date format string.
    
    If your date and time values use formats different from each other, set this to auto.
  - getDateFormat
```
public String getDateFormat()
```
    The date format you are using. Valid values are auto (case-sensitive), your date format string enclosed in quotes, or NULL. If this is left unset (NULL), it defaults to a format of 'YYYY-MM-DD'. Using auto recognizes most strings, even some that are not supported when you use a date format string.
    
    If your date and time values use formats different from each other, set this to auto.
    
    Returns:
    
    The date format you are using. Valid values are auto (case-sensitive), your date format string enclosed in quotes, or NULL. If this is left unset (NULL), it defaults to a format of 'YYYY-MM-DD'. Using auto recognizes most strings, even some that are not supported when you use a date format string.
    
    If your date and time values use formats different from each other, set this to auto.
  - withDateFormat
```
public RedshiftSettings withDateFormat(String dateFormat)
```
    The date format you are using. Valid values are auto (case-sensitive), your date format string enclosed in quotes, or NULL. If this is left unset (NULL), it defaults to a format of 'YYYY-MM-DD'. Using auto recognizes most strings, even some that are not supported when you use a date format string.
    
    If your date and time values use formats different from each other, set this to auto.
    
    Parameters:
    
    dateFormat - The date format you are using. Valid values are auto (case-sensitive), your date format string enclosed in quotes, or NULL. If this is left unset (NULL), it defaults to a format of 'YYYY-MM-DD'. Using auto recognizes most strings, even some that are not supported when you use a date format string.
    
    If your date and time values use formats different from each other, set this to auto.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEmptyAsNull
```
public void setEmptyAsNull(Boolean emptyAsNull)
```
    Specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of TRUE sets empty CHAR and VARCHAR fields to null. The default is FALSE.
    
    Parameters:
    
    emptyAsNull - Specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of TRUE sets empty CHAR and VARCHAR fields to null. The default is FALSE.
  - getEmptyAsNull
```
public Boolean getEmptyAsNull()
```
    Specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of TRUE sets empty CHAR and VARCHAR fields to null. The default is FALSE.
    
    Returns:
    
    Specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of TRUE sets empty CHAR and VARCHAR fields to null. The default is FALSE.
  - withEmptyAsNull
```
public RedshiftSettings withEmptyAsNull(Boolean emptyAsNull)
```
    Specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of TRUE sets empty CHAR and VARCHAR fields to null. The default is FALSE.
    
    Parameters:
    
    emptyAsNull - Specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of TRUE sets empty CHAR and VARCHAR fields to null. The default is FALSE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEmptyAsNull
```
public Boolean isEmptyAsNull()
```
    Specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of TRUE sets empty CHAR and VARCHAR fields to null. The default is FALSE.
    
    Returns:
    
    Specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of TRUE sets empty CHAR and VARCHAR fields to null. The default is FALSE.
  - setEncryptionMode
```
public void setEncryptionMode(String encryptionMode)
```
    The type of server side encryption you want to use for your data. This is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (default) or SSE_KMS. To use SSE_S3, create an IAM role with a policy that allows "arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket".
    
    Parameters:
    
    encryptionMode - The type of server side encryption you want to use for your data. This is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (default) or SSE_KMS. To use SSE_S3, create an IAM role with a policy that allows "arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket".
    
    See Also:
    
    EncryptionModeValue
  - getEncryptionMode
```
public String getEncryptionMode()
```
    The type of server side encryption you want to use for your data. This is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (default) or SSE_KMS. To use SSE_S3, create an IAM role with a policy that allows "arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket".
    
    Returns:
    
    The type of server side encryption you want to use for your data. This is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (default) or SSE_KMS. To use SSE_S3, create an IAM role with a policy that allows "arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket".
    
    See Also:
    
    EncryptionModeValue
  - withEncryptionMode
```
public RedshiftSettings withEncryptionMode(String encryptionMode)
```
    The type of server side encryption you want to use for your data. This is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (default) or SSE_KMS. To use SSE_S3, create an IAM role with a policy that allows "arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket".
    
    Parameters:
    
    encryptionMode - The type of server side encryption you want to use for your data. This is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (default) or SSE_KMS. To use SSE_S3, create an IAM role with a policy that allows "arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EncryptionModeValue
  - withEncryptionMode
```
public RedshiftSettings withEncryptionMode(EncryptionModeValue encryptionMode)
```
    The type of server side encryption you want to use for your data. This is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (default) or SSE_KMS. To use SSE_S3, create an IAM role with a policy that allows "arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket".
    
    Parameters:
    
    encryptionMode - The type of server side encryption you want to use for your data. This is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (default) or SSE_KMS. To use SSE_S3, create an IAM role with a policy that allows "arn:aws:s3:::*" to use the following actions: "s3:PutObject", "s3:ListBucket".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EncryptionModeValue
  - setFileTransferUploadStreams
```
public void setFileTransferUploadStreams(Integer fileTransferUploadStreams)
```
    Specifies the number of threads used to upload a single file. This accepts a value between 1 and 64. It defaults to 10.
    
    Parameters:
    
    fileTransferUploadStreams - Specifies the number of threads used to upload a single file. This accepts a value between 1 and 64. It defaults to 10.
  - getFileTransferUploadStreams
```
public Integer getFileTransferUploadStreams()
```
    Specifies the number of threads used to upload a single file. This accepts a value between 1 and 64. It defaults to 10.
    
    Returns:
    
    Specifies the number of threads used to upload a single file. This accepts a value between 1 and 64. It defaults to 10.
  - withFileTransferUploadStreams
```
public RedshiftSettings withFileTransferUploadStreams(Integer fileTransferUploadStreams)
```
    Specifies the number of threads used to upload a single file. This accepts a value between 1 and 64. It defaults to 10.
    
    Parameters:
    
    fileTransferUploadStreams - Specifies the number of threads used to upload a single file. This accepts a value between 1 and 64. It defaults to 10.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLoadTimeout
```
public void setLoadTimeout(Integer loadTimeout)
```
    Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you begin loading.
    
    Parameters:
    
    loadTimeout - Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you begin loading.
  - getLoadTimeout
```
public Integer getLoadTimeout()
```
    Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you begin loading.
    
    Returns:
    
    Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you begin loading.
  - withLoadTimeout
```
public RedshiftSettings withLoadTimeout(Integer loadTimeout)
```
    Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you begin loading.
    
    Parameters:
    
    loadTimeout - Sets the amount of time to wait (in milliseconds) before timing out, beginning from when you begin loading.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxFileSize
```
public void setMaxFileSize(Integer maxFileSize)
```
    Specifies the maximum size (in KB) of any CSV file used to transfer data to Amazon Redshift. This accepts a value between 1 and 1048576. It defaults to 32768 KB (32 MB).
    
    Parameters:
    
    maxFileSize - Specifies the maximum size (in KB) of any CSV file used to transfer data to Amazon Redshift. This accepts a value between 1 and 1048576. It defaults to 32768 KB (32 MB).
  - getMaxFileSize
```
public Integer getMaxFileSize()
```
    Specifies the maximum size (in KB) of any CSV file used to transfer data to Amazon Redshift. This accepts a value between 1 and 1048576. It defaults to 32768 KB (32 MB).
    
    Returns:
    
    Specifies the maximum size (in KB) of any CSV file used to transfer data to Amazon Redshift. This accepts a value between 1 and 1048576. It defaults to 32768 KB (32 MB).
  - withMaxFileSize
```
public RedshiftSettings withMaxFileSize(Integer maxFileSize)
```
    Specifies the maximum size (in KB) of any CSV file used to transfer data to Amazon Redshift. This accepts a value between 1 and 1048576. It defaults to 32768 KB (32 MB).
    
    Parameters:
    
    maxFileSize - Specifies the maximum size (in KB) of any CSV file used to transfer data to Amazon Redshift. This accepts a value between 1 and 1048576. It defaults to 32768 KB (32 MB).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPassword
```
public void setPassword(String password)
```
    The password for the user named in the username property.
    
    Parameters:
    
    password - The password for the user named in the username property.
  - getPassword
```
public String getPassword()
```
    The password for the user named in the username property.
    
    Returns:
    
    The password for the user named in the username property.
  - withPassword
```
public RedshiftSettings withPassword(String password)
```
    The password for the user named in the username property.
    
    Parameters:
    
    password - The password for the user named in the username property.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPort
```
public void setPort(Integer port)
```
    The port number for Amazon Redshift. The default value is 5439.
    
    Parameters:
    
    port - The port number for Amazon Redshift. The default value is 5439.
  - getPort
```
public Integer getPort()
```
    The port number for Amazon Redshift. The default value is 5439.
    
    Returns:
    
    The port number for Amazon Redshift. The default value is 5439.
  - withPort
```
public RedshiftSettings withPort(Integer port)
```
    The port number for Amazon Redshift. The default value is 5439.
    
    Parameters:
    
    port - The port number for Amazon Redshift. The default value is 5439.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRemoveQuotes
```
public void setRemoveQuotes(Boolean removeQuotes)
```
    Removes surrounding quotation marks from strings in the incoming data. All characters within the quotation marks, including delimiters, are retained. Choose TRUE to remove quotation marks. The default is FALSE.
    
    Parameters:
    
    removeQuotes - Removes surrounding quotation marks from strings in the incoming data. All characters within the quotation marks, including delimiters, are retained. Choose TRUE to remove quotation marks. The default is FALSE.
  - getRemoveQuotes
```
public Boolean getRemoveQuotes()
```
    Removes surrounding quotation marks from strings in the incoming data. All characters within the quotation marks, including delimiters, are retained. Choose TRUE to remove quotation marks. The default is FALSE.
    
    Returns:
    
    Removes surrounding quotation marks from strings in the incoming data. All characters within the quotation marks, including delimiters, are retained. Choose TRUE to remove quotation marks. The default is FALSE.
  - withRemoveQuotes
```
public RedshiftSettings withRemoveQuotes(Boolean removeQuotes)
```
    Removes surrounding quotation marks from strings in the incoming data. All characters within the quotation marks, including delimiters, are retained. Choose TRUE to remove quotation marks. The default is FALSE.
    
    Parameters:
    
    removeQuotes - Removes surrounding quotation marks from strings in the incoming data. All characters within the quotation marks, including delimiters, are retained. Choose TRUE to remove quotation marks. The default is FALSE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isRemoveQuotes
```
public Boolean isRemoveQuotes()
```
    Removes surrounding quotation marks from strings in the incoming data. All characters within the quotation marks, including delimiters, are retained. Choose TRUE to remove quotation marks. The default is FALSE.
    
    Returns:
    
    Removes surrounding quotation marks from strings in the incoming data. All characters within the quotation marks, including delimiters, are retained. Choose TRUE to remove quotation marks. The default is FALSE.
  - setReplaceInvalidChars
```
public void setReplaceInvalidChars(String replaceInvalidChars)
```
    A list of chars you want to replace. Use with ReplaceChars.
    
    Parameters:
    
    replaceInvalidChars - A list of chars you want to replace. Use with ReplaceChars.
  - getReplaceInvalidChars
```
public String getReplaceInvalidChars()
```
    A list of chars you want to replace. Use with ReplaceChars.
    
    Returns:
    
    A list of chars you want to replace. Use with ReplaceChars.
  - withReplaceInvalidChars
```
public RedshiftSettings withReplaceInvalidChars(String replaceInvalidChars)
```
    A list of chars you want to replace. Use with ReplaceChars.
    
    Parameters:
    
    replaceInvalidChars - A list of chars you want to replace. Use with ReplaceChars.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReplaceChars
```
public void setReplaceChars(String replaceChars)
```
    Replaces invalid characters specified in ReplaceInvalidChars, substituting the specified value instead. The default is "?".
    
    Parameters:
    
    replaceChars - Replaces invalid characters specified in ReplaceInvalidChars, substituting the specified value instead. The default is "?".
  - getReplaceChars
```
public String getReplaceChars()
```
    Replaces invalid characters specified in ReplaceInvalidChars, substituting the specified value instead. The default is "?".
    
    Returns:
    
    Replaces invalid characters specified in ReplaceInvalidChars, substituting the specified value instead. The default is "?".
  - withReplaceChars
```
public RedshiftSettings withReplaceChars(String replaceChars)
```
    Replaces invalid characters specified in ReplaceInvalidChars, substituting the specified value instead. The default is "?".
    
    Parameters:
    
    replaceChars - Replaces invalid characters specified in ReplaceInvalidChars, substituting the specified value instead. The default is "?".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setServerName
```
public void setServerName(String serverName)
```
    The name of the Amazon Redshift cluster you are using.
    
    Parameters:
    
    serverName - The name of the Amazon Redshift cluster you are using.
  - getServerName
```
public String getServerName()
```
    The name of the Amazon Redshift cluster you are using.
    
    Returns:
    
    The name of the Amazon Redshift cluster you are using.
  - withServerName
```
public RedshiftSettings withServerName(String serverName)
```
    The name of the Amazon Redshift cluster you are using.
    
    Parameters:
    
    serverName - The name of the Amazon Redshift cluster you are using.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setServiceAccessRoleArn
```
public void setServiceAccessRoleArn(String serviceAccessRoleArn)
```
    The ARN of the role that has access to the Redshift service.
    
    Parameters:
    
    serviceAccessRoleArn - The ARN of the role that has access to the Redshift service.
  - getServiceAccessRoleArn
```
public String getServiceAccessRoleArn()
```
    The ARN of the role that has access to the Redshift service.
    
    Returns:
    
    The ARN of the role that has access to the Redshift service.
  - withServiceAccessRoleArn
```
public RedshiftSettings withServiceAccessRoleArn(String serviceAccessRoleArn)
```
    The ARN of the role that has access to the Redshift service.
    
    Parameters:
    
    serviceAccessRoleArn - The ARN of the role that has access to the Redshift service.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setServerSideEncryptionKmsKeyId
```
public void setServerSideEncryptionKmsKeyId(String serverSideEncryptionKmsKeyId)
```
    If you are using SSE_KMS for the EncryptionMode, provide the KMS Key ID. The key you use needs an attached policy that enables IAM user permissions and allows use of the key.
    
    Parameters:
    
    serverSideEncryptionKmsKeyId - If you are using SSE_KMS for the EncryptionMode, provide the KMS Key ID. The key you use needs an attached policy that enables IAM user permissions and allows use of the key.
  - getServerSideEncryptionKmsKeyId
```
public String getServerSideEncryptionKmsKeyId()
```
    If you are using SSE_KMS for the EncryptionMode, provide the KMS Key ID. The key you use needs an attached policy that enables IAM user permissions and allows use of the key.
    
    Returns:
    
    If you are using SSE_KMS for the EncryptionMode, provide the KMS Key ID. The key you use needs an attached policy that enables IAM user permissions and allows use of the key.
  - withServerSideEncryptionKmsKeyId
```
public RedshiftSettings withServerSideEncryptionKmsKeyId(String serverSideEncryptionKmsKeyId)
```
    If you are using SSE_KMS for the EncryptionMode, provide the KMS Key ID. The key you use needs an attached policy that enables IAM user permissions and allows use of the key.
    
    Parameters:
    
    serverSideEncryptionKmsKeyId - If you are using SSE_KMS for the EncryptionMode, provide the KMS Key ID. The key you use needs an attached policy that enables IAM user permissions and allows use of the key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeFormat
```
public void setTimeFormat(String timeFormat)
```
    The time format you want to use. Valid values are auto (case-sensitive), 'timeformat_string', 'epochsecs', or 'epochmillisecs'. It defaults to 10. Using auto recognizes most strings, even some that are not supported when you use a time format string.
    
    If your date and time values use formats different from each other, set this to auto.
    
    Parameters:
    
    timeFormat - The time format you want to use. Valid values are auto (case-sensitive), 'timeformat_string', 'epochsecs', or 'epochmillisecs'. It defaults to 10. Using auto recognizes most strings, even some that are not supported when you use a time format string.
    
    If your date and time values use formats different from each other, set this to auto.
  - getTimeFormat
```
public String getTimeFormat()
```
    The time format you want to use. Valid values are auto (case-sensitive), 'timeformat_string', 'epochsecs', or 'epochmillisecs'. It defaults to 10. Using auto recognizes most strings, even some that are not supported when you use a time format string.
    
    If your date and time values use formats different from each other, set this to auto.
    
    Returns:
    
    The time format you want to use. Valid values are auto (case-sensitive), 'timeformat_string', 'epochsecs', or 'epochmillisecs'. It defaults to 10. Using auto recognizes most strings, even some that are not supported when you use a time format string.
    
    If your date and time values use formats different from each other, set this to auto.
  - withTimeFormat
```
public RedshiftSettings withTimeFormat(String timeFormat)
```
    The time format you want to use. Valid values are auto (case-sensitive), 'timeformat_string', 'epochsecs', or 'epochmillisecs'. It defaults to 10. Using auto recognizes most strings, even some that are not supported when you use a time format string.
    
    If your date and time values use formats different from each other, set this to auto.
    
    Parameters:
    
    timeFormat - The time format you want to use. Valid values are auto (case-sensitive), 'timeformat_string', 'epochsecs', or 'epochmillisecs'. It defaults to 10. Using auto recognizes most strings, even some that are not supported when you use a time format string.
    
    If your date and time values use formats different from each other, set this to auto.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTrimBlanks
```
public void setTrimBlanks(Boolean trimBlanks)
```
    Removes the trailing white space characters from a VARCHAR string. This parameter applies only to columns with a VARCHAR data type. Choose TRUE to remove unneeded white space. The default is FALSE.
    
    Parameters:
    
    trimBlanks - Removes the trailing white space characters from a VARCHAR string. This parameter applies only to columns with a VARCHAR data type. Choose TRUE to remove unneeded white space. The default is FALSE.
  - getTrimBlanks
```
public Boolean getTrimBlanks()
```
    Removes the trailing white space characters from a VARCHAR string. This parameter applies only to columns with a VARCHAR data type. Choose TRUE to remove unneeded white space. The default is FALSE.
    
    Returns:
    
    Removes the trailing white space characters from a VARCHAR string. This parameter applies only to columns with a VARCHAR data type. Choose TRUE to remove unneeded white space. The default is FALSE.
  - withTrimBlanks
```
public RedshiftSettings withTrimBlanks(Boolean trimBlanks)
```
    Removes the trailing white space characters from a VARCHAR string. This parameter applies only to columns with a VARCHAR data type. Choose TRUE to remove unneeded white space. The default is FALSE.
    
    Parameters:
    
    trimBlanks - Removes the trailing white space characters from a VARCHAR string. This parameter applies only to columns with a VARCHAR data type. Choose TRUE to remove unneeded white space. The default is FALSE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isTrimBlanks
```
public Boolean isTrimBlanks()
```
    Removes the trailing white space characters from a VARCHAR string. This parameter applies only to columns with a VARCHAR data type. Choose TRUE to remove unneeded white space. The default is FALSE.
    
    Returns:
    
    Removes the trailing white space characters from a VARCHAR string. This parameter applies only to columns with a VARCHAR data type. Choose TRUE to remove unneeded white space. The default is FALSE.
  - setTruncateColumns
```
public void setTruncateColumns(Boolean truncateColumns)
```
    Truncates data in columns to the appropriate number of characters, so that it fits in the column. Applies only to columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less. Choose TRUE to truncate data. The default is FALSE.
    
    Parameters:
    
    truncateColumns - Truncates data in columns to the appropriate number of characters, so that it fits in the column. Applies only to columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less. Choose TRUE to truncate data. The default is FALSE.
  - getTruncateColumns
```
public Boolean getTruncateColumns()
```
    Truncates data in columns to the appropriate number of characters, so that it fits in the column. Applies only to columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less. Choose TRUE to truncate data. The default is FALSE.
    
    Returns:
    
    Truncates data in columns to the appropriate number of characters, so that it fits in the column. Applies only to columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less. Choose TRUE to truncate data. The default is FALSE.
  - withTruncateColumns
```
public RedshiftSettings withTruncateColumns(Boolean truncateColumns)
```
    Truncates data in columns to the appropriate number of characters, so that it fits in the column. Applies only to columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less. Choose TRUE to truncate data. The default is FALSE.
    
    Parameters:
    
    truncateColumns - Truncates data in columns to the appropriate number of characters, so that it fits in the column. Applies only to columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less. Choose TRUE to truncate data. The default is FALSE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isTruncateColumns
```
public Boolean isTruncateColumns()
```
    Truncates data in columns to the appropriate number of characters, so that it fits in the column. Applies only to columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less. Choose TRUE to truncate data. The default is FALSE.
    
    Returns:
    
    Truncates data in columns to the appropriate number of characters, so that it fits in the column. Applies only to columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less. Choose TRUE to truncate data. The default is FALSE.
  - setUsername
```
public void setUsername(String username)
```
    An Amazon Redshift user name for a registered user.
    
    Parameters:
    
    username - An Amazon Redshift user name for a registered user.
  - getUsername
```
public String getUsername()
```
    An Amazon Redshift user name for a registered user.
    
    Returns:
    
    An Amazon Redshift user name for a registered user.
  - withUsername
```
public RedshiftSettings withUsername(String username)
```
    An Amazon Redshift user name for a registered user.
    
    Parameters:
    
    username - An Amazon Redshift user name for a registered user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWriteBufferSize
```
public void setWriteBufferSize(Integer writeBufferSize)
```
    The size of the write buffer to use in rows. Valid values range from 1 to 2048. Defaults to 1024. Use this setting to tune performance.
    
    Parameters:
    
    writeBufferSize - The size of the write buffer to use in rows. Valid values range from 1 to 2048. Defaults to 1024. Use this setting to tune performance.
  - getWriteBufferSize
```
public Integer getWriteBufferSize()
```
    The size of the write buffer to use in rows. Valid values range from 1 to 2048. Defaults to 1024. Use this setting to tune performance.
    
    Returns:
    
    The size of the write buffer to use in rows. Valid values range from 1 to 2048. Defaults to 1024. Use this setting to tune performance.
  - withWriteBufferSize
```
public RedshiftSettings withWriteBufferSize(Integer writeBufferSize)
```
    The size of the write buffer to use in rows. Valid values range from 1 to 2048. Defaults to 1024. Use this setting to tune performance.
    
    Parameters:
    
    writeBufferSize - The size of the write buffer to use in rows. Valid values range from 1 to 2048. Defaults to 1024. Use this setting to tune performance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public RedshiftSettings clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class RedshiftSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RedshiftSettings

Method Detail

setAcceptAnyDate

getAcceptAnyDate

withAcceptAnyDate

isAcceptAnyDate

setAfterConnectScript

getAfterConnectScript

withAfterConnectScript

setBucketFolder

getBucketFolder

withBucketFolder

setBucketName

getBucketName

withBucketName

setConnectionTimeout

getConnectionTimeout

withConnectionTimeout

setDatabaseName

getDatabaseName

withDatabaseName

setDateFormat

getDateFormat

withDateFormat

setEmptyAsNull

getEmptyAsNull

withEmptyAsNull

isEmptyAsNull

setEncryptionMode

getEncryptionMode

withEncryptionMode

withEncryptionMode

setFileTransferUploadStreams

getFileTransferUploadStreams

withFileTransferUploadStreams

setLoadTimeout

getLoadTimeout

withLoadTimeout

setMaxFileSize

getMaxFileSize

withMaxFileSize

setPassword

getPassword

withPassword

setPort

getPort

withPort

setRemoveQuotes

getRemoveQuotes

withRemoveQuotes

isRemoveQuotes

setReplaceInvalidChars

getReplaceInvalidChars

withReplaceInvalidChars

setReplaceChars

getReplaceChars

withReplaceChars

setServerName

getServerName

withServerName

setServiceAccessRoleArn

getServiceAccessRoleArn

withServiceAccessRoleArn

setServerSideEncryptionKmsKeyId

getServerSideEncryptionKmsKeyId

withServerSideEncryptionKmsKeyId

setTimeFormat

getTimeFormat

withTimeFormat

setTrimBlanks

getTrimBlanks

withTrimBlanks

isTrimBlanks

setTruncateColumns