Interface CreateWebExperienceRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<CreateWebExperienceRequest.Builder,CreateWebExperienceRequest>,QBusinessRequest.Builder,SdkBuilder<CreateWebExperienceRequest.Builder,CreateWebExperienceRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- CreateWebExperienceRequest
public static interface CreateWebExperienceRequest.Builder extends QBusinessRequest.Builder, SdkPojo, CopyableBuilder<CreateWebExperienceRequest.Builder,CreateWebExperienceRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CreateWebExperienceRequest.BuilderapplicationId(String applicationId)The identifier of the Amazon Q Business web experience.CreateWebExperienceRequest.BuilderclientToken(String clientToken)A token you provide to identify a request to create an Amazon Q Business web experience.CreateWebExperienceRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)CreateWebExperienceRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)CreateWebExperienceRequest.BuilderroleArn(String roleArn)The Amazon Resource Name (ARN) of the service role attached to your web experience.CreateWebExperienceRequest.BuildersamplePromptsControlMode(String samplePromptsControlMode)Determines whether sample prompts are enabled in the web experience for an end user.CreateWebExperienceRequest.BuildersamplePromptsControlMode(WebExperienceSamplePromptsControlMode samplePromptsControlMode)Determines whether sample prompts are enabled in the web experience for an end user.CreateWebExperienceRequest.Buildersubtitle(String subtitle)A subtitle to personalize your Amazon Q Business web experience.CreateWebExperienceRequest.Buildertags(Collection<Tag> tags)A list of key-value pairs that identify or categorize your Amazon Q Business web experience.CreateWebExperienceRequest.Buildertags(Consumer<Tag.Builder>... tags)A list of key-value pairs that identify or categorize your Amazon Q Business web experience.CreateWebExperienceRequest.Buildertags(Tag... tags)A list of key-value pairs that identify or categorize your Amazon Q Business web experience.CreateWebExperienceRequest.Buildertitle(String title)The title for your Amazon Q Business web experience.CreateWebExperienceRequest.BuilderwelcomeMessage(String welcomeMessage)The customized welcome message for end users of an Amazon Q Business web experience.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.qbusiness.model.QBusinessRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
applicationId
CreateWebExperienceRequest.Builder applicationId(String applicationId)
The identifier of the Amazon Q Business web experience.
- Parameters:
applicationId- The identifier of the Amazon Q Business web experience.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
title
CreateWebExperienceRequest.Builder title(String title)
The title for your Amazon Q Business web experience.
- Parameters:
title- The title for your Amazon Q Business web experience.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subtitle
CreateWebExperienceRequest.Builder subtitle(String subtitle)
A subtitle to personalize your Amazon Q Business web experience.
- Parameters:
subtitle- A subtitle to personalize your Amazon Q Business web experience.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
welcomeMessage
CreateWebExperienceRequest.Builder welcomeMessage(String welcomeMessage)
The customized welcome message for end users of an Amazon Q Business web experience.
- Parameters:
welcomeMessage- The customized welcome message for end users of an Amazon Q Business web experience.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
samplePromptsControlMode
CreateWebExperienceRequest.Builder samplePromptsControlMode(String samplePromptsControlMode)
Determines whether sample prompts are enabled in the web experience for an end user.
- Parameters:
samplePromptsControlMode- Determines whether sample prompts are enabled in the web experience for an end user.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
WebExperienceSamplePromptsControlMode,WebExperienceSamplePromptsControlMode
-
samplePromptsControlMode
CreateWebExperienceRequest.Builder samplePromptsControlMode(WebExperienceSamplePromptsControlMode samplePromptsControlMode)
Determines whether sample prompts are enabled in the web experience for an end user.
- Parameters:
samplePromptsControlMode- Determines whether sample prompts are enabled in the web experience for an end user.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
WebExperienceSamplePromptsControlMode,WebExperienceSamplePromptsControlMode
-
roleArn
CreateWebExperienceRequest.Builder roleArn(String roleArn)
The Amazon Resource Name (ARN) of the service role attached to your web experience.
- Parameters:
roleArn- The Amazon Resource Name (ARN) of the service role attached to your web experience.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
CreateWebExperienceRequest.Builder tags(Collection<Tag> tags)
A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
- Parameters:
tags- A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
CreateWebExperienceRequest.Builder tags(Tag... tags)
A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
- Parameters:
tags- A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
CreateWebExperienceRequest.Builder tags(Consumer<Tag.Builder>... tags)
A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
This is a convenience method that creates an instance of theTag.Builderavoiding the need to create one manually viaTag.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#tags(List.) - Parameters:
tags- a consumer that will call methods onTag.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#tags(java.util.Collection)
-
clientToken
CreateWebExperienceRequest.Builder clientToken(String clientToken)
A token you provide to identify a request to create an Amazon Q Business web experience.
- Parameters:
clientToken- A token you provide to identify a request to create an Amazon Q Business web experience.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateWebExperienceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
CreateWebExperienceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-