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

#include <DataSourceSyncJob.h>

Public Member Functions

 DataSourceSyncJob ()
 
 DataSourceSyncJob (Aws::Utils::Json::JsonView jsonValue)
 
DataSourceSyncJoboperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetExecutionId () const
 
bool ExecutionIdHasBeenSet () const
 
void SetExecutionId (const Aws::String &value)
 
void SetExecutionId (Aws::String &&value)
 
void SetExecutionId (const char *value)
 
DataSourceSyncJobWithExecutionId (const Aws::String &value)
 
DataSourceSyncJobWithExecutionId (Aws::String &&value)
 
DataSourceSyncJobWithExecutionId (const char *value)
 
const Aws::Utils::DateTimeGetStartTime () const
 
bool StartTimeHasBeenSet () const
 
void SetStartTime (const Aws::Utils::DateTime &value)
 
void SetStartTime (Aws::Utils::DateTime &&value)
 
DataSourceSyncJobWithStartTime (const Aws::Utils::DateTime &value)
 
DataSourceSyncJobWithStartTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetEndTime () const
 
bool EndTimeHasBeenSet () const
 
void SetEndTime (const Aws::Utils::DateTime &value)
 
void SetEndTime (Aws::Utils::DateTime &&value)
 
DataSourceSyncJobWithEndTime (const Aws::Utils::DateTime &value)
 
DataSourceSyncJobWithEndTime (Aws::Utils::DateTime &&value)
 
const DataSourceSyncJobStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const DataSourceSyncJobStatus &value)
 
void SetStatus (DataSourceSyncJobStatus &&value)
 
DataSourceSyncJobWithStatus (const DataSourceSyncJobStatus &value)
 
DataSourceSyncJobWithStatus (DataSourceSyncJobStatus &&value)
 
const Aws::StringGetErrorMessage () const
 
bool ErrorMessageHasBeenSet () const
 
void SetErrorMessage (const Aws::String &value)
 
void SetErrorMessage (Aws::String &&value)
 
void SetErrorMessage (const char *value)
 
DataSourceSyncJobWithErrorMessage (const Aws::String &value)
 
DataSourceSyncJobWithErrorMessage (Aws::String &&value)
 
DataSourceSyncJobWithErrorMessage (const char *value)
 
const ErrorCodeGetErrorCode () const
 
bool ErrorCodeHasBeenSet () const
 
void SetErrorCode (const ErrorCode &value)
 
void SetErrorCode (ErrorCode &&value)
 
DataSourceSyncJobWithErrorCode (const ErrorCode &value)
 
DataSourceSyncJobWithErrorCode (ErrorCode &&value)
 
const Aws::StringGetDataSourceErrorCode () const
 
bool DataSourceErrorCodeHasBeenSet () const
 
void SetDataSourceErrorCode (const Aws::String &value)
 
void SetDataSourceErrorCode (Aws::String &&value)
 
void SetDataSourceErrorCode (const char *value)
 
DataSourceSyncJobWithDataSourceErrorCode (const Aws::String &value)
 
DataSourceSyncJobWithDataSourceErrorCode (Aws::String &&value)
 
DataSourceSyncJobWithDataSourceErrorCode (const char *value)
 
const DataSourceSyncJobMetricsGetMetrics () const
 
bool MetricsHasBeenSet () const
 
void SetMetrics (const DataSourceSyncJobMetrics &value)
 
void SetMetrics (DataSourceSyncJobMetrics &&value)
 
DataSourceSyncJobWithMetrics (const DataSourceSyncJobMetrics &value)
 
DataSourceSyncJobWithMetrics (DataSourceSyncJobMetrics &&value)
 

Detailed Description

Provides information about a synchronization job.

See Also:


AWS API Reference

Definition at line 36 of file DataSourceSyncJob.h.

Constructor & Destructor Documentation

◆ DataSourceSyncJob() [1/2]

Aws::kendra::Model::DataSourceSyncJob::DataSourceSyncJob ( )

◆ DataSourceSyncJob() [2/2]

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

Member Function Documentation

◆ DataSourceErrorCodeHasBeenSet()

bool Aws::kendra::Model::DataSourceSyncJob::DataSourceErrorCodeHasBeenSet ( ) const
inline

If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.

Definition at line 309 of file DataSourceSyncJob.h.

◆ EndTimeHasBeenSet()

bool Aws::kendra::Model::DataSourceSyncJob::EndTimeHasBeenSet ( ) const
inline

The UNIX datetime that the synchronization job was completed.

Definition at line 125 of file DataSourceSyncJob.h.

◆ ErrorCodeHasBeenSet()

