Class KnowledgeBase

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

A knowledge base resource that provides data from connected sources for AI-powered experiences in Amazon QuickSight.

See Also:

  • Method Details

    • 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 unique identifier for the knowledge base.

      Returns:
      The unique identifier for the knowledge base.

    • name

      public final String name()

      The name of the knowledge base.

      Returns:
      The name of the knowledge base.

    • status

      public final DataSetStatus status()

      The status of the knowledge base.

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

      Returns:
      The status of the knowledge base.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the knowledge base.

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

      Returns:
      The status of the knowledge base.
      See Also:

    • dataSourceArn

      public final String dataSourceArn()

      The ARN of the data source associated with the knowledge base.

      Returns:
      The ARN of the data source associated with the knowledge base.

    • knowledgeBaseConfiguration

      public final KnowledgeBaseConfiguration knowledgeBaseConfiguration()

      The configuration settings for the knowledge base.

      Returns:
      The configuration settings for the knowledge base.

    • mediaExtractionConfiguration

      public final MediaExtractionConfiguration mediaExtractionConfiguration()

      The media extraction configuration for the knowledge base.

      Returns:
      The media extraction configuration for the knowledge base.

    • type

      public final String type()

      The type of the knowledge base.

      Returns:
      The type of the knowledge base.

    • createdAt

      public final Instant createdAt()

      The date and time that the knowledge base was created.

      Returns:
      The date and time that the knowledge base was created.

    • updatedAt

      public final Instant updatedAt()

      The date and time that the knowledge base was last updated.

      Returns:
      The date and time that the knowledge base was last updated.

    • description

      public final String description()

      The description of the knowledge base.

      Returns:
      The description of the knowledge base.

    • isEmailNotificationOptedForIngestionFailures

      public final Boolean isEmailNotificationOptedForIngestionFailures()

      Indicates whether email notifications are enabled for ingestion failures.

      Returns:
      Indicates whether email notifications are enabled for ingestion failures.

    • firstCompletedIngestionSummary

      public final KnowledgeBaseIngestionSummary firstCompletedIngestionSummary()

      A summary of the first completed ingestion for the knowledge base.

      Returns:
      A summary of the first completed ingestion for the knowledge base.

    • firstIncompleteIngestionSummary

      public final KnowledgeBaseIngestionSummary firstIncompleteIngestionSummary()

      A summary of the first incomplete ingestion for the knowledge base.

      Returns:
      A summary of the first incomplete ingestion for the knowledge base.

    • latestIngestionSummary

      public final KnowledgeBaseIngestionSummary latestIngestionSummary()

      A summary of the most recent ingestion for the knowledge base.

      Returns:
      A summary of the most recent ingestion for the knowledge base.

    • knowledgeBaseSizeBytes

      public final Long knowledgeBaseSizeBytes()

      The size of the knowledge base in bytes.

      Returns:
      The size of the knowledge base in bytes.

    • documentCount

      public final Long documentCount()

      The number of documents in the knowledge base.

      Returns:
      The number of documents in the knowledge base.

    • primaryOwnerArn

      public final String primaryOwnerArn()

      The ARN of the primary owner of the knowledge base.

      Returns:
      The ARN of the primary owner of the knowledge base.

    • primaryOwnerUsername

      public final String primaryOwnerUsername()

      The username of the primary owner of the knowledge base.

      Returns:
      The username of the primary owner of the knowledge base.

    • toBuilder

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

    • builder

      public static KnowledgeBase.Builder builder()

    • serializableBuilderClass

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