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

Class QPluginCardInput

java.lang.Object

software.amazon.awssdk.services.qapps.model.QPluginCardInput

All Implemented Interfaces:

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

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	QPluginCardInput.Builder

Method Summary

Modifier and Type	Method	Description
static QPluginCardInput.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 plugin card.
String	pluginId()	The unique identifier of the plugin used by the card.
String	prompt()	The prompt or instructions displayed for the plugin card.
List<SdkField<?>>	sdkFields()
static Class<? extends QPluginCardInput.Builder>	serializableBuilderClass()
String	title()	The title or label of the plugin card.
QPluginCardInput.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 plugin card.

Returns:

The title or label of the plugin card.

id

public final String id()

The unique identifier of the plugin card.

Returns:

The unique identifier of the plugin 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 plugin card.

Returns:

The prompt or instructions displayed for the plugin card.

pluginId

public final String pluginId()

The unique identifier of the plugin used by the card.

Returns:

The unique identifier of the plugin used by the card.

toBuilder

public QPluginCardInput.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<QPluginCardInput.Builder,QPluginCardInput>

builder

public static QPluginCardInput.Builder builder()

serializableBuilderClass

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