Class AnalyticsSessionResult
- java.lang.Object
-
- software.amazon.awssdk.services.lexmodelsv2.model.AnalyticsSessionResult
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<AnalyticsSessionResult.Builder,AnalyticsSessionResult>
@Generated("software.amazon.awssdk:codegen") public final class AnalyticsSessionResult extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AnalyticsSessionResult.Builder,AnalyticsSessionResult>
An object containing the results for the session 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 Description static interfaceAnalyticsSessionResult.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<AnalyticsBinKey>binKeys()A list of objects containing the criteria you requested for binning results and the values of the bins.static AnalyticsSessionResult.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)List<AnalyticsSessionGroupByKey>groupByKeys()A list of objects containing the criteria you requested for grouping results and the values of the bins.booleanhasBinKeys()For responses, this returns true if the service returned a value for the BinKeys property.booleanhasGroupByKeys()For responses, this returns true if the service returned a value for the GroupByKeys property.inthashCode()booleanhasMetricsResults()For responses, this returns true if the service returned a value for the MetricsResults property.List<AnalyticsSessionMetricResult>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 AnalyticsSessionResult.Builder>serializableBuilderClass()AnalyticsSessionResult.BuildertoBuilder()StringtoString()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 theisEmpty()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 theisEmpty()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<AnalyticsSessionGroupByKey> groupByKeys()
A list of objects containing the criteria you requested for grouping 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
hasGroupByKeys()method.- Returns:
- A list of objects containing the criteria you requested for grouping results and the values of the bins.
-
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 theisEmpty()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<AnalyticsSessionMetricResult> 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 AnalyticsSessionResult.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<AnalyticsSessionResult.Builder,AnalyticsSessionResult>
-
builder
public static AnalyticsSessionResult.Builder builder()
-
serializableBuilderClass
public static Class<? extends AnalyticsSessionResult.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-