## Interface TransferDeviceAsync

  * All Superinterfaces:
    AutoCloseable

All Known Implementing Classes:
    TransferDeviceAsyncClient

Data Transfer Service API Specification




  *     * ### Method Summary

All MethodsInstance MethodsAbstract Methods Modifier and Type | Method and Description  
---|---  
`Future<CreateTransferDeviceResponse>` | `createTransferDevice(CreateTransferDeviceRequest request, AsyncHandler<CreateTransferDeviceRequest,CreateTransferDeviceResponse> handler)` Create a new Transfer Device  
`Future<DeleteTransferDeviceResponse>` | `deleteTransferDevice(DeleteTransferDeviceRequest request, AsyncHandler<DeleteTransferDeviceRequest,DeleteTransferDeviceResponse> handler)` deletes a transfer Device  
`String` | `getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)  
`Future<GetTransferDeviceResponse>` | `getTransferDevice(GetTransferDeviceRequest request, AsyncHandler<GetTransferDeviceRequest,GetTransferDeviceResponse> handler)` Describes a transfer package in detail  
`Future<ListTransferDevicesResponse>` | `listTransferDevices(ListTransferDevicesRequest request, AsyncHandler<ListTransferDevicesRequest,ListTransferDevicesResponse> handler)` Lists Transfer Devices associated with a transferJob  
`void` | `refreshClient()` Rebuilds the client from scratch.  
`void` | `setEndpoint(String endpoint)` Sets the endpoint to call (ex, https://www.example.com).  
`void` | `setRegion(Region region)` Sets the region to call (ex, Region.US_PHOENIX_1).  
`void` | `setRegion(String regionId)` Sets the region to call (ex, ‘us-phoenix-1’).  
`Future<UpdateTransferDeviceResponse>` | `updateTransferDevice(UpdateTransferDeviceRequest request, AsyncHandler<UpdateTransferDeviceRequest,UpdateTransferDeviceResponse> handler)` Updates a Transfer Device  
`void` | `useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)` Determines whether realm specific endpoint should be used or not.  
      * ### Methods inherited from interface java.lang.AutoCloseable

`close`



  *     * ### Method Detail

      * #### refreshClient
            
            void refreshClient()

Rebuilds the client from scratch. Useful to refresh certificates.

      * #### setEndpoint
            
            void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:
    `endpoint` \- The endpoint of the serice.
      * #### getEndpoint
            
            String getEndpoint()

Gets the set endpoint for REST call (ex, https://www.example.com)

      * #### setRegion
            
            void setRegion(Region region)

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call `setEndpoint` after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.

Parameters:
    `region` \- The region of the service.
      * #### setRegion
            
            void setRegion(String regionId)

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call `setRegion`. 

If no known Region could be determined, it will create an endpoint based on the default endpoint format (`Region.formatDefaultRegionEndpoint(Service, String)` and then call `setEndpoint`.

Parameters:
    `regionId` \- The public region ID.
      * #### useRealmSpecificEndpointTemplate
            
            void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)

Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

Parameters:
    `realmSpecificEndpointTemplateEnabled` \- flag to enable the use of realm specific endpoint template
      * #### createTransferDevice
            
            Future<CreateTransferDeviceResponse> createTransferDevice(CreateTransferDeviceRequest request,
                                                                      AsyncHandler<CreateTransferDeviceRequest,CreateTransferDeviceResponse> handler)

Create a new Transfer Device

Parameters:
    `request` \- The request object containing the details to send
    `handler` \- The request handler to invoke upon completion, may be null.
Returns:
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
      * #### deleteTransferDevice
            
            Future<DeleteTransferDeviceResponse> deleteTransferDevice(DeleteTransferDeviceRequest request,
                                                                      AsyncHandler<DeleteTransferDeviceRequest,DeleteTransferDeviceResponse> handler)

deletes a transfer Device

Parameters:
    `request` \- The request object containing the details to send
    `handler` \- The request handler to invoke upon completion, may be null.
Returns:
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
      * #### getTransferDevice
            
            Future<GetTransferDeviceResponse> getTransferDevice(GetTransferDeviceRequest request,
                                                                AsyncHandler<GetTransferDeviceRequest,GetTransferDeviceResponse> handler)

Describes a transfer package in detail

Parameters:
    `request` \- The request object containing the details to send
    `handler` \- The request handler to invoke upon completion, may be null.
Returns:
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
      * #### listTransferDevices
            
            Future<ListTransferDevicesResponse> listTransferDevices(ListTransferDevicesRequest request,
                                                                    AsyncHandler<ListTransferDevicesRequest,ListTransferDevicesResponse> handler)

Lists Transfer Devices associated with a transferJob

Parameters:
    `request` \- The request object containing the details to send
    `handler` \- The request handler to invoke upon completion, may be null.
Returns:
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
      * #### updateTransferDevice
            
            Future<UpdateTransferDeviceResponse> updateTransferDevice(UpdateTransferDeviceRequest request,
                                                                      AsyncHandler<UpdateTransferDeviceRequest,UpdateTransferDeviceResponse> handler)

Updates a Transfer Device

Parameters:
    `request` \- The request object containing the details to send
    `handler` \- The request handler to invoke upon completion, may be null.
Returns:
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.