Class KnowledgeBaseData

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

Information about the knowledge base.

See Also:

  • Method Details

    • description

      public final String description()

      The description.

      Returns:
      The description.

    • hasIngestionFailureReasons

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

    • ingestionFailureReasons

      public final List<String> ingestionFailureReasons()

      List of failure reasons on ingestion per file.

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

      Returns:
      List of failure reasons on ingestion per file.

    • ingestionStatus

      public final SyncStatus ingestionStatus()

      Status of ingestion on data source.

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

      Returns:
      Status of ingestion on data source.
      See Also:

    • ingestionStatusAsString

      public final String ingestionStatusAsString()

      Status of ingestion on data source.

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

      Returns:
      Status of ingestion on data source.
      See Also:

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

      Returns:
      The identifier of the knowledge base.

    • knowledgeBaseType

      public final KnowledgeBaseType knowledgeBaseType()

      The type of knowledge base.

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

      Returns:
      The type of knowledge base.
      See Also:

    • knowledgeBaseTypeAsString

      public final String knowledgeBaseTypeAsString()

      The type of knowledge base.

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

      Returns:
      The type of knowledge base.
      See Also:

    • lastContentModificationTime

      public final Instant lastContentModificationTime()

      An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.

      Returns:
      An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.

    • name

      public final String name()

      The name of the knowledge base.

      Returns:
      The name of the knowledge base.

    • renderingConfiguration

      public final RenderingConfiguration renderingConfiguration()

      Information about how to render the content.

      Returns:
      Information about how to render the content.

    • serverSideEncryptionConfiguration

      public final ServerSideEncryptionConfiguration serverSideEncryptionConfiguration()

      The configuration information for the customer managed key used for encryption.

      This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect.

      For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.

      Returns:
      The configuration information for the customer managed key used for encryption.

      This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect.

      For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.

    • sourceConfiguration

      public final SourceConfiguration sourceConfiguration()

      Source configuration information about the knowledge base.

      Returns:
      Source configuration information about the knowledge base.

    • status

      public final KnowledgeBaseStatus 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 KnowledgeBaseStatus.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 KnowledgeBaseStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

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

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

    • vectorIngestionConfiguration

      public final VectorIngestionConfiguration vectorIngestionConfiguration()

      Contains details about how to ingest the documents in a data source.

      Returns:
      Contains details about how to ingest the documents in a data source.

    • toBuilder

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

    • builder

      public static KnowledgeBaseData.Builder builder()

    • serializableBuilderClass

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