@Generated(value="software.amazon.awssdk:codegen") public interface DataSyncAsyncClient extends SdkClient
builder()
method.
AWS DataSync is a managed data transfer service that makes it simpler for you to automate moving data between on-premises storage and Amazon Simple Storage Service (Amazon S3) or Amazon Elastic File System (Amazon EFS).
This API interface reference for AWS DataSync contains documentation for a programming interface that you can use to manage AWS DataSync.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static DataSyncAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
DataSyncAsyncClient . |
default CompletableFuture<CancelTaskExecutionResponse> |
cancelTaskExecution(CancelTaskExecutionRequest cancelTaskExecutionRequest)
Cancels execution of a task.
|
default CompletableFuture<CancelTaskExecutionResponse> |
cancelTaskExecution(Consumer<CancelTaskExecutionRequest.Builder> cancelTaskExecutionRequest)
Cancels execution of a task.
|
static DataSyncAsyncClient |
create()
Create a
DataSyncAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<CreateAgentResponse> |
createAgent(Consumer<CreateAgentRequest.Builder> createAgentRequest)
Activates an AWS DataSync agent that you have deployed on your host.
|
default CompletableFuture<CreateAgentResponse> |
createAgent(CreateAgentRequest createAgentRequest)
Activates an AWS DataSync agent that you have deployed on your host.
|
default CompletableFuture<CreateLocationEfsResponse> |
createLocationEfs(Consumer<CreateLocationEfsRequest.Builder> createLocationEfsRequest)
Creates an endpoint for an Amazon EFS file system.
|
default CompletableFuture<CreateLocationEfsResponse> |
createLocationEfs(CreateLocationEfsRequest createLocationEfsRequest)
Creates an endpoint for an Amazon EFS file system.
|
default CompletableFuture<CreateLocationNfsResponse> |
createLocationNfs(Consumer<CreateLocationNfsRequest.Builder> createLocationNfsRequest)
Creates an endpoint for a Network File System (NFS) file system.
|
default CompletableFuture<CreateLocationNfsResponse> |
createLocationNfs(CreateLocationNfsRequest createLocationNfsRequest)
Creates an endpoint for a Network File System (NFS) file system.
|
default CompletableFuture<CreateLocationS3Response> |
createLocationS3(Consumer<CreateLocationS3Request.Builder> createLocationS3Request)
Creates an endpoint for an Amazon S3 bucket.
|
default CompletableFuture<CreateLocationS3Response> |
createLocationS3(CreateLocationS3Request createLocationS3Request)
Creates an endpoint for an Amazon S3 bucket.
|
default CompletableFuture<CreateTaskResponse> |
createTask(Consumer<CreateTaskRequest.Builder> createTaskRequest)
Creates a task.
|
default CompletableFuture<CreateTaskResponse> |
createTask(CreateTaskRequest createTaskRequest)
Creates a task.
|
default CompletableFuture<DeleteAgentResponse> |
deleteAgent(Consumer<DeleteAgentRequest.Builder> deleteAgentRequest)
Deletes an agent.
|
default CompletableFuture<DeleteAgentResponse> |
deleteAgent(DeleteAgentRequest deleteAgentRequest)
Deletes an agent.
|
default CompletableFuture<DeleteLocationResponse> |
deleteLocation(Consumer<DeleteLocationRequest.Builder> deleteLocationRequest)
Deletes the configuration of a location used by AWS DataSync.
|
default CompletableFuture<DeleteLocationResponse> |
deleteLocation(DeleteLocationRequest deleteLocationRequest)
Deletes the configuration of a location used by AWS DataSync.
|
default CompletableFuture<DeleteTaskResponse> |
deleteTask(Consumer<DeleteTaskRequest.Builder> deleteTaskRequest)
Deletes a task.
|
default CompletableFuture<DeleteTaskResponse> |
deleteTask(DeleteTaskRequest deleteTaskRequest)
Deletes a task.
|
default CompletableFuture<DescribeAgentResponse> |
describeAgent(Consumer<DescribeAgentRequest.Builder> describeAgentRequest)
Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running
or not) for an agent.
|
default CompletableFuture<DescribeAgentResponse> |
describeAgent(DescribeAgentRequest describeAgentRequest)
Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running
or not) for an agent.
|
default CompletableFuture<DescribeLocationEfsResponse> |
describeLocationEfs(Consumer<DescribeLocationEfsRequest.Builder> describeLocationEfsRequest)
Returns metadata, such as the path information about an Amazon EFS location.
|
default CompletableFuture<DescribeLocationEfsResponse> |
describeLocationEfs(DescribeLocationEfsRequest describeLocationEfsRequest)
Returns metadata, such as the path information about an Amazon EFS location.
|
default CompletableFuture<DescribeLocationNfsResponse> |
describeLocationNfs(Consumer<DescribeLocationNfsRequest.Builder> describeLocationNfsRequest)
Returns metadata, such as the path information, about a NFS location.
|
default CompletableFuture<DescribeLocationNfsResponse> |
describeLocationNfs(DescribeLocationNfsRequest describeLocationNfsRequest)
Returns metadata, such as the path information, about a NFS location.
|
default CompletableFuture<DescribeLocationS3Response> |
describeLocationS3(Consumer<DescribeLocationS3Request.Builder> describeLocationS3Request)
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
|
default CompletableFuture<DescribeLocationS3Response> |
describeLocationS3(DescribeLocationS3Request describeLocationS3Request)
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
|
default CompletableFuture<DescribeTaskResponse> |
describeTask(Consumer<DescribeTaskRequest.Builder> describeTaskRequest)
Returns metadata about a task.
|
default CompletableFuture<DescribeTaskResponse> |
describeTask(DescribeTaskRequest describeTaskRequest)
Returns metadata about a task.
|
default CompletableFuture<DescribeTaskExecutionResponse> |
describeTaskExecution(Consumer<DescribeTaskExecutionRequest.Builder> describeTaskExecutionRequest)
Returns detailed metadata about a task that is being executed.
|
default CompletableFuture<DescribeTaskExecutionResponse> |
describeTaskExecution(DescribeTaskExecutionRequest describeTaskExecutionRequest)
Returns detailed metadata about a task that is being executed.
|
default CompletableFuture<ListAgentsResponse> |
listAgents()
Returns a list of agents owned by an AWS account in the AWS Region specified in the request.
|
default CompletableFuture<ListAgentsResponse> |
listAgents(Consumer<ListAgentsRequest.Builder> listAgentsRequest)
Returns a list of agents owned by an AWS account in the AWS Region specified in the request.
|
default CompletableFuture<ListAgentsResponse> |
listAgents(ListAgentsRequest listAgentsRequest)
Returns a list of agents owned by an AWS account in the AWS Region specified in the request.
|
default ListAgentsPublisher |
listAgentsPaginator()
Returns a list of agents owned by an AWS account in the AWS Region specified in the request.
|
default ListAgentsPublisher |
listAgentsPaginator(Consumer<ListAgentsRequest.Builder> listAgentsRequest)
Returns a list of agents owned by an AWS account in the AWS Region specified in the request.
|
default ListAgentsPublisher |
listAgentsPaginator(ListAgentsRequest listAgentsRequest)
Returns a list of agents owned by an AWS account in the AWS Region specified in the request.
|
default CompletableFuture<ListLocationsResponse> |
listLocations()
Returns a lists of source and destination locations.
|
default CompletableFuture<ListLocationsResponse> |
listLocations(Consumer<ListLocationsRequest.Builder> listLocationsRequest)
Returns a lists of source and destination locations.
|
default CompletableFuture<ListLocationsResponse> |
listLocations(ListLocationsRequest listLocationsRequest)
Returns a lists of source and destination locations.
|
default ListLocationsPublisher |
listLocationsPaginator()
Returns a lists of source and destination locations.
|
default ListLocationsPublisher |
listLocationsPaginator(Consumer<ListLocationsRequest.Builder> listLocationsRequest)
Returns a lists of source and destination locations.
|
default ListLocationsPublisher |
listLocationsPaginator(ListLocationsRequest listLocationsRequest)
Returns a lists of source and destination locations.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns all the tags associated with a specified resources.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns all the tags associated with a specified resources.
|
default ListTagsForResourcePublisher |
listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns all the tags associated with a specified resources.
|
default ListTagsForResourcePublisher |
listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)
Returns all the tags associated with a specified resources.
|
default CompletableFuture<ListTaskExecutionsResponse> |
listTaskExecutions()
Returns a list of executed tasks.
|
default CompletableFuture<ListTaskExecutionsResponse> |
listTaskExecutions(Consumer<ListTaskExecutionsRequest.Builder> listTaskExecutionsRequest)
Returns a list of executed tasks.
|
default CompletableFuture<ListTaskExecutionsResponse> |
listTaskExecutions(ListTaskExecutionsRequest listTaskExecutionsRequest)
Returns a list of executed tasks.
|
default ListTaskExecutionsPublisher |
listTaskExecutionsPaginator()
Returns a list of executed tasks.
|
default ListTaskExecutionsPublisher |
listTaskExecutionsPaginator(Consumer<ListTaskExecutionsRequest.Builder> listTaskExecutionsRequest)
Returns a list of executed tasks.
|
default ListTaskExecutionsPublisher |
listTaskExecutionsPaginator(ListTaskExecutionsRequest listTaskExecutionsRequest)
Returns a list of executed tasks.
|
default CompletableFuture<ListTasksResponse> |
listTasks()
Returns a list of all the tasks.
|
default CompletableFuture<ListTasksResponse> |
listTasks(Consumer<ListTasksRequest.Builder> listTasksRequest)
Returns a list of all the tasks.
|
default CompletableFuture<ListTasksResponse> |
listTasks(ListTasksRequest listTasksRequest)
Returns a list of all the tasks.
|
default ListTasksPublisher |
listTasksPaginator()
Returns a list of all the tasks.
|
default ListTasksPublisher |
listTasksPaginator(Consumer<ListTasksRequest.Builder> listTasksRequest)
Returns a list of all the tasks.
|
default ListTasksPublisher |
listTasksPaginator(ListTasksRequest listTasksRequest)
Returns a list of all the tasks.
|
default CompletableFuture<StartTaskExecutionResponse> |
startTaskExecution(Consumer<StartTaskExecutionRequest.Builder> startTaskExecutionRequest)
Starts a specific invocation of a task.
|
default CompletableFuture<StartTaskExecutionResponse> |
startTaskExecution(StartTaskExecutionRequest startTaskExecutionRequest)
Starts a specific invocation of a task.
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Applies a key-value pair to an AWS resource.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Applies a key-value pair to an AWS resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes a tag from an AWS resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from an AWS resource.
|
default CompletableFuture<UpdateAgentResponse> |
updateAgent(Consumer<UpdateAgentRequest.Builder> updateAgentRequest)
Updates the name of an agent.
|
default CompletableFuture<UpdateAgentResponse> |
updateAgent(UpdateAgentRequest updateAgentRequest)
Updates the name of an agent.
|
default CompletableFuture<UpdateTaskResponse> |
updateTask(Consumer<UpdateTaskRequest.Builder> updateTaskRequest)
Updates the metadata associated with a task.
|
default CompletableFuture<UpdateTaskResponse> |
updateTask(UpdateTaskRequest updateTaskRequest)
Updates the metadata associated with a task.
|
serviceName
close
static final String SERVICE_NAME
static DataSyncAsyncClient create()
DataSyncAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static DataSyncAsyncClientBuilder builder()
DataSyncAsyncClient
.default CompletableFuture<CancelTaskExecutionResponse> cancelTaskExecution(CancelTaskExecutionRequest cancelTaskExecutionRequest)
Cancels execution of a task.
When you cancel a task execution, the transfer of some files are abruptly interrupted. The contents of files that are transferred to the destination might be incomplete or inconsistent with the source files. However, if you start a new task execution on the same task and you allow the task execution to complete, file content on the destination is complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, AWS DataSync successfully complete the transfer when you start the next task execution.
cancelTaskExecutionRequest
- CancelTaskExecutionRequestdefault CompletableFuture<CancelTaskExecutionResponse> cancelTaskExecution(Consumer<CancelTaskExecutionRequest.Builder> cancelTaskExecutionRequest)
Cancels execution of a task.
When you cancel a task execution, the transfer of some files are abruptly interrupted. The contents of files that are transferred to the destination might be incomplete or inconsistent with the source files. However, if you start a new task execution on the same task and you allow the task execution to complete, file content on the destination is complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, AWS DataSync successfully complete the transfer when you start the next task execution.
This is a convenience which creates an instance of the CancelTaskExecutionRequest.Builder
avoiding the
need to create one manually via CancelTaskExecutionRequest.builder()
cancelTaskExecutionRequest
- A Consumer
that will call methods on CancelTaskExecutionRequest.Builder
to create a
request. CancelTaskExecutionRequestdefault CompletableFuture<CreateAgentResponse> createAgent(CreateAgentRequest createAgentRequest)
Activates an AWS DataSync agent that you have deployed on your host. The activation process associates your agent with your account. In the activation process, you specify information such as the AWS Region that you want to activate the agent in. You activate the agent in the AWS Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this AWS Region.
You can use an agent for more than one location. If a task uses multiple agents, all of them need to have status AVAILABLE for the task to run. If you use multiple agents for a source location, the status of all the agents must be AVAILABLE for the task to run. For more information, see Activating a Sync Agent in the AWS DataSync User Guide.
Agents are automatically updated by AWS on a regular basis, using a mechanism that ensures minimal interruption to your tasks.
createAgentRequest
- CreateAgentRequestdefault CompletableFuture<CreateAgentResponse> createAgent(Consumer<CreateAgentRequest.Builder> createAgentRequest)
Activates an AWS DataSync agent that you have deployed on your host. The activation process associates your agent with your account. In the activation process, you specify information such as the AWS Region that you want to activate the agent in. You activate the agent in the AWS Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this AWS Region.
You can use an agent for more than one location. If a task uses multiple agents, all of them need to have status AVAILABLE for the task to run. If you use multiple agents for a source location, the status of all the agents must be AVAILABLE for the task to run. For more information, see Activating a Sync Agent in the AWS DataSync User Guide.
Agents are automatically updated by AWS on a regular basis, using a mechanism that ensures minimal interruption to your tasks.
This is a convenience which creates an instance of the CreateAgentRequest.Builder
avoiding the need to
create one manually via CreateAgentRequest.builder()
createAgentRequest
- A Consumer
that will call methods on CreateAgentRequest.Builder
to create a request.
CreateAgentRequestdefault CompletableFuture<CreateLocationEfsResponse> createLocationEfs(CreateLocationEfsRequest createLocationEfsRequest)
Creates an endpoint for an Amazon EFS file system.
createLocationEfsRequest
- CreateLocationEfsRequestdefault CompletableFuture<CreateLocationEfsResponse> createLocationEfs(Consumer<CreateLocationEfsRequest.Builder> createLocationEfsRequest)
Creates an endpoint for an Amazon EFS file system.
This is a convenience which creates an instance of the CreateLocationEfsRequest.Builder
avoiding the need
to create one manually via CreateLocationEfsRequest.builder()
createLocationEfsRequest
- A Consumer
that will call methods on CreateLocationEfsRequest.Builder
to create a request.
CreateLocationEfsRequestdefault CompletableFuture<CreateLocationNfsResponse> createLocationNfs(CreateLocationNfsRequest createLocationNfsRequest)
Creates an endpoint for a Network File System (NFS) file system.
createLocationNfsRequest
- CreateLocationNfsRequestdefault CompletableFuture<CreateLocationNfsResponse> createLocationNfs(Consumer<CreateLocationNfsRequest.Builder> createLocationNfsRequest)
Creates an endpoint for a Network File System (NFS) file system.
This is a convenience which creates an instance of the CreateLocationNfsRequest.Builder
avoiding the need
to create one manually via CreateLocationNfsRequest.builder()
createLocationNfsRequest
- A Consumer
that will call methods on CreateLocationNfsRequest.Builder
to create a request.
CreateLocationNfsRequestdefault CompletableFuture<CreateLocationS3Response> createLocationS3(CreateLocationS3Request createLocationS3Request)
Creates an endpoint for an Amazon S3 bucket.
For AWS DataSync to access a destination S3 bucket, it needs an AWS Identity and Access Management (IAM) role that has the required permissions. You can set up the required permissions by creating an IAM policy that grants the required permissions and attaching the policy to the role. An example of such a policy is shown in the examples section. For more information, see Configuring Amazon S3 Location Settings in the AWS DataSync User Guide.
createLocationS3Request
- CreateLocationS3Requestdefault CompletableFuture<CreateLocationS3Response> createLocationS3(Consumer<CreateLocationS3Request.Builder> createLocationS3Request)
Creates an endpoint for an Amazon S3 bucket.
For AWS DataSync to access a destination S3 bucket, it needs an AWS Identity and Access Management (IAM) role that has the required permissions. You can set up the required permissions by creating an IAM policy that grants the required permissions and attaching the policy to the role. An example of such a policy is shown in the examples section. For more information, see Configuring Amazon S3 Location Settings in the AWS DataSync User Guide.
This is a convenience which creates an instance of the CreateLocationS3Request.Builder
avoiding the need
to create one manually via CreateLocationS3Request.builder()
createLocationS3Request
- A Consumer
that will call methods on CreateLocationS3Request.Builder
to create a request.
CreateLocationS3Requestdefault CompletableFuture<CreateTaskResponse> createTask(CreateTaskRequest createTaskRequest)
Creates a task. A task is a set of two locations (source and destination) and a set of default
OverrideOptions
that you use to control the behavior of a task. If you don't specify default values
for Options
when you create a task, AWS DataSync populates them with safe service defaults.
When you initially create a task, it enters the INITIALIZING status and then the CREATING status. In CREATING status, AWS DataSync attempts to mount the source Network File System (NFS) location. The task transitions to the AVAILABLE status without waiting for the destination location to mount. Instead, AWS DataSync mounts a destination before every task execution and then unmounts it after every task execution.
If an agent that is associated with a source (NFS) location goes offline, the task transitions to the UNAVAILABLE
status. If the status of the task remains in the CREATING status for more than a few minutes, it means that your
agent might be having trouble mounting the source NFS file system. Check the task's ErrorCode
and
ErrorDetail
. Mount issues are often caused by either a misconfigured firewall or a mistyped NFS
server host name.
createTaskRequest
- CreateTaskRequestdefault CompletableFuture<CreateTaskResponse> createTask(Consumer<CreateTaskRequest.Builder> createTaskRequest)
Creates a task. A task is a set of two locations (source and destination) and a set of default
OverrideOptions
that you use to control the behavior of a task. If you don't specify default values
for Options
when you create a task, AWS DataSync populates them with safe service defaults.
When you initially create a task, it enters the INITIALIZING status and then the CREATING status. In CREATING status, AWS DataSync attempts to mount the source Network File System (NFS) location. The task transitions to the AVAILABLE status without waiting for the destination location to mount. Instead, AWS DataSync mounts a destination before every task execution and then unmounts it after every task execution.
If an agent that is associated with a source (NFS) location goes offline, the task transitions to the UNAVAILABLE
status. If the status of the task remains in the CREATING status for more than a few minutes, it means that your
agent might be having trouble mounting the source NFS file system. Check the task's ErrorCode
and
ErrorDetail
. Mount issues are often caused by either a misconfigured firewall or a mistyped NFS
server host name.
This is a convenience which creates an instance of the CreateTaskRequest.Builder
avoiding the need to
create one manually via CreateTaskRequest.builder()
createTaskRequest
- A Consumer
that will call methods on CreateTaskRequest.Builder
to create a request.
CreateTaskRequestdefault CompletableFuture<DeleteAgentResponse> deleteAgent(DeleteAgentRequest deleteAgentRequest)
Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your AWS account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment.
After you delete an agent, you can't reactivate it and you longer pay software charges for it.
deleteAgentRequest
- DeleteAgentRequestdefault CompletableFuture<DeleteAgentResponse> deleteAgent(Consumer<DeleteAgentRequest.Builder> deleteAgentRequest)
Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your AWS account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment.
After you delete an agent, you can't reactivate it and you longer pay software charges for it.
This is a convenience which creates an instance of the DeleteAgentRequest.Builder
avoiding the need to
create one manually via DeleteAgentRequest.builder()
deleteAgentRequest
- A Consumer
that will call methods on DeleteAgentRequest.Builder
to create a request.
DeleteAgentRequestdefault CompletableFuture<DeleteLocationResponse> deleteLocation(DeleteLocationRequest deleteLocationRequest)
Deletes the configuration of a location used by AWS DataSync.
deleteLocationRequest
- DeleteLocationdefault CompletableFuture<DeleteLocationResponse> deleteLocation(Consumer<DeleteLocationRequest.Builder> deleteLocationRequest)
Deletes the configuration of a location used by AWS DataSync.
This is a convenience which creates an instance of the DeleteLocationRequest.Builder
avoiding the need to
create one manually via DeleteLocationRequest.builder()
deleteLocationRequest
- A Consumer
that will call methods on DeleteLocationRequest.Builder
to create a request.
DeleteLocationdefault CompletableFuture<DeleteTaskResponse> deleteTask(DeleteTaskRequest deleteTaskRequest)
Deletes a task.
deleteTaskRequest
- DeleteTaskdefault CompletableFuture<DeleteTaskResponse> deleteTask(Consumer<DeleteTaskRequest.Builder> deleteTaskRequest)
Deletes a task.
This is a convenience which creates an instance of the DeleteTaskRequest.Builder
avoiding the need to
create one manually via DeleteTaskRequest.builder()
deleteTaskRequest
- A Consumer
that will call methods on DeleteTaskRequest.Builder
to create a request.
DeleteTaskdefault CompletableFuture<DescribeAgentResponse> describeAgent(DescribeAgentRequest describeAgentRequest)
Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running or not) for an agent. To specify which agent to describe, use the Amazon Resource Name (ARN) of the agent in your request.
describeAgentRequest
- DescribeAgentdefault CompletableFuture<DescribeAgentResponse> describeAgent(Consumer<DescribeAgentRequest.Builder> describeAgentRequest)
Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running or not) for an agent. To specify which agent to describe, use the Amazon Resource Name (ARN) of the agent in your request.
This is a convenience which creates an instance of the DescribeAgentRequest.Builder
avoiding the need to
create one manually via DescribeAgentRequest.builder()
describeAgentRequest
- A Consumer
that will call methods on DescribeAgentRequest.Builder
to create a request.
DescribeAgentdefault CompletableFuture<DescribeLocationEfsResponse> describeLocationEfs(DescribeLocationEfsRequest describeLocationEfsRequest)
Returns metadata, such as the path information about an Amazon EFS location.
describeLocationEfsRequest
- DescribeLocationEfsRequestdefault CompletableFuture<DescribeLocationEfsResponse> describeLocationEfs(Consumer<DescribeLocationEfsRequest.Builder> describeLocationEfsRequest)
Returns metadata, such as the path information about an Amazon EFS location.
This is a convenience which creates an instance of the DescribeLocationEfsRequest.Builder
avoiding the
need to create one manually via DescribeLocationEfsRequest.builder()
describeLocationEfsRequest
- A Consumer
that will call methods on DescribeLocationEfsRequest.Builder
to create a
request. DescribeLocationEfsRequestdefault CompletableFuture<DescribeLocationNfsResponse> describeLocationNfs(DescribeLocationNfsRequest describeLocationNfsRequest)
Returns metadata, such as the path information, about a NFS location.
describeLocationNfsRequest
- DescribeLocationNfsRequestdefault CompletableFuture<DescribeLocationNfsResponse> describeLocationNfs(Consumer<DescribeLocationNfsRequest.Builder> describeLocationNfsRequest)
Returns metadata, such as the path information, about a NFS location.
This is a convenience which creates an instance of the DescribeLocationNfsRequest.Builder
avoiding the
need to create one manually via DescribeLocationNfsRequest.builder()
describeLocationNfsRequest
- A Consumer
that will call methods on DescribeLocationNfsRequest.Builder
to create a
request. DescribeLocationNfsRequestdefault CompletableFuture<DescribeLocationS3Response> describeLocationS3(DescribeLocationS3Request describeLocationS3Request)
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
describeLocationS3Request
- DescribeLocationS3Requestdefault CompletableFuture<DescribeLocationS3Response> describeLocationS3(Consumer<DescribeLocationS3Request.Builder> describeLocationS3Request)
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
This is a convenience which creates an instance of the DescribeLocationS3Request.Builder
avoiding the
need to create one manually via DescribeLocationS3Request.builder()
describeLocationS3Request
- A Consumer
that will call methods on DescribeLocationS3Request.Builder
to create a
request. DescribeLocationS3Requestdefault CompletableFuture<DescribeTaskResponse> describeTask(DescribeTaskRequest describeTaskRequest)
Returns metadata about a task.
describeTaskRequest
- DescribeTaskRequestdefault CompletableFuture<DescribeTaskResponse> describeTask(Consumer<DescribeTaskRequest.Builder> describeTaskRequest)
Returns metadata about a task.
This is a convenience which creates an instance of the DescribeTaskRequest.Builder
avoiding the need to
create one manually via DescribeTaskRequest.builder()
describeTaskRequest
- A Consumer
that will call methods on DescribeTaskRequest.Builder
to create a request.
DescribeTaskRequestdefault CompletableFuture<DescribeTaskExecutionResponse> describeTaskExecution(DescribeTaskExecutionRequest describeTaskExecutionRequest)
Returns detailed metadata about a task that is being executed.
describeTaskExecutionRequest
- DescribeTaskExecutionRequestdefault CompletableFuture<DescribeTaskExecutionResponse> describeTaskExecution(Consumer<DescribeTaskExecutionRequest.Builder> describeTaskExecutionRequest)
Returns detailed metadata about a task that is being executed.
This is a convenience which creates an instance of the DescribeTaskExecutionRequest.Builder
avoiding the
need to create one manually via DescribeTaskExecutionRequest.builder()
describeTaskExecutionRequest
- A Consumer
that will call methods on DescribeTaskExecutionRequest.Builder
to create a
request. DescribeTaskExecutionRequestdefault CompletableFuture<ListAgentsResponse> listAgents(ListAgentsRequest listAgentsRequest)
Returns a list of agents owned by an AWS account in the AWS Region specified in the request. The returned list is ordered by agent Amazon Resource Name (ARN).
By default, this operation returns a maximum of 100 agents. This operation supports pagination that enables you to optionally reduce the number of agents returned in a response.
If you have more agents than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a marker that you can specify in your next request to fetch the next page of agents.
listAgentsRequest
- ListAgentsRequestdefault CompletableFuture<ListAgentsResponse> listAgents(Consumer<ListAgentsRequest.Builder> listAgentsRequest)
Returns a list of agents owned by an AWS account in the AWS Region specified in the request. The returned list is ordered by agent Amazon Resource Name (ARN).
By default, this operation returns a maximum of 100 agents. This operation supports pagination that enables you to optionally reduce the number of agents returned in a response.
If you have more agents than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a marker that you can specify in your next request to fetch the next page of agents.
This is a convenience which creates an instance of the ListAgentsRequest.Builder
avoiding the need to
create one manually via ListAgentsRequest.builder()
listAgentsRequest
- A Consumer
that will call methods on ListAgentsRequest.Builder
to create a request.
ListAgentsRequestdefault CompletableFuture<ListAgentsResponse> listAgents()
Returns a list of agents owned by an AWS account in the AWS Region specified in the request. The returned list is ordered by agent Amazon Resource Name (ARN).
By default, this operation returns a maximum of 100 agents. This operation supports pagination that enables you to optionally reduce the number of agents returned in a response.
If you have more agents than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a marker that you can specify in your next request to fetch the next page of agents.
default ListAgentsPublisher listAgentsPaginator()
Returns a list of agents owned by an AWS account in the AWS Region specified in the request. The returned list is ordered by agent Amazon Resource Name (ARN).
By default, this operation returns a maximum of 100 agents. This operation supports pagination that enables you to optionally reduce the number of agents returned in a response.
If you have more agents than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a marker that you can specify in your next request to fetch the next page of agents.
This is a variant of listAgents(software.amazon.awssdk.services.datasync.model.ListAgentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListAgentsPublisher publisher = client.listAgentsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListAgentsPublisher publisher = client.listAgentsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListAgentsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListAgentsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listAgents(software.amazon.awssdk.services.datasync.model.ListAgentsRequest)
operation.
default ListAgentsPublisher listAgentsPaginator(ListAgentsRequest listAgentsRequest)
Returns a list of agents owned by an AWS account in the AWS Region specified in the request. The returned list is ordered by agent Amazon Resource Name (ARN).
By default, this operation returns a maximum of 100 agents. This operation supports pagination that enables you to optionally reduce the number of agents returned in a response.
If you have more agents than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a marker that you can specify in your next request to fetch the next page of agents.
This is a variant of listAgents(software.amazon.awssdk.services.datasync.model.ListAgentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListAgentsPublisher publisher = client.listAgentsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListAgentsPublisher publisher = client.listAgentsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListAgentsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListAgentsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listAgents(software.amazon.awssdk.services.datasync.model.ListAgentsRequest)
operation.
listAgentsRequest
- ListAgentsRequestdefault ListAgentsPublisher listAgentsPaginator(Consumer<ListAgentsRequest.Builder> listAgentsRequest)
Returns a list of agents owned by an AWS account in the AWS Region specified in the request. The returned list is ordered by agent Amazon Resource Name (ARN).
By default, this operation returns a maximum of 100 agents. This operation supports pagination that enables you to optionally reduce the number of agents returned in a response.
If you have more agents than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a marker that you can specify in your next request to fetch the next page of agents.
This is a variant of listAgents(software.amazon.awssdk.services.datasync.model.ListAgentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListAgentsPublisher publisher = client.listAgentsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListAgentsPublisher publisher = client.listAgentsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListAgentsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListAgentsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listAgents(software.amazon.awssdk.services.datasync.model.ListAgentsRequest)
operation.
This is a convenience which creates an instance of the ListAgentsRequest.Builder
avoiding the need to
create one manually via ListAgentsRequest.builder()
listAgentsRequest
- A Consumer
that will call methods on ListAgentsRequest.Builder
to create a request.
ListAgentsRequestdefault CompletableFuture<ListLocationsResponse> listLocations(ListLocationsRequest listLocationsRequest)
Returns a lists of source and destination locations.
If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations.
listLocationsRequest
- ListLocationsRequestdefault CompletableFuture<ListLocationsResponse> listLocations(Consumer<ListLocationsRequest.Builder> listLocationsRequest)
Returns a lists of source and destination locations.
If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations.
This is a convenience which creates an instance of the ListLocationsRequest.Builder
avoiding the need to
create one manually via ListLocationsRequest.builder()
listLocationsRequest
- A Consumer
that will call methods on ListLocationsRequest.Builder
to create a request.
ListLocationsRequestdefault CompletableFuture<ListLocationsResponse> listLocations()
Returns a lists of source and destination locations.
If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations.
default ListLocationsPublisher listLocationsPaginator()
Returns a lists of source and destination locations.
If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations.
This is a variant of listLocations(software.amazon.awssdk.services.datasync.model.ListLocationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListLocationsPublisher publisher = client.listLocationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListLocationsPublisher publisher = client.listLocationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListLocationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListLocationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listLocations(software.amazon.awssdk.services.datasync.model.ListLocationsRequest)
operation.
default ListLocationsPublisher listLocationsPaginator(ListLocationsRequest listLocationsRequest)
Returns a lists of source and destination locations.
If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations.
This is a variant of listLocations(software.amazon.awssdk.services.datasync.model.ListLocationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListLocationsPublisher publisher = client.listLocationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListLocationsPublisher publisher = client.listLocationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListLocationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListLocationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listLocations(software.amazon.awssdk.services.datasync.model.ListLocationsRequest)
operation.
listLocationsRequest
- ListLocationsRequestdefault ListLocationsPublisher listLocationsPaginator(Consumer<ListLocationsRequest.Builder> listLocationsRequest)
Returns a lists of source and destination locations.
If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations.
This is a variant of listLocations(software.amazon.awssdk.services.datasync.model.ListLocationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListLocationsPublisher publisher = client.listLocationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListLocationsPublisher publisher = client.listLocationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListLocationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListLocationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listLocations(software.amazon.awssdk.services.datasync.model.ListLocationsRequest)
operation.
This is a convenience which creates an instance of the ListLocationsRequest.Builder
avoiding the need to
create one manually via ListLocationsRequest.builder()
listLocationsRequest
- A Consumer
that will call methods on ListLocationsRequest.Builder
to create a request.
ListLocationsRequestdefault CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns all the tags associated with a specified resources.
listTagsForResourceRequest
- ListTagsForResourceRequestdefault CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns all the tags associated with a specified resources.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder
avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest
- A Consumer
that will call methods on ListTagsForResourceRequest.Builder
to create a
request. ListTagsForResourceRequestdefault ListTagsForResourcePublisher listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)
Returns all the tags associated with a specified resources.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.datasync.model.ListTagsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListTagsForResourceResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListTagsForResourceResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.datasync.model.ListTagsForResourceRequest)
operation.
listTagsForResourceRequest
- ListTagsForResourceRequestdefault ListTagsForResourcePublisher listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns all the tags associated with a specified resources.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.datasync.model.ListTagsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListTagsForResourceResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListTagsForResourceResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.datasync.model.ListTagsForResourceRequest)
operation.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder
avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest
- A Consumer
that will call methods on ListTagsForResourceRequest.Builder
to create a
request. ListTagsForResourceRequestdefault CompletableFuture<ListTaskExecutionsResponse> listTaskExecutions(ListTaskExecutionsRequest listTaskExecutionsRequest)
Returns a list of executed tasks.
listTaskExecutionsRequest
- ListTaskExecutionsdefault CompletableFuture<ListTaskExecutionsResponse> listTaskExecutions(Consumer<ListTaskExecutionsRequest.Builder> listTaskExecutionsRequest)
Returns a list of executed tasks.
This is a convenience which creates an instance of the ListTaskExecutionsRequest.Builder
avoiding the
need to create one manually via ListTaskExecutionsRequest.builder()
listTaskExecutionsRequest
- A Consumer
that will call methods on ListTaskExecutionsRequest.Builder
to create a
request. ListTaskExecutionsdefault CompletableFuture<ListTaskExecutionsResponse> listTaskExecutions()
Returns a list of executed tasks.
default ListTaskExecutionsPublisher listTaskExecutionsPaginator()
Returns a list of executed tasks.
This is a variant of
listTaskExecutions(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsPublisher publisher = client.listTaskExecutionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsPublisher publisher = client.listTaskExecutionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListTaskExecutionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listTaskExecutions(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsRequest)
operation.
default ListTaskExecutionsPublisher listTaskExecutionsPaginator(ListTaskExecutionsRequest listTaskExecutionsRequest)
Returns a list of executed tasks.
This is a variant of
listTaskExecutions(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsPublisher publisher = client.listTaskExecutionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsPublisher publisher = client.listTaskExecutionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListTaskExecutionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listTaskExecutions(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsRequest)
operation.
listTaskExecutionsRequest
- ListTaskExecutionsdefault ListTaskExecutionsPublisher listTaskExecutionsPaginator(Consumer<ListTaskExecutionsRequest.Builder> listTaskExecutionsRequest)
Returns a list of executed tasks.
This is a variant of
listTaskExecutions(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsPublisher publisher = client.listTaskExecutionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsPublisher publisher = client.listTaskExecutionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListTaskExecutionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listTaskExecutions(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsRequest)
operation.
This is a convenience which creates an instance of the ListTaskExecutionsRequest.Builder
avoiding the
need to create one manually via ListTaskExecutionsRequest.builder()
listTaskExecutionsRequest
- A Consumer
that will call methods on ListTaskExecutionsRequest.Builder
to create a
request. ListTaskExecutionsdefault CompletableFuture<ListTasksResponse> listTasks(ListTasksRequest listTasksRequest)
Returns a list of all the tasks.
listTasksRequest
- ListTasksRequestdefault CompletableFuture<ListTasksResponse> listTasks(Consumer<ListTasksRequest.Builder> listTasksRequest)
Returns a list of all the tasks.
This is a convenience which creates an instance of the ListTasksRequest.Builder
avoiding the need to
create one manually via ListTasksRequest.builder()
listTasksRequest
- A Consumer
that will call methods on ListTasksRequest.Builder
to create a request.
ListTasksRequestdefault CompletableFuture<ListTasksResponse> listTasks()
Returns a list of all the tasks.
default ListTasksPublisher listTasksPaginator()
Returns a list of all the tasks.
This is a variant of listTasks(software.amazon.awssdk.services.datasync.model.ListTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListTasksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListTasksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listTasks(software.amazon.awssdk.services.datasync.model.ListTasksRequest)
operation.
default ListTasksPublisher listTasksPaginator(ListTasksRequest listTasksRequest)
Returns a list of all the tasks.
This is a variant of listTasks(software.amazon.awssdk.services.datasync.model.ListTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListTasksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListTasksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listTasks(software.amazon.awssdk.services.datasync.model.ListTasksRequest)
operation.
listTasksRequest
- ListTasksRequestdefault ListTasksPublisher listTasksPaginator(Consumer<ListTasksRequest.Builder> listTasksRequest)
Returns a list of all the tasks.
This is a variant of listTasks(software.amazon.awssdk.services.datasync.model.ListTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datasync.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datasync.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListTasksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datasync.model.ListTasksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listTasks(software.amazon.awssdk.services.datasync.model.ListTasksRequest)
operation.
This is a convenience which creates an instance of the ListTasksRequest.Builder
avoiding the need to
create one manually via ListTasksRequest.builder()
listTasksRequest
- A Consumer
that will call methods on ListTasksRequest.Builder
to create a request.
ListTasksRequestdefault CompletableFuture<StartTaskExecutionResponse> startTaskExecution(StartTaskExecutionRequest startTaskExecutionRequest)
Starts a specific invocation of a task. A TaskExecution
value represents an individual run of a
task. Each task can have at most one TaskExecution
at a time.
TaskExecution
has the following transition phases: INITIALIZING | PREPARING | TRANSFERRING |
VERIFYING | SUCCESS/FAILURE.
For detailed information, see Task Execution in Components and Terminology in the AWS DataSync User Guide.
startTaskExecutionRequest
- StartTaskExecutionRequestdefault CompletableFuture<StartTaskExecutionResponse> startTaskExecution(Consumer<StartTaskExecutionRequest.Builder> startTaskExecutionRequest)
Starts a specific invocation of a task. A TaskExecution
value represents an individual run of a
task. Each task can have at most one TaskExecution
at a time.
TaskExecution
has the following transition phases: INITIALIZING | PREPARING | TRANSFERRING |
VERIFYING | SUCCESS/FAILURE.
For detailed information, see Task Execution in Components and Terminology in the AWS DataSync User Guide.
This is a convenience which creates an instance of the StartTaskExecutionRequest.Builder
avoiding the
need to create one manually via StartTaskExecutionRequest.builder()
startTaskExecutionRequest
- A Consumer
that will call methods on StartTaskExecutionRequest.Builder
to create a
request. StartTaskExecutionRequestdefault CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Applies a key-value pair to an AWS resource.
tagResourceRequest
- TagResourceRequestdefault CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Applies a key-value pair to an AWS resource.
This is a convenience which creates an instance of the TagResourceRequest.Builder
avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest
- A Consumer
that will call methods on TagResourceRequest.Builder
to create a request.
TagResourceRequestdefault CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from an AWS resource.
untagResourceRequest
- UntagResourceRequestdefault CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes a tag from an AWS resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder
avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest
- A Consumer
that will call methods on UntagResourceRequest.Builder
to create a request.
UntagResourceRequestdefault CompletableFuture<UpdateAgentResponse> updateAgent(UpdateAgentRequest updateAgentRequest)
Updates the name of an agent.
updateAgentRequest
- UpdateAgentRequestdefault CompletableFuture<UpdateAgentResponse> updateAgent(Consumer<UpdateAgentRequest.Builder> updateAgentRequest)
Updates the name of an agent.
This is a convenience which creates an instance of the UpdateAgentRequest.Builder
avoiding the need to
create one manually via UpdateAgentRequest.builder()
updateAgentRequest
- A Consumer
that will call methods on UpdateAgentRequest.Builder
to create a request.
UpdateAgentRequestdefault CompletableFuture<UpdateTaskResponse> updateTask(UpdateTaskRequest updateTaskRequest)
Updates the metadata associated with a task.
updateTaskRequest
- UpdateTaskResponsedefault CompletableFuture<UpdateTaskResponse> updateTask(Consumer<UpdateTaskRequest.Builder> updateTaskRequest)
Updates the metadata associated with a task.
This is a convenience which creates an instance of the UpdateTaskRequest.Builder
avoiding the need to
create one manually via UpdateTaskRequest.builder()
updateTaskRequest
- A Consumer
that will call methods on UpdateTaskRequest.Builder
to create a request.
UpdateTaskResponseCopyright © 2017 Amazon Web Services, Inc. All Rights Reserved.