software.amazon.awssdk.services.kendra.model

Interface DataSourceSyncJob.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DataSourceSyncJob.Builder,DataSourceSyncJob>, SdkBuilder<DataSourceSyncJob.Builder,DataSourceSyncJob>, SdkPojo

Enclosing class:

DataSourceSyncJob

public static interface DataSourceSyncJob.Builder
extends SdkPojo, CopyableBuilder<DataSourceSyncJob.Builder,DataSourceSyncJob>

Method Summary

Modifier and Type	Method and Description
DataSourceSyncJob.Builder	dataSourceErrorCode(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.
DataSourceSyncJob.Builder	endTime(Instant endTime) The UNIX datetime that the synchronization job was completed.
DataSourceSyncJob.Builder	errorCode(ErrorCode errorCode) If the Status field is set to FAILED, the ErrorCode field contains a the reason that the synchronization failed.
DataSourceSyncJob.Builder	errorCode(String errorCode) If the Status field is set to FAILED, the ErrorCode field contains a the reason that the synchronization failed.
DataSourceSyncJob.Builder	errorMessage(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.
DataSourceSyncJob.Builder	executionId(String executionId) A unique identifier for the synchronization job.
default DataSourceSyncJob.Builder	metrics(Consumer<DataSourceSyncJobMetrics.Builder> metrics) Maps a batch delete document request to a specific data source sync job.
DataSourceSyncJob.Builder	metrics(DataSourceSyncJobMetrics metrics) Maps a batch delete document request to a specific data source sync job.
DataSourceSyncJob.Builder	startTime(Instant startTime) The UNIX datetime that the synchronization job was started.
DataSourceSyncJob.Builder	status(DataSourceSyncJobStatus status) The execution status of the synchronization job.
DataSourceSyncJob.Builder	status(String status) The execution status of the synchronization job.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

executionId

DataSourceSyncJob.Builder executionId(String executionId)

A unique identifier for the synchronization job.

Parameters:

executionId - A unique identifier for the synchronization job.

Returns:

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

startTime

DataSourceSyncJob.Builder startTime(Instant startTime)

The UNIX datetime that the synchronization job was started.

Parameters:

startTime - The UNIX datetime that the synchronization job was started.

Returns:

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

endTime

DataSourceSyncJob.Builder endTime(Instant endTime)

The UNIX datetime that the synchronization job was completed.

Parameters:

endTime - The UNIX datetime that the synchronization job was completed.

Returns:

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

status

DataSourceSyncJob.Builder status(String 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.

Parameters:

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.

Returns:

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

See Also:

DataSourceSyncJobStatus, DataSourceSyncJobStatus

status

DataSourceSyncJob.Builder status(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.

Parameters:

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.

Returns:

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

See Also:

DataSourceSyncJobStatus, DataSourceSyncJobStatus

errorMessage

DataSourceSyncJob.Builder errorMessage(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.

Parameters:

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:

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

errorCode

DataSourceSyncJob.Builder errorCode(String errorCode)

If the Status field is set to FAILED, the ErrorCode field contains a the reason that the synchronization failed.

Parameters:

errorCode - If the Status field is set to FAILED, the ErrorCode field contains a the reason that the synchronization failed.

Returns:

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

See Also:

ErrorCode, ErrorCode

errorCode

DataSourceSyncJob.Builder errorCode(ErrorCode errorCode)

If the Status field is set to FAILED, the ErrorCode field contains a the reason that the synchronization failed.

Parameters:

errorCode - If the Status field is set to FAILED, the ErrorCode field contains a the reason that the synchronization failed.

Returns:

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

See Also:

ErrorCode, ErrorCode

dataSourceErrorCode

DataSourceSyncJob.Builder dataSourceErrorCode(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.

Parameters:

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:

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

metrics

DataSourceSyncJob.Builder metrics(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.

Parameters:

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:

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

metrics

default DataSourceSyncJob.Builder metrics(Consumer<DataSourceSyncJobMetrics.Builder> 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.

This is a convenience that creates an instance of the DataSourceSyncJobMetrics.Builder avoiding the need to create one manually via DataSourceSyncJobMetrics.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to metrics(DataSourceSyncJobMetrics).

Parameters:

metrics - a consumer that will call methods on DataSourceSyncJobMetrics.Builder

Returns:

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

See Also:

metrics(DataSourceSyncJobMetrics)