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 interfaceTableFieldOptions.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static TableFieldOptions.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasOrder()For responses, this returns true if the service returned a value for the Order property.booleanhasSelectedFieldOptions()For responses, this returns true if the service returned a value for the SelectedFieldOptions property.booleanhasTransposedTableOptions()For responses, this returns true if the service returned a value for the TransposedTableOptions property.List<String>order()The order of the field IDs that are configured as field options for a table visual.TablePinnedFieldOptionspinnedFieldOptions()The settings for the pinned columns of a table visual.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()List<TableFieldOption>selectedFieldOptions()The field options to be configured to a table.static Class<? extends TableFieldOptions.Builder>serializableBuilderClass()TableFieldOptions.BuildertoBuilder()StringtoString()Returns a string representation of this object.List<TransposedTableOption>transposedTableOptions()TheTableOptionsof a transposed table.-
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 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.
-
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 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.
-
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.
-
hasTransposedTableOptions
public final boolean hasTransposedTableOptions()
For responses, this returns true if the service returned a value for the TransposedTableOptions 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.
-
transposedTableOptions
public final List<TransposedTableOption> transposedTableOptions()
The
TableOptionsof a transposed 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
hasTransposedTableOptions()method.- Returns:
- The
TableOptionsof a transposed table.
-
toBuilder
public TableFieldOptions.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<TableFieldOptions.Builder,TableFieldOptions>
-
builder
public static TableFieldOptions.Builder builder()
-
serializableBuilderClass
public static Class<? extends TableFieldOptions.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
-
-