@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface IotEventsDataAsyncClient extends AwsClient
builder() method.
IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. You can use IoT Events Data API commands to send inputs to detectors, list detectors, and view or update a detector's status.
For more information, see What is IoT Events? in the IoT Events Developer Guide.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<BatchAcknowledgeAlarmResponse> batchAcknowledgeAlarm(BatchAcknowledgeAlarmRequest batchAcknowledgeAlarmRequest)
Acknowledges one or more alarms. The alarms change to the ACKNOWLEDGED state after you acknowledge
them.
batchAcknowledgeAlarmRequest - default CompletableFuture<BatchAcknowledgeAlarmResponse> batchAcknowledgeAlarm(Consumer<BatchAcknowledgeAlarmRequest.Builder> batchAcknowledgeAlarmRequest)
Acknowledges one or more alarms. The alarms change to the ACKNOWLEDGED state after you acknowledge
them.
This is a convenience which creates an instance of the BatchAcknowledgeAlarmRequest.Builder avoiding the
need to create one manually via BatchAcknowledgeAlarmRequest.builder()
batchAcknowledgeAlarmRequest - A Consumer that will call methods on
BatchAcknowledgeAlarmRequest.Builder to create
a request.default CompletableFuture<BatchDeleteDetectorResponse> batchDeleteDetector(BatchDeleteDetectorRequest batchDeleteDetectorRequest)
Deletes one or more detectors that were created. When a detector is deleted, its state will be cleared and the detector will be removed from the list of detectors. The deleted detector will no longer appear if referenced in the ListDetectors API call.
batchDeleteDetectorRequest - default CompletableFuture<BatchDeleteDetectorResponse> batchDeleteDetector(Consumer<BatchDeleteDetectorRequest.Builder> batchDeleteDetectorRequest)
Deletes one or more detectors that were created. When a detector is deleted, its state will be cleared and the detector will be removed from the list of detectors. The deleted detector will no longer appear if referenced in the ListDetectors API call.
This is a convenience which creates an instance of the BatchDeleteDetectorRequest.Builder avoiding the
need to create one manually via BatchDeleteDetectorRequest.builder()
batchDeleteDetectorRequest - A Consumer that will call methods on
BatchDeleteDetectorRequest.Builder to create a
request.default CompletableFuture<BatchDisableAlarmResponse> batchDisableAlarm(BatchDisableAlarmRequest batchDisableAlarmRequest)
Disables one or more alarms. The alarms change to the DISABLED state after you disable them.
batchDisableAlarmRequest - default CompletableFuture<BatchDisableAlarmResponse> batchDisableAlarm(Consumer<BatchDisableAlarmRequest.Builder> batchDisableAlarmRequest)
Disables one or more alarms. The alarms change to the DISABLED state after you disable them.
This is a convenience which creates an instance of the BatchDisableAlarmRequest.Builder avoiding the need
to create one manually via BatchDisableAlarmRequest.builder()
batchDisableAlarmRequest - A Consumer that will call methods on
BatchDisableAlarmRequest.Builder to create a
request.default CompletableFuture<BatchEnableAlarmResponse> batchEnableAlarm(BatchEnableAlarmRequest batchEnableAlarmRequest)
Enables one or more alarms. The alarms change to the NORMAL state after you enable them.
batchEnableAlarmRequest - default CompletableFuture<BatchEnableAlarmResponse> batchEnableAlarm(Consumer<BatchEnableAlarmRequest.Builder> batchEnableAlarmRequest)
Enables one or more alarms. The alarms change to the NORMAL state after you enable them.
This is a convenience which creates an instance of the BatchEnableAlarmRequest.Builder avoiding the need
to create one manually via BatchEnableAlarmRequest.builder()
batchEnableAlarmRequest - A Consumer that will call methods on
BatchEnableAlarmRequest.Builder to create a
request.default CompletableFuture<BatchPutMessageResponse> batchPutMessage(BatchPutMessageRequest batchPutMessageRequest)
Sends a set of messages to the 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.
batchPutMessageRequest - default CompletableFuture<BatchPutMessageResponse> batchPutMessage(Consumer<BatchPutMessageRequest.Builder> batchPutMessageRequest)
Sends a set of messages to the 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.
This is a convenience which creates an instance of the BatchPutMessageRequest.Builder avoiding the need
to create one manually via BatchPutMessageRequest.builder()
batchPutMessageRequest - A Consumer that will call methods on
BatchPutMessageRequest.Builder to create a
request.default CompletableFuture<BatchResetAlarmResponse> batchResetAlarm(BatchResetAlarmRequest batchResetAlarmRequest)
Resets one or more alarms. The alarms return to the NORMAL state after you reset them.
batchResetAlarmRequest - default CompletableFuture<BatchResetAlarmResponse> batchResetAlarm(Consumer<BatchResetAlarmRequest.Builder> batchResetAlarmRequest)
Resets one or more alarms. The alarms return to the NORMAL state after you reset them.
This is a convenience which creates an instance of the BatchResetAlarmRequest.Builder avoiding the need
to create one manually via BatchResetAlarmRequest.builder()
batchResetAlarmRequest - A Consumer that will call methods on
BatchResetAlarmRequest.Builder to create a
request.default CompletableFuture<BatchSnoozeAlarmResponse> batchSnoozeAlarm(BatchSnoozeAlarmRequest batchSnoozeAlarmRequest)
Changes one or more alarms to the snooze mode. The alarms change to the SNOOZE_DISABLED state after
you set them to the snooze mode.
batchSnoozeAlarmRequest - default CompletableFuture<BatchSnoozeAlarmResponse> batchSnoozeAlarm(Consumer<BatchSnoozeAlarmRequest.Builder> batchSnoozeAlarmRequest)
Changes one or more alarms to the snooze mode. The alarms change to the SNOOZE_DISABLED state after
you set them to the snooze mode.
This is a convenience which creates an instance of the BatchSnoozeAlarmRequest.Builder avoiding the need
to create one manually via BatchSnoozeAlarmRequest.builder()
batchSnoozeAlarmRequest - A Consumer that will call methods on
BatchSnoozeAlarmRequest.Builder to create a
request.default CompletableFuture<BatchUpdateDetectorResponse> batchUpdateDetector(BatchUpdateDetectorRequest batchUpdateDetectorRequest)
Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.
batchUpdateDetectorRequest - default CompletableFuture<BatchUpdateDetectorResponse> batchUpdateDetector(Consumer<BatchUpdateDetectorRequest.Builder> batchUpdateDetectorRequest)
Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.
This is a convenience which creates an instance of the BatchUpdateDetectorRequest.Builder avoiding the
need to create one manually via BatchUpdateDetectorRequest.builder()
batchUpdateDetectorRequest - A Consumer that will call methods on
BatchUpdateDetectorRequest.Builder to create a
request.default CompletableFuture<DescribeAlarmResponse> describeAlarm(DescribeAlarmRequest describeAlarmRequest)
Retrieves information about an alarm.
describeAlarmRequest - default CompletableFuture<DescribeAlarmResponse> describeAlarm(Consumer<DescribeAlarmRequest.Builder> describeAlarmRequest)
Retrieves information about an alarm.
This is a convenience which creates an instance of the DescribeAlarmRequest.Builder avoiding the need to
create one manually via DescribeAlarmRequest.builder()
describeAlarmRequest - A Consumer that will call methods on
DescribeAlarmRequest.Builder to create a
request.default CompletableFuture<DescribeDetectorResponse> describeDetector(DescribeDetectorRequest describeDetectorRequest)
Returns information about the specified detector (instance).
describeDetectorRequest - default CompletableFuture<DescribeDetectorResponse> describeDetector(Consumer<DescribeDetectorRequest.Builder> describeDetectorRequest)
Returns information about the specified detector (instance).
This is a convenience which creates an instance of the DescribeDetectorRequest.Builder avoiding the need
to create one manually via DescribeDetectorRequest.builder()
describeDetectorRequest - A Consumer that will call methods on
DescribeDetectorRequest.Builder to create a
request.default CompletableFuture<ListAlarmsResponse> listAlarms(ListAlarmsRequest listAlarmsRequest)
Lists one or more alarms. The operation returns only the metadata associated with each alarm.
listAlarmsRequest - default CompletableFuture<ListAlarmsResponse> listAlarms(Consumer<ListAlarmsRequest.Builder> listAlarmsRequest)
Lists one or more alarms. The operation returns only the metadata associated with each alarm.
This is a convenience which creates an instance of the ListAlarmsRequest.Builder avoiding the need to
create one manually via ListAlarmsRequest.builder()
listAlarmsRequest - A Consumer that will call methods on
ListAlarmsRequest.Builder to create a request.default CompletableFuture<ListDetectorsResponse> listDetectors(ListDetectorsRequest listDetectorsRequest)
Lists detectors (the instances of a detector model).
listDetectorsRequest - default CompletableFuture<ListDetectorsResponse> listDetectors(Consumer<ListDetectorsRequest.Builder> listDetectorsRequest)
Lists detectors (the instances of a detector model).
This is a convenience which creates an instance of the ListDetectorsRequest.Builder avoiding the need to
create one manually via ListDetectorsRequest.builder()
listDetectorsRequest - A Consumer that will call methods on
ListDetectorsRequest.Builder to create a
request.default IotEventsDataServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic IotEventsDataAsyncClient create()
IotEventsDataAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static IotEventsDataAsyncClientBuilder builder()
IotEventsDataAsyncClient.Copyright © 2023. All rights reserved.