Class CategoricalMeasureField

java.lang.Object

software.amazon.awssdk.services.quicksight.model.CategoricalMeasureField

All Implemented Interfaces:

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

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

The measure type field with categorical type columns.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CategoricalMeasureField.Builder

Method Summary

Modifier and Type	Method	Description
final CategoricalAggregationFunction	aggregationFunction()	The aggregation function of the measure field.
final String	aggregationFunctionAsString()	The aggregation function of the measure field.
static CategoricalMeasureField.Builder	builder()
final ColumnIdentifier	column()	The column that is used in the CategoricalMeasureField.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final String	fieldId()	The custom field ID.
final StringFormatConfiguration	formatConfiguration()	The format configuration of the field.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final List<SdkField<?>>	sdkFields()
static Class<? extends CategoricalMeasureField.Builder>	serializableBuilderClass()
CategoricalMeasureField.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

fieldId

public final String fieldId()

The custom field ID.

Returns:

The custom field ID.

column

public final ColumnIdentifier column()

The column that is used in the CategoricalMeasureField.

Returns:

The column that is used in the CategoricalMeasureField.

aggregationFunction

public final CategoricalAggregationFunction aggregationFunction()

The aggregation function of the measure field.

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

Returns:

The aggregation function of the measure field.

See Also:

• CategoricalAggregationFunction

aggregationFunctionAsString

public final String aggregationFunctionAsString()

The aggregation function of the measure field.

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

Returns:

The aggregation function of the measure field.

See Also:

• CategoricalAggregationFunction

formatConfiguration

public final StringFormatConfiguration formatConfiguration()

The format configuration of the field.

Returns:

The format configuration of the field.

toBuilder

public CategoricalMeasureField.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<CategoricalMeasureField.Builder,CategoricalMeasureField>

Returns:

a builder for type T

builder

public static CategoricalMeasureField.Builder builder()

serializableBuilderClass

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