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

Class ChatSyncResponse

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.ChatSyncResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ChatSyncResponse.Builder,ChatSyncResponse>
@Generated("software.amazon.awssdk:codegen") public final class ChatSyncResponse extends QBusinessResponse implements ToCopyableBuilder<ChatSyncResponse.Builder,ChatSyncResponse>

  • Method Details

    • conversationId

      public final String conversationId()

      The identifier of the Amazon Q Business conversation.

      Returns:
      The identifier of the Amazon Q Business conversation.

    • systemMessage

      public final String systemMessage()

      An AI-generated message in a conversation.

      Returns:
      An AI-generated message in a conversation.

    • systemMessageId

      public final String systemMessageId()

      The identifier of an Amazon Q Business AI generated message within the conversation.

      Returns:
      The identifier of an Amazon Q Business AI generated message within the conversation.

    • userMessageId

      public final String userMessageId()

      The identifier of an Amazon Q Business end user text input message within the conversation.

      Returns:
      The identifier of an Amazon Q Business end user text input message within the conversation.

    • actionReview

      public final ActionReview actionReview()

      A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.

      Returns:
      A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.

    • authChallengeRequest

      public final AuthChallengeRequest authChallengeRequest()

      An authentication verification event activated by an end user request to use a custom plugin.

      Returns:
      An authentication verification event activated by an end user request to use a custom plugin.

    • hasSourceAttributions

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

    • sourceAttributions

      public final List<SourceAttribution> sourceAttributions()

      The source documents used to generate the conversation response.

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

      Returns:
      The source documents used to generate the conversation response.

    • hasFailedAttachments

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

    • failedAttachments

      public final List<AttachmentOutput> failedAttachments()

      A list of files which failed to upload during chat.

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

      Returns:
      A list of files which failed to upload during chat.

    • toBuilder

      public ChatSyncResponse.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<ChatSyncResponse.Builder,ChatSyncResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static ChatSyncResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ChatSyncResponse.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.