Class AIAgentData

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

The data for the AI Agent.

See Also:

  • Method Details

    • assistantId

      public final String assistantId()

      The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

      Returns:
      The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    • assistantArn

      public final String assistantArn()

      The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

      Returns:
      The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

    • aiAgentId

      public final String aiAgentId()

      The identifier of the AI Agent.

      Returns:
      The identifier of the AI Agent.

    • aiAgentArn

      public final String aiAgentArn()

      The Amazon Resource Name (ARN) of the AI agent.

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

    • name

      public final String name()

      The name of the AI Agent.

      Returns:
      The name of the AI Agent.

    • type

      public final AIAgentType type()

      The type of the AI Agent.

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

      Returns:
      The type of the AI Agent.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the AI Agent.

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

      Returns:
      The type of the AI Agent.
      See Also:

    • configuration

      public final AIAgentConfiguration configuration()

      Configuration for the AI Agent.

      Returns:
      Configuration for the AI Agent.

    • modifiedTime

      public final Instant modifiedTime()

      The time the AI Agent was last modified.

      Returns:
      The time the AI Agent was last modified.

    • description

      public final String description()

      The description of the AI Agent.

      Returns:
      The description of the AI Agent.

    • visibilityStatus

      public final VisibilityStatus visibilityStatus()

      The visibility status of the AI Agent.

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

      Returns:
      The visibility status of the AI Agent.
      See Also:

    • visibilityStatusAsString

      public final String visibilityStatusAsString()

      The visibility status of the AI Agent.

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

      Returns:
      The visibility status of the AI Agent.
      See Also:

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

    • origin

      public final Origin origin()

      Specifies the origin of the AI Agent. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.

      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:
      Specifies the origin of the AI Agent. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.
      See Also:

    • originAsString

      public final String originAsString()

      Specifies the origin of the AI Agent. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.

      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:
      Specifies the origin of the AI Agent. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.
      See Also:

    • status

      public final Status status()

      The status of the AI Agent.

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

      Returns:
      The status of the AI Agent.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the AI Agent.

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

      Returns:
      The status of the AI Agent.
      See Also:

    • toBuilder

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

    • builder

      public static AIAgentData.Builder builder()

    • serializableBuilderClass

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