software.amazon.awssdk.services.lexmodelsv2.model

Class AnalyticsIntentResult

java.lang.Object

software.amazon.awssdk.services.lexmodelsv2.model.AnalyticsIntentResult

All Implemented Interfaces:

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

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

An object containing the results for the intent metrics you requested and the bin and/or group(s) they refer to, if applicable.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AnalyticsIntentResult.Builder

Method Summary

Modifier and Type	Method and Description
List<AnalyticsBinKey>	binKeys() A list of objects containing the criteria you requested for binning results and the values of the bins.
static AnalyticsIntentResult.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
List<AnalyticsIntentGroupByKey>	groupByKeys() A list of objects containing the criteria you requested for grouping results and the values of the groups.
boolean	hasBinKeys() For responses, this returns true if the service returned a value for the BinKeys property.
boolean	hasGroupByKeys() For responses, this returns true if the service returned a value for the GroupByKeys property.
int	hashCode()
boolean	hasMetricsResults() For responses, this returns true if the service returned a value for the MetricsResults property.
List<AnalyticsIntentMetricResult>	metricsResults() A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
List<SdkField<?>>	sdkFields()
static Class<? extends AnalyticsIntentResult.Builder>	serializableBuilderClass()
AnalyticsIntentResult.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

hasBinKeys

public final boolean hasBinKeys()

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

binKeys

public final List<AnalyticsBinKey> binKeys()

A list of objects containing the criteria you requested for binning results and the values of the bins.

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

Returns:

A list of objects containing the criteria you requested for binning results and the values of the bins.

hasGroupByKeys

public final boolean hasGroupByKeys()

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

groupByKeys

public final List<AnalyticsIntentGroupByKey> groupByKeys()

A list of objects containing the criteria you requested for grouping results and the values of the groups.

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

Returns:

A list of objects containing the criteria you requested for grouping results and the values of the groups.

hasMetricsResults

public final boolean hasMetricsResults()

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

metricsResults

public final List<AnalyticsIntentMetricResult> metricsResults()

A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.

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

Returns:

A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.

toBuilder

public AnalyticsIntentResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AnalyticsIntentResult.Builder,AnalyticsIntentResult>

builder

public static AnalyticsIntentResult.Builder builder()

serializableBuilderClass

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