software.amazon.awssdk.services.glue.model

Class SparkSQL

java.lang.Object

software.amazon.awssdk.services.glue.model.SparkSQL

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SparkSQL.Builder,SparkSQL>

@Generated(value="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 and Description
static interface	SparkSQL.Builder

Method Summary

Modifier and Type	Method and Description
static SparkSQL.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInputs() For responses, this returns true if the service returned a value for the Inputs property.
boolean	hasOutputSchemas() For responses, this returns true if the service returned a value for the OutputSchemas property.
boolean	hasSqlAliases() 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.
String	name() The name of the transform node.
List<GlueSchema>	outputSchemas() Specifies the data schema for the SparkSQL transform.
List<SdkField<?>>	sdkFields()
static Class<? extends SparkSQL.Builder>	serializableBuilderClass()
List<SqlAlias>	sqlAliases() A list of aliases.
String	sqlQuery() A SQL query that must use Spark SQL syntax and return a single data set.
SparkSQL.Builder	toBuilder()
String	toString() 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 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.

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

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 From as MyDataSource, and Alias as SqlName, then in your SQL you can do:

select * from SqlName

and 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 From as MyDataSource, and Alias as SqlName, then in your SQL you can do:

select * from SqlName

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

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:

toBuilder in interface ToCopyableBuilder<SparkSQL.Builder,SparkSQL>

builder

public static SparkSQL.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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