com.amazonaws.services.iotdata

Interface AWSIotDataAsync

All Superinterfaces:

AWSIotData

All Known Implementing Classes:

AbstractAWSIotDataAsync, AWSIotDataAsyncClient

public interface AWSIotDataAsync
extends AWSIotData

Interface for accessing AWS IoT Data Plane asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

AWS IoT (Beta)

AWS IoT is considered a beta service as defined in the Service Terms

AWS IoT-Data enables secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. It implements a broker for applications and things to publish messages over HTTP (Publish) and retrieve, update, and delete thing shadows. A thing shadow is a persistent representation of your things and their state in the AWS cloud.

Method Summary

Methods

Modifier and Type	Method and Description
Future<DeleteThingShadowResult>	deleteThingShadowAsync(DeleteThingShadowRequest deleteThingShadowRequest) Deletes the thing shadow for the specified thing.
Future<DeleteThingShadowResult>	deleteThingShadowAsync(DeleteThingShadowRequest deleteThingShadowRequest, AsyncHandler<DeleteThingShadowRequest,DeleteThingShadowResult> asyncHandler) Deletes the thing shadow for the specified thing.
Future<GetThingShadowResult>	getThingShadowAsync(GetThingShadowRequest getThingShadowRequest) Gets the thing shadow for the specified thing.
Future<GetThingShadowResult>	getThingShadowAsync(GetThingShadowRequest getThingShadowRequest, AsyncHandler<GetThingShadowRequest,GetThingShadowResult> asyncHandler) Gets the thing shadow for the specified thing.
Future<Void>	publishAsync(PublishRequest publishRequest) Publishes state information.
Future<Void>	publishAsync(PublishRequest publishRequest, AsyncHandler<PublishRequest,Void> asyncHandler) Publishes state information.
Future<UpdateThingShadowResult>	updateThingShadowAsync(UpdateThingShadowRequest updateThingShadowRequest) Updates the thing shadow for the specified thing.
Future<UpdateThingShadowResult>	updateThingShadowAsync(UpdateThingShadowRequest updateThingShadowRequest, AsyncHandler<UpdateThingShadowRequest,UpdateThingShadowResult> asyncHandler) Updates the thing shadow for the specified thing.

Methods inherited from interface com.amazonaws.services.iotdata.AWSIotData

deleteThingShadow, getCachedResponseMetadata, getThingShadow, publish, setEndpoint, setRegion, shutdown, updateThingShadow

Method Detail

deleteThingShadowAsync

Future<DeleteThingShadowResult> deleteThingShadowAsync(DeleteThingShadowRequest deleteThingShadowRequest)

Deletes the thing shadow for the specified thing.

For more information, see DeleteThingShadow in the AWS IoT Developer Guide.

Parameters:

deleteThingShadowRequest - The input for the DeleteThingShadow operation.

Returns:

A Java Future containing the result of the DeleteThingShadow operation returned by the service.

deleteThingShadowAsync

Future<DeleteThingShadowResult> deleteThingShadowAsync(DeleteThingShadowRequest deleteThingShadowRequest,
                                                     AsyncHandler<DeleteThingShadowRequest,DeleteThingShadowResult> asyncHandler)

Deletes the thing shadow for the specified thing.

For more information, see DeleteThingShadow in the AWS IoT Developer Guide.

Parameters:

deleteThingShadowRequest - The input for the DeleteThingShadow operation.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteThingShadow operation returned by the service.

getThingShadowAsync

Future<GetThingShadowResult> getThingShadowAsync(GetThingShadowRequest getThingShadowRequest)

Gets the thing shadow for the specified thing.

For more information, see GetThingShadow in the AWS IoT Developer Guide.

Parameters:

getThingShadowRequest - The input for the GetThingShadow operation.

Returns:

A Java Future containing the result of the GetThingShadow operation returned by the service.

getThingShadowAsync

Future<GetThingShadowResult> getThingShadowAsync(GetThingShadowRequest getThingShadowRequest,
                                               AsyncHandler<GetThingShadowRequest,GetThingShadowResult> asyncHandler)

Gets the thing shadow for the specified thing.

For more information, see GetThingShadow in the AWS IoT Developer Guide.

Parameters:

getThingShadowRequest - The input for the GetThingShadow operation.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetThingShadow operation returned by the service.

publishAsync

Future<Void> publishAsync(PublishRequest publishRequest)

Publishes state information.

For more information, see HTTP Protocol in the AWS IoT Developer Guide.

Parameters:

publishRequest - The input for the Publish operation.

publishAsync

Future<Void> publishAsync(PublishRequest publishRequest,
                        AsyncHandler<PublishRequest,Void> asyncHandler)

Publishes state information.

For more information, see HTTP Protocol in the AWS IoT Developer Guide.

Parameters:

publishRequest - The input for the Publish operation.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

updateThingShadowAsync

Future<UpdateThingShadowResult> updateThingShadowAsync(UpdateThingShadowRequest updateThingShadowRequest)

Updates the thing shadow for the specified thing.

For more information, see UpdateThingShadow in the AWS IoT Developer Guide.

Parameters:

updateThingShadowRequest - The input for the UpdateThingShadow operation.

Returns:

A Java Future containing the result of the UpdateThingShadow operation returned by the service.

updateThingShadowAsync

Future<UpdateThingShadowResult> updateThingShadowAsync(UpdateThingShadowRequest updateThingShadowRequest,
                                                     AsyncHandler<UpdateThingShadowRequest,UpdateThingShadowResult> asyncHandler)

Updates the thing shadow for the specified thing.

For more information, see UpdateThingShadow in the AWS IoT Developer Guide.

Parameters:

updateThingShadowRequest - The input for the UpdateThingShadow operation.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UpdateThingShadow operation returned by the service.