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

Class CreateQuickResponseRequest

    • Method Detail

      • hasChannels

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

      • channels

        public final List<String> channels()

        The Amazon Connect channels this quick response applies to.

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

        Returns:
        The Amazon Connect channels this quick response applies to.

      • clientToken

        public final String clientToken()

        A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

        Returns:
        A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

      • content

        public final QuickResponseDataProvider content()

        The content of the quick response.

        Returns:
        The content of the quick response.

      • contentType

        public final String contentType()

        The media type of the quick response content.

        • Use application/x.quickresponse;format=plain for a quick response written in plain text.

        • Use application/x.quickresponse;format=markdown for a quick response written in richtext.

        Returns:
        The media type of the quick response content.

        • Use application/x.quickresponse;format=plain for a quick response written in plain text.

        • Use application/x.quickresponse;format=markdown for a quick response written in richtext.

      • description

        public final String description()

        The description of the quick response.

        Returns:
        The description of the quick response.

      • groupingConfiguration

        public final GroupingConfiguration groupingConfiguration()

        The configuration information of the user groups that the quick response is accessible to.

        Returns:
        The configuration information of the user groups that the quick response is accessible to.

      • isActive

        public final Boolean isActive()

        Whether the quick response is active.

        Returns:
        Whether the quick response is active.

      • knowledgeBaseId

        public final String knowledgeBaseId()

        The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

        Returns:
        The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

      • language

        public final String language()

        The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW

        Returns:
        The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW

      • name

        public final String name()

        The name of the quick response.

        Returns:
        The name of the quick response.

      • shortcutKey

        public final String shortcutKey()

        The shortcut key of the quick response. The value should be unique across the knowledge base.

        Returns:
        The shortcut key of the quick response. The value should be unique across the knowledge base.

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

      • 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