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

Class QQueryCardInput

java.lang.Object

software.amazon.awssdk.services.qapps.model.QQueryCardInput

All Implemented Interfaces:

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

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

The input shape for defining a query card in an Amazon Q App.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	QQueryCardInput.Builder

Method Summary

Modifier and Type	Method	Description
AttributeFilter	attributeFilter()	Turns on filtering of responses based on document attributes or metadata fields.
static QQueryCardInput.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The unique identifier of the query card.
CardOutputSource	outputSource()	The source or type of output to generate for the query card.
String	outputSourceAsString()	The source or type of output to generate for the query card.
String	prompt()	The prompt or instructions displayed for the query card.
List<SdkField<?>>	sdkFields()
static Class<? extends QQueryCardInput.Builder>	serializableBuilderClass()
String	title()	The title or label of the query card.
QQueryCardInput.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
CardType	type()	The type of the card.
String	typeAsString()	The type of the card.

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

title

public final String title()

The title or label of the query card.

Returns:

The title or label of the query card.

id

public final String id()

The unique identifier of the query card.

Returns:

The unique identifier of the query card.

type

public final CardType type()

The type of the card.

If the service returns an enum value that is not available in the current SDK version, type will return CardType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of the card.

See Also:

CardType

typeAsString

public final String typeAsString()

The type of the card.

If the service returns an enum value that is not available in the current SDK version, type will return CardType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of the card.

See Also:

CardType

prompt

public final String prompt()

The prompt or instructions displayed for the query card.

Returns:

The prompt or instructions displayed for the query card.

outputSource

public final CardOutputSource outputSource()

The source or type of output to generate for the query card.

If the service returns an enum value that is not available in the current SDK version, outputSource will return CardOutputSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputSourceAsString().

Returns:

The source or type of output to generate for the query card.

See Also:

CardOutputSource

outputSourceAsString

public final String outputSourceAsString()

The source or type of output to generate for the query card.

If the service returns an enum value that is not available in the current SDK version, outputSource will return CardOutputSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputSourceAsString().

Returns:

The source or type of output to generate for the query card.

See Also:

CardOutputSource

attributeFilter

public final AttributeFilter attributeFilter()

Turns on filtering of responses based on document attributes or metadata fields.

Returns:

Turns on filtering of responses based on document attributes or metadata fields.

toBuilder

public QQueryCardInput.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<QQueryCardInput.Builder,QQueryCardInput>

builder

public static QQueryCardInput.Builder builder()

serializableBuilderClass

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