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

Class QQueryCard

java.lang.Object

software.amazon.awssdk.services.qapps.model.QQueryCard

All Implemented Interfaces:

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

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

A card in a Amazon Q App that generates a response based on the Amazon Q Business service.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	QQueryCard.Builder

Method Summary

Modifier and Type	Method	Description
AttributeFilter	attributeFilter()	The Amazon Q Business filters applied in this query card when resolving data sources
static QQueryCard.Builder	builder()
List<String>	dependencies()	Any dependencies or requirements for the query card.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDependencies()	For responses, this returns true if the service returned a value for the Dependencies property.
int	hashCode()
String	id()	The unique identifier of the query card.
CardOutputSource	outputSource()	The source or type of output generated by the query card.
String	outputSourceAsString()	The source or type of output generated by the query card.
String	prompt()	The prompt or instructions displayed for the query card.
List<SdkField<?>>	sdkFields()
static Class<? extends QQueryCard.Builder>	serializableBuilderClass()
String	title()	The title or label of the query card.
QQueryCard.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

id

public final String id()

The unique identifier of the query card.

Returns:

The unique identifier of the query card.

title

public final String title()

The title or label of the query card.

Returns:

The title or label of the query card.

hasDependencies

public final boolean hasDependencies()

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

dependencies

public final List<String> dependencies()

Any dependencies or requirements for the query card.

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

Returns:

Any dependencies or requirements for 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 generated by 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 generated by the query card.

See Also:

CardOutputSource

outputSourceAsString

public final String outputSourceAsString()

The source or type of output generated by 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 generated by the query card.

See Also:

CardOutputSource

attributeFilter

public final AttributeFilter attributeFilter()

The Amazon Q Business filters applied in this query card when resolving data sources

Returns:

The Amazon Q Business filters applied in this query card when resolving data sources

toBuilder

public QQueryCard.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<QQueryCard.Builder,QQueryCard>

builder

public static QQueryCard.Builder builder()

serializableBuilderClass

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