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:

  • Method Details

    • 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:

    • 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:

    • toBuilder

      public DataPathType.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DataPathType.Builder,DataPathType>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.