com.amazonaws.services.iotdata.AWSIotDataAsync Maven / Gradle / Ivy
/*
* Copyright 2015-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.iotdata;
import javax.annotation.Generated;
import com.amazonaws.services.iotdata.model.*;
/**
* 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 {@code AsyncHandler} can be used to receive
* notification when an asynchronous operation completes.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.iotdata.AbstractAWSIotDataAsync} instead.
*
*
* AWS IoT
*
* 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 shadows. A shadow is a persistent
* representation of your things and their state in the AWS cloud.
*
*
* Find the endpoint address for actions in the AWS IoT data plane by running this CLI command:
*
*
* aws iot describe-endpoint --endpoint-type iot:Data-ATS
*
*
* The service name used by AWS
* Signature Version 4 to sign requests is: iotdevicegateway.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSIotDataAsync extends AWSIotData {
/**
*
* Deletes the shadow for the specified thing.
*
*
* For more information, see DeleteThingShadow in
* the AWS IoT Developer Guide.
*
*
* @param deleteThingShadowRequest
* The input for the DeleteThingShadow operation.
* @return A Java Future containing the result of the DeleteThingShadow operation returned by the service.
* @sample AWSIotDataAsync.DeleteThingShadow
*/
java.util.concurrent.Future deleteThingShadowAsync(DeleteThingShadowRequest deleteThingShadowRequest);
/**
*
* Deletes the shadow for the specified thing.
*
*
* For more information, see DeleteThingShadow in
* the AWS IoT Developer Guide.
*
*
* @param deleteThingShadowRequest
* The input for the DeleteThingShadow operation.
* @param 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.
* @return A Java Future containing the result of the DeleteThingShadow operation returned by the service.
* @sample AWSIotDataAsyncHandler.DeleteThingShadow
*/
java.util.concurrent.Future deleteThingShadowAsync(DeleteThingShadowRequest deleteThingShadowRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets the shadow for the specified thing.
*
*
* For more information, see GetThingShadow in the AWS
* IoT Developer Guide.
*
*
* @param getThingShadowRequest
* The input for the GetThingShadow operation.
* @return A Java Future containing the result of the GetThingShadow operation returned by the service.
* @sample AWSIotDataAsync.GetThingShadow
*/
java.util.concurrent.Future getThingShadowAsync(GetThingShadowRequest getThingShadowRequest);
/**
*
* Gets the shadow for the specified thing.
*
*
* For more information, see GetThingShadow in the AWS
* IoT Developer Guide.
*
*
* @param getThingShadowRequest
* The input for the GetThingShadow operation.
* @param 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.
* @return A Java Future containing the result of the GetThingShadow operation returned by the service.
* @sample AWSIotDataAsyncHandler.GetThingShadow
*/
java.util.concurrent.Future getThingShadowAsync(GetThingShadowRequest getThingShadowRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists the shadows for the specified thing.
*
*
* @param listNamedShadowsForThingRequest
* @return A Java Future containing the result of the ListNamedShadowsForThing operation returned by the service.
* @sample AWSIotDataAsync.ListNamedShadowsForThing
*/
java.util.concurrent.Future listNamedShadowsForThingAsync(ListNamedShadowsForThingRequest listNamedShadowsForThingRequest);
/**
*
* Lists the shadows for the specified thing.
*
*
* @param listNamedShadowsForThingRequest
* @param 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.
* @return A Java Future containing the result of the ListNamedShadowsForThing operation returned by the service.
* @sample AWSIotDataAsyncHandler.ListNamedShadowsForThing
*/
java.util.concurrent.Future listNamedShadowsForThingAsync(ListNamedShadowsForThingRequest listNamedShadowsForThingRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Publishes state information.
*
*
* For more information, see HTTP
* Protocol in the AWS IoT Developer Guide.
*
*
* @param publishRequest
* The input for the Publish operation.
* @return A Java Future containing the result of the Publish operation returned by the service.
* @sample AWSIotDataAsync.Publish
*/
java.util.concurrent.Future publishAsync(PublishRequest publishRequest);
/**
*
* Publishes state information.
*
*
* For more information, see HTTP
* Protocol in the AWS IoT Developer Guide.
*
*
* @param publishRequest
* The input for the Publish operation.
* @param 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.
* @return A Java Future containing the result of the Publish operation returned by the service.
* @sample AWSIotDataAsyncHandler.Publish
*/
java.util.concurrent.Future publishAsync(PublishRequest publishRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates the shadow for the specified thing.
*
*
* For more information, see UpdateThingShadow in
* the AWS IoT Developer Guide.
*
*
* @param updateThingShadowRequest
* The input for the UpdateThingShadow operation.
* @return A Java Future containing the result of the UpdateThingShadow operation returned by the service.
* @sample AWSIotDataAsync.UpdateThingShadow
*/
java.util.concurrent.Future updateThingShadowAsync(UpdateThingShadowRequest updateThingShadowRequest);
/**
*
* Updates the shadow for the specified thing.
*
*
* For more information, see UpdateThingShadow in
* the AWS IoT Developer Guide.
*
*
* @param updateThingShadowRequest
* The input for the UpdateThingShadow operation.
* @param 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.
* @return A Java Future containing the result of the UpdateThingShadow operation returned by the service.
* @sample AWSIotDataAsyncHandler.UpdateThingShadow
*/
java.util.concurrent.Future updateThingShadowAsync(UpdateThingShadowRequest updateThingShadowRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}