DataSourceSyncJob (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kendra.model.DataSourceSyncJob

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DataSourceSyncJob
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides information about a data source synchronization job.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DataSourceSyncJob()

Constructors
Constructor and Description
`DataSourceSyncJob()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DataSourceSyncJob`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDataSourceErrorCode()` 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.
`Date`	`getEndTime()` The Unix timestamp when the synchronization job completed.
`String`	`getErrorCode()` If the `Status` field is set to `FAILED`, the `ErrorCode` field indicates the reason the synchronization failed.
`String`	`getErrorMessage()` If the `Status` field is set to `ERROR`, the `ErrorMessage` field contains a description of the error that caused the synchronization to fail.
`String`	`getExecutionId()` A identifier for the synchronization job.
`DataSourceSyncJobMetrics`	`getMetrics()` Maps a batch delete document request to a specific data source sync job.
`Date`	`getStartTime()` The Unix timestamp when the synchronization job started.
`String`	`getStatus()` The execution status of the synchronization job.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDataSourceErrorCode(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.
`void`	`setEndTime(Date endTime)` The Unix timestamp when the synchronization job completed.
`void`	`setErrorCode(String errorCode)` If the `Status` field is set to `FAILED`, the `ErrorCode` field indicates the reason the synchronization failed.
`void`	`setErrorMessage(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.
`void`	`setExecutionId(String executionId)` A identifier for the synchronization job.
`void`	`setMetrics(DataSourceSyncJobMetrics metrics)` Maps a batch delete document request to a specific data source sync job.
`void`	`setStartTime(Date startTime)` The Unix timestamp when the synchronization job started.
`void`	`setStatus(String status)` The execution status of the synchronization job.
`String`	`toString()` Returns a string representation of this object.
`DataSourceSyncJob`	`withDataSourceErrorCode(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`	`withEndTime(Date endTime)` The Unix timestamp when the synchronization job completed.
`DataSourceSyncJob`	`withErrorCode(ErrorCode errorCode)` If the `Status` field is set to `FAILED`, the `ErrorCode` field indicates the reason the synchronization failed.
`DataSourceSyncJob`	`withErrorCode(String errorCode)` If the `Status` field is set to `FAILED`, the `ErrorCode` field indicates the reason the synchronization failed.
`DataSourceSyncJob`	`withErrorMessage(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`	`withExecutionId(String executionId)` A identifier for the synchronization job.
`DataSourceSyncJob`	`withMetrics(DataSourceSyncJobMetrics metrics)` Maps a batch delete document request to a specific data source sync job.
`DataSourceSyncJob`	`withStartTime(Date startTime)` The Unix timestamp when the synchronization job started.
`DataSourceSyncJob`	`withStatus(DataSourceSyncJobStatus status)` The execution status of the synchronization job.
`DataSourceSyncJob`	`withStatus(String status)` The execution status of the synchronization job.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DataSourceSyncJob
```
public DataSourceSyncJob()
```
- Method Detail
  - setExecutionId
```
public void setExecutionId(String executionId)
```
    A identifier for the synchronization job.
    
    Parameters:
    
    executionId - A identifier for the synchronization job.
  - getExecutionId
```
public String getExecutionId()
```
    A identifier for the synchronization job.
    
    Returns:
    
    A identifier for the synchronization job.
  - withExecutionId
```
public DataSourceSyncJob withExecutionId(String 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.
  - setStartTime
```
public void setStartTime(Date startTime)
```
    The Unix timestamp when the synchronization job started.
    
    Parameters:
    
    startTime - The Unix timestamp when the synchronization job started.
  - getStartTime
```
public Date getStartTime()
```
    The Unix timestamp when the synchronization job started.
    
    Returns:
    
    The Unix timestamp when the synchronization job started.
  - withStartTime
```
public DataSourceSyncJob withStartTime(Date 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.
  - setEndTime
```
public void setEndTime(Date endTime)
```
    The Unix timestamp when the synchronization job completed.
    
    Parameters:
    
    endTime - The Unix timestamp when the synchronization job completed.
  - getEndTime
```
public Date getEndTime()
```
    The Unix timestamp when the synchronization job completed.
    
    Returns:
    
    The Unix timestamp when the synchronization job completed.
  - withEndTime
```
public DataSourceSyncJob withEndTime(Date 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.
  - setStatus
```
public void setStatus(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.
    
    See Also:
    
    DataSourceSyncJobStatus
  - getStatus
```
public String getStatus()
```
    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:
    
    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
  - withStatus
```
public DataSourceSyncJob withStatus(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
  - withStatus
```
public DataSourceSyncJob withStatus(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
  - setErrorMessage
```
public void setErrorMessage(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.
  - getErrorMessage
```
public String getErrorMessage()
```
    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.
  - withErrorMessage
```
public DataSourceSyncJob withErrorMessage(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.
  - setErrorCode
```
public void setErrorCode(String errorCode)
```
    If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.
    
    Parameters:
    
    errorCode - If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.
    
    See Also:
    
    ErrorCode
  - getErrorCode
```
public String getErrorCode()
```
    If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.
    
    Returns:
    
    If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.
    
    See Also:
    
    ErrorCode
  - withErrorCode
```
public DataSourceSyncJob withErrorCode(String errorCode)
```
    If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.
    
    Parameters:
    
    errorCode - If the Status field is set to FAILED, the ErrorCode 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
  - withErrorCode
```
public DataSourceSyncJob withErrorCode(ErrorCode errorCode)
```
    If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.
    
    Parameters:
    
    errorCode - If the Status field is set to FAILED, the ErrorCode 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
  - setDataSourceErrorCode
```
public void setDataSourceErrorCode(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.
  - getDataSourceErrorCode
```
public String getDataSourceErrorCode()
```
    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.
  - withDataSourceErrorCode
```
public DataSourceSyncJob withDataSourceErrorCode(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.
  - setMetrics
```
public void setMetrics(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.
  - getMetrics
```
public DataSourceSyncJobMetrics getMetrics()
```
    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.
  - withMetrics
```
public DataSourceSyncJob withMetrics(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.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DataSourceSyncJob clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.792

Class DataSourceSyncJob

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DataSourceSyncJob

Method Detail

setExecutionId

getExecutionId

withExecutionId

setStartTime

getStartTime

withStartTime

setEndTime

getEndTime

withEndTime

setStatus

getStatus

withStatus

withStatus

setErrorMessage

getErrorMessage

withErrorMessage

setErrorCode

getErrorCode

withErrorCode

withErrorCode

setDataSourceErrorCode

getDataSourceErrorCode

withDataSourceErrorCode

setMetrics

getMetrics

withMetrics

toString

equals

hashCode

clone

marshall