Package software.amazon.awssdk.services.kendra.model

Class ListDataSourceSyncJobsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kendra.model.KendraRequest

software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListDataSourceSyncJobsRequest.Builder,ListDataSourceSyncJobsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ListDataSourceSyncJobsRequest
extends KendraRequest
implements ToCopyableBuilder<ListDataSourceSyncJobsRequest.Builder,ListDataSourceSyncJobsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListDataSourceSyncJobsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListDataSourceSyncJobsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The identifier of the data source connector.
String	indexId()	The identifier of the index used with the data source connector.
Integer	maxResults()	The maximum number of synchronization jobs to return in the response.
String	nextToken()	If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response.
List<SdkField<?>>	sdkFields()
static Class<? extends ListDataSourceSyncJobsRequest.Builder>	serializableBuilderClass()
TimeRange	startTimeFilter()	When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.
DataSourceSyncJobStatus	statusFilter()	Only returns synchronization jobs with the Status field equal to the specified status.
String	statusFilterAsString()	Only returns synchronization jobs with the Status field equal to the specified status.
ListDataSourceSyncJobsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

id

public final String id()

The identifier of the data source connector.

Returns:

The identifier of the data source connector.

indexId

public final String indexId()

The identifier of the index used with the data source connector.

Returns:

The identifier of the index used with the data source connector.

nextToken

public final 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.

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.

maxResults

public final 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.

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.

startTimeFilter

public final TimeRange startTimeFilter()

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.

statusFilter

public final DataSourceSyncJobStatus statusFilter()

Only returns synchronization jobs with the Status field equal to the specified status.

If the service returns an enum value that is not available in the current SDK version, statusFilter will return DataSourceSyncJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusFilterAsString().

Returns:

Only returns synchronization jobs with the Status field equal to the specified status.

See Also:

DataSourceSyncJobStatus

statusFilterAsString

public final String statusFilterAsString()

Only returns synchronization jobs with the Status field equal to the specified status.

If the service returns an enum value that is not available in the current SDK version, statusFilter will return DataSourceSyncJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusFilterAsString().

Returns:

Only returns synchronization jobs with the Status field equal to the specified status.

See Also:

DataSourceSyncJobStatus

toBuilder

public ListDataSourceSyncJobsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListDataSourceSyncJobsRequest.Builder,ListDataSourceSyncJobsRequest>

Specified by:

toBuilder in class KendraRequest

builder

public static ListDataSourceSyncJobsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListDataSourceSyncJobsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo