com.amazonaws.services.ioteventsdata

Class AWSIoTEventsDataAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.ioteventsdata.AWSIoTEventsDataClient

com.amazonaws.services.ioteventsdata.AWSIoTEventsDataAsyncClient

All Implemented Interfaces:

AWSIoTEventsData, AWSIoTEventsDataAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSIoTEventsDataAsyncClient
extends AWSIoTEventsDataClient
implements AWSIoTEventsDataAsync

Client for accessing AWS IoT Events Data 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 Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. AWS IoT Events Data API commands enable you to send inputs to detectors, list detectors, and view or update a detector's status.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.ioteventsdata.AWSIoTEventsData

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSIoTEventsDataAsyncClientBuilder	asyncBuilder()
Future<BatchPutMessageResult>	batchPutMessageAsync(BatchPutMessageRequest request) Sends a set of messages to the AWS IoT Events system.
Future<BatchPutMessageResult>	batchPutMessageAsync(BatchPutMessageRequest request, AsyncHandler<BatchPutMessageRequest,BatchPutMessageResult> asyncHandler) Sends a set of messages to the AWS IoT Events system.
Future<BatchUpdateDetectorResult>	batchUpdateDetectorAsync(BatchUpdateDetectorRequest request) Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.
Future<BatchUpdateDetectorResult>	batchUpdateDetectorAsync(BatchUpdateDetectorRequest request, AsyncHandler<BatchUpdateDetectorRequest,BatchUpdateDetectorResult> asyncHandler) Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.
Future<DescribeDetectorResult>	describeDetectorAsync(DescribeDetectorRequest request) Returns information about the specified detector (instance).
Future<DescribeDetectorResult>	describeDetectorAsync(DescribeDetectorRequest request, AsyncHandler<DescribeDetectorRequest,DescribeDetectorResult> asyncHandler) Returns information about the specified detector (instance).
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<ListDetectorsResult>	listDetectorsAsync(ListDetectorsRequest request) Lists detectors (the instances of a detector model).
Future<ListDetectorsResult>	listDetectorsAsync(ListDetectorsRequest request, AsyncHandler<ListDetectorsRequest,ListDetectorsResult> asyncHandler) Lists detectors (the instances of a detector model).
void	shutdown() Shuts down the client, releasing all managed resources.

Methods inherited from class com.amazonaws.services.ioteventsdata.AWSIoTEventsDataClient

batchPutMessage, batchUpdateDetector, builder, describeDetector, getCachedResponseMetadata, listDetectors

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.ioteventsdata.AWSIoTEventsData

batchPutMessage, batchUpdateDetector, describeDetector, getCachedResponseMetadata, listDetectors

Method Detail

asyncBuilder

public static AWSIoTEventsDataAsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

batchPutMessageAsync

public Future<BatchPutMessageResult> batchPutMessageAsync(BatchPutMessageRequest request)

Description copied from interface: AWSIoTEventsDataAsync

Sends a set of messages to the AWS IoT Events system. Each message payload is transformed into the input you specify ("inputName") and ingested into any detectors that monitor that input. If multiple messages are sent, the order in which the messages are processed isn't guaranteed. To guarantee ordering, you must send messages one at a time and wait for a successful response.

Specified by:

batchPutMessageAsync in interface AWSIoTEventsDataAsync

Returns:

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

See Also:

AWS API Documentation

batchPutMessageAsync

public Future<BatchPutMessageResult> batchPutMessageAsync(BatchPutMessageRequest request,
                                                          AsyncHandler<BatchPutMessageRequest,BatchPutMessageResult> asyncHandler)

Description copied from interface: AWSIoTEventsDataAsync

Sends a set of messages to the AWS IoT Events system. Each message payload is transformed into the input you specify ("inputName") and ingested into any detectors that monitor that input. If multiple messages are sent, the order in which the messages are processed isn't guaranteed. To guarantee ordering, you must send messages one at a time and wait for a successful response.

Specified by:

batchPutMessageAsync in interface AWSIoTEventsDataAsync

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 BatchPutMessage operation returned by the service.

See Also:

AWS API Documentation

batchUpdateDetectorAsync

public Future<BatchUpdateDetectorResult> batchUpdateDetectorAsync(BatchUpdateDetectorRequest request)

Description copied from interface: AWSIoTEventsDataAsync

Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.

Specified by:

batchUpdateDetectorAsync in interface AWSIoTEventsDataAsync

Returns:

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

See Also:

AWS API Documentation

batchUpdateDetectorAsync

public Future<BatchUpdateDetectorResult> batchUpdateDetectorAsync(BatchUpdateDetectorRequest request,
                                                                  AsyncHandler<BatchUpdateDetectorRequest,BatchUpdateDetectorResult> asyncHandler)

Description copied from interface: AWSIoTEventsDataAsync

Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.

Specified by:

batchUpdateDetectorAsync in interface AWSIoTEventsDataAsync

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 BatchUpdateDetector operation returned by the service.

See Also:

AWS API Documentation

describeDetectorAsync

public Future<DescribeDetectorResult> describeDetectorAsync(DescribeDetectorRequest request)

Description copied from interface: AWSIoTEventsDataAsync

Returns information about the specified detector (instance).

Specified by:

describeDetectorAsync in interface AWSIoTEventsDataAsync

Returns:

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

See Also:

AWS API Documentation

describeDetectorAsync

public Future<DescribeDetectorResult> describeDetectorAsync(DescribeDetectorRequest request,
                                                            AsyncHandler<DescribeDetectorRequest,DescribeDetectorResult> asyncHandler)

Description copied from interface: AWSIoTEventsDataAsync

Returns information about the specified detector (instance).

Specified by:

describeDetectorAsync in interface AWSIoTEventsDataAsync

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 DescribeDetector operation returned by the service.

See Also:

AWS API Documentation

listDetectorsAsync

public Future<ListDetectorsResult> listDetectorsAsync(ListDetectorsRequest request)

Description copied from interface: AWSIoTEventsDataAsync

Lists detectors (the instances of a detector model).

Specified by:

listDetectorsAsync in interface AWSIoTEventsDataAsync

Returns:

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

See Also:

AWS API Documentation

listDetectorsAsync

public Future<ListDetectorsResult> listDetectorsAsync(ListDetectorsRequest request,
                                                      AsyncHandler<ListDetectorsRequest,ListDetectorsResult> asyncHandler)

Description copied from interface: AWSIoTEventsDataAsync

Lists detectors (the instances of a detector model).

Specified by:

listDetectorsAsync in interface AWSIoTEventsDataAsync

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 ListDetectors operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AWSIoTEventsData

Overrides:

shutdown in class AWSIoTEventsDataClient