Class ContentSummary

    • Method Detail

      • contentArn

        public final String contentArn()

        The Amazon Resource Name (ARN) of the content.

        Returns:
        The Amazon Resource Name (ARN) of the content.
      • contentId

        public final String contentId()

        The identifier of the content.

        Returns:
        The identifier of the content.
      • contentType

        public final String contentType()

        The media type of the content.

        Returns:
        The media type of the content.
      • 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. This should not be a QUICK_RESPONSES type knowledge base.

        Returns:
        The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
      • hasMetadata

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

        public final Map<String,​String> metadata()

        A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.

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

        Returns:
        A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.
      • name

        public final String name()

        The name of the content.

        Returns:
        The name of the content.
      • revisionId

        public final String revisionId()

        The identifier of the revision of the content.

        Returns:
        The identifier of the revision of the content.
      • 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.
      • title

        public final String title()

        The title of the content.

        Returns:
        The title of the content.
      • 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)