AWS SDK for C++  1.8.94
AWS SDK for C++
Public Member Functions | List of all members
Aws::Firehose::Model::CopyCommand Class Reference

#include <CopyCommand.h>

Public Member Functions

 CopyCommand ()
 
 CopyCommand (Aws::Utils::Json::JsonView jsonValue)
 
CopyCommandoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetDataTableName () const
 
bool DataTableNameHasBeenSet () const
 
void SetDataTableName (const Aws::String &value)
 
void SetDataTableName (Aws::String &&value)
 
void SetDataTableName (const char *value)
 
CopyCommandWithDataTableName (const Aws::String &value)
 
CopyCommandWithDataTableName (Aws::String &&value)
 
CopyCommandWithDataTableName (const char *value)
 
const Aws::StringGetDataTableColumns () const
 
bool DataTableColumnsHasBeenSet () const
 
void SetDataTableColumns (const Aws::String &value)
 
void SetDataTableColumns (Aws::String &&value)
 
void SetDataTableColumns (const char *value)
 
CopyCommandWithDataTableColumns (const Aws::String &value)
 
CopyCommandWithDataTableColumns (Aws::String &&value)
 
CopyCommandWithDataTableColumns (const char *value)
 
const Aws::StringGetCopyOptions () const
 
bool CopyOptionsHasBeenSet () const
 
void SetCopyOptions (const Aws::String &value)
 
void SetCopyOptions (Aws::String &&value)
 
void SetCopyOptions (const char *value)
 
CopyCommandWithCopyOptions (const Aws::String &value)
 
CopyCommandWithCopyOptions (Aws::String &&value)
 
CopyCommandWithCopyOptions (const char *value)
 

Detailed Description

Describes a COPY command for Amazon Redshift.

See Also:

AWS API Reference

Definition at line 32 of file CopyCommand.h.

Constructor & Destructor Documentation

◆ CopyCommand() [1/2]

Aws::Firehose::Model::CopyCommand::CopyCommand ( )

◆ CopyCommand() [2/2]

Aws::Firehose::Model::CopyCommand::CopyCommand ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ CopyOptionsHasBeenSet()

bool Aws::Firehose::Model::CopyCommand::CopyOptionsHasBeenSet ( ) const
inline

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 Kinesis Data Firehose are as follows:

delimiter '' 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.

Definition at line 169 of file CopyCommand.h.

◆ DataTableColumnsHasBeenSet()

bool Aws::Firehose::Model::CopyCommand::DataTableColumnsHasBeenSet ( ) const
inline

A comma-separated list of column names.

Definition at line 98 of file CopyCommand.h.

◆ DataTableNameHasBeenSet()

bool Aws::Firehose::Model::CopyCommand::DataTableNameHasBeenSet ( ) const
inline

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

Definition at line 51 of file CopyCommand.h.

◆ GetCopyOptions()

const Aws::String& Aws::Firehose::Model::CopyCommand::GetCopyOptions ( ) const
inline

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 Kinesis Data Firehose are as follows:

delimiter '' 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.

Definition at line 149 of file CopyCommand.h.

◆ GetDataTableColumns()

const Aws::String& Aws::Firehose::Model::CopyCommand::GetDataTableColumns ( ) const
inline

A comma-separated list of column names.

Definition at line 93 of file CopyCommand.h.

◆ GetDataTableName()

const Aws::String& Aws::Firehose::Model::CopyCommand::GetDataTableName ( ) const
inline

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

Definition at line 45 of file CopyCommand.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Firehose::Model::CopyCommand::Jsonize ( ) const

◆ operator=()

CopyCommand& Aws::Firehose::Model::CopyCommand::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetCopyOptions() [1/3]

void Aws::Firehose::Model::CopyCommand::SetCopyOptions ( const Aws::String value)
inline

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 Kinesis Data Firehose are as follows:

delimiter '' 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.

Definition at line 189 of file CopyCommand.h.

◆ SetCopyOptions() [2/3]

void Aws::Firehose::Model::CopyCommand::SetCopyOptions ( Aws::String &&  value)
inline

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 Kinesis Data Firehose are as follows:

