Interface KnowledgeBase.Builder

All Superinterfaces:
Buildable, CopyableBuilder<KnowledgeBase.Builder,KnowledgeBase>, SdkBuilder<KnowledgeBase.Builder,KnowledgeBase>, SdkPojo
Enclosing class:
KnowledgeBase
public static interface KnowledgeBase.Builder extends SdkPojo, CopyableBuilder<KnowledgeBase.Builder,KnowledgeBase>

  • Method Details

    • createdAt

      KnowledgeBase.Builder createdAt(Instant createdAt)

      The time the knowledge base was created.

      Parameters:
      createdAt - The time the knowledge base was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      KnowledgeBase.Builder description(String description)

      The description of the knowledge base.

      Parameters:
      description - The description of the knowledge base.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • failureReasons

      KnowledgeBase.Builder failureReasons(Collection<String> failureReasons)

      A list of reasons that the API operation on the knowledge base failed.

      Parameters:
      failureReasons - A list of reasons that the API operation on the knowledge base failed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • failureReasons

      KnowledgeBase.Builder failureReasons(String... failureReasons)

      A list of reasons that the API operation on the knowledge base failed.

      Parameters:
      failureReasons - A list of reasons that the API operation on the knowledge base failed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • knowledgeBaseArn

      KnowledgeBase.Builder knowledgeBaseArn(String knowledgeBaseArn)

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

      Parameters:
      knowledgeBaseArn - The Amazon Resource Name (ARN) of the knowledge base.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • knowledgeBaseConfiguration

      KnowledgeBase.Builder knowledgeBaseConfiguration(KnowledgeBaseConfiguration knowledgeBaseConfiguration)

      Contains details about the embeddings configuration of the knowledge base.

      Parameters:
      knowledgeBaseConfiguration - Contains details about the embeddings configuration of the knowledge base.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • knowledgeBaseConfiguration

      default KnowledgeBase.Builder knowledgeBaseConfiguration(Consumer<KnowledgeBaseConfiguration.Builder> knowledgeBaseConfiguration)

      Contains details about the embeddings configuration of the knowledge base.

      This is a convenience method that creates an instance of the KnowledgeBaseConfiguration.Builder avoiding the need to create one manually via KnowledgeBaseConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to knowledgeBaseConfiguration(KnowledgeBaseConfiguration).

      Parameters:
      knowledgeBaseConfiguration - a consumer that will call methods on KnowledgeBaseConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • knowledgeBaseId

      KnowledgeBase.Builder knowledgeBaseId(String knowledgeBaseId)

      The unique identifier of the knowledge base.

      Parameters:
      knowledgeBaseId - The unique identifier of the knowledge base.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      KnowledgeBase.Builder name(String name)

      The name of the knowledge base.

      Parameters:
      name - The name of the knowledge base.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleArn

      KnowledgeBase.Builder roleArn(String roleArn)

      The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.

      Parameters:
      roleArn - The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      KnowledgeBase.Builder status(String status)

      The status of the knowledge base. The following statuses are possible:

      • CREATING – The knowledge base is being created.

      • ACTIVE – The knowledge base is ready to be queried.

      • DELETING – The knowledge base is being deleted.

      • UPDATING – The knowledge base is being updated.

      • FAILED – The knowledge base API operation failed.

      Parameters:
      status - The status of the knowledge base. The following statuses are possible:

      • CREATING – The knowledge base is being created.

      • ACTIVE – The knowledge base is ready to be queried.

      • DELETING – The knowledge base is being deleted.

      • UPDATING – The knowledge base is being updated.

      • FAILED – The knowledge base API operation failed.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      KnowledgeBase.Builder status(KnowledgeBaseStatus status)

      The status of the knowledge base. The following statuses are possible:

      • CREATING – The knowledge base is being created.

      • ACTIVE – The knowledge base is ready to be queried.

      • DELETING – The knowledge base is being deleted.

      • UPDATING – The knowledge base is being updated.

      • FAILED – The knowledge base API operation failed.

      Parameters:
      status - The status of the knowledge base. The following statuses are possible:

      • CREATING – The knowledge base is being created.

      • ACTIVE – The knowledge base is ready to be queried.

      • DELETING – The knowledge base is being deleted.

      • UPDATING – The knowledge base is being updated.

      • FAILED – The knowledge base API operation failed.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • storageConfiguration

      KnowledgeBase.Builder storageConfiguration(StorageConfiguration storageConfiguration)

      Contains details about the storage configuration of the knowledge base.

      Parameters:
      storageConfiguration - Contains details about the storage configuration of the knowledge base.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • storageConfiguration

      default KnowledgeBase.Builder storageConfiguration(Consumer<StorageConfiguration.Builder> storageConfiguration)

      Contains details about the storage configuration of the knowledge base.

      This is a convenience method that creates an instance of the StorageConfiguration.Builder avoiding the need to create one manually via StorageConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to storageConfiguration(StorageConfiguration).

      Parameters:
      storageConfiguration - a consumer that will call methods on StorageConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • updatedAt

      KnowledgeBase.Builder updatedAt(Instant updatedAt)

      The time the knowledge base was last updated.

      Parameters:
      updatedAt - The time the knowledge base was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.