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

Class NamedEntityDefinitionMetric

java.lang.Object

software.amazon.awssdk.services.quicksight.model.NamedEntityDefinitionMetric

All Implemented Interfaces:

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

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

A structure that represents a metric.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NamedEntityDefinitionMetric.Builder

Method Summary

Modifier and Type	Method	Description
NamedEntityAggType	aggregation()	The aggregation of a named entity.
String	aggregationAsString()	The aggregation of a named entity.
Map<String,String>	aggregationFunctionParameters()	The additional parameters for an aggregation function.
static NamedEntityDefinitionMetric.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAggregationFunctionParameters()	For responses, this returns true if the service returned a value for the AggregationFunctionParameters property.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends NamedEntityDefinitionMetric.Builder>	serializableBuilderClass()
NamedEntityDefinitionMetric.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

aggregation

public final NamedEntityAggType aggregation()

The aggregation of a named entity. Valid values for this structure are SUM, MIN, MAX, COUNT, AVERAGE, DISTINCT_COUNT, STDEV, STDEVP, VAR, VARP, PERCENTILE, MEDIAN, and CUSTOM.

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

Returns:

The aggregation of a named entity. Valid values for this structure are SUM, MIN , MAX, COUNT, AVERAGE, DISTINCT_COUNT, STDEV, STDEVP, VAR, VARP, PERCENTILE, MEDIAN, and CUSTOM.

See Also:

NamedEntityAggType

aggregationAsString

public final String aggregationAsString()

The aggregation of a named entity. Valid values for this structure are SUM, MIN, MAX, COUNT, AVERAGE, DISTINCT_COUNT, STDEV, STDEVP, VAR, VARP, PERCENTILE, MEDIAN, and CUSTOM.

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

Returns:

The aggregation of a named entity. Valid values for this structure are SUM, MIN , MAX, COUNT, AVERAGE, DISTINCT_COUNT, STDEV, STDEVP, VAR, VARP, PERCENTILE, MEDIAN, and CUSTOM.

See Also:

NamedEntityAggType

hasAggregationFunctionParameters

public final boolean hasAggregationFunctionParameters()

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

aggregationFunctionParameters

public final Map<String,String> aggregationFunctionParameters()

The additional parameters for an aggregation function.

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

Returns:

The additional parameters for an aggregation function.

toBuilder

public NamedEntityDefinitionMetric.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<NamedEntityDefinitionMetric.Builder,NamedEntityDefinitionMetric>

builder

public static NamedEntityDefinitionMetric.Builder builder()

serializableBuilderClass

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