com.amazonaws.services.kendra.model

Class ListDataSourceSyncJobsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kendra.model.ListDataSourceSyncJobsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListDataSourceSyncJobsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListDataSourceSyncJobsRequest()

Method Summary

Modifier and Type	Method and Description
ListDataSourceSyncJobsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getId() The identifier of the data source.
String	getIndexId() The identifier of the index that contains the data source.
Integer	getMaxResults() The maximum number of synchronization jobs to return in the response.
String	getNextToken() If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response.
TimeRange	getStartTimeFilter() When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.
String	getStatusFilter() When specified, only returns synchronization jobs with the Status field equal to the specified status.
int	hashCode()
void	setId(String id) The identifier of the data source.
void	setIndexId(String indexId) The identifier of the index that contains the data source.
void	setMaxResults(Integer maxResults) The maximum number of synchronization jobs to return in the response.
void	setNextToken(String nextToken) If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response.
void	setStartTimeFilter(TimeRange startTimeFilter) When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.
void	setStatusFilter(String statusFilter) When specified, only returns synchronization jobs with the Status field equal to the specified status.
String	toString() Returns a string representation of this object.
ListDataSourceSyncJobsRequest	withId(String id) The identifier of the data source.
ListDataSourceSyncJobsRequest	withIndexId(String indexId) The identifier of the index that contains the data source.
ListDataSourceSyncJobsRequest	withMaxResults(Integer maxResults) The maximum number of synchronization jobs to return in the response.
ListDataSourceSyncJobsRequest	withNextToken(String nextToken) If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response.
ListDataSourceSyncJobsRequest	withStartTimeFilter(TimeRange startTimeFilter) When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.
ListDataSourceSyncJobsRequest	withStatusFilter(DataSourceSyncJobStatus statusFilter) When specified, only returns synchronization jobs with the Status field equal to the specified status.
ListDataSourceSyncJobsRequest	withStatusFilter(String statusFilter) When specified, only returns synchronization jobs with the Status field equal to the specified status.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListDataSourceSyncJobsRequest

public ListDataSourceSyncJobsRequest()

Method Detail

setId

public void setId(String id)

The identifier of the data source.

Parameters:

id - The identifier of the data source.

getId

public String getId()

The identifier of the data source.

Returns:

The identifier of the data source.

withId

public ListDataSourceSyncJobsRequest withId(String id)

The identifier of the data source.

Parameters:

id - The identifier of the data source.

Returns:

Returns a reference to this object so that method calls can be chained together.

setIndexId

public void setIndexId(String indexId)

The identifier of the index that contains the data source.

Parameters:

indexId - The identifier of the index that contains the data source.

getIndexId

public String getIndexId()

The identifier of the index that contains the data source.

Returns:

The identifier of the index that contains the data source.

withIndexId

public ListDataSourceSyncJobsRequest withIndexId(String indexId)

The identifier of the index that contains the data source.

Parameters:

indexId - The identifier of the index that contains the data source.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNextToken

public void setNextToken(String nextToken)

If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of jobs.

Parameters:

nextToken - If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of jobs.

getNextToken

public String getNextToken()

If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of jobs.

Returns:

If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of jobs.

withNextToken

public ListDataSourceSyncJobsRequest withNextToken(String nextToken)

If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of jobs.

Parameters:

nextToken - If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of jobs.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxResults

public void setMaxResults(Integer maxResults)

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.

Parameters:

maxResults - 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.

getMaxResults

public Integer getMaxResults()

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.

Returns:

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.

withMaxResults

public ListDataSourceSyncJobsRequest withMaxResults(Integer maxResults)

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.

Parameters:

maxResults - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStartTimeFilter

public void setStartTimeFilter(TimeRange startTimeFilter)

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

Parameters:

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

getStartTimeFilter

public TimeRange getStartTimeFilter()

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

Returns:

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

withStartTimeFilter

public ListDataSourceSyncJobsRequest withStartTimeFilter(TimeRange startTimeFilter)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setStatusFilter

public void setStatusFilter(String statusFilter)

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

Parameters:

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

See Also:

DataSourceSyncJobStatus

getStatusFilter

public String getStatusFilter()

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

Returns:

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

See Also:

DataSourceSyncJobStatus

withStatusFilter

public ListDataSourceSyncJobsRequest withStatusFilter(String statusFilter)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DataSourceSyncJobStatus

withStatusFilter

public ListDataSourceSyncJobsRequest withStatusFilter(DataSourceSyncJobStatus statusFilter)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DataSourceSyncJobStatus

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ListDataSourceSyncJobsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()