AWS SDK for C++  1.9.1
AWS SDK for C++
Public Member Functions | List of all members
Aws::kendra::Model::Document Class Reference

#include <Document.h>

Public Member Functions

 Document ()
 
 Document (Aws::Utils::Json::JsonView jsonValue)
 
Documentoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetId () const
 
bool IdHasBeenSet () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
DocumentWithId (const Aws::String &value)
 
DocumentWithId (Aws::String &&value)
 
DocumentWithId (const char *value)
 
const Aws::StringGetTitle () const
 
bool TitleHasBeenSet () const
 
void SetTitle (const Aws::String &value)
 
void SetTitle (Aws::String &&value)
 
void SetTitle (const char *value)
 
DocumentWithTitle (const Aws::String &value)
 
DocumentWithTitle (Aws::String &&value)
 
DocumentWithTitle (const char *value)
 
const Aws::Utils::ByteBufferGetBlob () const
 
bool BlobHasBeenSet () const
 
void SetBlob (const Aws::Utils::ByteBuffer &value)
 
void SetBlob (Aws::Utils::ByteBuffer &&value)
 
DocumentWithBlob (const Aws::Utils::ByteBuffer &value)
 
DocumentWithBlob (Aws::Utils::ByteBuffer &&value)
 
const S3PathGetS3Path () const
 
bool S3PathHasBeenSet () const
 
void SetS3Path (const S3Path &value)
 
void SetS3Path (S3Path &&value)
 
DocumentWithS3Path (const S3Path &value)
 
DocumentWithS3Path (S3Path &&value)
 
const Aws::Vector< DocumentAttribute > & GetAttributes () const
 
bool AttributesHasBeenSet () const
 
void SetAttributes (const Aws::Vector< DocumentAttribute > &value)
 
void SetAttributes (Aws::Vector< DocumentAttribute > &&value)
 
DocumentWithAttributes (const Aws::Vector< DocumentAttribute > &value)
 
DocumentWithAttributes (Aws::Vector< DocumentAttribute > &&value)
 
DocumentAddAttributes (const DocumentAttribute &value)
 
DocumentAddAttributes (DocumentAttribute &&value)
 
const Aws::Vector< Principal > & GetAccessControlList () const
 
bool AccessControlListHasBeenSet () const
 
void SetAccessControlList (const Aws::Vector< Principal > &value)
 
void SetAccessControlList (Aws::Vector< Principal > &&value)
 
DocumentWithAccessControlList (const Aws::Vector< Principal > &value)
 
DocumentWithAccessControlList (Aws::Vector< Principal > &&value)
 
DocumentAddAccessControlList (const Principal &value)
 
DocumentAddAccessControlList (Principal &&value)
 
const ContentTypeGetContentType () const
 
bool ContentTypeHasBeenSet () const
 
void SetContentType (const ContentType &value)
 
void SetContentType (ContentType &&value)
 
DocumentWithContentType (const ContentType &value)
 
DocumentWithContentType (ContentType &&value)
 

Detailed Description

A document in an index.

See Also:

AWS API Reference

Definition at line 37 of file Document.h.

Constructor & Destructor Documentation

◆ Document() [1/2]

Aws::kendra::Model::Document::Document ( )

◆ Document() [2/2]

Aws::kendra::Model::Document::Document ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AccessControlListHasBeenSet()

bool Aws::kendra::Model::Document::AccessControlListHasBeenSet ( ) const
inline

Information to use for user context filtering.

Definition at line 267 of file Document.h.

◆ AddAccessControlList() [1/2]

Document& Aws::kendra::Model::Document::AddAccessControlList ( const Principal value)
inline

Information to use for user context filtering.

Definition at line 292 of file Document.h.

◆ AddAccessControlList() [2/2]

Document& Aws::kendra::Model::Document::AddAccessControlList ( Principal &&  value)
inline

Information to use for user context filtering.

Definition at line 297 of file Document.h.

◆ AddAttributes() [1/2]

Document& Aws::kendra::Model::Document::AddAttributes ( const DocumentAttribute value)
inline

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.

Definition at line 249 of file Document.h.

◆ AddAttributes() [2/2]

Document& Aws::kendra::Model::Document::AddAttributes ( DocumentAttribute &&  value)
inline

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.

Definition at line 256 of file Document.h.

◆ AttributesHasBeenSet()

bool Aws::kendra::Model::Document::AttributesHasBeenSet ( ) const
inline

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.

