software.amazon.awssdk.services.kendra.model

Class Document

java.lang.Object

software.amazon.awssdk.services.kendra.model.Document

All Implemented Interfaces:

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

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

A document in an index.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Document.Builder

Method Summary

Modifier and Type	Method and Description
List<Principal>	accessControlList() Information to use for user context filtering.
List<DocumentAttribute>	attributes() Custom attributes to apply to the document.
SdkBytes	blob() The contents of the document.
static Document.Builder	builder()
ContentType	contentType() The file type of the document in the Blob field.
String	contentTypeAsString() The file type of the document in the Blob field.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAccessControlList() Returns true if the AccessControlList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasAttributes() Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
String	id() A unique identifier of the document in the index.
S3Path	s3Path() Returns the value of the S3Path property for this object.
List<SdkField<?>>	sdkFields()
static Class<? extends Document.Builder>	serializableBuilderClass()
String	title() The title of the document.
Document.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

id

public String id()

A unique identifier of the document in the index.

Returns:

A unique identifier of the document in the index.

title

public String title()

The title of the document.

Returns:

The title of the document.

blob

public 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 AWS SDK to call Amazon Kendra operations. If you are calling the Amazon Kendra 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 AWS SDK to call Amazon Kendra operations. If you are calling the Amazon Kendra endpoint directly using REST, you must base64 encode the contents before sending.

s3Path

public S3Path s3Path()

Returns the value of the S3Path property for this object.

Returns:

The value of the S3Path property for this object.

hasAttributes

public boolean hasAttributes()

Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

attributes

public List<DocumentAttribute> attributes()

Custom attributes to apply to the document. Use the custom attributes to provide additional information for searching, to provide facets for refining searches, and to provide additional information in the query response.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasAttributes() to see if a value was sent in this field.

Returns:

Custom attributes to apply to the document. Use the custom attributes to provide additional information for searching, to provide facets for refining searches, and to provide additional information in the query response.

hasAccessControlList

public boolean hasAccessControlList()

Returns true if the AccessControlList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

accessControlList

public List<Principal> accessControlList()

Information to use for user context filtering.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasAccessControlList() to see if a value was sent in this field.

Returns:

Information to use for user context filtering.

contentType

public ContentType contentType()

The file type of the document in the Blob field.

If the service returns an enum value that is not available in the current SDK version, contentType will return ContentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentTypeAsString().

Returns:

The file type of the document in the Blob field.

See Also:

ContentType

contentTypeAsString

public String contentTypeAsString()

The file type of the document in the Blob field.

If the service returns an enum value that is not available in the current SDK version, contentType will return ContentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentTypeAsString().

Returns:

The file type of the document in the Blob field.

See Also:

ContentType

toBuilder

public Document.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Document.Builder,Document>

builder

public static Document.Builder builder()

serializableBuilderClass

public static Class<? extends Document.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo