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

Class SnowflakeNodeData

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

Specifies configuration for Snowflake nodes in Glue Studio.

See Also:

  • Method Details

    • sourceType

      public final String sourceType()

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

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

    • connection

      public final Option connection()

      Specifies a Glue Data Catalog Connection to a Snowflake endpoint.

      Returns:
      Specifies a Glue Data Catalog Connection to a Snowflake endpoint.

    • schema

      public final String schema()

      Specifies a Snowflake database schema for your node to use.

      Returns:
      Specifies a Snowflake database schema for your node to use.

    • table

      public final String table()

      Specifies a Snowflake table for your node to use.

      Returns:
      Specifies a Snowflake table for your node to use.

    • database

      public final String database()

      Specifies a Snowflake database for your node to use.

      Returns:
      Specifies a Snowflake database for your node to use.

    • tempDir

      public final String tempDir()

      Not currently used.

      Returns:
      Not currently used.

    • iamRole

      public final Option iamRole()

      Not currently used.

      Returns:
      Not currently used.

    • hasAdditionalOptions

      public final boolean hasAdditionalOptions()
      For responses, this returns true if the service returned a value for the AdditionalOptions 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.

    • additionalOptions

      public final Map<String,String> additionalOptions()

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

      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 hasAdditionalOptions() method.

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

    • sampleQuery

      public final String sampleQuery()

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

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

    • preAction

      public final String preAction()

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

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

    • postAction

      public final String postAction()

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

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

    • action

      public final String action()

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

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

    • upsert

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

      Returns:
      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.

    • mergeAction

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

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

    • mergeWhenMatched

      public final String mergeWhenMatched()

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

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

    • mergeWhenNotMatched

      public final String mergeWhenNotMatched()

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

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

    • mergeClause

      public final String mergeClause()

      A SQL statement that specifies a custom merge behavior.

      Returns:
      A SQL statement that specifies a custom merge behavior.

    • stagingTable

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

      Returns:
      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.

    • 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()

      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.

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

    • autoPushdown

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

      Returns:
      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.

    • 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()

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

      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:
      Manually defines the target schema for the node. A list of structures with value , label and description keys. Each structure defines a column.

    • toBuilder

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

    • builder

      public static SnowflakeNodeData.Builder builder()

    • serializableBuilderClass

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