com.amazonaws.services.datasync.model

Class TaskReportConfig

java.lang.Object

com.amazonaws.services.datasync.model.TaskReportConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TaskReportConfig
extends Object
implements Serializable, Cloneable, StructuredPojo

Specifies how you want to configure a task report, which provides detailed information about for your DataSync transfer.

For more information, see Task reports.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
TaskReportConfig()

Method Summary

Modifier and Type	Method and Description
TaskReportConfig	clone()
boolean	equals(Object obj)
ReportDestination	getDestination() Specifies the Amazon S3 bucket where DataSync uploads your task report.
String	getObjectVersionIds() Specifies whether your task report includes the new version of each object transferred into an S3 bucket.
String	getOutputType() Specifies the type of task report that you want:
ReportOverrides	getOverrides() Customizes the reporting level for aspects of your task report.
String	getReportLevel() Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setDestination(ReportDestination destination) Specifies the Amazon S3 bucket where DataSync uploads your task report.
void	setObjectVersionIds(String objectVersionIds) Specifies whether your task report includes the new version of each object transferred into an S3 bucket.
void	setOutputType(String outputType) Specifies the type of task report that you want:
void	setOverrides(ReportOverrides overrides) Customizes the reporting level for aspects of your task report.
void	setReportLevel(String reportLevel) Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.
String	toString() Returns a string representation of this object.
TaskReportConfig	withDestination(ReportDestination destination) Specifies the Amazon S3 bucket where DataSync uploads your task report.
TaskReportConfig	withObjectVersionIds(ObjectVersionIds objectVersionIds) Specifies whether your task report includes the new version of each object transferred into an S3 bucket.
TaskReportConfig	withObjectVersionIds(String objectVersionIds) Specifies whether your task report includes the new version of each object transferred into an S3 bucket.
TaskReportConfig	withOutputType(ReportOutputType outputType) Specifies the type of task report that you want:
TaskReportConfig	withOutputType(String outputType) Specifies the type of task report that you want:
TaskReportConfig	withOverrides(ReportOverrides overrides) Customizes the reporting level for aspects of your task report.
TaskReportConfig	withReportLevel(ReportLevel reportLevel) Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.
TaskReportConfig	withReportLevel(String reportLevel) Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TaskReportConfig

public TaskReportConfig()

Method Detail

setDestination

public void setDestination(ReportDestination destination)

Specifies the Amazon S3 bucket where DataSync uploads your task report. For more information, see Task reports.

Parameters:

destination - Specifies the Amazon S3 bucket where DataSync uploads your task report. For more information, see Task reports.

getDestination

public ReportDestination getDestination()

Specifies the Amazon S3 bucket where DataSync uploads your task report. For more information, see Task reports.

Returns:

Specifies the Amazon S3 bucket where DataSync uploads your task report. For more information, see Task reports.

withDestination

public TaskReportConfig withDestination(ReportDestination destination)

Specifies the Amazon S3 bucket where DataSync uploads your task report. For more information, see Task reports.

Parameters:

destination - Specifies the Amazon S3 bucket where DataSync uploads your task report. For more information, see Task reports.

Returns:

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

setOutputType

public void setOutputType(String outputType)

Specifies the type of task report that you want:

• SUMMARY_ONLY: Provides necessary details about your task, including the number of files, objects, and directories transferred and transfer duration.

• STANDARD: Provides complete details about your task, including a full list of files, objects, and directories that were transferred, skipped, verified, and more.

Parameters:

outputType - Specifies the type of task report that you want:

• SUMMARY_ONLY: Provides necessary details about your task, including the number of files, objects, and directories transferred and transfer duration.

• STANDARD: Provides complete details about your task, including a full list of files, objects, and directories that were transferred, skipped, verified, and more.

See Also:

ReportOutputType

getOutputType

public String getOutputType()

Specifies the type of task report that you want:

• SUMMARY_ONLY: Provides necessary details about your task, including the number of files, objects, and directories transferred and transfer duration.

• STANDARD: Provides complete details about your task, including a full list of files, objects, and directories that were transferred, skipped, verified, and more.

Returns:

Specifies the type of task report that you want:

• SUMMARY_ONLY: Provides necessary details about your task, including the number of files, objects, and directories transferred and transfer duration.

• STANDARD: Provides complete details about your task, including a full list of files, objects, and directories that were transferred, skipped, verified, and more.

See Also:

ReportOutputType

withOutputType

public TaskReportConfig withOutputType(String outputType)

Specifies the type of task report that you want:

• SUMMARY_ONLY: Provides necessary details about your task, including the number of files, objects, and directories transferred and transfer duration.

• STANDARD: Provides complete details about your task, including a full list of files, objects, and directories that were transferred, skipped, verified, and more.

Parameters:

outputType - Specifies the type of task report that you want:

