Class GetWebExperienceResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetWebExperienceResponse.Builder,
GetWebExperienceResponse>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal String
The identifier of the Amazon Q Business application linked to the web experience.Deprecated.Property associated with legacy SAML IdP flow.builder()
final Instant
The Unix timestamp when the Amazon Q Business web experience was last created.final String
The endpoint of your 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 ErrorDetail
error()
When theStatus
field value isFAILED
, theErrorMessage
field contains a description of the error that caused the data source connector to fail.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
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 GetWebExperienceResponse.Builder> final WebExperienceStatus
status()
The current status of the Amazon Q Business web experience.final String
The current status of the Amazon Q Business web experience.final String
subtitle()
The subtitle for 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 Instant
The Unix timestamp when the Amazon Q Business web experience was last updated.final String
The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.final String
The identifier of the Amazon Q Business web experience.final String
The customized welcome message for end users of an Amazon Q Business web experience.Methods inherited from class software.amazon.awssdk.services.qbusiness.model.QBusinessResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
applicationId
The identifier of the Amazon Q Business application linked to the web experience.
- Returns:
- The identifier of the Amazon Q Business application linked to the web experience.
-
webExperienceId
The identifier of the Amazon Q Business web experience.
- Returns:
- The identifier of the Amazon Q Business web experience.
-
webExperienceArn
The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.
- Returns:
- The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.
-
defaultEndpoint
The endpoint of your Amazon Q Business web experience.
- Returns:
- The endpoint of your Amazon Q Business web experience.
-
status
The current status of the Amazon Q Business web experience. When the
Status
field value isFAILED
, theErrorMessage
field contains a description of the error that caused the data source connector to fail.If the service returns an enum value that is not available in the current SDK version,
status
will returnWebExperienceStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the Amazon Q Business web experience. When the
Status
field value isFAILED
, theErrorMessage
field contains a description of the error that caused the data source connector to fail. - See Also:
-
statusAsString
The current status of the Amazon Q Business web experience. When the
Status
field value isFAILED
, theErrorMessage
field contains a description of the error that caused the data source connector to fail.If the service returns an enum value that is not available in the current SDK version,
status
will returnWebExperienceStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the Amazon Q Business web experience. When the
Status
field value isFAILED
, theErrorMessage
field contains a description of the error that caused the data source connector to fail. - See Also:
-
createdAt
The Unix timestamp when the Amazon Q Business web experience was last created.
- Returns:
- The Unix timestamp when the Amazon Q Business web experience was last created.
-
updatedAt
The Unix timestamp when the Amazon Q Business web experience was last updated.
- Returns:
- The Unix timestamp when the Amazon Q Business web experience was last updated.
-
title
The title for your Amazon Q Business web experience.
- Returns:
- The title for your Amazon Q Business web experience.
-
subtitle
The subtitle for your Amazon Q Business web experience.
- Returns:
- The subtitle for 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.
-
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.
- Returns:
- The authentication configuration information for your Amazon Q Business web experience.
-
error
When the
Status
field value isFAILED
, theErrorMessage
field contains a description of the error that caused the data source connector to fail.- Returns:
- When the
Status
field value isFAILED
, theErrorMessage
field contains a description of the error that caused the data source connector to fail.
-
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<GetWebExperienceResponse.Builder,
GetWebExperienceResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-