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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceSnowflakeNodeData.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringaction()Specifies what action to take when writing to a table with preexisting data.Map<String,String>additionalOptions()Specifies additional options passed to the Snowflake connector.BooleanautoPushdown()Specifies whether automatic query pushdown is enabled.static SnowflakeNodeData.Builderbuilder()Optionconnection()Specifies a Glue Data Catalog Connection to a Snowflake endpoint.Stringdatabase()Specifies a Snowflake database for your node to use.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAdditionalOptions()For responses, this returns true if the service returned a value for the AdditionalOptions property.inthashCode()booleanhasSelectedColumns()For responses, this returns true if the service returned a value for the SelectedColumns property.booleanhasTableSchema()For responses, this returns true if the service returned a value for the TableSchema property.OptioniamRole()Not currently used.StringmergeAction()Specifies a merge action.StringmergeClause()A SQL statement that specifies a custom merge behavior.StringmergeWhenMatched()Specifies how to resolve records that match preexisting data when merging.StringmergeWhenNotMatched()Specifies how to process records that do not match preexisting data when merging.StringpostAction()A SQL string run after the Snowflake connector performs its standard actions.StringpreAction()A SQL string run before the Snowflake connector performs its standard actions.StringsampleQuery()A SQL string used to retrieve data with thequerysourcetype.Stringschema()Specifies a Snowflake database schema for your node to use.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()List<Option>selectedColumns()Specifies the columns combined to identify a record when detecting matches for merges and upserts.static Class<? extends SnowflakeNodeData.Builder>serializableBuilderClass()StringsourceType()Specifies how retrieved data is specified.StringstagingTable()The name of a staging table used when performingmergeor upsertappendactions.Stringtable()Specifies a Snowflake table for your node to use.List<Option>tableSchema()Manually defines the target schema for the node.StringtempDir()Not currently used.SnowflakeNodeData.BuildertoBuilder()StringtoString()Returns a string representation of this object.Booleanupsert()Used when Action isappend.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 theisEmpty()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
querysourcetype.- Returns:
- A SQL string used to retrieve data with the
querysourcetype.
-
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 byMergeWhenMatchedandMergeWhenNotMatched. If custom, defined byMergeClause.- Returns:
- Specifies a merge action. Valid values:
simple,custom. If simple, merge behavior is defined byMergeWhenMatchedandMergeWhenNotMatched. If custom, defined byMergeClause.
-
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
mergeor upsertappendactions. Data is written to this table, then moved totableby a generated postaction.- Returns:
- The name of a staging table used when performing
mergeor upsertappendactions. Data is written to this table, then moved totableby 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 theisEmpty()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,labelanddescriptionkeys. 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,labelanddescriptionkeys. 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 theisEmpty()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,labelanddescriptionkeys. 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,labelanddescriptionkeys. Each structure defines a column.
-
toBuilder
public SnowflakeNodeData.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<SnowflakeNodeData.Builder,SnowflakeNodeData>
-
builder
public static SnowflakeNodeData.Builder builder()
-
serializableBuilderClass
public static Class<? extends SnowflakeNodeData.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-