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

Class PredefinedHierarchy

java.lang.Object

software.amazon.awssdk.services.quicksight.model.PredefinedHierarchy

All Implemented Interfaces:

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

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

The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PredefinedHierarchy.Builder

Method Summary

Modifier and Type	Method	Description
static PredefinedHierarchy.Builder	builder()
List<ColumnIdentifier>	columns()	The list of columns that define the predefined hierarchy.
List<DrillDownFilter>	drillDownFilters()	The option that determines the drill down filters for the predefined hierarchy.
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.
boolean	hasDrillDownFilters()	For responses, this returns true if the service returned a value for the DrillDownFilters property.
int	hashCode()
String	hierarchyId()	The hierarchy ID of the predefined hierarchy.
List<SdkField<?>>	sdkFields()
static Class<? extends PredefinedHierarchy.Builder>	serializableBuilderClass()
PredefinedHierarchy.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

hierarchyId

public final String hierarchyId()

The hierarchy ID of the predefined hierarchy.

Returns:

The hierarchy ID of the predefined hierarchy.

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<ColumnIdentifier> columns()

The list of columns that define the predefined hierarchy.

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 list of columns that define the predefined hierarchy.

hasDrillDownFilters

public final boolean hasDrillDownFilters()

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

drillDownFilters

public final List<DrillDownFilter> drillDownFilters()

The option that determines the drill down filters for the predefined hierarchy.

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

Returns:

The option that determines the drill down filters for the predefined hierarchy.

toBuilder

public PredefinedHierarchy.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PredefinedHierarchy.Builder,PredefinedHierarchy>

builder

public static PredefinedHierarchy.Builder builder()

serializableBuilderClass

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