Class CreateWebExperienceRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateWebExperienceRequest.Builder,
CreateWebExperienceRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The identifier of the Amazon Q Business web experience.builder()
final String
A token you provide to identify a request to create an Amazon Q Business web experience.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
roleArn()
The Amazon Resource Name (ARN) of the service role attached to your web experience.Determines whether sample prompts are enabled in the web experience for an end user.final String
Determines whether sample prompts are enabled in the web experience for an end user.static Class
<? extends CreateWebExperienceRequest.Builder> final String
subtitle()
A subtitle to personalize your Amazon Q Business web experience.tags()
A list of key-value pairs that identify or categorize your Amazon Q Business web experience.final String
title()
The title for your Amazon Q Business web experience.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
applicationId
The identifier of the Amazon Q Business web experience.
- Returns:
- The identifier of the Amazon Q Business web experience.
-
title
The title for your Amazon Q Business web experience.
- Returns:
- The title for your Amazon Q Business web experience.
-
subtitle
A subtitle to personalize your Amazon Q Business web experience.
- Returns:
- A subtitle to personalize your Amazon Q Business web experience.
-
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
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 returnWebExperienceSamplePromptsControlMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsamplePromptsControlModeAsString()
.- Returns:
- Determines whether sample prompts are enabled in the web experience for an end user.
- See Also:
-
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 returnWebExperienceSamplePromptsControlMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsamplePromptsControlModeAsString()
.- Returns:
- Determines whether sample prompts are enabled in the web experience for an end user.
- See Also:
-
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 theisEmpty()
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
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateWebExperienceRequest.Builder,
CreateWebExperienceRequest> - Specified by:
toBuilder
in classQBusinessRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-