java.lang.Object
com.amazonaws.services.kinesisfirehose.model.CopyCommand
All Implemented Interfaces:
Serializable, Cloneable

public class CopyCommand extends Object implements Serializable, Cloneable

Describes a COPY command for Amazon Redshift.

See Also:
  • Constructor Details

    • CopyCommand

      public CopyCommand()
  • Method Details

    • setDataTableName

      public void setDataTableName(String dataTableName)

      The name of the target table. The table must already exist in the database.

      Parameters:
      dataTableName - The name of the target table. The table must already exist in the database.
    • getDataTableName

      public String getDataTableName()

      The name of the target table. The table must already exist in the database.

      Returns:
      The name of the target table. The table must already exist in the database.
    • withDataTableName

      public CopyCommand withDataTableName(String dataTableName)

      The name of the target table. The table must already exist in the database.

      Parameters:
      dataTableName - The name of the target table. The table must already exist in the database.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setDataTableColumns

      public void setDataTableColumns(String dataTableColumns)

      A comma-separated list of column names.

      Parameters:
      dataTableColumns - A comma-separated list of column names.
    • getDataTableColumns

      public String getDataTableColumns()

      A comma-separated list of column names.

      Returns:
      A comma-separated list of column names.
    • withDataTableColumns

      public CopyCommand withDataTableColumns(String dataTableColumns)

      A comma-separated list of column names.

      Parameters:
      dataTableColumns - A comma-separated list of column names.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setCopyOptions

      public void setCopyOptions(String copyOptions)

      Optional parameters to use with the Amazon Redshift COPY command. For more information, see the "Optional Parameters" section of Amazon Redshift COPY command. Some possible examples that would apply to Firehose are as follows.

      delimiter '\t' lzop; - fields are delimited with "\t" (TAB character) and compressed using lzop.

      delimiter '| - fields are delimited with "|" (this is the default delimiter).

      delimiter '|' escape - the delimiter should be escaped.

      fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6' - fields are fixed width in the source, with each width specified after every column in the table.

      JSON 's3://mybucket/jsonpaths.txt' - data is in JSON format, and the path specified is the format of the data.

      For more examples, see Amazon Redshift COPY command examples.

      Parameters:
      copyOptions - Optional parameters to use with the Amazon Redshift COPY command. For more information, see the "Optional Parameters" section of Amazon Redshift COPY command. Some possible examples that would apply to Firehose are as follows.

      delimiter '\t' lzop; - fields are delimited with "\t" (TAB character) and compressed using lzop.

      delimiter '| - fields are delimited with "|" (this is the default delimiter).

      delimiter '|' escape - the delimiter should be escaped.

      fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6' - fields are fixed width in the source, with each width specified after every column in the table.

      JSON 's3://mybucket/jsonpaths.txt' - data is in JSON format, and the path specified is the format of the data.

      For more examples, see Amazon Redshift COPY command examples.

    • getCopyOptions

      public String getCopyOptions()

      Optional parameters to use with the Amazon Redshift COPY command. For more information, see the "Optional Parameters" section of Amazon Redshift COPY command. Some possible examples that would apply to Firehose are as follows.

      delimiter '\t' lzop; - fields are delimited with "\t" (TAB character) and compressed using lzop.

      delimiter '| - fields are delimited with "|" (this is the default delimiter).

      delimiter '|' escape - the delimiter should be escaped.

      fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6' - fields are fixed width in the source, with each width specified after every column in the table.

      JSON 's3://mybucket/jsonpaths.txt' - data is in JSON format, and the path specified is the format of the data.

      For more examples, see Amazon Redshift COPY command examples.

      Returns:
      Optional parameters to use with the Amazon Redshift COPY command. For more information, see the "Optional Parameters" section of Amazon Redshift COPY command. Some possible examples that would apply to Firehose are as follows.

      delimiter '\t' lzop; - fields are delimited with "\t" (TAB character) and compressed using lzop.

      delimiter '| - fields are delimited with "|" (this is the default delimiter).

      delimiter '|' escape - the delimiter should be escaped.

      fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6' - fields are fixed width in the source, with each width specified after every column in the table.

      JSON 's3://mybucket/jsonpaths.txt' - data is in JSON format, and the path specified is the format of the data.

      For more examples, see Amazon Redshift COPY command examples.

    • withCopyOptions

      public CopyCommand withCopyOptions(String copyOptions)

      Optional parameters to use with the Amazon Redshift COPY command. For more information, see the "Optional Parameters" section of Amazon Redshift COPY command. Some possible examples that would apply to Firehose are as follows.

      delimiter '\t' lzop; - fields are delimited with "\t" (TAB character) and compressed using lzop.

      delimiter '| - fields are delimited with "|" (this is the default delimiter).

      delimiter '|' escape - the delimiter should be escaped.

      fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6' - fields are fixed width in the source, with each width specified after every column in the table.

      JSON 's3://mybucket/jsonpaths.txt' - data is in JSON format, and the path specified is the format of the data.

      For more examples, see Amazon Redshift COPY command examples.

      Parameters:
      copyOptions - Optional parameters to use with the Amazon Redshift COPY command. For more information, see the "Optional Parameters" section of Amazon Redshift COPY command. Some possible examples that would apply to Firehose are as follows.

      delimiter '\t' lzop; - fields are delimited with "\t" (TAB character) and compressed using lzop.

      delimiter '| - fields are delimited with "|" (this is the default delimiter).

      delimiter '|' escape - the delimiter should be escaped.

      fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6' - fields are fixed width in the source, with each width specified after every column in the table.

      JSON 's3://mybucket/jsonpaths.txt' - data is in JSON format, and the path specified is the format of the data.

      For more examples, see Amazon Redshift COPY command examples.

      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; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public CopyCommand clone()
      Overrides:
      clone in class Object