Package software.amazon.awssdk.services.qbusiness.model

Class DocumentContent

java.lang.Object

software.amazon.awssdk.services.qbusiness.model.DocumentContent

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DocumentContent.Builder,DocumentContent>

@Generated("software.amazon.awssdk:codegen")
public final class DocumentContent
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DocumentContent.Builder,DocumentContent>

The contents of a document.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DocumentContent.Builder
static class	DocumentContent.Type

Method Summary

Modifier and Type	Method	Description
SdkBytes	blob()	The contents of the document.
static DocumentContent.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static DocumentContent	fromBlob(SdkBytes blob)	Create an instance of this class with blob() initialized to the given value.
static DocumentContent	fromS3(Consumer<S3.Builder> s3)	Create an instance of this class with s3() initialized to the given value.
static DocumentContent	fromS3(S3 s3)	Create an instance of this class with s3() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
S3	s3()	The path to the document in an Amazon S3 bucket.
List<SdkField<?>>	sdkFields()
static Class<? extends DocumentContent.Builder>	serializableBuilderClass()
DocumentContent.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
DocumentContent.Type	type()	Retrieve an enum value representing which member of this object is populated.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

blob

public final SdkBytes 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 APIs. If you are calling the Amazon Q endpoint directly using REST, you must base64 encode the contents before sending.

Returns:

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 APIs. If you are calling the Amazon Q endpoint directly using REST, you must base64 encode the contents before sending.

s3

public final S3 s3()

The path to the document in an Amazon S3 bucket.

Returns:

The path to the document in an Amazon S3 bucket.

toBuilder

public DocumentContent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DocumentContent.Builder,DocumentContent>

builder

public static DocumentContent.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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)

fromBlob

public static DocumentContent fromBlob(SdkBytes blob)

Create an instance of this class with blob() initialized to the given value.

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 APIs. If you are calling the Amazon Q endpoint directly using REST, you must base64 encode the contents before sending.

Parameters:

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 APIs. If you are calling the Amazon Q endpoint directly using REST, you must base64 encode the contents before sending.

fromS3

public static DocumentContent fromS3(S3 s3)

Create an instance of this class with s3() initialized to the given value.

The path to the document in an Amazon S3 bucket.

Parameters:

s3 - The path to the document in an Amazon S3 bucket.

fromS3

public static DocumentContent fromS3(Consumer<S3.Builder> s3)

Create an instance of this class with s3() initialized to the given value.

The path to the document in an Amazon S3 bucket.

Parameters:

s3 - The path to the document in an Amazon S3 bucket.

type

public DocumentContent.Type type()

Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be DocumentContent.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be DocumentContent.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo