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

Class DataSourceSyncJob

java.lang.Object

software.amazon.awssdk.services.kendra.model.DataSourceSyncJob

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DataSourceSyncJob.Builder,DataSourceSyncJob>

@Generated("software.amazon.awssdk:codegen")
public final class DataSourceSyncJob
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DataSourceSyncJob.Builder,DataSourceSyncJob>

Provides information about a data source synchronization job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DataSourceSyncJob.Builder

Method Summary

Modifier and Type	Method	Description
static DataSourceSyncJob.Builder	builder()
String	dataSourceErrorCode()	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.
Instant	endTime()	The Unix timestamp when the synchronization job completed.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ErrorCode	errorCode()	If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.
String	errorCodeAsString()	If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.
String	errorMessage()	If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.
String	executionId()	A identifier for the synchronization job.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
DataSourceSyncJobMetrics	metrics()	Maps a batch delete document request to a specific data source sync job.
List<SdkField<?>>	sdkFields()
static Class<? extends DataSourceSyncJob.Builder>	serializableBuilderClass()
Instant	startTime()	The Unix timestamp when the synchronization job started.
DataSourceSyncJobStatus	status()	The execution status of the synchronization job.
String	statusAsString()	The execution status of the synchronization job.
DataSourceSyncJob.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

executionId

public final String executionId()

A identifier for the synchronization job.

Returns:

A identifier for the synchronization job.

startTime

public final Instant startTime()

The Unix timestamp when the synchronization job started.

Returns:

The Unix timestamp when the synchronization job started.

endTime

public final Instant endTime()

The Unix timestamp when the synchronization job completed.

Returns:

The Unix timestamp when the synchronization job completed.

status

public final DataSourceSyncJobStatus status()

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.

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

Returns:

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.

See Also:

DataSourceSyncJobStatus

statusAsString

public final String statusAsString()

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.

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

Returns:

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.

See Also:

DataSourceSyncJobStatus

errorMessage

public final String errorMessage()

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

Returns:

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

errorCode

public final ErrorCode errorCode()

If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.

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

Returns:

If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.

See Also:

ErrorCode

errorCodeAsString

public final String errorCodeAsString()

If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.

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

Returns:

If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.

See Also:

ErrorCode

dataSourceErrorCode

public final String dataSourceErrorCode()

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.

Returns:

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.

metrics

public final DataSourceSyncJobMetrics metrics()

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.

Returns:

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.

toBuilder

public DataSourceSyncJob.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DataSourceSyncJob.Builder,DataSourceSyncJob>

builder

public static DataSourceSyncJob.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo