GetWebExperienceResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.qbusiness.model.GetWebExperienceResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetWebExperienceResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetWebExperienceResult()

Constructors
Constructor and Description
`GetWebExperienceResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetWebExperienceResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getApplicationId()` The identifier of the Amazon Q application linked to the web experience.
`WebExperienceAuthConfiguration`	`getAuthenticationConfiguration()` The authentication configuration information for your Amazon Q web experience.
`Date`	`getCreatedAt()` The Unix timestamp when the retriever was created.
`String`	`getDefaultEndpoint()` The endpoint of your Amazon Q web experience.
`ErrorDetail`	`getError()` When the `Status` field value is `FAILED`, the `ErrorMessage` field contains a description of the error that caused the data source connector to fail.
`String`	`getSamplePromptsControlMode()` Determines whether sample prompts are enabled in the web experience for an end user.
`String`	`getStatus()` The current status of the Amazon Q web experience.
`String`	`getSubtitle()` The subtitle for your Amazon Q web experience.
`String`	`getTitle()` The title for your Amazon Q web experience.
`Date`	`getUpdatedAt()` The Unix timestamp when the data source connector was last updated.
`String`	`getWebExperienceArn()` The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q web experience and required resources.
`String`	`getWebExperienceId()` The identifier of the Amazon Q web experience.
`String`	`getWelcomeMessage()` The customized welcome message for end users of an Amazon Q web experience.
`int`	`hashCode()`
`void`	`setApplicationId(String applicationId)` The identifier of the Amazon Q application linked to the web experience.
`void`	`setAuthenticationConfiguration(WebExperienceAuthConfiguration authenticationConfiguration)` The authentication configuration information for your Amazon Q web experience.
`void`	`setCreatedAt(Date createdAt)` The Unix timestamp when the retriever was created.
`void`	`setDefaultEndpoint(String defaultEndpoint)` The endpoint of your Amazon Q web experience.
`void`	`setError(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.
`void`	`setSamplePromptsControlMode(String samplePromptsControlMode)` Determines whether sample prompts are enabled in the web experience for an end user.
`void`	`setStatus(String status)` The current status of the Amazon Q web experience.
`void`	`setSubtitle(String subtitle)` The subtitle for your Amazon Q web experience.
`void`	`setTitle(String title)` The title for your Amazon Q web experience.
`void`	`setUpdatedAt(Date updatedAt)` The Unix timestamp when the data source connector was last updated.
`void`	`setWebExperienceArn(String webExperienceArn)` The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q web experience and required resources.
`void`	`setWebExperienceId(String webExperienceId)` The identifier of the Amazon Q web experience.
`void`	`setWelcomeMessage(String welcomeMessage)` The customized welcome message for end users of an Amazon Q web experience.
`String`	`toString()` Returns a string representation of this object.
`GetWebExperienceResult`	`withApplicationId(String applicationId)` The identifier of the Amazon Q application linked to the web experience.
`GetWebExperienceResult`	`withAuthenticationConfiguration(WebExperienceAuthConfiguration authenticationConfiguration)` The authentication configuration information for your Amazon Q web experience.
`GetWebExperienceResult`	`withCreatedAt(Date createdAt)` The Unix timestamp when the retriever was created.
`GetWebExperienceResult`	`withDefaultEndpoint(String defaultEndpoint)` The endpoint of your Amazon Q web experience.
`GetWebExperienceResult`	`withError(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.
`GetWebExperienceResult`	`withSamplePromptsControlMode(String samplePromptsControlMode)` Determines whether sample prompts are enabled in the web experience for an end user.
`GetWebExperienceResult`	`withSamplePromptsControlMode(WebExperienceSamplePromptsControlMode samplePromptsControlMode)` Determines whether sample prompts are enabled in the web experience for an end user.
`GetWebExperienceResult`	`withStatus(String status)` The current status of the Amazon Q web experience.
`GetWebExperienceResult`	`withStatus(WebExperienceStatus status)` The current status of the Amazon Q web experience.
`GetWebExperienceResult`	`withSubtitle(String subtitle)` The subtitle for your Amazon Q web experience.
`GetWebExperienceResult`	`withTitle(String title)` The title for your Amazon Q web experience.
`GetWebExperienceResult`	`withUpdatedAt(Date updatedAt)` The Unix timestamp when the data source connector was last updated.
`GetWebExperienceResult`	`withWebExperienceArn(String webExperienceArn)` The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q web experience and required resources.
`GetWebExperienceResult`	`withWebExperienceId(String webExperienceId)` The identifier of the Amazon Q web experience.
`GetWebExperienceResult`	`withWelcomeMessage(String welcomeMessage)` The customized welcome message for end users of an Amazon Q web experience.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GetWebExperienceResult
```
public GetWebExperienceResult()
```
- Method Detail
  - setApplicationId
```
public void setApplicationId(String applicationId)
```
    The identifier of the Amazon Q application linked to the web experience.
    
    Parameters:
    
    applicationId - The identifier of the Amazon Q application linked to the web experience.
  - getApplicationId
```
public String getApplicationId()
```
    The identifier of the Amazon Q application linked to the web experience.
    
    Returns:
    
    The identifier of the Amazon Q application linked to the web experience.
  - withApplicationId
```
public GetWebExperienceResult withApplicationId(String applicationId)
```
    The identifier of the Amazon Q application linked to the web experience.
    
    Parameters:
    
    applicationId - The identifier of the Amazon Q application linked to the web experience.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAuthenticationConfiguration
```
public void setAuthenticationConfiguration(WebExperienceAuthConfiguration authenticationConfiguration)
```
    The authentication configuration information for your Amazon Q web experience.
    
    Parameters:
    
    authenticationConfiguration - The authentication configuration information for your Amazon Q web experience.
  - getAuthenticationConfiguration
```
public WebExperienceAuthConfiguration getAuthenticationConfiguration()
```
    The authentication configuration information for your Amazon Q web experience.
    
    Returns:
    
    The authentication configuration information for your Amazon Q web experience.
  - withAuthenticationConfiguration
```
public GetWebExperienceResult withAuthenticationConfiguration(WebExperienceAuthConfiguration authenticationConfiguration)
```
    The authentication configuration information for your Amazon Q web experience.
    
    Parameters:
    
    authenticationConfiguration - The authentication configuration information for your Amazon Q web experience.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The Unix timestamp when the retriever was created.
    
    Parameters:
    
    createdAt - The Unix timestamp when the retriever was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The Unix timestamp when the retriever was created.
    
    Returns:
    
    The Unix timestamp when the retriever was created.
  - withCreatedAt
```
public GetWebExperienceResult withCreatedAt(Date createdAt)
```
    The Unix timestamp when the retriever was created.
    
    Parameters:
    
    createdAt - The Unix timestamp when the retriever was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefaultEndpoint
```
public void setDefaultEndpoint(String defaultEndpoint)
```
    The endpoint of your Amazon Q web experience.
    
    Parameters:
    
    defaultEndpoint - The endpoint of your Amazon Q web experience.
  - getDefaultEndpoint
```
public String getDefaultEndpoint()
```
    The endpoint of your Amazon Q web experience.
    
    Returns:
    
    The endpoint of your Amazon Q web experience.
  - withDefaultEndpoint
```
public GetWebExperienceResult withDefaultEndpoint(String defaultEndpoint)
```
    The endpoint of your Amazon Q web experience.
    
    Parameters:
    
    defaultEndpoint - The endpoint of your Amazon Q web experience.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setError
```
public void setError(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.
    
    Parameters:
    
    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.
  - getError
```
public ErrorDetail getError()
```
    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.
  - withError
```
public GetWebExperienceResult withError(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSamplePromptsControlMode
```
public void setSamplePromptsControlMode(String samplePromptsControlMode)
```
    Determines whether sample prompts are enabled in the web experience for an end user.
    
    Parameters:
    
    samplePromptsControlMode - Determines whether sample prompts are enabled in the web experience for an end user.
    
    See Also:
    
    WebExperienceSamplePromptsControlMode
  - getSamplePromptsControlMode
```
public String getSamplePromptsControlMode()
```
    Determines whether sample prompts are enabled in the web experience for an end user.
    
    Returns:
    
    Determines whether sample prompts are enabled in the web experience for an end user.
    
    See Also:
    
    WebExperienceSamplePromptsControlMode
  - withSamplePromptsControlMode
```
public GetWebExperienceResult withSamplePromptsControlMode(String samplePromptsControlMode)
```
    Determines whether sample prompts are enabled in the web experience for an end user.
    
    Parameters:
    
    samplePromptsControlMode - Determines whether sample prompts are enabled in the web experience for an end user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WebExperienceSamplePromptsControlMode
  - withSamplePromptsControlMode
```
public GetWebExperienceResult withSamplePromptsControlMode(WebExperienceSamplePromptsControlMode samplePromptsControlMode)
```
    Determines whether sample prompts are enabled in the web experience for an end user.
    
    Parameters:
    
    samplePromptsControlMode - Determines whether sample prompts are enabled in the web experience for an end user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WebExperienceSamplePromptsControlMode
  - setStatus
```
public void setStatus(String status)
```
    The current status of the Amazon Q 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.
    
    Parameters:
    
    status - The current status of the Amazon Q 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
  - getStatus
```
public String getStatus()
```
    The current status of the Amazon Q 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.
    
    Returns:
    
    The current status of the Amazon Q 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
  - withStatus
```
public GetWebExperienceResult withStatus(String status)
```
    The current status of the Amazon Q 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.
    
    Parameters:
    
    status - The current status of the Amazon Q 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WebExperienceStatus
  - withStatus
```
public GetWebExperienceResult withStatus(WebExperienceStatus status)
```
    The current status of the Amazon Q 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.
    
    Parameters:
    
    status - The current status of the Amazon Q 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WebExperienceStatus
  - setSubtitle
```
public void setSubtitle(String subtitle)
```
    The subtitle for your Amazon Q web experience.
    
    Parameters:
    
    subtitle - The subtitle for your Amazon Q web experience.
  - getSubtitle
```
public String getSubtitle()
```
    The subtitle for your Amazon Q web experience.
    
    Returns:
    
    The subtitle for your Amazon Q web experience.
  - withSubtitle
```
public GetWebExperienceResult withSubtitle(String subtitle)
```
    The subtitle for your Amazon Q web experience.
    
    Parameters:
    
    subtitle - The subtitle for your Amazon Q web experience.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTitle
```
public void setTitle(String title)
```
    The title for your Amazon Q web experience.
    
    Parameters:
    
    title - The title for your Amazon Q web experience.
  - getTitle
```
public String getTitle()
```
    The title for your Amazon Q web experience.
    
    Returns:
    
    The title for your Amazon Q web experience.
  - withTitle
```
public GetWebExperienceResult withTitle(String title)
```
    The title for your Amazon Q web experience.
    
    Parameters:
    
    title - The title for your Amazon Q web experience.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUpdatedAt
```
public void setUpdatedAt(Date updatedAt)
```
    The Unix timestamp when the data source connector was last updated.
    
    Parameters:
    
    updatedAt - The Unix timestamp when the data source connector was last updated.
  - getUpdatedAt
```
public Date getUpdatedAt()
```
    The Unix timestamp when the data source connector was last updated.
    
    Returns:
    
    The Unix timestamp when the data source connector was last updated.
  - withUpdatedAt
```
public GetWebExperienceResult withUpdatedAt(Date updatedAt)
```
    The Unix timestamp when the data source connector was last updated.
    
    Parameters:
    
    updatedAt - The Unix timestamp when the data source connector was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWebExperienceArn
```
public void setWebExperienceArn(String webExperienceArn)
```
    The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q web experience and required resources.
    
    Parameters:
    
    webExperienceArn - The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q web experience and required resources.
  - getWebExperienceArn
```
public String getWebExperienceArn()
```
    The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q web experience and required resources.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q web experience and required resources.
  - withWebExperienceArn
```
public GetWebExperienceResult withWebExperienceArn(String webExperienceArn)
```
    The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q web experience and required resources.
    
    Parameters:
    
    webExperienceArn - The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q web experience and required resources.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWebExperienceId
```
public void setWebExperienceId(String webExperienceId)
```
    The identifier of the Amazon Q web experience.
    
    Parameters:
    
    webExperienceId - The identifier of the Amazon Q web experience.
  - getWebExperienceId
```
public String getWebExperienceId()
```
    The identifier of the Amazon Q web experience.
    
    Returns:
    
    The identifier of the Amazon Q web experience.
  - withWebExperienceId
```
public GetWebExperienceResult withWebExperienceId(String webExperienceId)
```
    The identifier of the Amazon Q web experience.
    
    Parameters:
    
    webExperienceId - The identifier of the Amazon Q web experience.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWelcomeMessage
```
public void setWelcomeMessage(String welcomeMessage)
```
    The customized welcome message for end users of an Amazon Q web experience.
    
    Parameters:
    
    welcomeMessage - The customized welcome message for end users of an Amazon Q web experience.
  - getWelcomeMessage
```
public String getWelcomeMessage()
```
    The customized welcome message for end users of an Amazon Q web experience.
    
    Returns:
    
    The customized welcome message for end users of an Amazon Q web experience.
  - withWelcomeMessage
```
public GetWebExperienceResult withWelcomeMessage(String welcomeMessage)
```
    The customized welcome message for end users of an Amazon Q web experience.
    
    Parameters:
    
    welcomeMessage - The customized welcome message for end users of an Amazon Q web experience.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GetWebExperienceResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.682

Class GetWebExperienceResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

GetWebExperienceResult

Method Detail

setApplicationId

getApplicationId

withApplicationId

setAuthenticationConfiguration

getAuthenticationConfiguration

withAuthenticationConfiguration

setCreatedAt

getCreatedAt

withCreatedAt

setDefaultEndpoint

getDefaultEndpoint

withDefaultEndpoint

setError

getError

withError

setSamplePromptsControlMode

getSamplePromptsControlMode

withSamplePromptsControlMode

withSamplePromptsControlMode

setStatus

getStatus

withStatus

withStatus

setSubtitle

getSubtitle

withSubtitle

setTitle

getTitle

withTitle

setUpdatedAt

getUpdatedAt

withUpdatedAt

setWebExperienceArn

getWebExperienceArn

withWebExperienceArn

setWebExperienceId

getWebExperienceId

withWebExperienceId

setWelcomeMessage

getWelcomeMessage

withWelcomeMessage

toString

equals

hashCode

clone