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(value="software.amazon.awssdk:codegen")
public final class ListDataSourceSyncJobsRequest
extends KendraRequest
implements ToCopyableBuilder<ListDataSourceSyncJobsRequest.Builder,ListDataSourceSyncJobsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListDataSourceSyncJobsRequest.Builder

Method Summary

Modifier and Type	Method and 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.
String	indexId() The identifier of the index that contains the data source.
Integer	maxResults() The maximum number of synchronization jobs to return in the response.
String	nextToken() If the result of the previous request to GetDataSourceSyncJobHistory was truncated, include the NextToken to fetch the next set of jobs.
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() When specified, only returns synchronization jobs with the Status field equal to the specified status.
String	statusFilterAsString() When specified, 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 String id()

The identifier of the data source.

Returns:

The identifier of the data source.

indexId

public String indexId()

The identifier of the index that contains the data source.

Returns:

The identifier of the index that contains the data source.

nextToken

public String nextToken()

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

Returns:

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

maxResults

public 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 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 DataSourceSyncJobStatus statusFilter()

When specified, 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:

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

See Also:

DataSourceSyncJobStatus

statusFilterAsString

public String statusFilterAsString()

When specified, 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:

When specified, 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 int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo