Interface GetWebExperienceResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<GetWebExperienceResponse.Builder,GetWebExperienceResponse>, QBusinessResponse.Builder, SdkBuilder<GetWebExperienceResponse.Builder,GetWebExperienceResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
GetWebExperienceResponse
@Mutable @NotThreadSafe public static interface GetWebExperienceResponse.Builder extends QBusinessResponse.Builder, SdkPojo, CopyableBuilder<GetWebExperienceResponse.Builder,GetWebExperienceResponse>

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • origins

      GetWebExperienceResponse.Builder origins(Collection<String> origins)

      Gets the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol (http/https), the domain name, and the port number (if specified).

      Parameters:
      origins - Gets the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol ( http/https), the domain name, and the port number (if specified).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • origins

      GetWebExperienceResponse.Builder origins(String... origins)

      Gets the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol (http/https), the domain name, and the port number (if specified).

      Parameters:
      origins - Gets the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol ( http/https), the domain name, and the port number (if specified).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

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

    • identityProviderConfiguration

      GetWebExperienceResponse.Builder identityProviderConfiguration(IdentityProviderConfiguration identityProviderConfiguration)

      Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

      Parameters:
      identityProviderConfiguration - Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • identityProviderConfiguration

      default GetWebExperienceResponse.Builder identityProviderConfiguration(Consumer<IdentityProviderConfiguration.Builder> identityProviderConfiguration)

      Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

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

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

      Parameters:
      identityProviderConfiguration - a consumer that will call methods on IdentityProviderConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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:

    • 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:

    • browserExtensionConfiguration

      GetWebExperienceResponse.Builder browserExtensionConfiguration(BrowserExtensionConfiguration browserExtensionConfiguration)

      The browser extension configuration for an Amazon Q Business web experience.

      Parameters:
      browserExtensionConfiguration - The browser extension configuration for an Amazon Q Business web experience.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • browserExtensionConfiguration

      default GetWebExperienceResponse.Builder browserExtensionConfiguration(Consumer<BrowserExtensionConfiguration.Builder> browserExtensionConfiguration)

      The browser extension configuration for an Amazon Q Business web experience.

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

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

      Parameters:
      browserExtensionConfiguration - a consumer that will call methods on BrowserExtensionConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • customizationConfiguration

      GetWebExperienceResponse.Builder customizationConfiguration(CustomizationConfiguration customizationConfiguration)

      Gets the custom logo, favicon, font, and color used in the Amazon Q web experience.

      Parameters:
      customizationConfiguration - Gets the custom logo, favicon, font, and color used in the Amazon Q web experience.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customizationConfiguration

      default GetWebExperienceResponse.Builder customizationConfiguration(Consumer<CustomizationConfiguration.Builder> customizationConfiguration)

      Gets the custom logo, favicon, font, and color used in the Amazon Q web experience.

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

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

      Parameters:
      customizationConfiguration - a consumer that will call methods on CustomizationConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: