Class SessionData

java.lang.Object
software.amazon.awssdk.services.qconnect.model.SessionData
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SessionData.Builder,SessionData>
@Generated("software.amazon.awssdk:codegen") public final class SessionData extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SessionData.Builder,SessionData>

Information about the session.

See Also:

  • Method Details

    • sessionArn

      public final String sessionArn()

      The Amazon Resource Name (ARN) of the session.

      Returns:
      The Amazon Resource Name (ARN) of the session.

    • sessionId

      public final String sessionId()

      The identifier of the session.

      Returns:
      The identifier of the session.

    • name

      public final String name()

      The name of the session.

      Returns:
      The name of the session.

    • description

      public final String description()

      The description of the session.

      Returns:
      The description of the session.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      The tags used to organize, track, or control access for this resource.

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

      Returns:
      The tags used to organize, track, or control access for this resource.

    • integrationConfiguration

      public final SessionIntegrationConfiguration integrationConfiguration()

      The configuration information for the session integration.

      Returns:
      The configuration information for the session integration.

    • tagFilter

      public final TagFilter tagFilter()

      An object that can be used to specify Tag conditions.

      Returns:
      An object that can be used to specify Tag conditions.

    • aiAgentConfiguration

      public final Map<AIAgentType,AIAgentConfigurationData> aiAgentConfiguration()

      The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.

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

      Returns:
      The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.

    • hasAiAgentConfiguration

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

    • aiAgentConfigurationAsStrings

      public final Map<String,AIAgentConfigurationData> aiAgentConfigurationAsStrings()

      The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.

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

      Returns:
      The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.

    • origin

      public final Origin origin()

      The origin of the Session to be listed. SYSTEM for a default Session created by Amazon Q in Connect or CUSTOMER for a Session created by calling CreateSession API.

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

      Returns:
      The origin of the Session to be listed. SYSTEM for a default Session created by Amazon Q in Connect or CUSTOMER for a Session created by calling CreateSession API.
      See Also:

    • originAsString

      public final String originAsString()

      The origin of the Session to be listed. SYSTEM for a default Session created by Amazon Q in Connect or CUSTOMER for a Session created by calling CreateSession API.

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

      Returns:
      The origin of the Session to be listed. SYSTEM for a default Session created by Amazon Q in Connect or CUSTOMER for a Session created by calling CreateSession API.
      See Also:

    • toBuilder

      public SessionData.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<SessionData.Builder,SessionData>
      Returns:
      a builder for type T

    • builder

      public static SessionData.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.