Definition at line 214 of file Document.h.

◆ BlobHasBeenSet()

bool Aws::kendra::Model::Document::BlobHasBeenSet ( ) const
inline

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.

Definition at line 144 of file Document.h.

◆ ContentTypeHasBeenSet()

bool Aws::kendra::Model::Document::ContentTypeHasBeenSet ( ) const
inline

The file type of the document in the Blob field.

Definition at line 308 of file Document.h.

◆ GetAccessControlList()

const Aws::Vector<Principal>& Aws::kendra::Model::Document::GetAccessControlList ( ) const
inline

Information to use for user context filtering.

Definition at line 262 of file Document.h.

◆ GetAttributes()

const Aws::Vector<DocumentAttribute>& Aws::kendra::Model::Document::GetAttributes ( ) const
inline

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.

Definition at line 207 of file Document.h.

◆ GetBlob()

const Aws::Utils::ByteBuffer& Aws::kendra::Model::Document::GetBlob ( ) const
inline

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.

Definition at line 135 of file Document.h.

◆ GetContentType()

const ContentType& Aws::kendra::Model::Document::GetContentType ( ) const
inline

The file type of the document in the Blob field.

Definition at line 303 of file Document.h.

◆ GetId()

const Aws::String& Aws::kendra::Model::Document::GetId ( ) const
inline

A unique identifier of the document in the index.

Definition at line 49 of file Document.h.

◆ GetS3Path()

const S3Path& Aws::kendra::Model::Document::GetS3Path ( ) const
inline

Definition at line 184 of file Document.h.

◆ GetTitle()

const Aws::String& Aws::kendra::Model::Document::GetTitle ( ) const
inline

The title of the document.

Definition at line 90 of file Document.h.

◆ IdHasBeenSet()

bool Aws::kendra::Model::Document::IdHasBeenSet ( ) const
inline

A unique identifier of the document in the index.

Definition at line 54 of file Document.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::kendra::Model::Document::Jsonize ( ) const

◆ operator=()

Document& Aws::kendra::Model::Document::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ S3PathHasBeenSet()

bool Aws::kendra::Model::Document::S3PathHasBeenSet ( ) const
inline

Definition at line 187 of file Document.h.

◆ SetAccessControlList() [1/2]

void Aws::kendra::Model::Document::SetAccessControlList ( Aws::Vector< Principal > &&  value)
inline

Information to use for user context filtering.

Definition at line 277 of file Document.h.

◆ SetAccessControlList() [2/2]

void Aws::kendra::Model::Document::SetAccessControlList ( const Aws::Vector< Principal > &  value)
inline

Information to use for user context filtering.

Definition at line 272 of file Document.h.

◆ SetAttributes() [1/2]

void Aws::kendra::Model::Document::SetAttributes ( Aws::Vector< DocumentAttribute > &&  value)
inline

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.

Definition at line 228 of file Document.h.

◆ SetAttributes() [2/2]

void Aws::kendra::Model::Document::SetAttributes ( const Aws::Vector< DocumentAttribute > &  value)
inline

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.

Definition at line 221 of file Document.h.

◆ SetBlob() [1/2]

void Aws::kendra::Model::Document::SetBlob ( Aws::Utils::ByteBuffer &&  value)
inline

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.

Definition at line 162 of file Document.h.

◆ SetBlob() [2/2]

void Aws::kendra::Model::Document::SetBlob ( const Aws::Utils::ByteBuffer value)
inline

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.

Definition at line 153 of file Document.h.

◆ SetContentType() [1/2]

void Aws::kendra::Model::Document::SetContentType ( const ContentType value)
inline

The file type of the document in the Blob field.

Definition at line 313 of file Document.h.

◆ SetContentType() [2/2]

void Aws::kendra::Model::Document::SetContentType ( ContentType &&  value)
inline

The file type of the document in the Blob field.

Definition at line 318 of file Document.h.

◆ SetId() [1/3]

void Aws::kendra::Model::Document::SetId ( Aws::String &&  value)
inline

A unique identifier of the document in the index.

Definition at line 64 of file Document.h.

◆ SetId() [2/3]

void Aws::kendra::Model::Document::SetId ( const Aws::String value)
inline

A unique identifier of the document in the index.

Definition at line 59 of file Document.h.

◆ SetId() [3/3]

void Aws::kendra::Model::Document::SetId ( const char *  value)
inline

