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

Class UpdateWebExperienceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.qbusiness.model.QBusinessRequest

software.amazon.awssdk.services.qbusiness.model.UpdateWebExperienceRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateWebExperienceRequest.Builder,UpdateWebExperienceRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateWebExperienceRequest
extends QBusinessRequest
implements ToCopyableBuilder<UpdateWebExperienceRequest.Builder,UpdateWebExperienceRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateWebExperienceRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	applicationId()	The identifier of the Amazon Q Business application attached to the web experience.
WebExperienceAuthConfiguration	authenticationConfiguration()	Deprecated. Property associated with legacy SAML IdP flow.
static UpdateWebExperienceRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	roleArn()	The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business web experience and required resources.
WebExperienceSamplePromptsControlMode	samplePromptsControlMode()	Determines whether sample prompts are enabled in the web experience for an end user.
String	samplePromptsControlModeAsString()	Determines whether sample prompts are enabled in the web experience for an end user.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateWebExperienceRequest.Builder>	serializableBuilderClass()
String	subtitle()	The subtitle of the Amazon Q Business web experience.
String	title()	The title of the Amazon Q Business web experience.
UpdateWebExperienceRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	webExperienceId()	The identifier of the Amazon Q Business web experience.
String	welcomeMessage()	A customized welcome message for an end user in an Amazon Q Business web experience.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

applicationId

public final String applicationId()

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

Returns:

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

webExperienceId

public final String webExperienceId()

The identifier of the Amazon Q Business web experience.

Returns:

The identifier of the Amazon Q Business web experience.

roleArn

public final String roleArn()

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

Returns:

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

authenticationConfiguration

@Deprecated
public final 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 of the Amazon Q Business web experience.

Returns:

The authentication configuration of the Amazon Q Business web experience.

title

public final String title()

The title of the Amazon Q Business web experience.

Returns:

The title of the Amazon Q Business web experience.

subtitle

public final String subtitle()

The subtitle of the Amazon Q Business web experience.

Returns:

The subtitle of the Amazon Q Business web experience.

welcomeMessage

public final String welcomeMessage()

A customized welcome message for an end user in an Amazon Q Business web experience.

Returns:

A customized welcome message for an end user in an Amazon Q Business web experience.

samplePromptsControlMode

public final WebExperienceSamplePromptsControlMode samplePromptsControlMode()

Determines whether sample prompts are enabled in the web experience for an end user.

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

Returns:

Determines whether sample prompts are enabled in the web experience for an end user.

See Also:

WebExperienceSamplePromptsControlMode

samplePromptsControlModeAsString

public final String samplePromptsControlModeAsString()

Determines whether sample prompts are enabled in the web experience for an end user.

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

Returns:

Determines whether sample prompts are enabled in the web experience for an end user.

See Also:

WebExperienceSamplePromptsControlMode

toBuilder

public UpdateWebExperienceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateWebExperienceRequest.Builder,UpdateWebExperienceRequest>

Specified by:

toBuilder in class QBusinessRequest

builder

public static UpdateWebExperienceRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateWebExperienceRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo