Class AmazonRedshiftNodeData

java.lang.Object
software.amazon.awssdk.services.glue.model.AmazonRedshiftNodeData
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AmazonRedshiftNodeData.Builder,AmazonRedshiftNodeData>
@Generated("software.amazon.awssdk:codegen") public final class AmazonRedshiftNodeData extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AmazonRedshiftNodeData.Builder,AmazonRedshiftNodeData>

Specifies an Amazon Redshift node.

See Also:

  • Method Details

    • accessType

      public final String accessType()

      The access type for the Redshift connection. Can be a direct connection or catalog connections.

      Returns:
      The access type for the Redshift connection. Can be a direct connection or catalog connections.

    • sourceType

      public final String sourceType()

      The source type to specify whether a specific table is the source or a custom query.

      Returns:
      The source type to specify whether a specific table is the source or a custom query.

    • connection

      public final Option connection()

      The Glue connection to the Redshift cluster.

      Returns:
      The Glue connection to the Redshift cluster.

    • schema

      public final Option schema()

      The Redshift schema name when working with a direct connection.

      Returns:
      The Redshift schema name when working with a direct connection.

    • table

      public final Option table()

      The Redshift table name when working with a direct connection.

      Returns:
      The Redshift table name when working with a direct connection.

    • catalogDatabase

      public final Option catalogDatabase()

      The name of the Glue Data Catalog database when working with a data catalog.

      Returns:
      The name of the Glue Data Catalog database when working with a data catalog.

    • catalogTable

      public final Option catalogTable()

      The Glue Data Catalog table name when working with a data catalog.

      Returns:
      The Glue Data Catalog table name when working with a data catalog.

    • catalogRedshiftSchema

      public final String catalogRedshiftSchema()

      The Redshift schema name when working with a data catalog.

      Returns:
      The Redshift schema name when working with a data catalog.

    • catalogRedshiftTable

      public final String catalogRedshiftTable()

      The database table to read from.

      Returns:
      The database table to read from.

    • tempDir

      public final String tempDir()

      The Amazon S3 path where temporary data can be staged when copying out of the database.

      Returns:
      The Amazon S3 path where temporary data can be staged when copying out of the database.

    • iamRole

      public final Option iamRole()

      Optional. The role name use when connection to S3. The IAM role ill default to the role on the job when left blank.

      Returns:
      Optional. The role name use when connection to S3. The IAM role ill default to the role on the job when left blank.

    • hasAdvancedOptions

      public final boolean hasAdvancedOptions()
      For responses, this returns true if the service returned a value for the AdvancedOptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • advancedOptions

      public final List<AmazonRedshiftAdvancedOption> advancedOptions()

      Optional values when connecting to the Redshift cluster.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdvancedOptions() method.

      Returns:
      Optional values when connecting to the Redshift cluster.

    • sampleQuery

      public final String sampleQuery()

      The SQL used to fetch the data from a Redshift sources when the SourceType is 'query'.

      Returns:
      The SQL used to fetch the data from a Redshift sources when the SourceType is 'query'.

    • preAction

      public final String preAction()

      The SQL used before a MERGE or APPEND with upsert is run.

      Returns:
      The SQL used before a MERGE or APPEND with upsert is run.

    • postAction

      public final String postAction()

      The SQL used before a MERGE or APPEND with upsert is run.

      Returns:
      The SQL used before a MERGE or APPEND with upsert is run.

    • action

      public final String action()

      Specifies how writing to a Redshift cluser will occur.

      Returns:
      Specifies how writing to a Redshift cluser will occur.

    • tablePrefix

      public final String tablePrefix()

      Specifies the prefix to a table.

      Returns:
      Specifies the prefix to a table.

    • upsert

      public final Boolean upsert()

      The action used on Redshift sinks when doing an APPEND.

      Returns:
      The action used on Redshift sinks when doing an APPEND.

    • mergeAction

      public final String mergeAction()

      The action used when to detemine how a MERGE in a Redshift sink will be handled.

      Returns:
      The action used when to detemine how a MERGE in a Redshift sink will be handled.

    • mergeWhenMatched

      public final String mergeWhenMatched()

      The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record matches a new record.

      Returns:
      The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record matches a new record.

    • mergeWhenNotMatched

      public final String mergeWhenNotMatched()

      The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record doesn't match a new record.

      Returns:
      The action used when to detemine how a MERGE in a Redshift sink will be handled when an existing record doesn't match a new record.

    • mergeClause

      public final String mergeClause()

      The SQL used in a custom merge to deal with matching records.

      Returns:
      The SQL used in a custom merge to deal with matching records.

    • crawlerConnection

      public final String crawlerConnection()

      Specifies the name of the connection that is associated with the catalog table used.

      Returns:
      Specifies the name of the connection that is associated with the catalog table used.

    • hasTableSchema

      public final boolean hasTableSchema()
      For responses, this returns true if the service returned a value for the TableSchema property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tableSchema

      public final List<Option> tableSchema()

      The array of schema output for a given node.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTableSchema() method.

      Returns:
      The array of schema output for a given node.

    • stagingTable

      public final String stagingTable()

      The name of the temporary staging table that is used when doing a MERGE or APPEND with upsert.

      Returns:
      The name of the temporary staging table that is used when doing a MERGE or APPEND with upsert.

    • hasSelectedColumns

      public final boolean hasSelectedColumns()
      For responses, this returns true if the service returned a value for the SelectedColumns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • selectedColumns

      public final List<Option> selectedColumns()

      The list of column names used to determine a matching record when doing a MERGE or APPEND with upsert.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSelectedColumns() method.

      Returns:
      The list of column names used to determine a matching record when doing a MERGE or APPEND with upsert.

    • toBuilder

      public AmazonRedshiftNodeData.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<AmazonRedshiftNodeData.Builder,AmazonRedshiftNodeData>
      Returns:
      a builder for type T

    • builder

      public static AmazonRedshiftNodeData.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AmazonRedshiftNodeData.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.