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

Class GetWebExperienceResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.qbusiness.model.QBusinessResponse

software.amazon.awssdk.services.qbusiness.model.GetWebExperienceResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetWebExperienceResponse.Builder,GetWebExperienceResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetWebExperienceResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	applicationId()	The identifier of the Amazon Q Business application linked to the web experience.
WebExperienceAuthConfiguration	authenticationConfiguration()	Deprecated. Property associated with legacy SAML IdP flow.
static GetWebExperienceResponse.Builder	builder()
Instant	createdAt()	The Unix timestamp when the Amazon Q Business web experience was last created.
String	defaultEndpoint()	The endpoint of your Amazon Q Business web experience.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
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.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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 GetWebExperienceResponse.Builder>	serializableBuilderClass()
WebExperienceStatus	status()	The current status of the Amazon Q Business web experience.
String	statusAsString()	The current status of the Amazon Q Business web experience.
String	subtitle()	The subtitle for your Amazon Q Business web experience.
String	title()	The title for your Amazon Q Business web experience.
GetWebExperienceResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Instant	updatedAt()	The Unix timestamp when the Amazon Q Business web experience was last updated.
String	webExperienceArn()	The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.
String	webExperienceId()	The identifier of the Amazon Q Business web experience.
String	welcomeMessage()	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 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 linked to the web experience.

Returns:

The identifier of the Amazon Q Business application linked 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.

webExperienceArn

public final String 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

public final String defaultEndpoint()

The endpoint of your Amazon Q Business web experience.

Returns:

The endpoint of your Amazon Q Business web experience.

status

public final 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.

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

Returns:

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.

See Also:

WebExperienceStatus

statusAsString

public final String statusAsString()

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.

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

Returns:

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.

See Also:

WebExperienceStatus

createdAt

public final Instant 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

public final Instant 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

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()

The subtitle for your Amazon Q Business web experience.

Returns:

The subtitle for 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.

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 information for your Amazon Q Business web experience.

Returns:

The authentication configuration information for your Amazon Q Business web experience.

error

public final 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.

Returns:

When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

toBuilder

public GetWebExperienceResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetWebExperienceResponse.Builder,GetWebExperienceResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetWebExperienceResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo