Package software.amazon.awssdk.services.qapps.model

Class PredictQAppInputOptions

java.lang.Object

software.amazon.awssdk.services.qapps.model.PredictQAppInputOptions

All Implemented Interfaces:

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

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

The input options for generating an Q App definition.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PredictQAppInputOptions.Builder
static class	PredictQAppInputOptions.Type

Method Summary

Modifier and Type	Method	Description
static PredictQAppInputOptions.Builder	builder()
List<ConversationMessage>	conversation()	A conversation to use as input for generating the Q App definition.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static PredictQAppInputOptions	fromConversation(List<ConversationMessage> conversation)	Create an instance of this class with conversation() initialized to the given value.
static PredictQAppInputOptions	fromProblemStatement(String problemStatement)	Create an instance of this class with problemStatement() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasConversation()	For responses, this returns true if the service returned a value for the Conversation property.
int	hashCode()
String	problemStatement()	A problem statement to use as input for generating the Q App definition.
List<SdkField<?>>	sdkFields()
static Class<? extends PredictQAppInputOptions.Builder>	serializableBuilderClass()
PredictQAppInputOptions.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
PredictQAppInputOptions.Type	type()	Retrieve an enum value representing which member of this object is populated.

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

hasConversation

public final boolean hasConversation()

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

conversation

public final List<ConversationMessage> conversation()

A conversation to use as input for generating the Q App definition.

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

Returns:

A conversation to use as input for generating the Q App definition.

problemStatement

public final String problemStatement()

A problem statement to use as input for generating the Q App definition.

Returns:

A problem statement to use as input for generating the Q App definition.

toBuilder

public PredictQAppInputOptions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PredictQAppInputOptions.Builder,PredictQAppInputOptions>

builder

public static PredictQAppInputOptions.Builder builder()

serializableBuilderClass

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

fromConversation

public static PredictQAppInputOptions fromConversation(List<ConversationMessage> conversation)

Create an instance of this class with conversation() initialized to the given value.

A conversation to use as input for generating the Q App definition.

Parameters:

conversation - A conversation to use as input for generating the Q App definition.

fromProblemStatement

public static PredictQAppInputOptions fromProblemStatement(String problemStatement)

Create an instance of this class with problemStatement() initialized to the given value.

A problem statement to use as input for generating the Q App definition.

Parameters:

problemStatement - A problem statement to use as input for generating the Q App definition.

type

public PredictQAppInputOptions.Type type()

Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be PredictQAppInputOptions.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be PredictQAppInputOptions.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

sdkFields

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

Specified by:

sdkFields in interface SdkPojo