Class SparkSQL
- java.lang.Object
-
- software.amazon.awssdk.services.glue.model.SparkSQL
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<SparkSQL.Builder,SparkSQL>
@Generated("software.amazon.awssdk:codegen") public final class SparkSQL extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SparkSQL.Builder,SparkSQL>
Specifies a transform where you enter a SQL query using Spark SQL syntax to transform the data. The output is a single
DynamicFrame.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceSparkSQL.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SparkSQL.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasInputs()For responses, this returns true if the service returned a value for the Inputs property.booleanhasOutputSchemas()For responses, this returns true if the service returned a value for the OutputSchemas property.booleanhasSqlAliases()For responses, this returns true if the service returned a value for the SqlAliases property.List<String>inputs()The data inputs identified by their node names.Stringname()The name of the transform node.List<GlueSchema>outputSchemas()Specifies the data schema for the SparkSQL transform.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends SparkSQL.Builder>serializableBuilderClass()List<SqlAlias>sqlAliases()A list of aliases.StringsqlQuery()A SQL query that must use Spark SQL syntax and return a single data set.SparkSQL.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
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
-
name
public final String name()
The name of the transform node.
- Returns:
- The name of the transform node.
-
hasInputs
public final boolean hasInputs()
For responses, this returns true if the service returned a value for the Inputs 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.
-
inputs
public final List<String> inputs()
The data inputs identified by their node names. You can associate a table name with each input node to use in the SQL query. The name you choose must meet the Spark SQL naming restrictions.
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
hasInputs()method.- Returns:
- The data inputs identified by their node names. You can associate a table name with each input node to use in the SQL query. The name you choose must meet the Spark SQL naming restrictions.
-
sqlQuery
public final String sqlQuery()
A SQL query that must use Spark SQL syntax and return a single data set.
- Returns:
- A SQL query that must use Spark SQL syntax and return a single data set.
-
hasSqlAliases
public final boolean hasSqlAliases()
For responses, this returns true if the service returned a value for the SqlAliases 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.
-
sqlAliases
public final List<SqlAlias> sqlAliases()
A list of aliases. An alias allows you to specify what name to use in the SQL for a given input. For example, you have a datasource named "MyDataSource". If you specify
Fromas MyDataSource, andAliasas SqlName, then in your SQL you can do:select * from SqlNameand that gets data from MyDataSource.
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
hasSqlAliases()method.- Returns:
- A list of aliases. An alias allows you to specify what name to use in the SQL for a given input. For
example, you have a datasource named "MyDataSource". If you specify
Fromas MyDataSource, andAliasas SqlName, then in your SQL you can do:select * from SqlNameand that gets data from MyDataSource.
-
hasOutputSchemas
public final boolean hasOutputSchemas()
For responses, this returns true if the service returned a value for the OutputSchemas 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.
-
outputSchemas
public final List<GlueSchema> outputSchemas()
Specifies the data schema for the SparkSQL transform.
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
hasOutputSchemas()method.- Returns:
- Specifies the data schema for the SparkSQL transform.
-
toBuilder
public SparkSQL.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<SparkSQL.Builder,SparkSQL>
-
builder
public static SparkSQL.Builder builder()
-
serializableBuilderClass
public static Class<? extends SparkSQL.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
-
-