Interface DataSourceSyncJob.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<DataSourceSyncJob.Builder,
,DataSourceSyncJob> SdkBuilder<DataSourceSyncJob.Builder,
,DataSourceSyncJob> SdkPojo
- Enclosing class:
DataSourceSyncJob
-
Method Summary
Modifier and TypeMethodDescriptiondataSourceErrorCode
(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.The Unix timestamp when the synchronization job completed.If theStatus
field is set toFAILED
, theErrorCode
field indicates the reason the synchronization failed.If theStatus
field is set toFAILED
, theErrorCode
field indicates the reason the synchronization failed.errorMessage
(String errorMessage) If theStatus
field is set toERROR
, theErrorMessage
field contains a description of the error that caused the synchronization to fail.executionId
(String executionId) A 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.metrics
(DataSourceSyncJobMetrics metrics) Maps a batch delete document request to a specific data source sync job.The Unix timestamp when the synchronization job started.The execution status of the synchronization job.status
(DataSourceSyncJobStatus status) The execution status of the synchronization job.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
executionId
A identifier for the synchronization job.
- Parameters:
executionId
- A identifier for the synchronization job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
startTime
The Unix timestamp when the synchronization job started.
- Parameters:
startTime
- The Unix timestamp when the synchronization job started.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endTime
The Unix timestamp when the synchronization job completed.
- Parameters:
endTime
- The Unix timestamp when the synchronization job completed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
The execution status of the synchronization job. When the
Status
field is set toSUCCEEDED
, the synchronization job is done. If the status code is set toFAILED
, theErrorCode
andErrorMessage
fields give you the reason for the failure.- Parameters:
status
- The execution status of the synchronization job. When theStatus
field is set toSUCCEEDED
, the synchronization job is done. If the status code is set toFAILED
, theErrorCode
andErrorMessage
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:
-
status
The execution status of the synchronization job. When the
Status
field is set toSUCCEEDED
, the synchronization job is done. If the status code is set toFAILED
, theErrorCode
andErrorMessage
fields give you the reason for the failure.- Parameters:
status
- The execution status of the synchronization job. When theStatus
field is set toSUCCEEDED
, the synchronization job is done. If the status code is set toFAILED
, theErrorCode
andErrorMessage
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:
-
errorMessage
If the
Status
field is set toERROR
, theErrorMessage
field contains a description of the error that caused the synchronization to fail.- Parameters:
errorMessage
- If theStatus
field is set toERROR
, theErrorMessage
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
If the
Status
field is set toFAILED
, theErrorCode
field indicates the reason the synchronization failed.- Parameters:
errorCode
- If theStatus
field is set toFAILED
, theErrorCode
field indicates the reason the synchronization failed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
errorCode
If the
Status
field is set toFAILED
, theErrorCode
field indicates the reason the synchronization failed.- Parameters:
errorCode
- If theStatus
field is set toFAILED
, theErrorCode
field indicates the reason the synchronization failed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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 method that creates an instance of theDataSourceSyncJobMetrics.Builder
avoiding the need to create one manually viaDataSourceSyncJobMetrics.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tometrics(DataSourceSyncJobMetrics)
.- Parameters:
metrics
- a consumer that will call methods onDataSourceSyncJobMetrics.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-