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

Class DataPathType

java.lang.Object

software.amazon.awssdk.services.quicksight.model.DataPathType

All Implemented Interfaces:

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

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

The type of the data path value.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DataPathType.Builder

Method Summary

Modifier and Type	Method	Description
static DataPathType.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
PivotTableDataPathType	pivotTableDataPathType()	The type of data path value utilized in a pivot table.
String	pivotTableDataPathTypeAsString()	The type of data path value utilized in a pivot table.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DataPathType.Builder>	serializableBuilderClass()
DataPathType.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

pivotTableDataPathType

public final PivotTableDataPathType pivotTableDataPathType()

The type of data path value utilized in a pivot table. Choose one of the following options:

• HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY.

• MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.

• EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.

• COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell.

If the service returns an enum value that is not available in the current SDK version, pivotTableDataPathType will return PivotTableDataPathType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pivotTableDataPathTypeAsString().

Returns:

The type of data path value utilized in a pivot table. Choose one of the following options:

• HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY.

• MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.

• EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.

• COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell.

See Also:

PivotTableDataPathType

pivotTableDataPathTypeAsString

public final String pivotTableDataPathTypeAsString()

The type of data path value utilized in a pivot table. Choose one of the following options:

• HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY.

• MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.

• EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.

• COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell.

If the service returns an enum value that is not available in the current SDK version, pivotTableDataPathType will return PivotTableDataPathType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pivotTableDataPathTypeAsString().

Returns:

The type of data path value utilized in a pivot table. Choose one of the following options:

• HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY.

• MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement.

• EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement.

• COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell.

See Also:

PivotTableDataPathType

toBuilder

public DataPathType.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DataPathType.Builder,DataPathType>

builder

public static DataPathType.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo