Package software.amazon.awssdk.services.quicksight.model

Class CustomSql

java.lang.Object

software.amazon.awssdk.services.quicksight.model.CustomSql

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class CustomSql
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CustomSql.Builder,CustomSql>

A physical table type built from the results of the custom SQL query.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CustomSql.Builder

Method Summary

Modifier and Type	Method	Description
static CustomSql.Builder	builder()
List<InputColumn>	columns()	The column schema from the SQL query result set.
String	dataSourceArn()	The Amazon Resource Name (ARN) of the data source.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasColumns()	For responses, this returns true if the service returned a value for the Columns property.
int	hashCode()
String	name()	A display name for the SQL query result.
List<SdkField<?>>	sdkFields()
static Class<? extends CustomSql.Builder>	serializableBuilderClass()
String	sqlQuery()	The SQL query.
CustomSql.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

dataSourceArn

public final String dataSourceArn()

The Amazon Resource Name (ARN) of the data source.

Returns:

The Amazon Resource Name (ARN) of the data source.

name

public final String name()

A display name for the SQL query result.

Returns:

A display name for the SQL query result.

sqlQuery

public final String sqlQuery()

The SQL query.

Returns:

The SQL query.

hasColumns

public final boolean hasColumns()

For responses, this returns true if the service returned a value for the Columns 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.

columns

public final List<InputColumn> columns()

The column schema from the SQL query result set.

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

Returns:

The column schema from the SQL query result set.

toBuilder

public CustomSql.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CustomSql.Builder,CustomSql>

builder

public static CustomSql.Builder builder()

serializableBuilderClass

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