A unique identifier of the document in the index.

Definition at line 69 of file Document.h.

◆ SetS3Path() [1/2]

void Aws::kendra::Model::Document::SetS3Path ( const S3Path value)
inline

Definition at line 190 of file Document.h.

◆ SetS3Path() [2/2]

void Aws::kendra::Model::Document::SetS3Path ( S3Path &&  value)
inline

Definition at line 193 of file Document.h.

◆ SetTitle() [1/3]

void Aws::kendra::Model::Document::SetTitle ( Aws::String &&  value)
inline

The title of the document.

Definition at line 105 of file Document.h.

◆ SetTitle() [2/3]

void Aws::kendra::Model::Document::SetTitle ( const Aws::String value)
inline

The title of the document.

Definition at line 100 of file Document.h.

◆ SetTitle() [3/3]

void Aws::kendra::Model::Document::SetTitle ( const char *  value)
inline

The title of the document.

Definition at line 110 of file Document.h.

◆ TitleHasBeenSet()

bool Aws::kendra::Model::Document::TitleHasBeenSet ( ) const
inline

The title of the document.

Definition at line 95 of file Document.h.

◆ WithAccessControlList() [1/2]

Document& Aws::kendra::Model::Document::WithAccessControlList ( Aws::Vector< Principal > &&  value)
inline

Information to use for user context filtering.

Definition at line 287 of file Document.h.

◆ WithAccessControlList() [2/2]

Document& Aws::kendra::Model::Document::WithAccessControlList ( const Aws::Vector< Principal > &  value)
inline

Information to use for user context filtering.

Definition at line 282 of file Document.h.

◆ WithAttributes() [1/2]

Document& Aws::kendra::Model::Document::WithAttributes ( Aws::Vector< DocumentAttribute > &&  value)
inline

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.

Definition at line 242 of file Document.h.

◆ WithAttributes() [2/2]

Document& Aws::kendra::Model::Document::WithAttributes ( const Aws::Vector< DocumentAttribute > &  value)
inline

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.

Definition at line 235 of file Document.h.

◆ WithBlob() [1/2]

Document& Aws::kendra::Model::Document::WithBlob ( Aws::Utils::ByteBuffer &&  value)
inline

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.

Definition at line 180 of file Document.h.

◆ WithBlob() [2/2]

Document& Aws::kendra::Model::Document::WithBlob ( const Aws::Utils::ByteBuffer value)
inline

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.

Definition at line 171 of file Document.h.

◆ WithContentType() [1/2]

Document& Aws::kendra::Model::Document::WithContentType ( const ContentType value)
inline

The file type of the document in the Blob field.

Definition at line 323 of file Document.h.

◆ WithContentType() [2/2]

Document& Aws::kendra::Model::Document::WithContentType ( ContentType &&  value)
inline

The file type of the document in the Blob field.

Definition at line 328 of file Document.h.

◆ WithId() [1/3]

Document& Aws::kendra::Model::Document::WithId ( Aws::String &&  value)
inline

A unique identifier of the document in the index.

Definition at line 79 of file Document.h.

◆ WithId() [2/3]

Document& Aws::kendra::Model::Document::WithId ( const Aws::String value)
inline

A unique identifier of the document in the index.

Definition at line 74 of file Document.h.

◆ WithId() [3/3]

Document& Aws::kendra::Model::Document::WithId ( const char *  value)
inline

A unique identifier of the document in the index.

Definition at line 84 of file Document.h.

◆ WithS3Path() [1/2]

Document& Aws::kendra::Model::Document::WithS3Path ( const S3Path value)
inline

Definition at line 196 of file Document.h.

◆ WithS3Path() [2/2]

Document& Aws::kendra::Model::Document::WithS3Path ( S3Path &&  value)
inline

Definition at line 199 of file Document.h.

◆ WithTitle() [1/3]

Document& Aws::kendra::Model::Document::WithTitle ( Aws::String &&  value)
inline

The title of the document.

Definition at line 120 of file Document.h.

◆ WithTitle() [2/3]

Document& Aws::kendra::Model::Document::WithTitle ( const Aws::String value)
inline

The title of the document.

Definition at line 115 of file Document.h.

◆ WithTitle() [3/3]

Document& Aws::kendra::Model::Document::WithTitle ( const char *  value)
inline

The title of the document.

Definition at line 125 of file Document.h.


The documentation for this class was generated from the following file: