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

Class QuickResponseSearchResultData

    • Method Detail

      • hasAttributesInterpolated

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

      • attributesInterpolated

        public final List<String> attributesInterpolated()

        The user defined contact attributes that are resolved when the search result is returned.

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

        Returns:
        The user defined contact attributes that are resolved when the search result is returned.

      • hasAttributesNotInterpolated

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

      • attributesNotInterpolated

        public final List<String> attributesNotInterpolated()

        The user defined contact attributes that are not resolved when the search result is returned.

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

        Returns:
        The user defined contact attributes that are not resolved when the search result is returned.

      • 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 contact channels this quick response applies to. The supported contact channel types include 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 hasChannels() method.

        Returns:
        The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.

      • contentType

        public final String contentType()

        The media type of the quick response content.

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

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

        Returns:
        The media type of the quick response content.

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

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

      • contents

        public final QuickResponseContents contents()

        The contents of the quick response.

        Returns:
        The contents of the quick response.

      • createdTime

        public final Instant createdTime()

        The timestamp when the quick response was created.

        Returns:
        The timestamp when the quick response was created.

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

      • knowledgeBaseArn

        public final String knowledgeBaseArn()

        The Amazon Resource Name (ARN) of the knowledge base.

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

      • knowledgeBaseId

        public final String knowledgeBaseId()

        The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

        Returns:
        The identifier of the knowledge base. 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.

        Returns:
        The language code value for the language in which the quick response is written.

      • lastModifiedBy

        public final String lastModifiedBy()

        The Amazon Resource Name (ARN) of the user who last updated the quick response search result data.

        Returns:
        The Amazon Resource Name (ARN) of the user who last updated the quick response search result data.

      • lastModifiedTime

        public final Instant lastModifiedTime()

        The timestamp when the quick response search result data was last modified.

        Returns:
        The timestamp when the quick response search result data was last modified.

      • name

        public final String name()

        The name of the quick response.

        Returns:
        The name of the quick response.

      • quickResponseArn

        public final String quickResponseArn()

        The Amazon Resource Name (ARN) of the quick response.

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

      • quickResponseId

        public final String quickResponseId()

        The identifier of the quick response.

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

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