bool Aws::kendra::Model::DataSourceSyncJob::ErrorCodeHasBeenSet ( ) const
inline

If the Status field is set to FAILED, the ErrorCode field contains a the reason that the synchronization failed.

Definition at line 266 of file DataSourceSyncJob.h.

◆ ErrorMessageHasBeenSet()

bool Aws::kendra::Model::DataSourceSyncJob::ErrorMessageHasBeenSet ( ) const
inline

If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

Definition at line 209 of file DataSourceSyncJob.h.

◆ ExecutionIdHasBeenSet()

bool Aws::kendra::Model::DataSourceSyncJob::ExecutionIdHasBeenSet ( ) const
inline

A unique identifier for the synchronization job.

Definition at line 53 of file DataSourceSyncJob.h.

◆ GetDataSourceErrorCode()

const Aws::String& Aws::kendra::Model::DataSourceSyncJob::GetDataSourceErrorCode ( ) const
inline

If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.

Definition at line 302 of file DataSourceSyncJob.h.

◆ GetEndTime()

const Aws::Utils::DateTime& Aws::kendra::Model::DataSourceSyncJob::GetEndTime ( ) const
inline

The UNIX datetime that the synchronization job was completed.

Definition at line 120 of file DataSourceSyncJob.h.

◆ GetErrorCode()

const ErrorCode& Aws::kendra::Model::DataSourceSyncJob::GetErrorCode ( ) const
inline

If the Status field is set to FAILED, the ErrorCode field contains a the reason that the synchronization failed.

Definition at line 259 of file DataSourceSyncJob.h.

◆ GetErrorMessage()

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

If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

Definition at line 202 of file DataSourceSyncJob.h.

◆ GetExecutionId()

const Aws::String& Aws::kendra::Model::DataSourceSyncJob::GetExecutionId ( ) const
inline

A unique identifier for the synchronization job.

Definition at line 48 of file DataSourceSyncJob.h.

◆ GetMetrics()

const DataSourceSyncJobMetrics& Aws::kendra::Model::DataSourceSyncJob::GetMetrics ( ) const
inline

Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.

Definition at line 359 of file DataSourceSyncJob.h.

◆ GetStartTime()

const Aws::Utils::DateTime& Aws::kendra::Model::DataSourceSyncJob::GetStartTime ( ) const
inline

The UNIX datetime that the synchronization job was started.

Definition at line 89 of file DataSourceSyncJob.h.

◆ GetStatus()

const DataSourceSyncJobStatus& Aws::kendra::Model::DataSourceSyncJob::GetStatus ( ) const
inline

The execution status of the synchronization job. When the Status field is set to SUCCEEDED, the synchronization job is done. If the status code is set to FAILED, the ErrorCode and ErrorMessage fields give you the reason for the failure.

Definition at line 154 of file DataSourceSyncJob.h.

◆ Jsonize()

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

◆ MetricsHasBeenSet()

bool Aws::kendra::Model::DataSourceSyncJob::MetricsHasBeenSet ( ) const
inline

Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.

Definition at line 366 of file DataSourceSyncJob.h.

◆ operator=()

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

◆ SetDataSourceErrorCode() [1/3]

void Aws::kendra::Model::DataSourceSyncJob::SetDataSourceErrorCode ( Aws::String &&  value)
inline

If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.

Definition at line 323 of file DataSourceSyncJob.h.

◆ SetDataSourceErrorCode() [2/3]

void Aws::kendra::Model::DataSourceSyncJob::SetDataSourceErrorCode ( const Aws::String value)
inline

If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.

Definition at line 316 of file DataSourceSyncJob.h.

◆ SetDataSourceErrorCode() [3/3]

void Aws::kendra::Model::DataSourceSyncJob::SetDataSourceErrorCode ( const char *  value)
inline

If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.

Definition at line 330 of file DataSourceSyncJob.h.

◆ SetEndTime() [1/2]

void Aws::kendra::Model::DataSourceSyncJob::SetEndTime ( Aws::Utils::DateTime &&  value)
inline

The UNIX datetime that the synchronization job was completed.

Definition at line 135 of file DataSourceSyncJob.h.

◆ SetEndTime() [2/2]

void Aws::kendra::Model::DataSourceSyncJob::SetEndTime ( const Aws::Utils::DateTime value)
inline

The UNIX datetime that the synchronization job was completed.

Definition at line 130 of file DataSourceSyncJob.h.

◆ SetErrorCode() [1/2]

void Aws::kendra::Model::DataSourceSyncJob::SetErrorCode ( const ErrorCode value)
inline

If the Status field is set to FAILED, the ErrorCode field contains a the reason that the synchronization failed.

Definition at line 273 of file DataSourceSyncJob.h.

