Package software.amazon.awssdk.services.notifications.model

Class SummarizationDimensionOverview

java.lang.Object

software.amazon.awssdk.services.notifications.model.SummarizationDimensionOverview

All Implemented Interfaces:

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

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

Provides an overview of how data is summarized across different dimensions.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SummarizationDimensionOverview.Builder

Method Summary

Modifier and Type	Method	Description
static SummarizationDimensionOverview.Builder	builder()
Integer	count()	Total number of occurrences for this dimension.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSampleValues()	For responses, this returns true if the service returned a value for the SampleValues property.
String	name()	Name of the summarization dimension.
List<String>	sampleValues()	Indicates the sample values found within the dimension.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SummarizationDimensionOverview.Builder>	serializableBuilderClass()
SummarizationDimensionOverview.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

name

public final String name()

Name of the summarization dimension.

Returns:

Name of the summarization dimension.

count

public final Integer count()

Total number of occurrences for this dimension.

Returns:

Total number of occurrences for this dimension.

hasSampleValues

public final boolean hasSampleValues()

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

sampleValues

public final List<String> sampleValues()

Indicates the sample values found within the dimension.

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

Returns:

Indicates the sample values found within the dimension.

toBuilder

public SummarizationDimensionOverview.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SummarizationDimensionOverview.Builder,SummarizationDimensionOverview>

builder

public static SummarizationDimensionOverview.Builder builder()

serializableBuilderClass

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