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

Class CreateWebExperienceRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateWebExperienceRequest.Builder,CreateWebExperienceRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateWebExperienceRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	applicationId()	The identifier of the Amazon Q Business web experience.
static CreateWebExperienceRequest.Builder	builder()
String	clientToken()	A token you provide to identify a request to create an Amazon Q Business web experience.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	roleArn()	The Amazon Resource Name (ARN) of the service role attached to your web experience.
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 CreateWebExperienceRequest.Builder>	serializableBuilderClass()
String	subtitle()	A subtitle to personalize your Amazon Q Business web experience.
List<Tag>	tags()	A list of key-value pairs that identify or categorize your Amazon Q Business web experience.
String	title()	The title for your Amazon Q Business web experience.
CreateWebExperienceRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	welcomeMessage()	The customized welcome message for end users of 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 web experience.

Returns:

The identifier of the Amazon Q Business web experience.

title

public final String title()

The title for your Amazon Q Business web experience.

Returns:

The title for your Amazon Q Business web experience.

subtitle

public final String subtitle()

A subtitle to personalize your Amazon Q Business web experience.

Returns:

A subtitle to personalize your Amazon Q Business web experience.

welcomeMessage

public final String welcomeMessage()

The customized welcome message for end users of an Amazon Q Business web experience.

Returns:

The customized welcome message for end users of 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

roleArn

public final String roleArn()

The Amazon Resource Name (ARN) of the service role attached to your web experience.

Returns:

The Amazon Resource Name (ARN) of the service role attached to your web experience.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<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: _ . : / = + - @.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

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: _ . : / = + - @.

clientToken

public final String clientToken()

A token you provide to identify a request to create an Amazon Q Business web experience.

Returns:

A token you provide to identify a request to create an Amazon Q Business web experience.

toBuilder

public CreateWebExperienceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateWebExperienceRequest.Builder,CreateWebExperienceRequest>

Specified by:

toBuilder in class QBusinessRequest

builder

public static CreateWebExperienceRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateWebExperienceRequest.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