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>

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • hasOrigins

      public final boolean hasOrigins()
      For responses, this returns true if the service returned a value for the Origins 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.

    • origins

      public final List<String> origins()

      Gets the website domain origins that are allowed to embed the Amazon Q Business web experience. 

        The <i>domain origin</i> refers to the base URL for accessing a website including the protocol (<code>http/https</code>), the domain name, and the port number (if specified). </p>

      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 hasOrigins() method.

      Returns:
      Gets the website domain origins that are allowed to embed the Amazon Q Business web experience. 
       The <i>domain origin</i> refers to the base URL for accessing a website including the protocol (<code>http/https</code>), the domain name, and the port number (if specified). </p>

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

    • identityProviderConfiguration

      public final IdentityProviderConfiguration identityProviderConfiguration()

      Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

      Returns:
      Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business 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()
      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 interface ToCopyableBuilder<GetWebExperienceResponse.Builder,GetWebExperienceResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.