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

#include <Status.h>

Public Member Functions

 Status ()
 
 Status (Aws::Utils::Json::JsonView jsonValue)
 
Statusoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetDocumentId () const
 
bool DocumentIdHasBeenSet () const
 
void SetDocumentId (const Aws::String &value)
 
void SetDocumentId (Aws::String &&value)
 
void SetDocumentId (const char *value)
 
StatusWithDocumentId (const Aws::String &value)
 
StatusWithDocumentId (Aws::String &&value)
 
StatusWithDocumentId (const char *value)
 
const DocumentStatusGetDocumentStatus () const
 
bool DocumentStatusHasBeenSet () const
 
void SetDocumentStatus (const DocumentStatus &value)
 
void SetDocumentStatus (DocumentStatus &&value)
 
StatusWithDocumentStatus (const DocumentStatus &value)
 
StatusWithDocumentStatus (DocumentStatus &&value)
 
const Aws::StringGetFailureCode () const
 
bool FailureCodeHasBeenSet () const
 
void SetFailureCode (const Aws::String &value)
 
void SetFailureCode (Aws::String &&value)
 
void SetFailureCode (const char *value)
 
StatusWithFailureCode (const Aws::String &value)
 
StatusWithFailureCode (Aws::String &&value)
 
StatusWithFailureCode (const char *value)
 
const Aws::StringGetFailureReason () const
 
bool FailureReasonHasBeenSet () const
 
void SetFailureReason (const Aws::String &value)
 
void SetFailureReason (Aws::String &&value)
 
void SetFailureReason (const char *value)
 
StatusWithFailureReason (const Aws::String &value)
 
StatusWithFailureReason (Aws::String &&value)
 
StatusWithFailureReason (const char *value)
 

Detailed Description

Provides information about the status of documents submitted for indexing.

See Also:

AWS API Reference

Definition at line 33 of file Status.h.

Constructor & Destructor Documentation

◆ Status() [1/2]

Aws::kendra::Model::Status::Status ( )

◆ Status() [2/2]

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

Member Function Documentation

◆ DocumentIdHasBeenSet()

bool Aws::kendra::Model::Status::DocumentIdHasBeenSet ( ) const
inline

The unique identifier of the document.

Definition at line 50 of file Status.h.

◆ DocumentStatusHasBeenSet()

bool Aws::kendra::Model::Status::DocumentStatusHasBeenSet ( ) const
inline

The current status of a document.

If the document was submitted for deletion, the status is NOT_FOUND after the document is deleted.

Definition at line 95 of file Status.h.

◆ FailureCodeHasBeenSet()

bool Aws::kendra::Model::Status::FailureCodeHasBeenSet ( ) const
inline

Indicates the source of the error.

Definition at line 134 of file Status.h.

◆ FailureReasonHasBeenSet()

bool Aws::kendra::Model::Status::FailureReasonHasBeenSet ( ) const
inline

Provides detailed information about why the document couldn't be indexed. Use this information to correct the error before you resubmit the document for indexing.

Definition at line 179 of file Status.h.

◆ GetDocumentId()

const Aws::String& Aws::kendra::Model::Status::GetDocumentId ( ) const
inline

The unique identifier of the document.

Definition at line 45 of file Status.h.

◆ GetDocumentStatus()

const DocumentStatus& Aws::kendra::Model::Status::GetDocumentStatus ( ) const
inline

The current status of a document.

If the document was submitted for deletion, the status is NOT_FOUND after the document is deleted.

Definition at line 88 of file Status.h.

◆ GetFailureCode()

const Aws::String& Aws::kendra::Model::Status::GetFailureCode ( ) const
inline

Indicates the source of the error.

Definition at line 129 of file Status.h.

◆ GetFailureReason()

const Aws::String& Aws::kendra::Model::Status::GetFailureReason ( ) const
inline

Provides detailed information about why the document couldn't be indexed. Use this information to correct the error before you resubmit the document for indexing.

Definition at line 172 of file Status.h.

◆ Jsonize()

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

◆ operator=()

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

◆ SetDocumentId() [1/3]

void Aws::kendra::Model::Status::SetDocumentId ( Aws::String &&  value)
inline

The unique identifier of the document.

Definition at line 60 of file Status.h.

◆ SetDocumentId() [2/3]

void Aws::kendra::Model::Status::SetDocumentId ( const Aws::String value)
inline

The unique identifier of the document.

Definition at line 55 of file Status.h.

◆ SetDocumentId() [3/3]

void Aws::kendra::Model::Status::SetDocumentId ( const char *  value)
inline

The unique identifier of the document.

Definition at line 65 of file Status.h.

◆ SetDocumentStatus() [1/2]

