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

Class TableFieldOptions

java.lang.Object

software.amazon.awssdk.services.quicksight.model.TableFieldOptions

All Implemented Interfaces:

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

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

The field options of a table visual.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TableFieldOptions.Builder

Method Summary

Modifier and Type	Method	Description
static TableFieldOptions.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasOrder()	For responses, this returns true if the service returned a value for the Order property.
boolean	hasSelectedFieldOptions()	For responses, this returns true if the service returned a value for the SelectedFieldOptions property.
List<String>	order()	The order of the field IDs that are configured as field options for a table visual.
TablePinnedFieldOptions	pinnedFieldOptions()	The settings for the pinned columns of a table visual.
List<SdkField<?>>	sdkFields()
List<TableFieldOption>	selectedFieldOptions()	The field options to be configured to a table.
static Class<? extends TableFieldOptions.Builder>	serializableBuilderClass()
TableFieldOptions.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

hasSelectedFieldOptions

public final boolean hasSelectedFieldOptions()

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

selectedFieldOptions

public final List<TableFieldOption> selectedFieldOptions()

The field options to be configured to a table.

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

Returns:

The field options to be configured to a table.

hasOrder

public final boolean hasOrder()

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

order

public final List<String> order()

The order of the field IDs that are configured as field options for a table visual.

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

Returns:

The order of the field IDs that are configured as field options for a table visual.

pinnedFieldOptions

public final TablePinnedFieldOptions pinnedFieldOptions()

The settings for the pinned columns of a table visual.

Returns:

The settings for the pinned columns of a table visual.

toBuilder

public TableFieldOptions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TableFieldOptions.Builder,TableFieldOptions>

builder

public static TableFieldOptions.Builder builder()

serializableBuilderClass

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