• SUMMARY_ONLY: Provides necessary details about your task, including the number of files, objects, and directories transferred and transfer duration.

• STANDARD: Provides complete details about your task, including a full list of files, objects, and directories that were transferred, skipped, verified, and more.

Returns:

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

See Also:

ReportOutputType

withOutputType

public TaskReportConfig withOutputType(ReportOutputType outputType)

Specifies the type of task report that you want:

• SUMMARY_ONLY: Provides necessary details about your task, including the number of files, objects, and directories transferred and transfer duration.

• STANDARD: Provides complete details about your task, including a full list of files, objects, and directories that were transferred, skipped, verified, and more.

Parameters:

outputType - Specifies the type of task report that you want:

• SUMMARY_ONLY: Provides necessary details about your task, including the number of files, objects, and directories transferred and transfer duration.

• STANDARD: Provides complete details about your task, including a full list of files, objects, and directories that were transferred, skipped, verified, and more.

Returns:

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

See Also:

ReportOutputType

setReportLevel

public void setReportLevel(String reportLevel)

Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.

• ERRORS_ONLY: A report shows what DataSync was unable to transfer, skip, verify, and delete.

• SUCCESSES_AND_ERRORS: A report shows what DataSync was able and unable to transfer, skip, verify, and delete.

Parameters:

reportLevel - Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.

• ERRORS_ONLY: A report shows what DataSync was unable to transfer, skip, verify, and delete.

• SUCCESSES_AND_ERRORS: A report shows what DataSync was able and unable to transfer, skip, verify, and delete.

See Also:

ReportLevel

getReportLevel

public String getReportLevel()

Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.

• ERRORS_ONLY: A report shows what DataSync was unable to transfer, skip, verify, and delete.

• SUCCESSES_AND_ERRORS: A report shows what DataSync was able and unable to transfer, skip, verify, and delete.

Returns:

Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.

• ERRORS_ONLY: A report shows what DataSync was unable to transfer, skip, verify, and delete.

• SUCCESSES_AND_ERRORS: A report shows what DataSync was able and unable to transfer, skip, verify, and delete.

See Also:

ReportLevel

withReportLevel

public TaskReportConfig withReportLevel(String reportLevel)

Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.

• ERRORS_ONLY: A report shows what DataSync was unable to transfer, skip, verify, and delete.

• SUCCESSES_AND_ERRORS: A report shows what DataSync was able and unable to transfer, skip, verify, and delete.

Parameters:

reportLevel - Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.

• ERRORS_ONLY: A report shows what DataSync was unable to transfer, skip, verify, and delete.

• SUCCESSES_AND_ERRORS: A report shows what DataSync was able and unable to transfer, skip, verify, and delete.

Returns:

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

See Also:

ReportLevel

withReportLevel

public TaskReportConfig withReportLevel(ReportLevel reportLevel)

Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.

• ERRORS_ONLY: A report shows what DataSync was unable to transfer, skip, verify, and delete.

• SUCCESSES_AND_ERRORS: A report shows what DataSync was able and unable to transfer, skip, verify, and delete.

Parameters:

reportLevel - Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.

• ERRORS_ONLY: A report shows what DataSync was unable to transfer, skip, verify, and delete.

• SUCCESSES_AND_ERRORS: A report shows what DataSync was able and unable to transfer, skip, verify, and delete.

Returns:

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

See Also:

ReportLevel

setObjectVersionIds

public void setObjectVersionIds(String objectVersionIds)

Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you enable versioning on your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task execution.

Parameters:

objectVersionIds - Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you enable versioning on your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task execution.

See Also:

ObjectVersionIds

getObjectVersionIds

public String getObjectVersionIds()

Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you enable versioning on your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task execution.

Returns:

Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you enable versioning on your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task execution.

See Also:

ObjectVersionIds

withObjectVersionIds

public TaskReportConfig withObjectVersionIds(String objectVersionIds)

Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you enable versioning on your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task execution.

Parameters:

objectVersionIds - Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you enable versioning on your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task execution.

Returns:

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

See Also:

ObjectVersionIds

withObjectVersionIds

public TaskReportConfig withObjectVersionIds(ObjectVersionIds objectVersionIds)

Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you enable versioning on your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task execution.

Parameters:

objectVersionIds - Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you enable versioning on your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task execution.

Returns:

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

See Also:

ObjectVersionIds

setOverrides

public void setOverrides(ReportOverrides overrides)

Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that DataSync attempted to delete in your destination location.

Parameters:

overrides - Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that DataSync attempted to delete in your destination location.

getOverrides

public ReportOverrides getOverrides()

Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that DataSync attempted to delete in your destination location.

Returns:

Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that DataSync attempted to delete in your destination location.

withOverrides

public TaskReportConfig withOverrides(ReportOverrides overrides)

Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that DataSync attempted to delete in your destination location.

Parameters:

overrides - Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that DataSync attempted to delete in your destination location.

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