com.amazonaws.services.kendra.model

Class DataSourceSyncJob

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 synchronization job.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DataSourceSyncJob()

Method Summary

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 datetime that the synchronization job was completed.
String	getErrorCode() If the Status field is set to FAILED, the ErrorCode field contains a the reason that 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 unique identifier for the synchronization job.
Date	getStartTime() The UNIX datetime that the synchronization job was started.
String	getStatus() The execution status of the synchronization job.
int	hashCode()
void	marshall(ProtocolMarshaller 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 datetime that the synchronization job was completed.
void	setErrorCode(String errorCode) If the Status field is set to FAILED, the ErrorCode field contains a the reason that 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 unique identifier for the synchronization job.
void	setStartTime(Date startTime) The UNIX datetime that the synchronization job was 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 datetime that the synchronization job was completed.
DataSourceSyncJob	withErrorCode(ErrorCode errorCode) If the Status field is set to FAILED, the ErrorCode field contains a the reason that the synchronization failed.
DataSourceSyncJob	withErrorCode(String errorCode) If the Status field is set to FAILED, the ErrorCode field contains a the reason that 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 unique identifier for the synchronization job.
DataSourceSyncJob	withStartTime(Date startTime) The UNIX datetime that the synchronization job was 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

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DataSourceSyncJob

public DataSourceSyncJob()

Method Detail

setExecutionId

public void setExecutionId(String executionId)

A unique identifier for the synchronization job.

Parameters:

executionId - A unique identifier for the synchronization job.

getExecutionId

public String getExecutionId()

A unique identifier for the synchronization job.

Returns:

A unique identifier for the synchronization job.

withExecutionId

public DataSourceSyncJob withExecutionId(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.

setStartTime

public void setStartTime(Date startTime)

The UNIX datetime that the synchronization job was started.

Parameters:

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

getStartTime

public Date getStartTime()

The UNIX datetime that the synchronization job was started.

Returns:

The UNIX datetime that the synchronization job was started.

withStartTime

public DataSourceSyncJob withStartTime(Date 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.

setEndTime

public void setEndTime(Date endTime)

The UNIX datetime that the synchronization job was completed.

Parameters:

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

getEndTime

public Date getEndTime()

The UNIX datetime that the synchronization job was completed.

Returns:

The UNIX datetime that the synchronization job was completed.

withEndTime

public DataSourceSyncJob withEndTime(Date 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.

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 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.

See Also:

ErrorCode

getErrorCode

public String getErrorCode()

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

Returns:

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

See Also:

ErrorCode

withErrorCode

public DataSourceSyncJob withErrorCode(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

withErrorCode

public DataSourceSyncJob withErrorCode(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

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.

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)

Specified by:

marshall in interface StructuredPojo