◆ SetErrorCode() [2/2]

void Aws::kendra::Model::DataSourceSyncJob::SetErrorCode ( ErrorCode &&  value)
inline

If the Status field is set to FAILED, the ErrorCode field contains a the reason that the synchronization failed.

Definition at line 280 of file DataSourceSyncJob.h.

◆ SetErrorMessage() [1/3]

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

If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

Definition at line 223 of file DataSourceSyncJob.h.

◆ SetErrorMessage() [2/3]

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

If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

Definition at line 216 of file DataSourceSyncJob.h.

◆ SetErrorMessage() [3/3]

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

If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

Definition at line 230 of file DataSourceSyncJob.h.

◆ SetExecutionId() [1/3]

void Aws::kendra::Model::DataSourceSyncJob::SetExecutionId ( Aws::String &&  value)
inline

A unique identifier for the synchronization job.

Definition at line 63 of file DataSourceSyncJob.h.

◆ SetExecutionId() [2/3]

void Aws::kendra::Model::DataSourceSyncJob::SetExecutionId ( const Aws::String value)
inline

A unique identifier for the synchronization job.

Definition at line 58 of file DataSourceSyncJob.h.

◆ SetExecutionId() [3/3]

void Aws::kendra::Model::DataSourceSyncJob::SetExecutionId ( const char *  value)
inline

A unique identifier for the synchronization job.

Definition at line 68 of file DataSourceSyncJob.h.

◆ SetMetrics() [1/2]

void Aws::kendra::Model::DataSourceSyncJob::SetMetrics ( const DataSourceSyncJobMetrics value)
inline

Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.

Definition at line 373 of file DataSourceSyncJob.h.

◆ SetMetrics() [2/2]

void Aws::kendra::Model::DataSourceSyncJob::SetMetrics ( DataSourceSyncJobMetrics &&  value)
inline

Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.

Definition at line 380 of file DataSourceSyncJob.h.

◆ SetStartTime() [1/2]

void Aws::kendra::Model::DataSourceSyncJob::SetStartTime ( Aws::Utils::DateTime &&  value)
inline

The UNIX datetime that the synchronization job was started.

Definition at line 104 of file DataSourceSyncJob.h.

◆ SetStartTime() [2/2]

void Aws::kendra::Model::DataSourceSyncJob::SetStartTime ( const Aws::Utils::DateTime value)
inline

The UNIX datetime that the synchronization job was started.

Definition at line 99 of file DataSourceSyncJob.h.

◆ SetStatus() [1/2]

void Aws::kendra::Model::DataSourceSyncJob::SetStatus ( const DataSourceSyncJobStatus value)
inline

The execution status of the synchronization job. When the Status field is set to SUCCEEDED, the synchronization job is done. If the status code is set to FAILED, the ErrorCode and ErrorMessage fields give you the reason for the failure.

Definition at line 170 of file DataSourceSyncJob.h.

◆ SetStatus() [2/2]

void Aws::kendra::Model::DataSourceSyncJob::SetStatus ( DataSourceSyncJobStatus &&  value)
inline

The execution status of the synchronization job. When the Status field is set to SUCCEEDED, the synchronization job is done. If the status code is set to FAILED, the ErrorCode and ErrorMessage fields give you the reason for the failure.

Definition at line 178 of file DataSourceSyncJob.h.

◆ StartTimeHasBeenSet()

bool Aws::kendra::Model::DataSourceSyncJob::StartTimeHasBeenSet ( ) const
inline

The UNIX datetime that the synchronization job was started.

Definition at line 94 of file DataSourceSyncJob.h.

◆ StatusHasBeenSet()

bool Aws::kendra::Model::DataSourceSyncJob::StatusHasBeenSet ( ) const
inline

The execution status of the synchronization job. When the Status field is set to SUCCEEDED, the synchronization job is done. If the status code is set to FAILED, the ErrorCode and ErrorMessage fields give you the reason for the failure.

Definition at line 162 of file DataSourceSyncJob.h.

◆ WithDataSourceErrorCode() [1/3]

DataSourceSyncJob& Aws::kendra::Model::DataSourceSyncJob::WithDataSourceErrorCode ( Aws::String &&  value)
inline

If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.

Definition at line 344 of file DataSourceSyncJob.h.

◆ WithDataSourceErrorCode() [2/3]

DataSourceSyncJob& Aws::kendra::Model::DataSourceSyncJob::WithDataSourceErrorCode ( const Aws::String value)
inline

If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.

Definition at line 337 of file DataSourceSyncJob.h.

◆ WithDataSourceErrorCode() [3/3]

