Interface SnowflakeNodeData.Builder

All Superinterfaces:
Buildable, CopyableBuilder<SnowflakeNodeData.Builder,SnowflakeNodeData>, SdkBuilder<SnowflakeNodeData.Builder,SnowflakeNodeData>, SdkPojo
Enclosing class:
SnowflakeNodeData
public static interface SnowflakeNodeData.Builder extends SdkPojo, CopyableBuilder<SnowflakeNodeData.Builder,SnowflakeNodeData>

  • Method Details

    • sourceType

      SnowflakeNodeData.Builder sourceType(String sourceType)

      Specifies how retrieved data is specified. Valid values: "table", "query".

      Parameters:
      sourceType - Specifies how retrieved data is specified. Valid values: "table", "query".
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • connection

      SnowflakeNodeData.Builder connection(Option connection)

      Specifies a Glue Data Catalog Connection to a Snowflake endpoint.

      Parameters:
      connection - Specifies a Glue Data Catalog Connection to a Snowflake endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • connection

      default SnowflakeNodeData.Builder connection(Consumer<Option.Builder> connection)

      Specifies a Glue Data Catalog Connection to a Snowflake endpoint.

      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 connection(Option).

      Parameters:
      connection - 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:

    • schema

      SnowflakeNodeData.Builder schema(String schema)

      Specifies a Snowflake database schema for your node to use.

      Parameters:
      schema - Specifies a Snowflake database schema for your node to use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • table

      SnowflakeNodeData.Builder table(String table)

      Specifies a Snowflake table for your node to use.

      Parameters:
      table - Specifies a Snowflake table for your node to use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • database

      SnowflakeNodeData.Builder database(String database)

      Specifies a Snowflake database for your node to use.

      Parameters:
      database - Specifies a Snowflake database for your node to use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tempDir

      SnowflakeNodeData.Builder tempDir(String tempDir)

      Not currently used.

      Parameters:
      tempDir - Not currently used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • iamRole

      SnowflakeNodeData.Builder iamRole(Option iamRole)

      Not currently used.

      Parameters:
      iamRole - Not currently used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • iamRole

      default SnowflakeNodeData.Builder iamRole(Consumer<Option.Builder> iamRole)

      Not currently used.

      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 iamRole(Option).

      Parameters:
      iamRole - 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:

    • additionalOptions

      SnowflakeNodeData.Builder additionalOptions(Map<String,String> additionalOptions)

      Specifies additional options passed to the Snowflake connector. If options are specified elsewhere in this node, this will take precedence.

      Parameters:
      additionalOptions - Specifies additional options passed to the Snowflake connector. If options are specified elsewhere in this node, this will take precedence.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sampleQuery

      SnowflakeNodeData.Builder sampleQuery(String sampleQuery)

      A SQL string used to retrieve data with the query sourcetype.

      Parameters:
      sampleQuery - A SQL string used to retrieve data with the query sourcetype.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • preAction

      SnowflakeNodeData.Builder preAction(String preAction)

      A SQL string run before the Snowflake connector performs its standard actions.

      Parameters:
      preAction - A SQL string run before the Snowflake connector performs its standard actions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • postAction

      SnowflakeNodeData.Builder postAction(String postAction)

      A SQL string run after the Snowflake connector performs its standard actions.

      Parameters:
      postAction - A SQL string run after the Snowflake connector performs its standard actions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • action

      SnowflakeNodeData.Builder action(String action)

      Specifies what action to take when writing to a table with preexisting data. Valid values: append, merge, truncate, drop.

      Parameters:
      action - Specifies what action to take when writing to a table with preexisting data. Valid values: append, merge, truncate, drop.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • upsert

      SnowflakeNodeData.Builder upsert(Boolean upsert)

      Used when Action is append. Specifies the resolution behavior when a row already exists. If true, preexisting rows will be updated. If false, those rows will be inserted.

      Parameters:
      upsert - Used when Action is append. Specifies the resolution behavior when a row already exists. If true, preexisting rows will be updated. If false, those rows will be inserted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • mergeAction

      SnowflakeNodeData.Builder mergeAction(String mergeAction)

      Specifies a merge action. Valid values: simple, custom. If simple, merge behavior is defined by MergeWhenMatched and MergeWhenNotMatched. If custom, defined by MergeClause.

      Parameters:
      mergeAction - Specifies a merge action. Valid values: simple, custom. If simple, merge behavior is defined by MergeWhenMatched and MergeWhenNotMatched. If custom, defined by MergeClause.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • mergeWhenMatched

      SnowflakeNodeData.Builder mergeWhenMatched(String mergeWhenMatched)

      Specifies how to resolve records that match preexisting data when merging. Valid values: update, delete.

      Parameters:
      mergeWhenMatched - Specifies how to resolve records that match preexisting data when merging. Valid values: update, delete.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • mergeWhenNotMatched

      SnowflakeNodeData.Builder mergeWhenNotMatched(String mergeWhenNotMatched)

      Specifies how to process records that do not match preexisting data when merging. Valid values: insert, none.

      Parameters:
      mergeWhenNotMatched - Specifies how to process records that do not match preexisting data when merging. Valid values: insert, none.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • mergeClause

      SnowflakeNodeData.Builder mergeClause(String mergeClause)

      A SQL statement that specifies a custom merge behavior.

      Parameters:
      mergeClause - A SQL statement that specifies a custom merge behavior.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stagingTable

      SnowflakeNodeData.Builder stagingTable(String stagingTable)

      The name of a staging table used when performing merge or upsert append actions. Data is written to this table, then moved to table by a generated postaction.

      Parameters:
      stagingTable - The name of a staging table used when performing merge or upsert append actions. Data is written to this table, then moved to table by a generated postaction.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • selectedColumns

      SnowflakeNodeData.Builder selectedColumns(Collection<Option> selectedColumns)

      Specifies the columns combined to identify a record when detecting matches for merges and upserts. A list of structures with value, label and description keys. Each structure describes a column.

      Parameters:
      selectedColumns - Specifies the columns combined to identify a record when detecting matches for merges and upserts. A list of structures with value, label and description keys. Each structure describes a column.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • selectedColumns

      SnowflakeNodeData.Builder selectedColumns(Option... selectedColumns)

      Specifies the columns combined to identify a record when detecting matches for merges and upserts. A list of structures with value, label and description keys. Each structure describes a column.

      Parameters:
      selectedColumns - Specifies the columns combined to identify a record when detecting matches for merges and upserts. A list of structures with value, label and description keys. Each structure describes a column.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • selectedColumns

      SnowflakeNodeData.Builder selectedColumns(Consumer<Option.Builder>... selectedColumns)

      Specifies the columns combined to identify a record when detecting matches for merges and upserts. A list of structures with value, label and description keys. Each structure describes a column.

      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<Option>).

      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:

    • autoPushdown

      SnowflakeNodeData.Builder autoPushdown(Boolean autoPushdown)

      Specifies whether automatic query pushdown is enabled. If pushdown is enabled, then when a query is run on Spark, if part of the query can be "pushed down" to the Snowflake server, it is pushed down. This improves performance of some queries.

      Parameters:
      autoPushdown - Specifies whether automatic query pushdown is enabled. If pushdown is enabled, then when a query is run on Spark, if part of the query can be "pushed down" to the Snowflake server, it is pushed down. This improves performance of some queries.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tableSchema

      SnowflakeNodeData.Builder tableSchema(Collection<Option> tableSchema)

      Manually defines the target schema for the node. A list of structures with value , label and description keys. Each structure defines a column.

      Parameters:
      tableSchema - Manually defines the target schema for the node. A list of structures with value , label and description keys. Each structure defines a column.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tableSchema

      SnowflakeNodeData.Builder tableSchema(Option... tableSchema)

      Manually defines the target schema for the node. A list of structures with value , label and description keys. Each structure defines a column.

      Parameters:
      tableSchema - Manually defines the target schema for the node. A list of structures with value , label and description keys. Each structure defines a column.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tableSchema

      SnowflakeNodeData.Builder tableSchema(Consumer<Option.Builder>... tableSchema)

      Manually defines the target schema for the node. A list of structures with value , label and description keys. Each structure defines a column.

      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<Option>).

      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: