Interface CreateKnowledgeBaseRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateKnowledgeBaseRequest.Builder,CreateKnowledgeBaseRequest>, QuickSightRequest.Builder, SdkBuilder<CreateKnowledgeBaseRequest.Builder,CreateKnowledgeBaseRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateKnowledgeBaseRequest
@Mutable @NotThreadSafe public static interface CreateKnowledgeBaseRequest.Builder extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder<CreateKnowledgeBaseRequest.Builder,CreateKnowledgeBaseRequest>

  • Method Details

    • awsAccountId

      CreateKnowledgeBaseRequest.Builder awsAccountId(String awsAccountId)

      The ID of the Amazon Web Services account that contains the knowledge base.

      Parameters:
      awsAccountId - The ID of the Amazon Web Services account that contains the knowledge base.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • knowledgeBaseId

      CreateKnowledgeBaseRequest.Builder knowledgeBaseId(String knowledgeBaseId)

      The unique identifier for the knowledge base.

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

    • name

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

    • dataSourceArn

      CreateKnowledgeBaseRequest.Builder dataSourceArn(String dataSourceArn)

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

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

    • knowledgeBaseConfiguration

      CreateKnowledgeBaseRequest.Builder knowledgeBaseConfiguration(KnowledgeBaseConfiguration knowledgeBaseConfiguration)
      Sets the value of the KnowledgeBaseConfiguration property for this object.
      Parameters:
      knowledgeBaseConfiguration - The new value for the KnowledgeBaseConfiguration property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • knowledgeBaseConfiguration

      default CreateKnowledgeBaseRequest.Builder knowledgeBaseConfiguration(Consumer<KnowledgeBaseConfiguration.Builder> knowledgeBaseConfiguration)
      Sets the value of the KnowledgeBaseConfiguration property for this object. 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:

    • description

      CreateKnowledgeBaseRequest.Builder description(String description)

      A description for the knowledge base. If you don't specify a description, the knowledge base is created without one.

      Parameters:
      description - A description for the knowledge base. If you don't specify a description, the knowledge base is created without one.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • permissions

      CreateKnowledgeBaseRequest.Builder permissions(Collection<ResourcePermission> permissions)

      A list of resource permissions on the knowledge base. Each entry grants a specified Amazon QuickSight principal either owner or viewer access. If you don't specify permissions, only the primary owner (if provided) receives owner access.

      Parameters:
      permissions - A list of resource permissions on the knowledge base. Each entry grants a specified Amazon QuickSight principal either owner or viewer access. If you don't specify permissions, only the primary owner (if provided) receives owner access.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • permissions

      CreateKnowledgeBaseRequest.Builder permissions(ResourcePermission... permissions)

      A list of resource permissions on the knowledge base. Each entry grants a specified Amazon QuickSight principal either owner or viewer access. If you don't specify permissions, only the primary owner (if provided) receives owner access.

      Parameters:
      permissions - A list of resource permissions on the knowledge base. Each entry grants a specified Amazon QuickSight principal either owner or viewer access. If you don't specify permissions, only the primary owner (if provided) receives owner access.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • permissions

      CreateKnowledgeBaseRequest.Builder permissions(Consumer<ResourcePermission.Builder>... permissions)

      A list of resource permissions on the knowledge base. Each entry grants a specified Amazon QuickSight principal either owner or viewer access. If you don't specify permissions, only the primary owner (if provided) receives owner access.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to permissions(List<ResourcePermission>).

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

    • mediaExtractionConfiguration

      CreateKnowledgeBaseRequest.Builder mediaExtractionConfiguration(MediaExtractionConfiguration mediaExtractionConfiguration)
      Sets the value of the MediaExtractionConfiguration property for this object.
      Parameters:
      mediaExtractionConfiguration - The new value for the MediaExtractionConfiguration property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • mediaExtractionConfiguration

      default CreateKnowledgeBaseRequest.Builder mediaExtractionConfiguration(Consumer<MediaExtractionConfiguration.Builder> mediaExtractionConfiguration)
      Sets the value of the MediaExtractionConfiguration property for this object. This is a convenience method that creates an instance of the MediaExtractionConfiguration.Builder avoiding the need to create one manually via MediaExtractionConfiguration.builder().

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

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

    • accessControlConfiguration

      CreateKnowledgeBaseRequest.Builder accessControlConfiguration(AccessControlConfiguration accessControlConfiguration)

      The access control configuration for the knowledge base. If you don't specify this parameter, document-level ACLs are disabled.

      Parameters:
      accessControlConfiguration - The access control configuration for the knowledge base. If you don't specify this parameter, document-level ACLs are disabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accessControlConfiguration

      default CreateKnowledgeBaseRequest.Builder accessControlConfiguration(Consumer<AccessControlConfiguration.Builder> accessControlConfiguration)

      The access control configuration for the knowledge base. If you don't specify this parameter, document-level ACLs are disabled.

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

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

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

    • primaryOwnerArn

      CreateKnowledgeBaseRequest.Builder primaryOwnerArn(String primaryOwnerArn)

      The Amazon Resource Name (ARN) of the Amazon QuickSight user or group to set as the primary owner of the knowledge base. The specified principal is always granted owner access, regardless of what is specified in the Permissions field.

      This must be an Amazon QuickSight principal ARN, not an IAM user or role ARN. The API caller is never assigned as the owner automatically. If you don't specify a primary owner and don't grant owner access in Permissions, the knowledge base is created without an owner, even when you call the operation as an Amazon QuickSight user.

      When you call CreateKnowledgeBase as an IAM user or an assumed IAM role, specify PrimaryOwnerArn (as an Amazon QuickSight principal ARN) or an owner entry in Permissions so that the knowledge base has an owner. Although optional, specifying a primary owner is recommended.

      Parameters:
      primaryOwnerArn - The Amazon Resource Name (ARN) of the Amazon QuickSight user or group to set as the primary owner of the knowledge base. The specified principal is always granted owner access, regardless of what is specified in the Permissions field.

      This must be an Amazon QuickSight principal ARN, not an IAM user or role ARN. The API caller is never assigned as the owner automatically. If you don't specify a primary owner and don't grant owner access in Permissions, the knowledge base is created without an owner, even when you call the operation as an Amazon QuickSight user.

      When you call CreateKnowledgeBase as an IAM user or an assumed IAM role, specify PrimaryOwnerArn (as an Amazon QuickSight principal ARN) or an owner entry in Permissions so that the knowledge base has an owner. Although optional, specifying a primary owner is recommended.

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

    • tags

      CreateKnowledgeBaseRequest.Builder tags(Collection<Tag> tags)

      The tags to assign to the knowledge base. If you don't specify tags, the knowledge base is created without tags.

      Parameters:
      tags - The tags to assign to the knowledge base. If you don't specify tags, the knowledge base is created without tags.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateKnowledgeBaseRequest.Builder tags(Tag... tags)

      The tags to assign to the knowledge base. If you don't specify tags, the knowledge base is created without tags.

      Parameters:
      tags - The tags to assign to the knowledge base. If you don't specify tags, the knowledge base is created without tags.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateKnowledgeBaseRequest.Builder tags(Consumer<Tag.Builder>... tags)

      The tags to assign to the knowledge base. If you don't specify tags, the knowledge base is created without tags.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

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

    • overrideConfiguration

      CreateKnowledgeBaseRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateKnowledgeBaseRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.