Package software.amazon.awssdk.services.qconnect.model

Class AIAgentData

    • Method Detail

      • aiAgentArn

        public final String aiAgentArn()

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

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

      • aiAgentId

        public final String aiAgentId()

        The identifier of the AI Agent.

        Returns:
        The identifier of the AI Agent.

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

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

      • configuration

        public final AIAgentConfiguration configuration()

        Configuration for the AI Agent.

        Returns:
        Configuration for the AI Agent.

      • description

        public final String description()

        The description of the AI Agent.

        Returns:
        The description of 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.

      • name

        public final String name()

        The name of the AI Agent.

        Returns:
        The name of the AI Agent.

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

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

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

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

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

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

      • hashCode

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

      • equals

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

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