delimiter '' 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.

Definition at line 209 of file CopyCommand.h.

◆ SetCopyOptions() [3/3]

void Aws::Firehose::Model::CopyCommand::SetCopyOptions ( const char *  value)
inline

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 Kinesis Data Firehose are as follows:

delimiter '' 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.

Definition at line 229 of file CopyCommand.h.

◆ SetDataTableColumns() [1/3]

void Aws::Firehose::Model::CopyCommand::SetDataTableColumns ( const Aws::String value)
inline

A comma-separated list of column names.

Definition at line 103 of file CopyCommand.h.

◆ SetDataTableColumns() [2/3]

void Aws::Firehose::Model::CopyCommand::SetDataTableColumns ( Aws::String &&  value)
inline

A comma-separated list of column names.

Definition at line 108 of file CopyCommand.h.

◆ SetDataTableColumns() [3/3]

void Aws::Firehose::Model::CopyCommand::SetDataTableColumns ( const char *  value)
inline

A comma-separated list of column names.

Definition at line 113 of file CopyCommand.h.

◆ SetDataTableName() [1/3]

void Aws::Firehose::Model::CopyCommand::SetDataTableName ( const Aws::String value)
inline

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

Definition at line 57 of file CopyCommand.h.

◆ SetDataTableName() [2/3]

void Aws::Firehose::Model::CopyCommand::SetDataTableName ( Aws::String &&  value)
inline

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

Definition at line 63 of file CopyCommand.h.

◆ SetDataTableName() [3/3]

void Aws::Firehose::Model::CopyCommand::SetDataTableName ( const char *  value)
inline

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

Definition at line 69 of file CopyCommand.h.

◆ WithCopyOptions() [1/3]

CopyCommand& Aws::Firehose::Model::CopyCommand::WithCopyOptions ( const Aws::String value)
inline

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 Kinesis Data Firehose are as follows:

delimiter '' 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.

Definition at line 249 of file CopyCommand.h.

◆ WithCopyOptions() [2/3]

CopyCommand& Aws::Firehose::Model::CopyCommand::WithCopyOptions ( Aws::String &&  value)
inline

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 Kinesis Data Firehose are as follows:

delimiter '' 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.

Definition at line 269 of file CopyCommand.h.

◆ WithCopyOptions() [3/3]

CopyCommand& Aws::Firehose::Model::CopyCommand::WithCopyOptions ( const char *  value)
inline

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 Kinesis Data Firehose are as follows:

delimiter '' 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.

Definition at line 289 of file CopyCommand.h.

◆ WithDataTableColumns() [1/3]

CopyCommand& Aws::Firehose::Model::CopyCommand::WithDataTableColumns ( const Aws::String value)
inline

A comma-separated list of column names.

Definition at line 118 of file CopyCommand.h.

◆ WithDataTableColumns() [2/3]

CopyCommand& Aws::Firehose::Model::CopyCommand::WithDataTableColumns ( Aws::String &&  value)
inline

A comma-separated list of column names.

Definition at line 123 of file CopyCommand.h.

◆ WithDataTableColumns() [3/3]

CopyCommand& Aws::Firehose::Model::CopyCommand::WithDataTableColumns ( const char *  value)
inline

A comma-separated list of column names.

Definition at line 128 of file CopyCommand.h.

◆ WithDataTableName() [1/3]

CopyCommand& Aws::Firehose::Model::CopyCommand::WithDataTableName ( const Aws::String value)
inline

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

Definition at line 75 of file CopyCommand.h.

◆ WithDataTableName() [2/3]

CopyCommand& Aws::Firehose::Model::CopyCommand::WithDataTableName ( Aws::String &&  value)
inline

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

Definition at line 81 of file CopyCommand.h.

◆ WithDataTableName() [3/3]

CopyCommand& Aws::Firehose::Model::CopyCommand::WithDataTableName ( const char *  value)
inline

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

Definition at line 87 of file CopyCommand.h.


The documentation for this class was generated from the following file: