Interface DocumentContent.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<DocumentContent.Builder,
,DocumentContent> SdkBuilder<DocumentContent.Builder,
,DocumentContent> SdkPojo
- Enclosing class:
DocumentContent
@Mutable
@NotThreadSafe
public static interface DocumentContent.Builder
extends SdkPojo, CopyableBuilder<DocumentContent.Builder,DocumentContent>
-
Method Summary
Modifier and TypeMethodDescriptionThe contents of the document.default DocumentContent.Builder
s3
(Consumer<S3.Builder> s3) The path to the document in an Amazon S3 bucket.The path to the document in an Amazon S3 bucket.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
blob
The contents of the document. Documents passed to the
blob
parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Q Business APIs. If you are calling the Amazon Q Business endpoint directly using REST, you must base64 encode the contents before sending.- Parameters:
blob
- The contents of the document. Documents passed to theblob
parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Q Business APIs. If you are calling the Amazon Q Business endpoint directly using REST, you must base64 encode the contents before sending.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
s3
The path to the document in an Amazon S3 bucket.
- Parameters:
s3
- The path to the document in an Amazon S3 bucket.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
s3
The path to the document in an Amazon S3 bucket.
This is a convenience method that creates an instance of theS3.Builder
avoiding the need to create one manually viaS3.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tos3(S3)
.- Parameters:
s3
- a consumer that will call methods onS3.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-