void Aws::kendra::Model::Status::SetDocumentStatus ( const DocumentStatus value)
inline

The current status of a document.

If the document was submitted for deletion, the status is NOT_FOUND after the document is deleted.

Definition at line 102 of file Status.h.

◆ SetDocumentStatus() [2/2]

void Aws::kendra::Model::Status::SetDocumentStatus ( DocumentStatus &&  value)
inline

The current status of a document.

If the document was submitted for deletion, the status is NOT_FOUND after the document is deleted.

Definition at line 109 of file Status.h.

◆ SetFailureCode() [1/3]

void Aws::kendra::Model::Status::SetFailureCode ( Aws::String &&  value)
inline

Indicates the source of the error.

Definition at line 144 of file Status.h.

◆ SetFailureCode() [2/3]

void Aws::kendra::Model::Status::SetFailureCode ( const Aws::String value)
inline

Indicates the source of the error.

Definition at line 139 of file Status.h.

◆ SetFailureCode() [3/3]

void Aws::kendra::Model::Status::SetFailureCode ( const char *  value)
inline

Indicates the source of the error.

Definition at line 149 of file Status.h.

◆ SetFailureReason() [1/3]

void Aws::kendra::Model::Status::SetFailureReason ( Aws::String &&  value)
inline

Provides detailed information about why the document couldn't be indexed. Use this information to correct the error before you resubmit the document for indexing.

Definition at line 193 of file Status.h.

◆ SetFailureReason() [2/3]

void Aws::kendra::Model::Status::SetFailureReason ( const Aws::String value)
inline

Provides detailed information about why the document couldn't be indexed. Use this information to correct the error before you resubmit the document for indexing.

Definition at line 186 of file Status.h.

◆ SetFailureReason() [3/3]

void Aws::kendra::Model::Status::SetFailureReason ( const char *  value)
inline

Provides detailed information about why the document couldn't be indexed. Use this information to correct the error before you resubmit the document for indexing.

Definition at line 200 of file Status.h.

◆ WithDocumentId() [1/3]

Status& Aws::kendra::Model::Status::WithDocumentId ( Aws::String &&  value)
inline

The unique identifier of the document.

Definition at line 75 of file Status.h.

◆ WithDocumentId() [2/3]

Status& Aws::kendra::Model::Status::WithDocumentId ( const Aws::String value)
inline

The unique identifier of the document.

Definition at line 70 of file Status.h.

◆ WithDocumentId() [3/3]

Status& Aws::kendra::Model::Status::WithDocumentId ( const char *  value)
inline

The unique identifier of the document.

Definition at line 80 of file Status.h.

◆ WithDocumentStatus() [1/2]

Status& Aws::kendra::Model::Status::WithDocumentStatus ( const DocumentStatus value)
inline

The current status of a document.

If the document was submitted for deletion, the status is NOT_FOUND after the document is deleted.

Definition at line 116 of file Status.h.

◆ WithDocumentStatus() [2/2]

Status& Aws::kendra::Model::Status::WithDocumentStatus ( DocumentStatus &&  value)
inline

The current status of a document.

If the document was submitted for deletion, the status is NOT_FOUND after the document is deleted.

Definition at line 123 of file Status.h.

◆ WithFailureCode() [1/3]

Status& Aws::kendra::Model::Status::WithFailureCode ( Aws::String &&  value)
inline

Indicates the source of the error.

Definition at line 159 of file Status.h.

◆ WithFailureCode() [2/3]

Status& Aws::kendra::Model::Status::WithFailureCode ( const Aws::String value)
inline

Indicates the source of the error.

Definition at line 154 of file Status.h.

◆ WithFailureCode() [3/3]

Status& Aws::kendra::Model::Status::WithFailureCode ( const char *  value)
inline

Indicates the source of the error.

Definition at line 164 of file Status.h.

◆ WithFailureReason() [1/3]

Status& Aws::kendra::Model::Status::WithFailureReason ( Aws::String &&  value)
inline

Provides detailed information about why the document couldn't be indexed. Use this information to correct the error before you resubmit the document for indexing.

Definition at line 214 of file Status.h.

◆ WithFailureReason() [2/3]

Status& Aws::kendra::Model::Status::WithFailureReason ( const Aws::String value)
inline

Provides detailed information about why the document couldn't be indexed. Use this information to correct the error before you resubmit the document for indexing.

Definition at line 207 of file Status.h.

◆ WithFailureReason() [3/3]

Status& Aws::kendra::Model::Status::WithFailureReason ( const char *  value)
inline

Provides detailed information about why the document couldn't be indexed. Use this information to correct the error before you resubmit the document for indexing.

Definition at line 221 of file Status.h.


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