Package software.amazon.awssdk.services.glue.model

Interface AmazonRedshiftNodeData.Builder

    • Method Detail

      • accessType

        AmazonRedshiftNodeData.Builder accessType​(String accessType)

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

        Parameters:
        accessType - The access type for the Redshift connection. Can be a direct connection or catalog connections.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sourceType

        AmazonRedshiftNodeData.Builder sourceType​(String sourceType)

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

        Parameters:
        sourceType - The source type to specify whether a specific table is the source or a custom query.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • connection

        AmazonRedshiftNodeData.Builder connection​(Option connection)

        The Glue connection to the Redshift cluster.

        Parameters:
        connection - The Glue connection to the Redshift cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • schema

        AmazonRedshiftNodeData.Builder schema​(Option schema)

        The Redshift schema name when working with a direct connection.

        Parameters:
        schema - The Redshift schema name when working with a direct connection.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • table

        AmazonRedshiftNodeData.Builder table​(Option table)

        The Redshift table name when working with a direct connection.

        Parameters:
        table - The Redshift table name when working with a direct connection.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • catalogDatabase

        AmazonRedshiftNodeData.Builder catalogDatabase​(Option catalogDatabase)

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

        Parameters:
        catalogDatabase - The name of the Glue Data Catalog database when working with a data catalog.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • catalogTable

        AmazonRedshiftNodeData.Builder catalogTable​(Option catalogTable)

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

        Parameters:
        catalogTable - The Glue Data Catalog table name when working with a data catalog.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • catalogRedshiftSchema

        AmazonRedshiftNodeData.Builder catalogRedshiftSchema​(String catalogRedshiftSchema)

        The Redshift schema name when working with a data catalog.

        Parameters:
        catalogRedshiftSchema - The Redshift schema name when working with a data catalog.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • catalogRedshiftTable

        AmazonRedshiftNodeData.Builder catalogRedshiftTable​(String catalogRedshiftTable)

        The database table to read from.

        Parameters:
        catalogRedshiftTable - The database table to read from.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tempDir

        AmazonRedshiftNodeData.Builder tempDir​(String tempDir)

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

        Parameters:
        tempDir - The Amazon S3 path where temporary data can be staged when copying out of the database.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • iamRole

        AmazonRedshiftNodeData.Builder iamRole​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • advancedOptions

        AmazonRedshiftNodeData.Builder advancedOptions​(Collection<AmazonRedshiftAdvancedOption> advancedOptions)

        Optional values when connecting to the Redshift cluster.

        Parameters:
        advancedOptions - Optional values when connecting to the Redshift cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • advancedOptions

        AmazonRedshiftNodeData.Builder advancedOptions​(AmazonRedshiftAdvancedOption... advancedOptions)

        Optional values when connecting to the Redshift cluster.

        Parameters:
        advancedOptions - Optional values when connecting to the Redshift cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sampleQuery

        AmazonRedshiftNodeData.Builder sampleQuery​(String sampleQuery)

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

        Parameters:
        sampleQuery - The SQL used to fetch the data from a Redshift sources when the SourceType is 'query'.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • preAction

        AmazonRedshiftNodeData.Builder preAction​(String preAction)

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

        Parameters:
        preAction - The SQL used before a MERGE or APPEND with upsert is run.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • postAction

        AmazonRedshiftNodeData.Builder postAction​(String postAction)

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

        Parameters:
        postAction - The SQL used before a MERGE or APPEND with upsert is run.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • action

        AmazonRedshiftNodeData.Builder action​(String action)

        Specifies how writing to a Redshift cluser will occur.

        Parameters:
        action - Specifies how writing to a Redshift cluser will occur.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tablePrefix

        AmazonRedshiftNodeData.Builder tablePrefix​(String tablePrefix)

        Specifies the prefix to a table.

        Parameters:
        tablePrefix - Specifies the prefix to a table.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • upsert

        AmazonRedshiftNodeData.Builder upsert​(Boolean upsert)

        The action used on Redshift sinks when doing an APPEND.

        Parameters:
        upsert - The action used on Redshift sinks when doing an APPEND.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • mergeAction

        AmazonRedshiftNodeData.Builder mergeAction​(String mergeAction)

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

        Parameters:
        mergeAction - The action used when to detemine how a MERGE in a Redshift sink will be handled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • mergeWhenMatched

        AmazonRedshiftNodeData.Builder mergeWhenMatched​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • mergeWhenNotMatched

        AmazonRedshiftNodeData.Builder mergeWhenNotMatched​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • mergeClause

        AmazonRedshiftNodeData.Builder mergeClause​(String mergeClause)

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

        Parameters:
        mergeClause - The SQL used in a custom merge to deal with matching records.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • crawlerConnection

        AmazonRedshiftNodeData.Builder crawlerConnection​(String crawlerConnection)

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

        Parameters:
        crawlerConnection - Specifies the name of the connection that is associated with the catalog table used.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tableSchema

        AmazonRedshiftNodeData.Builder tableSchema​(Collection<Option> tableSchema)

        The array of schema output for a given node.

        Parameters:
        tableSchema - The array of schema output for a given node.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tableSchema

        AmazonRedshiftNodeData.Builder tableSchema​(Option... tableSchema)

        The array of schema output for a given node.

        Parameters:
        tableSchema - The array of schema output for a given node.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tableSchema

        AmazonRedshiftNodeData.Builder tableSchema​(Consumer<Option.Builder>... tableSchema)

        The array of schema output for a given node.

        This is a convenience method that creates an instance of the Option.Builder avoiding the need to create one manually via Option.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tableSchema(List.

        Parameters:
        tableSchema - a consumer that will call methods on Option.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tableSchema(java.util.Collection

      • stagingTable

        AmazonRedshiftNodeData.Builder stagingTable​(String stagingTable)

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

        Parameters:
        stagingTable - The name of the temporary staging table that is used when doing a MERGE or APPEND with upsert.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • selectedColumns

        AmazonRedshiftNodeData.Builder selectedColumns​(Collection<Option> selectedColumns)

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

        Parameters:
        selectedColumns - The list of column names used to determine a matching record when doing a MERGE or APPEND with upsert.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • selectedColumns

        AmazonRedshiftNodeData.Builder selectedColumns​(Option... selectedColumns)

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

        Parameters:
        selectedColumns - The list of column names used to determine a matching record when doing a MERGE or APPEND with upsert.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • selectedColumns

        AmazonRedshiftNodeData.Builder selectedColumns​(Consumer<Option.Builder>... selectedColumns)

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

        This is a convenience method that creates an instance of the Option.Builder avoiding the need to create one manually via Option.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #selectedColumns(List.

        Parameters:
        selectedColumns - a consumer that will call methods on Option.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #selectedColumns(java.util.Collection