software.amazon.awssdk.services.lexmodelsv2.model

Class IntentSummary

java.lang.Object

software.amazon.awssdk.services.lexmodelsv2.model.IntentSummary

All Implemented Interfaces:

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

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

Summary information about an intent returned by the ListIntents operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IntentSummary.Builder

Method Summary

Modifier and Type	Method and Description
static IntentSummary.Builder	builder()
String	description() The description of the intent.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInputContexts() For responses, this returns true if the service returned a value for the InputContexts property.
boolean	hasOutputContexts() For responses, this returns true if the service returned a value for the OutputContexts property.
List<InputContext>	inputContexts() The input contexts that must be active for this intent to be considered for recognition.
String	intentId() The unique identifier assigned to the intent.
String	intentName() The name of the intent.
Instant	lastUpdatedDateTime() The timestamp of the date and time that the intent was last updated.
List<OutputContext>	outputContexts() The output contexts that are activated when this intent is fulfilled.
String	parentIntentSignature() If this intent is derived from a built-in intent, the name of the parent intent.
List<SdkField<?>>	sdkFields()
static Class<? extends IntentSummary.Builder>	serializableBuilderClass()
IntentSummary.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

intentId

public final String intentId()

The unique identifier assigned to the intent. Use this ID to get detailed information about the intent with the DescribeIntent operation.

Returns:

The unique identifier assigned to the intent. Use this ID to get detailed information about the intent with the DescribeIntent operation.

intentName

public final String intentName()

The name of the intent.

Returns:

The name of the intent.

description

public final String description()

The description of the intent.

Returns:

The description of the intent.

parentIntentSignature

public final String parentIntentSignature()

If this intent is derived from a built-in intent, the name of the parent intent.

Returns:

If this intent is derived from a built-in intent, the name of the parent intent.

hasInputContexts

public final boolean hasInputContexts()

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

inputContexts

public final List<InputContext> inputContexts()

The input contexts that must be active for this intent to be considered for recognition.

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

Returns:

The input contexts that must be active for this intent to be considered for recognition.

hasOutputContexts

public final boolean hasOutputContexts()

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

outputContexts

public final List<OutputContext> outputContexts()

The output contexts that are activated when this intent is fulfilled.

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

Returns:

The output contexts that are activated when this intent is fulfilled.

lastUpdatedDateTime

public final Instant lastUpdatedDateTime()

The timestamp of the date and time that the intent was last updated.

Returns:

The timestamp of the date and time that the intent was last updated.

toBuilder

public IntentSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IntentSummary.Builder,IntentSummary>

builder

public static IntentSummary.Builder builder()

serializableBuilderClass

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