Interface DescribeTaskExecutionResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<DescribeTaskExecutionResponse.Builder,
,DescribeTaskExecutionResponse> DataSyncResponse.Builder
,SdkBuilder<DescribeTaskExecutionResponse.Builder,
,DescribeTaskExecutionResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
DescribeTaskExecutionResponse
-
Method Summary
Modifier and TypeMethodDescriptionbytesCompressed
(Long bytesCompressed) The number of physical bytes that DataSync transfers over the network after compression (if compression is possible).bytesTransferred
(Long bytesTransferred) The number of bytes that DataSync sends to the network before compression (if compression is possible).bytesWritten
(Long bytesWritten) The number of logical bytes that DataSync actually writes to the destination location.The time that the transfer task ends.estimatedBytesToTransfer
(Long estimatedBytesToTransfer) The number of logical bytes that DataSync expects to write to the destination location.estimatedFilesToDelete
(Long estimatedFilesToDelete) The number of files, objects, and directories that DataSync expects to delete in your destination location.estimatedFilesToTransfer
(Long estimatedFilesToTransfer) The number of files, objects, and directories that DataSync expects to transfer over the network.excludes
(Collection<FilterRule> excludes) A list of filter rules that exclude specific data during your transfer.excludes
(Consumer<FilterRule.Builder>... excludes) A list of filter rules that exclude specific data during your transfer.excludes
(FilterRule... excludes) A list of filter rules that exclude specific data during your transfer.filesDeleted
(Long filesDeleted) The number of files, objects, and directories that DataSync actually deletes in your destination location.filesFailed
(Consumer<TaskExecutionFilesFailedDetail.Builder> filesFailed) The number of objects that DataSync fails to prepare, transfer, verify, and delete during your task execution.filesFailed
(TaskExecutionFilesFailedDetail filesFailed) The number of objects that DataSync fails to prepare, transfer, verify, and delete during your task execution.filesListed
(Consumer<TaskExecutionFilesListedDetail.Builder> filesListed) The number of objects that DataSync finds at your locations.filesListed
(TaskExecutionFilesListedDetail filesListed) The number of objects that DataSync finds at your locations.filesPrepared
(Long filesPrepared) The number of objects that DataSync will attempt to transfer after comparing your source and destination locations.filesSkipped
(Long filesSkipped) The number of files, objects, and directories that DataSync skips during your transfer.filesTransferred
(Long filesTransferred) The number of files, objects, and directories that DataSync actually transfers over the network.filesVerified
(Long filesVerified) The number of files, objects, and directories that DataSync verifies during your transfer.includes
(Collection<FilterRule> includes) A list of filter rules that include specific data during your transfer.includes
(Consumer<FilterRule.Builder>... includes) A list of filter rules that include specific data during your transfer.includes
(FilterRule... includes) A list of filter rules that include specific data during your transfer.launchTime
(Instant launchTime) The time that the task execution actually begins.manifestConfig
(Consumer<ManifestConfig.Builder> manifestConfig) The configuration of the manifest that lists the files or objects to transfer.manifestConfig
(ManifestConfig manifestConfig) The configuration of the manifest that lists the files or objects to transfer.options
(Consumer<Options.Builder> options) Sets the value of the Options property for this object.Sets the value of the Options property for this object.reportResult
(Consumer<ReportResult.Builder> reportResult) Indicates whether DataSync generated a complete task report for your transfer.reportResult
(ReportResult reportResult) Indicates whether DataSync generated a complete task report for your transfer.The result of the task execution.result
(TaskExecutionResultDetail result) The result of the task execution.The time that DataSync sends the request to start the task execution.The status of the task execution.status
(TaskExecutionStatus status) The status of the task execution.taskExecutionArn
(String taskExecutionArn) The ARN of the task execution that you wanted information about.The task mode that you're using.The task mode that you're using.taskReportConfig
(Consumer<TaskReportConfig.Builder> taskReportConfig) The configuration of your task report, which provides detailed information about for your DataSync transfer.taskReportConfig
(TaskReportConfig taskReportConfig) The configuration of your task report, which provides detailed information about for your DataSync transfer.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.datasync.model.DataSyncResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
taskExecutionArn
The ARN of the task execution that you wanted information about.
TaskExecutionArn
is hierarchical and includesTaskArn
for the task that was executed.For example, a
TaskExecution
value with the ARNarn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b
executed the task with the ARNarn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2
.- Parameters:
taskExecutionArn
- The ARN of the task execution that you wanted information about.TaskExecutionArn
is hierarchical and includesTaskArn
for the task that was executed.For example, a
TaskExecution
value with the ARNarn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b
executed the task with the ARNarn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
The status of the task execution.
- Parameters:
status
- The status of the task execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
The status of the task execution.
- Parameters:
status
- The status of the task execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
options
Sets the value of the Options property for this object.- Parameters:
options
- The new value for the Options property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
options
Sets the value of the Options property for this object. This is a convenience method that creates an instance of theOptions.Builder
avoiding the need to create one manually viaOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooptions(Options)
.- Parameters:
options
- a consumer that will call methods onOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
excludes
A list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.
- Parameters:
excludes
- A list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
excludes
A list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.
- Parameters:
excludes
- A list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
excludes
A list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.
This is a convenience method that creates an instance of theFilterRule.Builder
avoiding the need to create one manually viaFilterRule.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toexcludes(List<FilterRule>)
.- Parameters:
excludes
- a consumer that will call methods onFilterRule.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
includes
A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.
- Parameters:
includes
- A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
includes
A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.
- Parameters:
includes
- A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
includes
A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.
This is a convenience method that creates an instance of theFilterRule.Builder
avoiding the need to create one manually viaFilterRule.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toincludes(List<FilterRule>)
.- Parameters:
includes
- a consumer that will call methods onFilterRule.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
manifestConfig
The configuration of the manifest that lists the files or objects to transfer. For more information, see Specifying what DataSync transfers by using a manifest.
- Parameters:
manifestConfig
- The configuration of the manifest that lists the files or objects to transfer. For more information, see Specifying what DataSync transfers by using a manifest.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
manifestConfig
default DescribeTaskExecutionResponse.Builder manifestConfig(Consumer<ManifestConfig.Builder> manifestConfig) The configuration of the manifest that lists the files or objects to transfer. For more information, see Specifying what DataSync transfers by using a manifest.
This is a convenience method that creates an instance of theManifestConfig.Builder
avoiding the need to create one manually viaManifestConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomanifestConfig(ManifestConfig)
.- Parameters:
manifestConfig
- a consumer that will call methods onManifestConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
startTime
The time that DataSync sends the request to start the task execution. For non-queued tasks,
LaunchTime
andStartTime
are typically the same. For queued tasks,LaunchTime
is typically later thanStartTime
because previously queued tasks must finish running before newer tasks can begin.- Parameters:
startTime
- The time that DataSync sends the request to start the task execution. For non-queued tasks,LaunchTime
andStartTime
are typically the same. For queued tasks,LaunchTime
is typically later thanStartTime
because previously queued tasks must finish running before newer tasks can begin.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
estimatedFilesToTransfer
The number of files, objects, and directories that DataSync expects to transfer over the network. This value is calculated while DataSync prepares the transfer.
How this gets calculated depends primarily on your task’s transfer mode configuration:
-
If
TranserMode
is set toCHANGED
- The calculation is based on comparing the content of the source and destination locations and determining the difference that needs to be transferred. The difference can include:-
Anything that's added or modified at the source location.
-
Anything that's in both locations and modified at the destination after an initial transfer (unless OverwriteMode is set to
NEVER
). -
(Basic task mode only) The number of items that DataSync expects to delete (if PreserveDeletedFiles is set to
REMOVE
).
-
-
If
TranserMode
is set toALL
- The calculation is based only on the items that DataSync finds at the source location.
- Parameters:
estimatedFilesToTransfer
- The number of files, objects, and directories that DataSync expects to transfer over the network. This value is calculated while DataSync prepares the transfer.How this gets calculated depends primarily on your task’s transfer mode configuration:
-
If
TranserMode
is set toCHANGED
- The calculation is based on comparing the content of the source and destination locations and determining the difference that needs to be transferred. The difference can include:-
Anything that's added or modified at the source location.
-
Anything that's in both locations and modified at the destination after an initial transfer (unless OverwriteMode is set to
NEVER
). -
(Basic task mode only) The number of items that DataSync expects to delete (if PreserveDeletedFiles is set to
REMOVE
).
-
-
If
TranserMode
is set toALL
- The calculation is based only on the items that DataSync finds at the source location.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
estimatedBytesToTransfer
The number of logical bytes that DataSync expects to write to the destination location.
- Parameters:
estimatedBytesToTransfer
- The number of logical bytes that DataSync expects to write to the destination location.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filesTransferred
The number of files, objects, and directories that DataSync actually transfers over the network. This value is updated periodically during your task execution when something is read from the source and sent over the network.
If DataSync fails to transfer something, this value can be less than
EstimatedFilesToTransfer
. In some cases, this value can also be greater thanEstimatedFilesToTransfer
. This element is implementation-specific for some location types, so don't use it as an exact indication of what's transferring or to monitor your task execution.- Parameters:
filesTransferred
- The number of files, objects, and directories that DataSync actually transfers over the network. This value is updated periodically during your task execution when something is read from the source and sent over the network.If DataSync fails to transfer something, this value can be less than
EstimatedFilesToTransfer
. In some cases, this value can also be greater thanEstimatedFilesToTransfer
. This element is implementation-specific for some location types, so don't use it as an exact indication of what's transferring or to monitor your task execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
bytesWritten
The number of logical bytes that DataSync actually writes to the destination location.
- Parameters:
bytesWritten
- The number of logical bytes that DataSync actually writes to the destination location.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
bytesTransferred
The number of bytes that DataSync sends to the network before compression (if compression is possible). For the number of bytes transferred over the network, see BytesCompressed.
- Parameters:
bytesTransferred
- The number of bytes that DataSync sends to the network before compression (if compression is possible). For the number of bytes transferred over the network, see BytesCompressed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
bytesCompressed
The number of physical bytes that DataSync transfers over the network after compression (if compression is possible). This number is typically less than BytesTransferred unless the data isn't compressible.
- Parameters:
bytesCompressed
- The number of physical bytes that DataSync transfers over the network after compression (if compression is possible). This number is typically less than BytesTransferred unless the data isn't compressible.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
result
The result of the task execution.
- Parameters:
result
- The result of the task execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
result
default DescribeTaskExecutionResponse.Builder result(Consumer<TaskExecutionResultDetail.Builder> result) The result of the task execution.
This is a convenience method that creates an instance of theTaskExecutionResultDetail.Builder
avoiding the need to create one manually viaTaskExecutionResultDetail.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toresult(TaskExecutionResultDetail)
.- Parameters:
result
- a consumer that will call methods onTaskExecutionResultDetail.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
taskReportConfig
The configuration of your task report, which provides detailed information about for your DataSync transfer. For more information, see Creating a task report.
- Parameters:
taskReportConfig
- The configuration of your task report, which provides detailed information about for your DataSync transfer. For more information, see Creating a task report.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
taskReportConfig
default DescribeTaskExecutionResponse.Builder taskReportConfig(Consumer<TaskReportConfig.Builder> taskReportConfig) The configuration of your task report, which provides detailed information about for your DataSync transfer. For more information, see Creating a task report.
This is a convenience method that creates an instance of theTaskReportConfig.Builder
avoiding the need to create one manually viaTaskReportConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totaskReportConfig(TaskReportConfig)
.- Parameters:
taskReportConfig
- a consumer that will call methods onTaskReportConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
filesDeleted
The number of files, objects, and directories that DataSync actually deletes in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always
0
.- Parameters:
filesDeleted
- The number of files, objects, and directories that DataSync actually deletes in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always0
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filesSkipped
The number of files, objects, and directories that DataSync skips during your transfer.
- Parameters:
filesSkipped
- The number of files, objects, and directories that DataSync skips during your transfer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filesVerified
The number of files, objects, and directories that DataSync verifies during your transfer.
When you configure your task to verify only the data that's transferred, DataSync doesn't verify directories in some situations or files that fail to transfer.
- Parameters:
filesVerified
- The number of files, objects, and directories that DataSync verifies during your transfer.When you configure your task to verify only the data that's transferred, DataSync doesn't verify directories in some situations or files that fail to transfer.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
reportResult
Indicates whether DataSync generated a complete task report for your transfer.
- Parameters:
reportResult
- Indicates whether DataSync generated a complete task report for your transfer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
reportResult
default DescribeTaskExecutionResponse.Builder reportResult(Consumer<ReportResult.Builder> reportResult) Indicates whether DataSync generated a complete task report for your transfer.
This is a convenience method that creates an instance of theReportResult.Builder
avoiding the need to create one manually viaReportResult.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toreportResult(ReportResult)
.- Parameters:
reportResult
- a consumer that will call methods onReportResult.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
estimatedFilesToDelete
The number of files, objects, and directories that DataSync expects to delete in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always
0
.- Parameters:
estimatedFilesToDelete
- The number of files, objects, and directories that DataSync expects to delete in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always0
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
taskMode
The task mode that you're using. For more information, see Choosing a task mode for your data transfer.
- Parameters:
taskMode
- The task mode that you're using. For more information, see Choosing a task mode for your data transfer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
taskMode
The task mode that you're using. For more information, see Choosing a task mode for your data transfer.
- Parameters:
taskMode
- The task mode that you're using. For more information, see Choosing a task mode for your data transfer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
filesPrepared
The number of objects that DataSync will attempt to transfer after comparing your source and destination locations.
Applies only to Enhanced mode tasks.
This counter isn't applicable if you configure your task to transfer all data. In that scenario, DataSync copies everything from the source to the destination without comparing differences between the locations.
- Parameters:
filesPrepared
- The number of objects that DataSync will attempt to transfer after comparing your source and destination locations.Applies only to Enhanced mode tasks.
This counter isn't applicable if you configure your task to transfer all data. In that scenario, DataSync copies everything from the source to the destination without comparing differences between the locations.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filesListed
The number of objects that DataSync finds at your locations.
Applies only to Enhanced mode tasks.
- Parameters:
filesListed
- The number of objects that DataSync finds at your locations.Applies only to Enhanced mode tasks.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filesListed
default DescribeTaskExecutionResponse.Builder filesListed(Consumer<TaskExecutionFilesListedDetail.Builder> filesListed) The number of objects that DataSync finds at your locations.
Applies only to Enhanced mode tasks.
TaskExecutionFilesListedDetail.Builder
avoiding the need to create one manually viaTaskExecutionFilesListedDetail.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilesListed(TaskExecutionFilesListedDetail)
.- Parameters:
filesListed
- a consumer that will call methods onTaskExecutionFilesListedDetail.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
filesFailed
The number of objects that DataSync fails to prepare, transfer, verify, and delete during your task execution.
Applies only to Enhanced mode tasks.
- Parameters:
filesFailed
- The number of objects that DataSync fails to prepare, transfer, verify, and delete during your task execution.Applies only to Enhanced mode tasks.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filesFailed
default DescribeTaskExecutionResponse.Builder filesFailed(Consumer<TaskExecutionFilesFailedDetail.Builder> filesFailed) The number of objects that DataSync fails to prepare, transfer, verify, and delete during your task execution.
Applies only to Enhanced mode tasks.
TaskExecutionFilesFailedDetail.Builder
avoiding the need to create one manually viaTaskExecutionFilesFailedDetail.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilesFailed(TaskExecutionFilesFailedDetail)
.- Parameters:
filesFailed
- a consumer that will call methods onTaskExecutionFilesFailedDetail.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
launchTime
The time that the task execution actually begins. For non-queued tasks,
LaunchTime
andStartTime
are typically the same. For queued tasks,LaunchTime
is typically later thanStartTime
because previously queued tasks must finish running before newer tasks can begin.- Parameters:
launchTime
- The time that the task execution actually begins. For non-queued tasks,LaunchTime
andStartTime
are typically the same. For queued tasks,LaunchTime
is typically later thanStartTime
because previously queued tasks must finish running before newer tasks can begin.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endTime
The time that the transfer task ends.
- Parameters:
endTime
- The time that the transfer task ends.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-