DataSourceSyncJob& Aws::kendra::Model::DataSourceSyncJob::WithDataSourceErrorCode ( const char *  value)
inline

If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.

Definition at line 351 of file DataSourceSyncJob.h.

◆ WithEndTime() [1/2]

DataSourceSyncJob& Aws::kendra::Model::DataSourceSyncJob::WithEndTime ( Aws::Utils::DateTime &&  value)
inline

The UNIX datetime that the synchronization job was completed.

Definition at line 145 of file DataSourceSyncJob.h.

◆ WithEndTime() [2/2]

DataSourceSyncJob& Aws::kendra::Model::DataSourceSyncJob::WithEndTime ( const Aws::Utils::DateTime value)
inline

The UNIX datetime that the synchronization job was completed.

Definition at line 140 of file DataSourceSyncJob.h.

◆ WithErrorCode() [1/2]

DataSourceSyncJob& Aws::kendra::Model::DataSourceSyncJob::WithErrorCode ( const ErrorCode value)
inline

If the Status field is set to FAILED, the ErrorCode field contains a the reason that the synchronization failed.

Definition at line 287 of file DataSourceSyncJob.h.

◆ WithErrorCode() [2/2]

DataSourceSyncJob& Aws::kendra::Model::DataSourceSyncJob::WithErrorCode ( ErrorCode &&  value)
inline

If the Status field is set to FAILED, the ErrorCode field contains a the reason that the synchronization failed.

Definition at line 294 of file DataSourceSyncJob.h.

◆ WithErrorMessage() [1/3]

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

If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

Definition at line 244 of file DataSourceSyncJob.h.

◆ WithErrorMessage() [2/3]

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

If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

Definition at line 237 of file DataSourceSyncJob.h.

◆ WithErrorMessage() [3/3]

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

If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

Definition at line 251 of file DataSourceSyncJob.h.

◆ WithExecutionId() [1/3]

DataSourceSyncJob& Aws::kendra::Model::DataSourceSyncJob::WithExecutionId ( Aws::String &&  value)
inline

A unique identifier for the synchronization job.

Definition at line 78 of file DataSourceSyncJob.h.

◆ WithExecutionId() [2/3]

DataSourceSyncJob& Aws::kendra::Model::DataSourceSyncJob::WithExecutionId ( const Aws::String value)
inline

A unique identifier for the synchronization job.

Definition at line 73 of file DataSourceSyncJob.h.

◆ WithExecutionId() [3/3]

DataSourceSyncJob& Aws::kendra::Model::DataSourceSyncJob::WithExecutionId ( const char *  value)
inline

A unique identifier for the synchronization job.

Definition at line 83 of file DataSourceSyncJob.h.

◆ WithMetrics() [1/2]

DataSourceSyncJob& Aws::kendra::Model::DataSourceSyncJob::WithMetrics ( const DataSourceSyncJobMetrics value)
inline

Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.

Definition at line 387 of file DataSourceSyncJob.h.

◆ WithMetrics() [2/2]

DataSourceSyncJob& Aws::kendra::Model::DataSourceSyncJob::WithMetrics ( DataSourceSyncJobMetrics &&  value)
inline

Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.

Definition at line 394 of file DataSourceSyncJob.h.

◆ WithStartTime() [1/2]

DataSourceSyncJob& Aws::kendra::Model::DataSourceSyncJob::WithStartTime ( Aws::Utils::DateTime &&  value)
inline

The UNIX datetime that the synchronization job was started.

Definition at line 114 of file DataSourceSyncJob.h.

◆ WithStartTime() [2/2]

DataSourceSyncJob& Aws::kendra::Model::DataSourceSyncJob::WithStartTime ( const Aws::Utils::DateTime value)
inline

The UNIX datetime that the synchronization job was started.

Definition at line 109 of file DataSourceSyncJob.h.

◆ WithStatus() [1/2]

DataSourceSyncJob& Aws::kendra::Model::DataSourceSyncJob::WithStatus ( const DataSourceSyncJobStatus value)
inline

The execution status of the synchronization job. When the Status field is set to SUCCEEDED, the synchronization job is done. If the status code is set to FAILED, the ErrorCode and ErrorMessage fields give you the reason for the failure.

Definition at line 186 of file DataSourceSyncJob.h.

◆ WithStatus() [2/2]

DataSourceSyncJob& Aws::kendra::Model::DataSourceSyncJob::WithStatus ( DataSourceSyncJobStatus &&  value)
inline

The execution status of the synchronization job. When the Status field is set to SUCCEEDED, the synchronization job is done. If the status code is set to FAILED, the ErrorCode and ErrorMessage fields give you the reason for the failure.

Definition at line 194 of file DataSourceSyncJob.h.


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