Package software.amazon.awssdk.services.lexmodelsv2.model

Class ListUtteranceMetricsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.lexmodelsv2.model.LexModelsV2Response

software.amazon.awssdk.services.lexmodelsv2.model.ListUtteranceMetricsResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListUtteranceMetricsResponse.Builder,ListUtteranceMetricsResponse>

@Generated("software.amazon.awssdk:codegen")
public final class ListUtteranceMetricsResponse
extends LexModelsV2Response
implements ToCopyableBuilder<ListUtteranceMetricsResponse.Builder,ListUtteranceMetricsResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListUtteranceMetricsResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	botId()	The identifier for the bot for which you retrieved utterance metrics.
static ListUtteranceMetricsResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasResults()	For responses, this returns true if the service returned a value for the Results property.
String	nextToken()	If the response from the ListUtteranceMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
List<AnalyticsUtteranceResult>	results()	The results for the utterance metrics.
List<SdkField<?>>	sdkFields()
static Class<? extends ListUtteranceMetricsResponse.Builder>	serializableBuilderClass()
ListUtteranceMetricsResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.lexmodelsv2.model.LexModelsV2Response

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

botId

public final String botId()

The identifier for the bot for which you retrieved utterance metrics.

Returns:

The identifier for the bot for which you retrieved utterance metrics.

hasResults

public final boolean hasResults()

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

results

public final List<AnalyticsUtteranceResult> results()

The results for the utterance metrics.

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

Returns:

The results for the utterance metrics.

nextToken

public final String nextToken()

If the response from the ListUtteranceMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.

Use the returned token in the nextToken parameter of a ListUtteranceMetrics request to return the next page of results. For a complete set of results, call the ListUtteranceMetrics operation until the nextToken returned in the response is null.

Returns:

If the response from the ListUtteranceMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.

Use the returned token in the nextToken parameter of a ListUtteranceMetrics request to return the next page of results. For a complete set of results, call the ListUtteranceMetrics operation until the nextToken returned in the response is null.

toBuilder

public ListUtteranceMetricsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListUtteranceMetricsResponse.Builder,ListUtteranceMetricsResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static ListUtteranceMetricsResponse.Builder builder()

serializableBuilderClass

public static Class<? extends ListUtteranceMetricsResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo