Document (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kendra.model.Document

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Document
extends Object
implements Serializable, Cloneable, StructuredPojo

A document in an index.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Document()

Constructors
Constructor and Description
`Document()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Document`	`clone()`
`boolean`	`equals(Object obj)`
`List<Principal>`	`getAccessControlList()` Information to use for user context filtering.
`List<DocumentAttribute>`	`getAttributes()` Custom attributes to apply to the document.
`ByteBuffer`	`getBlob()` The contents of the document.
`String`	`getContentType()` The file type of the document in the `Blob` field.
`String`	`getId()` A unique identifier of the document in the index.
`S3Path`	`getS3Path()`
`String`	`getTitle()` The title of the document.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAccessControlList(Collection<Principal> accessControlList)` Information to use for user context filtering.
`void`	`setAttributes(Collection<DocumentAttribute> attributes)` Custom attributes to apply to the document.
`void`	`setBlob(ByteBuffer blob)` The contents of the document.
`void`	`setContentType(String contentType)` The file type of the document in the `Blob` field.
`void`	`setId(String id)` A unique identifier of the document in the index.
`void`	`setS3Path(S3Path s3Path)`
`void`	`setTitle(String title)` The title of the document.
`String`	`toString()` Returns a string representation of this object.
`Document`	`withAccessControlList(Collection<Principal> accessControlList)` Information to use for user context filtering.
`Document`	`withAccessControlList(Principal... accessControlList)` Information to use for user context filtering.
`Document`	`withAttributes(Collection<DocumentAttribute> attributes)` Custom attributes to apply to the document.
`Document`	`withAttributes(DocumentAttribute... attributes)` Custom attributes to apply to the document.
`Document`	`withBlob(ByteBuffer blob)` The contents of the document.
`Document`	`withContentType(ContentType contentType)` The file type of the document in the `Blob` field.
`Document`	`withContentType(String contentType)` The file type of the document in the `Blob` field.
`Document`	`withId(String id)` A unique identifier of the document in the index.
`Document`	`withS3Path(S3Path s3Path)`
`Document`	`withTitle(String title)` The title of the document.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Document
```
public Document()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    A unique identifier of the document in the index.
    
    Parameters:
    
    id - A unique identifier of the document in the index.
  - getId
```
public String getId()
```
    A unique identifier of the document in the index.
    
    Returns:
    
    A unique identifier of the document in the index.
  - withId
```
public Document withId(String id)
```
    A unique identifier of the document in the index.
    
    Parameters:
    
    id - A unique identifier of the document in the index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTitle
```
public void setTitle(String title)
```
    The title of the document.
    
    Parameters:
    
    title - The title of the document.
  - getTitle
```
public String getTitle()
```
    The title of the document.
    
    Returns:
    
    The title of the document.
  - withTitle
```
public Document withTitle(String title)
```
    The title of the document.
    
    Parameters:
    
    title - The title of the document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBlob
```
public void setBlob(ByteBuffer 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.
    
    The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
    
    Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.
    
    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 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.
  - getBlob
```
public ByteBuffer getBlob()
```
    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.
    
    ByteBuffers are stateful. Calling their get methods changes their position. We recommend using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent position, and calling get methods on this rather than directly on the returned ByteBuffer. Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the position.
    
    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.
  - withBlob
```
public Document withBlob(ByteBuffer 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.
    
    The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
    
    Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.
    
    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 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setS3Path
```
public void setS3Path(S3Path s3Path)
```
    Parameters:
    
    s3Path -
  - getS3Path
```
public S3Path getS3Path()
```
    Returns:
  - withS3Path
```
public Document withS3Path(S3Path s3Path)
```
    Parameters:
    
    s3Path -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAttributes
```
public List<DocumentAttribute> getAttributes()
```
    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.
    
    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.
  - setAttributes
```
public void setAttributes(Collection<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.
    
    Parameters:
    
    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.
  - withAttributes
```
public Document withAttributes(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setAttributes(java.util.Collection) or withAttributes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAttributes
```
public Document withAttributes(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAccessControlList
```
public List<Principal> getAccessControlList()
```
    Information to use for user context filtering.
    
    Returns:
    
    Information to use for user context filtering.
  - setAccessControlList
```
public void setAccessControlList(Collection<Principal> accessControlList)
```
    Information to use for user context filtering.
    
    Parameters:
    
    accessControlList - Information to use for user context filtering.
  - withAccessControlList
```
public Document withAccessControlList(Principal... accessControlList)
```
    Information to use for user context filtering.
    
    NOTE: This method appends the values to the existing list (if any). Use setAccessControlList(java.util.Collection) or withAccessControlList(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    accessControlList - Information to use for user context filtering.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAccessControlList
```
public Document withAccessControlList(Collection<Principal> accessControlList)
```
    Information to use for user context filtering.
    
    Parameters:
    
    accessControlList - Information to use for user context filtering.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setContentType
```
public void setContentType(String contentType)
```
    The file type of the document in the Blob field.
    
    Parameters:
    
    contentType - The file type of the document in the Blob field.
    
    See Also:
    
    ContentType
  - getContentType
```
public String getContentType()
```
    The file type of the document in the Blob field.
    
    Returns:
    
    The file type of the document in the Blob field.
    
    See Also:
    
    ContentType
  - withContentType
```
public Document withContentType(String contentType)
```
    The file type of the document in the Blob field.
    
    Parameters:
    
    contentType - The file type of the document in the Blob field.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ContentType
  - withContentType
```
public Document withContentType(ContentType contentType)
```
    The file type of the document in the Blob field.
    
    Parameters:
    
    contentType - The file type of the document in the Blob field.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ContentType
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Document clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Document

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Document

Method Detail

setId

getId

withId

setTitle

getTitle

withTitle

setBlob

getBlob

withBlob

setS3Path

getS3Path

withS3Path

getAttributes

setAttributes

withAttributes

withAttributes

getAccessControlList

setAccessControlList

withAccessControlList

withAccessControlList

setContentType

getContentType

withContentType

withContentType

toString

equals

hashCode

clone

marshall