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

#include <ListDataSourceSyncJobsRequest.h>

+ Inheritance diagram for Aws::kendra::Model::ListDataSourceSyncJobsRequest:

Public Member Functions

 ListDataSourceSyncJobsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetId () const
 
bool IdHasBeenSet () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
ListDataSourceSyncJobsRequestWithId (const Aws::String &value)
 
ListDataSourceSyncJobsRequestWithId (Aws::String &&value)
 
ListDataSourceSyncJobsRequestWithId (const char *value)
 
const Aws::StringGetIndexId () const
 
bool IndexIdHasBeenSet () const
 
void SetIndexId (const Aws::String &value)
 
void SetIndexId (Aws::String &&value)
 
void SetIndexId (const char *value)
 
ListDataSourceSyncJobsRequestWithIndexId (const Aws::String &value)
 
ListDataSourceSyncJobsRequestWithIndexId (Aws::String &&value)
 
ListDataSourceSyncJobsRequestWithIndexId (const char *value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListDataSourceSyncJobsRequestWithNextToken (const Aws::String &value)
 
ListDataSourceSyncJobsRequestWithNextToken (Aws::String &&value)
 
ListDataSourceSyncJobsRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListDataSourceSyncJobsRequestWithMaxResults (int value)
 
const TimeRangeGetStartTimeFilter () const
 
bool StartTimeFilterHasBeenSet () const
 
void SetStartTimeFilter (const TimeRange &value)
 
void SetStartTimeFilter (TimeRange &&value)
 
ListDataSourceSyncJobsRequestWithStartTimeFilter (const TimeRange &value)
 
ListDataSourceSyncJobsRequestWithStartTimeFilter (TimeRange &&value)
 
const DataSourceSyncJobStatusGetStatusFilter () const
 
bool StatusFilterHasBeenSet () const
 
void SetStatusFilter (const DataSourceSyncJobStatus &value)
 
void SetStatusFilter (DataSourceSyncJobStatus &&value)
 
ListDataSourceSyncJobsRequestWithStatusFilter (const DataSourceSyncJobStatus &value)
 
ListDataSourceSyncJobsRequestWithStatusFilter (DataSourceSyncJobStatus &&value)
 
- Public Member Functions inherited from Aws::kendra::KendraRequest
virtual ~KendraRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 23 of file ListDataSourceSyncJobsRequest.h.

Constructor & Destructor Documentation

◆ ListDataSourceSyncJobsRequest()

Aws::kendra::Model::ListDataSourceSyncJobsRequest::ListDataSourceSyncJobsRequest ( )

Member Function Documentation

◆ GetId()

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

The identifier of the data source.

Definition at line 42 of file ListDataSourceSyncJobsRequest.h.

◆ GetIndexId()

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

The identifier of the index that contains the data source.

Definition at line 83 of file ListDataSourceSyncJobsRequest.h.

◆ GetMaxResults()

int Aws::kendra::Model::ListDataSourceSyncJobsRequest::GetMaxResults ( ) const
inline

The maximum number of synchronization jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

Definition at line 183 of file ListDataSourceSyncJobsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::kendra::Model::ListDataSourceSyncJobsRequest::GetNextToken ( ) const
inline

If the result of the previous request to GetDataSourceSyncJobHistory was truncated, include the NextToken to fetch the next set of jobs.

Definition at line 126 of file ListDataSourceSyncJobsRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::kendra::Model::ListDataSourceSyncJobsRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::kendra::KendraRequest.

◆ GetServiceRequestName()

virtual const char* Aws::kendra::Model::ListDataSourceSyncJobsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file ListDataSourceSyncJobsRequest.h.

◆ GetStartTimeFilter()

const TimeRange& Aws::kendra::Model::ListDataSourceSyncJobsRequest::GetStartTimeFilter ( ) const
inline

When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.

Definition at line 211 of file ListDataSourceSyncJobsRequest.h.

◆ GetStatusFilter()

const DataSourceSyncJobStatus& Aws::kendra::Model::ListDataSourceSyncJobsRequest::GetStatusFilter ( ) const
inline

When specified, only returns synchronization jobs with the Status field equal to the specified status.

Definition at line 248 of file ListDataSourceSyncJobsRequest.h.

◆ IdHasBeenSet()

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

The identifier of the data source.

Definition at line 47 of file ListDataSourceSyncJobsRequest.h.

◆ IndexIdHasBeenSet()

bool Aws::kendra::Model::ListDataSourceSyncJobsRequest::IndexIdHasBeenSet ( ) const
inline

The identifier of the index that contains the data source.

Definition at line 88 of file ListDataSourceSyncJobsRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::kendra::Model::ListDataSourceSyncJobsRequest::MaxResultsHasBeenSet ( ) const
inline

The maximum number of synchronization jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

Definition at line 190 of file ListDataSourceSyncJobsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::kendra::Model::ListDataSourceSyncJobsRequest::NextTokenHasBeenSet ( ) const
inline

If the result of the previous request to GetDataSourceSyncJobHistory was truncated, include the NextToken to fetch the next set of jobs.

Definition at line 133 of file ListDataSourceSyncJobsRequest.h.

◆ SerializePayload()

Aws::String Aws::kendra::Model::ListDataSourceSyncJobsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetId() [1/3]

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

The identifier of the data source.

Definition at line 52 of file ListDataSourceSyncJobsRequest.h.

◆ SetId() [2/3]

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

The identifier of the data source.

Definition at line 57 of file ListDataSourceSyncJobsRequest.h.

◆ SetId() [3/3]

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

The identifier of the data source.

Definition at line 62 of file ListDataSourceSyncJobsRequest.h.

◆ SetIndexId() [1/3]

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

The identifier of the index that contains the data source.

Definition at line 93 of file ListDataSourceSyncJobsRequest.h.

◆ SetIndexId() [2/3]

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

The identifier of the index that contains the data source.

Definition at line 98 of file ListDataSourceSyncJobsRequest.h.

◆ SetIndexId() [3/3]

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

The identifier of the index that contains the data source.

Definition at line 103 of file ListDataSourceSyncJobsRequest.h.

◆ SetMaxResults()

void Aws::kendra::Model::ListDataSourceSyncJobsRequest::SetMaxResults ( int  value)
inline

The maximum number of synchronization jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

Definition at line 197 of file ListDataSourceSyncJobsRequest.h.

◆ SetNextToken() [1/3]

void Aws::kendra::Model::ListDataSourceSyncJobsRequest::SetNextToken ( const Aws::String value)
inline

If the result of the previous request to GetDataSourceSyncJobHistory was truncated, include the NextToken to fetch the next set of jobs.

Definition at line 140 of file ListDataSourceSyncJobsRequest.h.

◆ SetNextToken() [2/3]

void Aws::kendra::Model::ListDataSourceSyncJobsRequest::SetNextToken ( Aws::String &&  value)
inline

If the result of the previous request to GetDataSourceSyncJobHistory was truncated, include the NextToken to fetch the next set of jobs.

Definition at line 147 of file ListDataSourceSyncJobsRequest.h.

◆ SetNextToken() [3/3]

void Aws::kendra::Model::ListDataSourceSyncJobsRequest::SetNextToken ( const char *  value)
inline

If the result of the previous request to GetDataSourceSyncJobHistory was truncated, include the NextToken to fetch the next set of jobs.

Definition at line 154 of file ListDataSourceSyncJobsRequest.h.

◆ SetStartTimeFilter() [1/2]

void Aws::kendra::Model::ListDataSourceSyncJobsRequest::SetStartTimeFilter ( const TimeRange value)
inline

When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.

Definition at line 223 of file ListDataSourceSyncJobsRequest.h.

◆ SetStartTimeFilter() [2/2]

void Aws::kendra::Model::ListDataSourceSyncJobsRequest::SetStartTimeFilter ( TimeRange &&  value)
inline

When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.

Definition at line 229 of file ListDataSourceSyncJobsRequest.h.

◆ SetStatusFilter() [1/2]

void Aws::kendra::Model::ListDataSourceSyncJobsRequest::SetStatusFilter ( const DataSourceSyncJobStatus value)
inline

When specified, only returns synchronization jobs with the Status field equal to the specified status.

Definition at line 260 of file ListDataSourceSyncJobsRequest.h.

◆ SetStatusFilter() [2/2]

void Aws::kendra::Model::ListDataSourceSyncJobsRequest::SetStatusFilter ( DataSourceSyncJobStatus &&  value)
inline

When specified, only returns synchronization jobs with the Status field equal to the specified status.

Definition at line 266 of file ListDataSourceSyncJobsRequest.h.

◆ StartTimeFilterHasBeenSet()

bool Aws::kendra::Model::ListDataSourceSyncJobsRequest::StartTimeFilterHasBeenSet ( ) const
inline

When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.

Definition at line 217 of file ListDataSourceSyncJobsRequest.h.

◆ StatusFilterHasBeenSet()

bool Aws::kendra::Model::ListDataSourceSyncJobsRequest::StatusFilterHasBeenSet ( ) const
inline

When specified, only returns synchronization jobs with the Status field equal to the specified status.

Definition at line 254 of file ListDataSourceSyncJobsRequest.h.

◆ WithId() [1/3]

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

The identifier of the data source.

Definition at line 67 of file ListDataSourceSyncJobsRequest.h.

◆ WithId() [2/3]

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

The identifier of the data source.

Definition at line 72 of file ListDataSourceSyncJobsRequest.h.

◆ WithId() [3/3]

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

The identifier of the data source.

Definition at line 77 of file ListDataSourceSyncJobsRequest.h.

◆ WithIndexId() [1/3]

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

The identifier of the index that contains the data source.

Definition at line 108 of file ListDataSourceSyncJobsRequest.h.

◆ WithIndexId() [2/3]

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

The identifier of the index that contains the data source.

Definition at line 113 of file ListDataSourceSyncJobsRequest.h.

◆ WithIndexId() [3/3]

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

The identifier of the index that contains the data source.

Definition at line 118 of file ListDataSourceSyncJobsRequest.h.

◆ WithMaxResults()

ListDataSourceSyncJobsRequest& Aws::kendra::Model::ListDataSourceSyncJobsRequest::WithMaxResults ( int  value)
inline

The maximum number of synchronization jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

Definition at line 204 of file ListDataSourceSyncJobsRequest.h.

◆ WithNextToken() [1/3]

ListDataSourceSyncJobsRequest& Aws::kendra::Model::ListDataSourceSyncJobsRequest::WithNextToken ( const Aws::String value)
inline

If the result of the previous request to GetDataSourceSyncJobHistory was truncated, include the NextToken to fetch the next set of jobs.

Definition at line 161 of file ListDataSourceSyncJobsRequest.h.

◆ WithNextToken() [2/3]

ListDataSourceSyncJobsRequest& Aws::kendra::Model::ListDataSourceSyncJobsRequest::WithNextToken ( Aws::String &&  value)
inline

If the result of the previous request to GetDataSourceSyncJobHistory was truncated, include the NextToken to fetch the next set of jobs.

Definition at line 168 of file ListDataSourceSyncJobsRequest.h.

◆ WithNextToken() [3/3]

ListDataSourceSyncJobsRequest& Aws::kendra::Model::ListDataSourceSyncJobsRequest::WithNextToken ( const char *  value)
inline

If the result of the previous request to GetDataSourceSyncJobHistory was truncated, include the NextToken to fetch the next set of jobs.

Definition at line 175 of file ListDataSourceSyncJobsRequest.h.

◆ WithStartTimeFilter() [1/2]

ListDataSourceSyncJobsRequest& Aws::kendra::Model::ListDataSourceSyncJobsRequest::WithStartTimeFilter ( const TimeRange value)
inline

When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.

Definition at line 235 of file ListDataSourceSyncJobsRequest.h.

◆ WithStartTimeFilter() [2/2]

ListDataSourceSyncJobsRequest& Aws::kendra::Model::ListDataSourceSyncJobsRequest::WithStartTimeFilter ( TimeRange &&  value)
inline

When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.

Definition at line 241 of file ListDataSourceSyncJobsRequest.h.

◆ WithStatusFilter() [1/2]

ListDataSourceSyncJobsRequest& Aws::kendra::Model::ListDataSourceSyncJobsRequest::WithStatusFilter ( const DataSourceSyncJobStatus value)
inline

When specified, only returns synchronization jobs with the Status field equal to the specified status.

Definition at line 272 of file ListDataSourceSyncJobsRequest.h.

◆ WithStatusFilter() [2/2]

ListDataSourceSyncJobsRequest& Aws::kendra::Model::ListDataSourceSyncJobsRequest::WithStatusFilter ( DataSourceSyncJobStatus &&  value)
inline

When specified, only returns synchronization jobs with the Status field equal to the specified status.

Definition at line 278 of file ListDataSourceSyncJobsRequest.h.


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