Package software.amazon.awssdk.services.kendra.model

Interface CreateFaqRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateFaqRequest.Builder,CreateFaqRequest>, KendraRequest.Builder, SdkBuilder<CreateFaqRequest.Builder,CreateFaqRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateFaqRequest
public static interface CreateFaqRequest.Builder extends KendraRequest.Builder, SdkPojo, CopyableBuilder<CreateFaqRequest.Builder,CreateFaqRequest>

  • Method Details

    • indexId

      CreateFaqRequest.Builder indexId(String indexId)

      The identifier of the index for the FAQ.

      Parameters:
      indexId - The identifier of the index for the FAQ.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      CreateFaqRequest.Builder name(String name)

      A name for the FAQ.

      Parameters:
      name - A name for the FAQ.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateFaqRequest.Builder description(String description)

      A description for the FAQ.

      Parameters:
      description - A description for the FAQ.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • s3Path

      CreateFaqRequest.Builder s3Path(S3Path s3Path)

      The path to the FAQ file in S3.

      Parameters:
      s3Path - The path to the FAQ file in S3.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • s3Path

      default CreateFaqRequest.Builder s3Path(Consumer<S3Path.Builder> s3Path)

      The path to the FAQ file in S3.

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

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

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

    • roleArn

      CreateFaqRequest.Builder roleArn(String roleArn)

      The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM access roles for Amazon Kendra.

      Parameters:
      roleArn - The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM access roles for Amazon Kendra.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateFaqRequest.Builder tags(Collection<Tag> tags)

      A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.

      Parameters:
      tags - A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateFaqRequest.Builder tags(Tag... tags)

      A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.

      Parameters:
      tags - A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

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

      A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.

      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:

    • fileFormat

      CreateFaqRequest.Builder fileFormat(String fileFormat)

      The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

      The default format is CSV.

      The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

      For more information, see Adding questions and answers.

      Parameters:
      fileFormat - The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

      The default format is CSV.

      The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

      For more information, see Adding questions and answers.

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

    • fileFormat

      CreateFaqRequest.Builder fileFormat(FaqFileFormat fileFormat)

      The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

      The default format is CSV.

      The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

      For more information, see Adding questions and answers.

      Parameters:
      fileFormat - The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

      The default format is CSV.

      The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

      For more information, see Adding questions and answers.

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

    • clientToken

      CreateFaqRequest.Builder clientToken(String clientToken)

      A token that you provide to identify the request to create a FAQ. Multiple calls to the CreateFaqRequest API with the same client token will create only one FAQ.

      Parameters:
      clientToken - A token that you provide to identify the request to create a FAQ. Multiple calls to the CreateFaqRequest API with the same client token will create only one FAQ.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • languageCode

      CreateFaqRequest.Builder languageCode(String languageCode)

      The code for a language. This allows you to support a language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

      Parameters:
      languageCode - The code for a language. This allows you to support a language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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