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

Class PivotTableFieldOptions

java.lang.Object

software.amazon.awssdk.services.quicksight.model.PivotTableFieldOptions

All Implemented Interfaces:

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

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

The field options for a pivot table visual.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PivotTableFieldOptions.Builder

Method Summary

Modifier and Type	Method	Description
static PivotTableFieldOptions.Builder	builder()
List<PivotTableFieldCollapseStateOption>	collapseStateOptions()	The collapse state options for the pivot table field options.
List<PivotTableDataPathOption>	dataPathOptions()	The data path options for the pivot table field options.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCollapseStateOptions()	For responses, this returns true if the service returned a value for the CollapseStateOptions property.
boolean	hasDataPathOptions()	For responses, this returns true if the service returned a value for the DataPathOptions property.
int	hashCode()
boolean	hasSelectedFieldOptions()	For responses, this returns true if the service returned a value for the SelectedFieldOptions property.
List<SdkField<?>>	sdkFields()
List<PivotTableFieldOption>	selectedFieldOptions()	The selected field options for the pivot table field options.
static Class<? extends PivotTableFieldOptions.Builder>	serializableBuilderClass()
PivotTableFieldOptions.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<PivotTableFieldOption> selectedFieldOptions()

The selected field options for the pivot table field options.

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 selected field options for the pivot table field options.

hasDataPathOptions

public final boolean hasDataPathOptions()

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

dataPathOptions

public final List<PivotTableDataPathOption> dataPathOptions()

The data path options for the pivot table field options.

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

Returns:

The data path options for the pivot table field options.

hasCollapseStateOptions

public final boolean hasCollapseStateOptions()

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

collapseStateOptions

public final List<PivotTableFieldCollapseStateOption> collapseStateOptions()

The collapse state options for the pivot table field options.

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

Returns:

The collapse state options for the pivot table field options.

toBuilder

public PivotTableFieldOptions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PivotTableFieldOptions.Builder,PivotTableFieldOptions>

builder

public static PivotTableFieldOptions.Builder builder()

serializableBuilderClass

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