Package software.amazon.awssdk.services.firehose.model

Class CopyCommand

java.lang.Object

software.amazon.awssdk.services.firehose.model.CopyCommand

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CopyCommand.Builder,CopyCommand>

@Generated("software.amazon.awssdk:codegen")
public final class CopyCommand
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CopyCommand.Builder,CopyCommand>

Describes a COPY command for Amazon Redshift.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CopyCommand.Builder

Method Summary

Modifier and Type	Method	Description
static CopyCommand.Builder	builder()
String	copyOptions()	Optional parameters to use with the Amazon Redshift COPY command.
String	dataTableColumns()	A comma-separated list of column names.
String	dataTableName()	The name of the target table.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends CopyCommand.Builder>	serializableBuilderClass()
CopyCommand.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

dataTableName

public final String dataTableName()

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.

dataTableColumns

public final String dataTableColumns()

A comma-separated list of column names.

Returns:

A comma-separated list of column names.

copyOptions

public final 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 Kinesis Data 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 Kinesis Data 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.

toBuilder

public CopyCommand.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CopyCommand.Builder,CopyCommand>

builder

public static CopyCommand.Builder builder()

serializableBuilderClass

public static Class<? extends CopyCommand.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo