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

#include <DescribeFaqResult.h>

Public Member Functions

 DescribeFaqResult ()
 
 DescribeFaqResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
DescribeFaqResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetId () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
DescribeFaqResultWithId (const Aws::String &value)
 
DescribeFaqResultWithId (Aws::String &&value)
 
DescribeFaqResultWithId (const char *value)
 
const Aws::StringGetIndexId () const
 
void SetIndexId (const Aws::String &value)
 
void SetIndexId (Aws::String &&value)
 
void SetIndexId (const char *value)
 
DescribeFaqResultWithIndexId (const Aws::String &value)
 
DescribeFaqResultWithIndexId (Aws::String &&value)
 
DescribeFaqResultWithIndexId (const char *value)
 
const Aws::StringGetName () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
DescribeFaqResultWithName (const Aws::String &value)
 
DescribeFaqResultWithName (Aws::String &&value)
 
DescribeFaqResultWithName (const char *value)
 
const Aws::StringGetDescription () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
DescribeFaqResultWithDescription (const Aws::String &value)
 
DescribeFaqResultWithDescription (Aws::String &&value)
 
DescribeFaqResultWithDescription (const char *value)
 
const Aws::Utils::DateTimeGetCreatedAt () const
 
void SetCreatedAt (const Aws::Utils::DateTime &value)
 
void SetCreatedAt (Aws::Utils::DateTime &&value)
 
DescribeFaqResultWithCreatedAt (const Aws::Utils::DateTime &value)
 
