Interface AIPromptData.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<AIPromptData.Builder,AIPromptData>,SdkBuilder<AIPromptData.Builder,AIPromptData>,SdkPojo
- Enclosing class:
- AIPromptData
public static interface AIPromptData.Builder extends SdkPojo, CopyableBuilder<AIPromptData.Builder,AIPromptData>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description AIPromptData.BuilderaiPromptArn(String aiPromptArn)The Amazon Resource Name (ARN) of the AI Prompt.AIPromptData.BuilderaiPromptId(String aiPromptId)The identifier of the Amazon Q in Connect AI prompt.AIPromptData.BuilderapiFormat(String apiFormat)The API format used for this AI Prompt.AIPromptData.BuilderapiFormat(AIPromptAPIFormat apiFormat)The API format used for this AI Prompt.AIPromptData.BuilderassistantArn(String assistantArn)The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.AIPromptData.BuilderassistantId(String assistantId)The identifier of the Amazon Q in Connect assistant.AIPromptData.Builderdescription(String description)The description of the AI Prompt.AIPromptData.BuildermodelId(String modelId)The identifier of the model used for this AI Prompt.AIPromptData.BuildermodifiedTime(Instant modifiedTime)The time the AI Prompt was last modified.AIPromptData.Buildername(String name)The name of the AI PromptAIPromptData.Builderorigin(String origin)The origin of the AI Prompt.AIPromptData.Builderorigin(Origin origin)The origin of the AI Prompt.AIPromptData.Builderstatus(String status)The status of the AI Prompt.AIPromptData.Builderstatus(Status status)The status of the AI Prompt.AIPromptData.Buildertags(Map<String,String> tags)The tags used to organize, track, or control access for this resource.default AIPromptData.BuildertemplateConfiguration(Consumer<AIPromptTemplateConfiguration.Builder> templateConfiguration)The configuration of the prompt template for this AI Prompt.AIPromptData.BuildertemplateConfiguration(AIPromptTemplateConfiguration templateConfiguration)The configuration of the prompt template for this AI Prompt.AIPromptData.BuildertemplateType(String templateType)The type of the prompt template for this AI Prompt.AIPromptData.BuildertemplateType(AIPromptTemplateType templateType)The type of the prompt template for this AI Prompt.AIPromptData.Buildertype(String type)The type of this AI Prompt.AIPromptData.Buildertype(AIPromptType type)The type of this AI Prompt.AIPromptData.BuildervisibilityStatus(String visibilityStatus)The visibility status of the AI Prompt.AIPromptData.BuildervisibilityStatus(VisibilityStatus visibilityStatus)The visibility status of the AI Prompt.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
aiPromptArn
AIPromptData.Builder aiPromptArn(String aiPromptArn)
The Amazon Resource Name (ARN) of the AI Prompt.
- Parameters:
aiPromptArn- The Amazon Resource Name (ARN) of the AI Prompt.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
aiPromptId
AIPromptData.Builder aiPromptId(String aiPromptId)
The identifier of the Amazon Q in Connect AI prompt.
- Parameters:
aiPromptId- The identifier of the Amazon Q in Connect AI prompt.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
apiFormat
AIPromptData.Builder apiFormat(String apiFormat)
The API format used for this AI Prompt.
- Parameters:
apiFormat- The API format used for this AI Prompt.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
AIPromptAPIFormat,AIPromptAPIFormat
-
apiFormat
AIPromptData.Builder apiFormat(AIPromptAPIFormat apiFormat)
The API format used for this AI Prompt.
- Parameters:
apiFormat- The API format used for this AI Prompt.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
AIPromptAPIFormat,AIPromptAPIFormat
-
assistantArn
AIPromptData.Builder assistantArn(String assistantArn)
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
- Parameters:
assistantArn- The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
assistantId
AIPromptData.Builder assistantId(String assistantId)
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- Parameters:
assistantId- The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
AIPromptData.Builder description(String description)
The description of the AI Prompt.
- Parameters:
description- The description of the AI Prompt.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
modelId
AIPromptData.Builder modelId(String modelId)
The identifier of the model used for this AI Prompt. Model Ids supported are:
CLAUDE_3_HAIKU_20240307_V1.- Parameters:
modelId- The identifier of the model used for this AI Prompt. Model Ids supported are:CLAUDE_3_HAIKU_20240307_V1.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
modifiedTime
AIPromptData.Builder modifiedTime(Instant modifiedTime)
The time the AI Prompt was last modified.
- Parameters:
modifiedTime- The time the AI Prompt was last modified.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
name
AIPromptData.Builder name(String name)
The name of the AI Prompt
- Parameters:
name- The name of the AI Prompt- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
origin
AIPromptData.Builder origin(String origin)
The origin of the AI Prompt.
SYSTEMfor a default AI Prompt created by Q in Connect orCUSTOMERfor an AI Prompt created by calling AI Prompt creation APIs.
-
origin
AIPromptData.Builder origin(Origin origin)
The origin of the AI Prompt.
SYSTEMfor a default AI Prompt created by Q in Connect orCUSTOMERfor an AI Prompt created by calling AI Prompt creation APIs.
-
status
AIPromptData.Builder status(String status)
The status of the AI Prompt.
-
status
AIPromptData.Builder status(Status status)
The status of the AI Prompt.
-
tags
AIPromptData.Builder tags(Map<String,String> tags)
The tags used to organize, track, or control access for this resource.
- Parameters:
tags- The tags used to organize, track, or control access for this resource.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
templateConfiguration
AIPromptData.Builder templateConfiguration(AIPromptTemplateConfiguration templateConfiguration)
The configuration of the prompt template for this AI Prompt.
- Parameters:
templateConfiguration- The configuration of the prompt template for this AI Prompt.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
templateConfiguration
default AIPromptData.Builder templateConfiguration(Consumer<AIPromptTemplateConfiguration.Builder> templateConfiguration)
The configuration of the prompt template for this AI Prompt.
This is a convenience method that creates an instance of theAIPromptTemplateConfiguration.Builderavoiding the need to create one manually viaAIPromptTemplateConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed totemplateConfiguration(AIPromptTemplateConfiguration).- Parameters:
templateConfiguration- a consumer that will call methods onAIPromptTemplateConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
templateConfiguration(AIPromptTemplateConfiguration)
-
templateType
AIPromptData.Builder templateType(String templateType)
The type of the prompt template for this AI Prompt.
- Parameters:
templateType- The type of the prompt template for this AI Prompt.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
AIPromptTemplateType,AIPromptTemplateType
-
templateType
AIPromptData.Builder templateType(AIPromptTemplateType templateType)
The type of the prompt template for this AI Prompt.
- Parameters:
templateType- The type of the prompt template for this AI Prompt.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
AIPromptTemplateType,AIPromptTemplateType
-
type
AIPromptData.Builder type(String type)
The type of this AI Prompt.
- Parameters:
type- The type of this AI Prompt.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
AIPromptType,AIPromptType
-
type
AIPromptData.Builder type(AIPromptType type)
The type of this AI Prompt.
- Parameters:
type- The type of this AI Prompt.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
AIPromptType,AIPromptType
-
visibilityStatus
AIPromptData.Builder visibilityStatus(String visibilityStatus)
The visibility status of the AI Prompt.
- Parameters:
visibilityStatus- The visibility status of the AI Prompt.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
VisibilityStatus,VisibilityStatus
-
visibilityStatus
AIPromptData.Builder visibilityStatus(VisibilityStatus visibilityStatus)
The visibility status of the AI Prompt.
- Parameters:
visibilityStatus- The visibility status of the AI Prompt.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
VisibilityStatus,VisibilityStatus
-
-