Package software.amazon.awssdk.services.qbusiness.model

Interface GetWebExperienceResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GetWebExperienceResponse.Builder,GetWebExperienceResponse>, QBusinessResponse.Builder, SdkBuilder<GetWebExperienceResponse.Builder,GetWebExperienceResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetWebExperienceResponse

public static interface GetWebExperienceResponse.Builder
extends QBusinessResponse.Builder, SdkPojo, CopyableBuilder<GetWebExperienceResponse.Builder,GetWebExperienceResponse>

Method Summary

Modifier and Type	Method	Description
GetWebExperienceResponse.Builder	applicationId(String applicationId)	The identifier of the Amazon Q Business application linked to the web experience.
default GetWebExperienceResponse.Builder	authenticationConfiguration(Consumer<WebExperienceAuthConfiguration.Builder> authenticationConfiguration)	Deprecated. Property associated with legacy SAML IdP flow.
GetWebExperienceResponse.Builder	authenticationConfiguration(WebExperienceAuthConfiguration authenticationConfiguration)	Deprecated. Property associated with legacy SAML IdP flow.
GetWebExperienceResponse.Builder	createdAt(Instant createdAt)	The Unix timestamp when the Amazon Q Business web experience was last created.
GetWebExperienceResponse.Builder	defaultEndpoint(String defaultEndpoint)	The endpoint of your Amazon Q Business web experience.
default GetWebExperienceResponse.Builder	error(Consumer<ErrorDetail.Builder> error)	When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.
GetWebExperienceResponse.Builder	error(ErrorDetail error)	When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.
GetWebExperienceResponse.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of the service role attached to your web experience.
GetWebExperienceResponse.Builder	samplePromptsControlMode(String samplePromptsControlMode)	Determines whether sample prompts are enabled in the web experience for an end user.
GetWebExperienceResponse.Builder	samplePromptsControlMode(WebExperienceSamplePromptsControlMode samplePromptsControlMode)	Determines whether sample prompts are enabled in the web experience for an end user.
GetWebExperienceResponse.Builder	status(String status)	The current status of the Amazon Q Business web experience.
GetWebExperienceResponse.Builder	status(WebExperienceStatus status)	The current status of the Amazon Q Business web experience.
GetWebExperienceResponse.Builder	subtitle(String subtitle)	The subtitle for your Amazon Q Business web experience.
GetWebExperienceResponse.Builder	title(String title)	The title for your Amazon Q Business web experience.
GetWebExperienceResponse.Builder	updatedAt(Instant updatedAt)	The Unix timestamp when the Amazon Q Business web experience was last updated.
GetWebExperienceResponse.Builder	webExperienceArn(String webExperienceArn)	The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.
GetWebExperienceResponse.Builder	webExperienceId(String webExperienceId)	The identifier of the Amazon Q Business web experience.
GetWebExperienceResponse.Builder	welcomeMessage(String welcomeMessage)	The customized welcome message for end users of an Amazon Q Business web experience.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.qbusiness.model.QBusinessResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

applicationId

GetWebExperienceResponse.Builder applicationId(String applicationId)

The identifier of the Amazon Q Business application linked to the web experience.

Parameters:

applicationId - The identifier of the Amazon Q Business application linked to the web experience.

Returns:

Returns a reference to this object so that method calls can be chained together.

webExperienceId

GetWebExperienceResponse.Builder webExperienceId(String webExperienceId)

The identifier of the Amazon Q Business web experience.

Parameters:

webExperienceId - The identifier of the Amazon Q Business web experience.

Returns:

Returns a reference to this object so that method calls can be chained together.

webExperienceArn

GetWebExperienceResponse.Builder webExperienceArn(String webExperienceArn)

The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.

Parameters:

webExperienceArn - The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.

Returns:

Returns a reference to this object so that method calls can be chained together.

defaultEndpoint

GetWebExperienceResponse.Builder defaultEndpoint(String defaultEndpoint)

The endpoint of your Amazon Q Business web experience.

Parameters:

defaultEndpoint - The endpoint of your Amazon Q Business web experience.

Returns:

Returns a reference to this object so that method calls can be chained together.

status

GetWebExperienceResponse.Builder status(String status)

The current status of the Amazon Q Business web experience. When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

Parameters:

status - The current status of the Amazon Q Business web experience. When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

WebExperienceStatus, WebExperienceStatus

status

GetWebExperienceResponse.Builder status(WebExperienceStatus status)

The current status of the Amazon Q Business web experience. When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

Parameters:

status - The current status of the Amazon Q Business web experience. When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

WebExperienceStatus, WebExperienceStatus

createdAt

GetWebExperienceResponse.Builder createdAt(Instant createdAt)

The Unix timestamp when the Amazon Q Business web experience was last created.

Parameters:

createdAt - The Unix timestamp when the Amazon Q Business web experience was last created.

Returns:

Returns a reference to this object so that method calls can be chained together.

updatedAt

GetWebExperienceResponse.Builder updatedAt(Instant updatedAt)

The Unix timestamp when the Amazon Q Business web experience was last updated.

Parameters:

updatedAt - The Unix timestamp when the Amazon Q Business web experience was last updated.

Returns:

Returns a reference to this object so that method calls can be chained together.

title

GetWebExperienceResponse.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

GetWebExperienceResponse.Builder subtitle(String subtitle)

The subtitle for your Amazon Q Business web experience.

Parameters:

subtitle - The subtitle for your Amazon Q Business web experience.

Returns:

Returns a reference to this object so that method calls can be chained together.

welcomeMessage

GetWebExperienceResponse.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

GetWebExperienceResponse.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

GetWebExperienceResponse.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

GetWebExperienceResponse.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.

authenticationConfiguration

@Deprecated
GetWebExperienceResponse.Builder authenticationConfiguration(WebExperienceAuthConfiguration authenticationConfiguration)

Deprecated.

Property associated with legacy SAML IdP flow. Deprecated in favor of using AWS IAM Identity Center for user management.

The authentication configuration information for your Amazon Q Business web experience.

Parameters:

authenticationConfiguration - The authentication configuration information for your Amazon Q Business web experience.

Returns:

Returns a reference to this object so that method calls can be chained together.

authenticationConfiguration

@Deprecated
default GetWebExperienceResponse.Builder authenticationConfiguration(Consumer<WebExperienceAuthConfiguration.Builder> authenticationConfiguration)

Deprecated.

Property associated with legacy SAML IdP flow. Deprecated in favor of using AWS IAM Identity Center for user management.

The authentication configuration information for your Amazon Q Business web experience.

This is a convenience method that creates an instance of the WebExperienceAuthConfiguration.Builder avoiding the need to create one manually via WebExperienceAuthConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to authenticationConfiguration(WebExperienceAuthConfiguration).

Parameters:

authenticationConfiguration - a consumer that will call methods on WebExperienceAuthConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

authenticationConfiguration(WebExperienceAuthConfiguration)

error

GetWebExperienceResponse.Builder error(ErrorDetail error)

When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

Parameters:

error - When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

Returns:

Returns a reference to this object so that method calls can be chained together.

error

default GetWebExperienceResponse.Builder error(Consumer<ErrorDetail.Builder> error)

When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

This is a convenience method that creates an instance of the ErrorDetail.Builder avoiding the need to create one manually via ErrorDetail.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to error(ErrorDetail).

Parameters:

error - a consumer that will call methods on ErrorDetail.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

error(ErrorDetail)