DescribeFaqResultWithCreatedAt (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetUpdatedAt () const
 
void SetUpdatedAt (const Aws::Utils::DateTime &value)
 
void SetUpdatedAt (Aws::Utils::DateTime &&value)
 
DescribeFaqResultWithUpdatedAt (const Aws::Utils::DateTime &value)
 
DescribeFaqResultWithUpdatedAt (Aws::Utils::DateTime &&value)
 
const S3PathGetS3Path () const
 
void SetS3Path (const S3Path &value)
 
void SetS3Path (S3Path &&value)
 
DescribeFaqResultWithS3Path (const S3Path &value)
 
DescribeFaqResultWithS3Path (S3Path &&value)
 
const FaqStatusGetStatus () const
 
void SetStatus (const FaqStatus &value)
 
void SetStatus (FaqStatus &&value)
 
DescribeFaqResultWithStatus (const FaqStatus &value)
 
DescribeFaqResultWithStatus (FaqStatus &&value)
 
const Aws::StringGetRoleArn () const
 
void SetRoleArn (const Aws::String &value)
 
void SetRoleArn (Aws::String &&value)
 
void SetRoleArn (const char *value)
 
DescribeFaqResultWithRoleArn (const Aws::String &value)
 
DescribeFaqResultWithRoleArn (Aws::String &&value)
 
DescribeFaqResultWithRoleArn (const char *value)
 
const Aws::StringGetErrorMessage () const
 
void SetErrorMessage (const Aws::String &value)
 
void SetErrorMessage (Aws::String &&value)
 
void SetErrorMessage (const char *value)
 
DescribeFaqResultWithErrorMessage (const Aws::String &value)
 
DescribeFaqResultWithErrorMessage (Aws::String &&value)
 
DescribeFaqResultWithErrorMessage (const char *value)
 
const FaqFileFormatGetFileFormat () const
 
void SetFileFormat (const FaqFileFormat &value)
 
void SetFileFormat (FaqFileFormat &&value)
 
DescribeFaqResultWithFileFormat (const FaqFileFormat &value)
 
DescribeFaqResultWithFileFormat (FaqFileFormat &&value)
 

Detailed Description

Definition at line 31 of file DescribeFaqResult.h.

Constructor & Destructor Documentation

◆ DescribeFaqResult() [1/2]

Aws::kendra::Model::DescribeFaqResult::DescribeFaqResult ( )

◆ DescribeFaqResult() [2/2]

Aws::kendra::Model::DescribeFaqResult::DescribeFaqResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

Member Function Documentation

◆ GetCreatedAt()

const Aws::Utils::DateTime& Aws::kendra::Model::DescribeFaqResult::GetCreatedAt ( ) const
inline

The date and time that the FAQ was created.

Definition at line 186 of file DescribeFaqResult.h.

◆ GetDescription()

const Aws::String& Aws::kendra::Model::DescribeFaqResult::GetDescription ( ) const
inline

The description of the FAQ that you provided when it was created.

Definition at line 150 of file DescribeFaqResult.h.

◆ GetErrorMessage()

const Aws::String& Aws::kendra::Model::DescribeFaqResult::GetErrorMessage ( ) const
inline

If the Status field is FAILED, the ErrorMessage field contains the reason why the FAQ failed.

Definition at line 329 of file DescribeFaqResult.h.

◆ GetFileFormat()

const FaqFileFormat& Aws::kendra::Model::DescribeFaqResult::GetFileFormat ( ) const
inline

The file format used by the input files for the FAQ.

Definition at line 371 of file DescribeFaqResult.h.

◆ GetId()

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

The identifier of the FAQ.

Definition at line 42 of file DescribeFaqResult.h.

◆ GetIndexId()

const Aws::String& Aws::kendra::Model::DescribeFaqResult::GetIndexId ( ) const
inline

The identifier of the index that contains the FAQ.

Definition at line 78 of file DescribeFaqResult.h.

◆ GetName()

const Aws::String& Aws::kendra::Model::DescribeFaqResult::GetName ( ) const
inline

The name that you gave the FAQ when it was created.

Definition at line 114 of file DescribeFaqResult.h.

◆ GetRoleArn()

const Aws::String& Aws::kendra::Model::DescribeFaqResult::GetRoleArn ( ) const
inline

The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.

Definition at line 286 of file DescribeFaqResult.h.

◆ GetS3Path()

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

Definition at line 236 of file DescribeFaqResult.h.

◆ GetStatus()

const FaqStatus& Aws::kendra::Model::DescribeFaqResult::GetStatus ( ) const
inline

The status of the FAQ. It is ready to use when the status is ACTIVE.

Definition at line 255 of file DescribeFaqResult.h.

◆ GetUpdatedAt()

const Aws::Utils::DateTime& Aws::kendra::Model::DescribeFaqResult::GetUpdatedAt ( ) const
inline

The date and time that the FAQ was last updated.

Definition at line 212 of file DescribeFaqResult.h.

◆ operator=()

DescribeFaqResult& Aws::kendra::Model::DescribeFaqResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

◆ SetCreatedAt() [1/2]

void Aws::kendra::Model::DescribeFaqResult::SetCreatedAt ( Aws::Utils::DateTime &&  value)
inline

The date and time that the FAQ was created.

Definition at line 196 of file DescribeFaqResult.h.

◆ SetCreatedAt() [2/2]

void Aws::kendra::Model::DescribeFaqResult::SetCreatedAt ( const Aws::Utils::DateTime value)
inline

The date and time that the FAQ was created.

Definition at line 191 of file DescribeFaqResult.h.

◆ SetDescription() [1/3]

void Aws::kendra::Model::DescribeFaqResult::SetDescription ( Aws::String &&  value)
inline

The description of the FAQ that you provided when it was created.

Definition at line 160 of file DescribeFaqResult.h.

◆ SetDescription() [2/3]

void Aws::kendra::Model::DescribeFaqResult::SetDescription ( const Aws::String value)
inline

The description of the FAQ that you provided when it was created.

Definition at line 155 of file DescribeFaqResult.h.

◆ SetDescription() [3/3]

void Aws::kendra::Model::DescribeFaqResult::SetDescription ( const char *  value)
inline

The description of the FAQ that you provided when it was created.

Definition at line 165 of file DescribeFaqResult.h.

◆ SetErrorMessage() [1/3]

void Aws::kendra::Model::DescribeFaqResult::SetErrorMessage ( Aws::String &&  value)
inline

If the Status field is FAILED, the ErrorMessage field contains the reason why the FAQ failed.

Definition at line 341 of file DescribeFaqResult.h.

◆ SetErrorMessage() [2/3]

void Aws::kendra::Model::DescribeFaqResult::SetErrorMessage ( const Aws::String value)
inline

If the Status field is FAILED, the ErrorMessage field contains the reason why the FAQ failed.

Definition at line 335 of file DescribeFaqResult.h.

◆ SetErrorMessage() [3/3]

void Aws::kendra::Model::DescribeFaqResult::SetErrorMessage ( const char *  value)
inline

If the Status field is FAILED, the ErrorMessage field contains the reason why the FAQ failed.

Definition at line 347 of file DescribeFaqResult.h.

◆ SetFileFormat() [1/2]

void Aws::kendra::Model::DescribeFaqResult::SetFileFormat ( const FaqFileFormat value)
inline

The file format used by the input files for the FAQ.

Definition at line 376 of file DescribeFaqResult.h.

◆ SetFileFormat() [2/2]

void Aws::kendra::Model::DescribeFaqResult::SetFileFormat ( FaqFileFormat &&  value)
inline

The file format used by the input files for the FAQ.

Definition at line 381 of file DescribeFaqResult.h.

◆ SetId() [1/3]

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

The identifier of the FAQ.

Definition at line 52 of file DescribeFaqResult.h.

◆ SetId() [2/3]

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

The identifier of the FAQ.

Definition at line 47 of file DescribeFaqResult.h.

◆ SetId() [3/3]

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

The identifier of the FAQ.

Definition at line 57 of file DescribeFaqResult.h.

◆ SetIndexId() [1/3]

void Aws::kendra::Model::DescribeFaqResult::SetIndexId ( Aws::String &&  value)
inline

The identifier of the index that contains the FAQ.

Definition at line 88 of file DescribeFaqResult.h.

◆ SetIndexId() [2/3]

void Aws::kendra::Model::DescribeFaqResult::SetIndexId ( const Aws::String value)
inline

The identifier of the index that contains the FAQ.

Definition at line 83 of file DescribeFaqResult.h.

◆ SetIndexId() [3/3]

void Aws::kendra::Model::DescribeFaqResult::SetIndexId ( const char *  value)
inline

The identifier of the index that contains the FAQ.

Definition at line 93 of file DescribeFaqResult.h.

◆ SetName() [1/3]

void Aws::kendra::Model::DescribeFaqResult::SetName ( Aws::String &&  value)
inline

The name that you gave the FAQ when it was created.

Definition at line 124 of file DescribeFaqResult.h.

◆ SetName() [2/3]

void Aws::kendra::Model::DescribeFaqResult::SetName ( const Aws::String value)
inline

The name that you gave the FAQ when it was created.

Definition at line 119 of file DescribeFaqResult.h.

◆ SetName() [3/3]

void Aws::kendra::Model::DescribeFaqResult::SetName ( const char *  value)
inline

The name that you gave the FAQ when it was created.

Definition at line 129 of file DescribeFaqResult.h.

◆ SetRoleArn() [1/3]

void Aws::kendra::Model::DescribeFaqResult::SetRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.

Definition at line 298 of file DescribeFaqResult.h.

◆ SetRoleArn() [2/3]

void Aws::kendra::Model::DescribeFaqResult::SetRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.

Definition at line 292 of file DescribeFaqResult.h.

◆ SetRoleArn() [3/3]

void Aws::kendra::Model::DescribeFaqResult::SetRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.

Definition at line 304 of file DescribeFaqResult.h.

◆ SetS3Path() [1/2]

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

Definition at line 239 of file DescribeFaqResult.h.

◆ SetS3Path() [2/2]

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

Definition at line 242 of file DescribeFaqResult.h.

◆ SetStatus() [1/2]

void Aws::kendra::Model::DescribeFaqResult::SetStatus ( const FaqStatus value)
inline

The status of the FAQ. It is ready to use when the status is ACTIVE.

Definition at line 261 of file DescribeFaqResult.h.

◆ SetStatus() [2/2]

void Aws::kendra::Model::DescribeFaqResult::SetStatus ( FaqStatus &&  value)
inline

The status of the FAQ. It is ready to use when the status is ACTIVE.

Definition at line 267 of file DescribeFaqResult.h.

◆ SetUpdatedAt() [1/2]

void Aws::kendra::Model::DescribeFaqResult::SetUpdatedAt ( Aws::Utils::DateTime &&  value)
inline

The date and time that the FAQ was last updated.

Definition at line 222 of file DescribeFaqResult.h.

◆ SetUpdatedAt() [2/2]

void Aws::kendra::Model::DescribeFaqResult::SetUpdatedAt ( const Aws::Utils::DateTime value)
inline

The date and time that the FAQ was last updated.

Definition at line 217 of file DescribeFaqResult.h.

◆ WithCreatedAt() [1/2]

DescribeFaqResult& Aws::kendra::Model::DescribeFaqResult::WithCreatedAt ( Aws::Utils::DateTime &&  value)
inline

The date and time that the FAQ was created.

Definition at line 206 of file DescribeFaqResult.h.

◆ WithCreatedAt() [2/2]

DescribeFaqResult& Aws::kendra::Model::DescribeFaqResult::WithCreatedAt ( const Aws::Utils::DateTime value)
inline

The date and time that the FAQ was created.

Definition at line 201 of file DescribeFaqResult.h.

◆ WithDescription() [1/3]

DescribeFaqResult& Aws::kendra::Model::DescribeFaqResult::WithDescription ( Aws::String &&  value)
inline

The description of the FAQ that you provided when it was created.

Definition at line 175 of file DescribeFaqResult.h.

◆ WithDescription() [2/3]

DescribeFaqResult& Aws::kendra::Model::DescribeFaqResult::WithDescription ( const Aws::String value)
inline

The description of the FAQ that you provided when it was created.

Definition at line 170 of file DescribeFaqResult.h.

◆ WithDescription() [3/3]

DescribeFaqResult& Aws::kendra::Model::DescribeFaqResult::WithDescription ( const char *  value)
inline

The description of the FAQ that you provided when it was created.

Definition at line 180 of file DescribeFaqResult.h.

◆ WithErrorMessage() [1/3]

DescribeFaqResult& Aws::kendra::Model::DescribeFaqResult::WithErrorMessage ( Aws::String &&  value)
inline

If the Status field is FAILED, the ErrorMessage field contains the reason why the FAQ failed.

Definition at line 359 of file DescribeFaqResult.h.

◆ WithErrorMessage() [2/3]

DescribeFaqResult& Aws::kendra::Model::DescribeFaqResult::WithErrorMessage ( const Aws::String value)
inline

If the Status field is FAILED, the ErrorMessage field contains the reason why the FAQ failed.

Definition at line 353 of file DescribeFaqResult.h.

◆ WithErrorMessage() [3/3]

DescribeFaqResult& Aws::kendra::Model::DescribeFaqResult::WithErrorMessage ( const char *  value)
inline

If the Status field is FAILED, the ErrorMessage field contains the reason why the FAQ failed.

Definition at line 365 of file DescribeFaqResult.h.

◆ WithFileFormat() [1/2]

DescribeFaqResult& Aws::kendra::Model::DescribeFaqResult::WithFileFormat ( const FaqFileFormat value)
inline

The file format used by the input files for the FAQ.

Definition at line 386 of file DescribeFaqResult.h.

◆ WithFileFormat() [2/2]

DescribeFaqResult& Aws::kendra::Model::DescribeFaqResult::WithFileFormat ( FaqFileFormat &&  value)
inline

The file format used by the input files for the FAQ.

Definition at line 391 of file DescribeFaqResult.h.

◆ WithId() [1/3]

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

The identifier of the FAQ.

Definition at line 67 of file DescribeFaqResult.h.

◆ WithId() [2/3]

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

The identifier of the FAQ.

Definition at line 62 of file DescribeFaqResult.h.

◆ WithId() [3/3]

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

The identifier of the FAQ.

Definition at line 72 of file DescribeFaqResult.h.

◆ WithIndexId() [1/3]

DescribeFaqResult& Aws::kendra::Model::DescribeFaqResult::WithIndexId ( Aws::String &&  value)
inline

The identifier of the index that contains the FAQ.

Definition at line 103 of file DescribeFaqResult.h.

◆ WithIndexId() [2/3]

DescribeFaqResult& Aws::kendra::Model::DescribeFaqResult::WithIndexId ( const Aws::String value)
inline

The identifier of the index that contains the FAQ.

Definition at line 98 of file DescribeFaqResult.h.

◆ WithIndexId() [3/3]

DescribeFaqResult& Aws::kendra::Model::DescribeFaqResult::WithIndexId ( const char *  value)
inline

The identifier of the index that contains the FAQ.

Definition at line 108 of file DescribeFaqResult.h.

◆ WithName() [1/3]

DescribeFaqResult& Aws::kendra::Model::DescribeFaqResult::WithName ( Aws::String &&  value)
inline

The name that you gave the FAQ when it was created.

Definition at line 139 of file DescribeFaqResult.h.

◆ WithName() [2/3]

DescribeFaqResult& Aws::kendra::Model::DescribeFaqResult::WithName ( const Aws::String value)
inline

The name that you gave the FAQ when it was created.

Definition at line 134 of file DescribeFaqResult.h.

◆ WithName() [3/3]

DescribeFaqResult& Aws::kendra::Model::DescribeFaqResult::WithName ( const char *  value)
inline

The name that you gave the FAQ when it was created.

Definition at line 144 of file DescribeFaqResult.h.

◆ WithRoleArn() [1/3]

DescribeFaqResult& Aws::kendra::Model::DescribeFaqResult::WithRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.

Definition at line 316 of file DescribeFaqResult.h.

◆ WithRoleArn() [2/3]

DescribeFaqResult& Aws::kendra::Model::DescribeFaqResult::WithRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.

Definition at line 310 of file DescribeFaqResult.h.

◆ WithRoleArn() [3/3]

DescribeFaqResult& Aws::kendra::Model::DescribeFaqResult::WithRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.

Definition at line 322 of file DescribeFaqResult.h.

◆ WithS3Path() [1/2]

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

Definition at line 245 of file DescribeFaqResult.h.

◆ WithS3Path() [2/2]

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

Definition at line 248 of file DescribeFaqResult.h.

◆ WithStatus() [1/2]

DescribeFaqResult& Aws::kendra::Model::DescribeFaqResult::WithStatus ( const FaqStatus value)
inline

The status of the FAQ. It is ready to use when the status is ACTIVE.

Definition at line 273 of file DescribeFaqResult.h.

◆ WithStatus() [2/2]

DescribeFaqResult& Aws::kendra::Model::DescribeFaqResult::WithStatus ( FaqStatus &&  value)
inline

The status of the FAQ. It is ready to use when the status is ACTIVE.

Definition at line 279 of file DescribeFaqResult.h.

◆ WithUpdatedAt() [1/2]

DescribeFaqResult& Aws::kendra::Model::DescribeFaqResult::WithUpdatedAt ( Aws::Utils::DateTime &&  value)
inline

The date and time that the FAQ was last updated.

Definition at line 232 of file DescribeFaqResult.h.

◆ WithUpdatedAt() [2/2]

DescribeFaqResult& Aws::kendra::Model::DescribeFaqResult::WithUpdatedAt ( const Aws::Utils::DateTime value)
inline

The date and time that the FAQ was last updated.

Definition at line 227 of file DescribeFaqResult.h.


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