Package software.amazon.awssdk.services.qconnect.model

Class AIPromptData

java.lang.Object

software.amazon.awssdk.services.qconnect.model.AIPromptData

All Implemented Interfaces:

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

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

The data for the AI Prompt

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AIPromptData.Builder

Method Summary

Modifier and Type	Method	Description
String	aiPromptArn()	The Amazon Resource Name (ARN) of the AI Prompt.
String	aiPromptId()	The identifier of the Amazon Q in Connect AI prompt.
AIPromptAPIFormat	apiFormat()	The API format used for this AI Prompt.
String	apiFormatAsString()	The API format used for this AI Prompt.
String	assistantArn()	The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
String	assistantId()	The identifier of the Amazon Q in Connect assistant.
static AIPromptData.Builder	builder()
String	description()	The description of the AI Prompt.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	modelId()	The identifier of the model used for this AI Prompt.
Instant	modifiedTime()	The time the AI Prompt was last modified.
String	name()	The name of the AI Prompt
Origin	origin()	The origin of the AI Prompt.
String	originAsString()	The origin of the AI Prompt.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AIPromptData.Builder>	serializableBuilderClass()
Status	status()	The status of the AI Prompt.
String	statusAsString()	The status of the AI Prompt.
Map<String,String>	tags()	The tags used to organize, track, or control access for this resource.
AIPromptTemplateConfiguration	templateConfiguration()	The configuration of the prompt template for this AI Prompt.
AIPromptTemplateType	templateType()	The type of the prompt template for this AI Prompt.
String	templateTypeAsString()	The type of the prompt template for this AI Prompt.
AIPromptData.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
AIPromptType	type()	The type of this AI Prompt.
String	typeAsString()	The type of this AI Prompt.
VisibilityStatus	visibilityStatus()	The visibility status of the AI Prompt.
String	visibilityStatusAsString()	The visibility status of the AI Prompt.

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

aiPromptArn

public final String aiPromptArn()

The Amazon Resource Name (ARN) of the AI Prompt.

Returns:

The Amazon Resource Name (ARN) of the AI Prompt.

aiPromptId

public final String aiPromptId()

The identifier of the Amazon Q in Connect AI prompt.

Returns:

The identifier of the Amazon Q in Connect AI prompt.

apiFormat

public final AIPromptAPIFormat apiFormat()

The API format used for this AI Prompt.

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

Returns:

The API format used for this AI Prompt.

See Also:

AIPromptAPIFormat

apiFormatAsString

public final String apiFormatAsString()

The API format used for this AI Prompt.

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

Returns:

The API format used for this AI Prompt.

See Also:

AIPromptAPIFormat

assistantArn

public final String assistantArn()

The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

Returns:

The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

assistantId

public final String assistantId()

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

description

public final String description()

The description of the AI Prompt.

Returns:

The description of the AI Prompt.

modelId

public final String modelId()

The identifier of the model used for this AI Prompt. Model Ids supported are: CLAUDE_3_HAIKU_20240307_V1.

Returns:

The identifier of the model used for this AI Prompt. Model Ids supported are: CLAUDE_3_HAIKU_20240307_V1.

modifiedTime

public final Instant modifiedTime()

The time the AI Prompt was last modified.

Returns:

The time the AI Prompt was last modified.

name

public final String name()

The name of the AI Prompt

Returns:

The name of the AI Prompt

origin

public final Origin origin()

The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.

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

Returns:

The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.

See Also:

Origin

originAsString

public final String originAsString()

The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.

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

Returns:

The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.

See Also:

Origin

status

public final Status status()

The status of the AI Prompt.

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

Returns:

The status of the AI Prompt.

See Also:

Status

statusAsString

public final String statusAsString()

The status of the AI Prompt.

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

Returns:

The status of the AI Prompt.

See Also:

Status

hasTags

public final boolean hasTags()

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

tags

public final Map<String,String> tags()

The tags used to organize, track, or control access for this resource.

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

Returns:

The tags used to organize, track, or control access for this resource.

templateConfiguration

public final AIPromptTemplateConfiguration templateConfiguration()

The configuration of the prompt template for this AI Prompt.

Returns:

The configuration of the prompt template for this AI Prompt.

templateType

public final AIPromptTemplateType templateType()

The type of the prompt template for this AI Prompt.

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

Returns:

The type of the prompt template for this AI Prompt.

See Also:

AIPromptTemplateType

templateTypeAsString

public final String templateTypeAsString()

The type of the prompt template for this AI Prompt.

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

Returns:

The type of the prompt template for this AI Prompt.

See Also:

AIPromptTemplateType

type

public final AIPromptType type()

The type of this AI Prompt.

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

Returns:

The type of this AI Prompt.

See Also:

AIPromptType

typeAsString

public final String typeAsString()

The type of this AI Prompt.

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

Returns:

The type of this AI Prompt.

See Also:

AIPromptType

visibilityStatus

public final VisibilityStatus visibilityStatus()

The visibility status of the AI Prompt.

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

Returns:

The visibility status of the AI Prompt.

See Also:

VisibilityStatus

visibilityStatusAsString

public final String visibilityStatusAsString()

The visibility status of the AI Prompt.

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

Returns:

The visibility status of the AI Prompt.

See Also:

VisibilityStatus

toBuilder

public AIPromptData.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AIPromptData.Builder,AIPromptData>

builder

public static AIPromptData.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo