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:

  • Method Details

    • 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 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.

    • toBuilder

      public CopyCommand.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CopyCommand.Builder,CopyCommand>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.