Interface IotEventsDataAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbatchAcknowledgeAlarm
(Consumer<BatchAcknowledgeAlarmRequest.Builder> batchAcknowledgeAlarmRequest) Acknowledges one or more alarms.batchAcknowledgeAlarm
(BatchAcknowledgeAlarmRequest batchAcknowledgeAlarmRequest) Acknowledges one or more alarms.batchDeleteDetector
(Consumer<BatchDeleteDetectorRequest.Builder> batchDeleteDetectorRequest) Deletes one or more detectors that were created.batchDeleteDetector
(BatchDeleteDetectorRequest batchDeleteDetectorRequest) Deletes one or more detectors that were created.batchDisableAlarm
(Consumer<BatchDisableAlarmRequest.Builder> batchDisableAlarmRequest) Disables one or more alarms.batchDisableAlarm
(BatchDisableAlarmRequest batchDisableAlarmRequest) Disables one or more alarms.batchEnableAlarm
(Consumer<BatchEnableAlarmRequest.Builder> batchEnableAlarmRequest) Enables one or more alarms.batchEnableAlarm
(BatchEnableAlarmRequest batchEnableAlarmRequest) Enables one or more alarms.default CompletableFuture
<BatchPutMessageResponse> batchPutMessage
(Consumer<BatchPutMessageRequest.Builder> batchPutMessageRequest) Sends a set of messages to the IoT Events system.default CompletableFuture
<BatchPutMessageResponse> batchPutMessage
(BatchPutMessageRequest batchPutMessageRequest) Sends a set of messages to the IoT Events system.default CompletableFuture
<BatchResetAlarmResponse> batchResetAlarm
(Consumer<BatchResetAlarmRequest.Builder> batchResetAlarmRequest) Resets one or more alarms.default CompletableFuture
<BatchResetAlarmResponse> batchResetAlarm
(BatchResetAlarmRequest batchResetAlarmRequest) Resets one or more alarms.batchSnoozeAlarm
(Consumer<BatchSnoozeAlarmRequest.Builder> batchSnoozeAlarmRequest) Changes one or more alarms to the snooze mode.batchSnoozeAlarm
(BatchSnoozeAlarmRequest batchSnoozeAlarmRequest) Changes one or more alarms to the snooze mode.batchUpdateDetector
(Consumer<BatchUpdateDetectorRequest.Builder> batchUpdateDetectorRequest) Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.batchUpdateDetector
(BatchUpdateDetectorRequest batchUpdateDetectorRequest) Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.builder()
Create a builder that can be used to configure and create aIotEventsDataAsyncClient
.static IotEventsDataAsyncClient
create()
Create aIotEventsDataAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<DescribeAlarmResponse> describeAlarm
(Consumer<DescribeAlarmRequest.Builder> describeAlarmRequest) Retrieves information about an alarm.default CompletableFuture
<DescribeAlarmResponse> describeAlarm
(DescribeAlarmRequest describeAlarmRequest) Retrieves information about an alarm.describeDetector
(Consumer<DescribeDetectorRequest.Builder> describeDetectorRequest) Returns information about the specified detector (instance).describeDetector
(DescribeDetectorRequest describeDetectorRequest) Returns information about the specified detector (instance).default CompletableFuture
<ListAlarmsResponse> listAlarms
(Consumer<ListAlarmsRequest.Builder> listAlarmsRequest) Lists one or more alarms.default CompletableFuture
<ListAlarmsResponse> listAlarms
(ListAlarmsRequest listAlarmsRequest) Lists one or more alarms.default CompletableFuture
<ListDetectorsResponse> listDetectors
(Consumer<ListDetectorsRequest.Builder> listDetectorsRequest) Lists detectors (the instances of a detector model).default CompletableFuture
<ListDetectorsResponse> listDetectors
(ListDetectorsRequest listDetectorsRequest) Lists detectors (the instances of a detector model).The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
batchAcknowledgeAlarm
default CompletableFuture<BatchAcknowledgeAlarmResponse> batchAcknowledgeAlarm(BatchAcknowledgeAlarmRequest batchAcknowledgeAlarmRequest) Acknowledges one or more alarms. The alarms change to the
ACKNOWLEDGED
state after you acknowledge them.- Parameters:
batchAcknowledgeAlarmRequest
-- Returns:
- A Java Future containing the result of the BatchAcknowledgeAlarm operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request was invalid.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- ThrottlingException The request could not be completed due to throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchAcknowledgeAlarm
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 viaBatchAcknowledgeAlarmRequest.builder()
- Parameters:
batchAcknowledgeAlarmRequest
- AConsumer
that will call methods onBatchAcknowledgeAlarmRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchAcknowledgeAlarm operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request was invalid.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- ThrottlingException The request could not be completed due to throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchDeleteDetector
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.
- Parameters:
batchDeleteDetectorRequest
-- Returns:
- A Java Future containing the result of the BatchDeleteDetector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request was invalid.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- ThrottlingException The request could not be completed due to throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchDeleteDetector
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 viaBatchDeleteDetectorRequest.builder()
- Parameters:
batchDeleteDetectorRequest
- AConsumer
that will call methods onBatchDeleteDetectorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchDeleteDetector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request was invalid.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- ThrottlingException The request could not be completed due to throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchDisableAlarm
default CompletableFuture<BatchDisableAlarmResponse> batchDisableAlarm(BatchDisableAlarmRequest batchDisableAlarmRequest) Disables one or more alarms. The alarms change to the
DISABLED
state after you disable them.- Parameters:
batchDisableAlarmRequest
-- Returns:
- A Java Future containing the result of the BatchDisableAlarm operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request was invalid.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- ThrottlingException The request could not be completed due to throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchDisableAlarm
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 viaBatchDisableAlarmRequest.builder()
- Parameters:
batchDisableAlarmRequest
- AConsumer
that will call methods onBatchDisableAlarmRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchDisableAlarm operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request was invalid.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- ThrottlingException The request could not be completed due to throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchEnableAlarm
default CompletableFuture<BatchEnableAlarmResponse> batchEnableAlarm(BatchEnableAlarmRequest batchEnableAlarmRequest) Enables one or more alarms. The alarms change to the
NORMAL
state after you enable them.- Parameters:
batchEnableAlarmRequest
-- Returns:
- A Java Future containing the result of the BatchEnableAlarm operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request was invalid.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- ThrottlingException The request could not be completed due to throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchEnableAlarm
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 viaBatchEnableAlarmRequest.builder()
- Parameters:
batchEnableAlarmRequest
- AConsumer
that will call methods onBatchEnableAlarmRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchEnableAlarm operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request was invalid.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- ThrottlingException The request could not be completed due to throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchPutMessage
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.- Parameters:
batchPutMessageRequest
-- Returns:
- A Java Future containing the result of the BatchPutMessage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request was invalid.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- ThrottlingException The request could not be completed due to throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchPutMessage
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 viaBatchPutMessageRequest.builder()
- Parameters:
batchPutMessageRequest
- AConsumer
that will call methods onBatchPutMessageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchPutMessage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request was invalid.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- ThrottlingException The request could not be completed due to throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchResetAlarm
default CompletableFuture<BatchResetAlarmResponse> batchResetAlarm(BatchResetAlarmRequest batchResetAlarmRequest) Resets one or more alarms. The alarms return to the
NORMAL
state after you reset them.- Parameters:
batchResetAlarmRequest
-- Returns:
- A Java Future containing the result of the BatchResetAlarm operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request was invalid.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- ThrottlingException The request could not be completed due to throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchResetAlarm
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 viaBatchResetAlarmRequest.builder()
- Parameters:
batchResetAlarmRequest
- AConsumer
that will call methods onBatchResetAlarmRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchResetAlarm operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request was invalid.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- ThrottlingException The request could not be completed due to throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchSnoozeAlarm
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.- Parameters:
batchSnoozeAlarmRequest
-- Returns:
- A Java Future containing the result of the BatchSnoozeAlarm operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request was invalid.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- ThrottlingException The request could not be completed due to throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchSnoozeAlarm
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 viaBatchSnoozeAlarmRequest.builder()
- Parameters:
batchSnoozeAlarmRequest
- AConsumer
that will call methods onBatchSnoozeAlarmRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchSnoozeAlarm operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request was invalid.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- ThrottlingException The request could not be completed due to throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchUpdateDetector
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.
- Parameters:
batchUpdateDetectorRequest
-- Returns:
- A Java Future containing the result of the BatchUpdateDetector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request was invalid.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- ThrottlingException The request could not be completed due to throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchUpdateDetector
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 viaBatchUpdateDetectorRequest.builder()
- Parameters:
batchUpdateDetectorRequest
- AConsumer
that will call methods onBatchUpdateDetectorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchUpdateDetector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request was invalid.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- ThrottlingException The request could not be completed due to throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAlarm
default CompletableFuture<DescribeAlarmResponse> describeAlarm(DescribeAlarmRequest describeAlarmRequest) Retrieves information about an alarm.
- Parameters:
describeAlarmRequest
-- Returns:
- A Java Future containing the result of the DescribeAlarm operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request was invalid.
- ResourceNotFoundException The resource was not found.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAlarm
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 viaDescribeAlarmRequest.builder()
- Parameters:
describeAlarmRequest
- AConsumer
that will call methods onDescribeAlarmRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAlarm operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request was invalid.
- ResourceNotFoundException The resource was not found.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDetector
default CompletableFuture<DescribeDetectorResponse> describeDetector(DescribeDetectorRequest describeDetectorRequest) Returns information about the specified detector (instance).
- Parameters:
describeDetectorRequest
-- Returns:
- A Java Future containing the result of the DescribeDetector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request was invalid.
- ResourceNotFoundException The resource was not found.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDetector
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 viaDescribeDetectorRequest.builder()
- Parameters:
describeDetectorRequest
- AConsumer
that will call methods onDescribeDetectorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDetector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request was invalid.
- ResourceNotFoundException The resource was not found.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAlarms
Lists one or more alarms. The operation returns only the metadata associated with each alarm.
- Parameters:
listAlarmsRequest
-- Returns:
- A Java Future containing the result of the ListAlarms operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request was invalid.
- ResourceNotFoundException The resource was not found.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAlarms
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 viaListAlarmsRequest.builder()
- Parameters:
listAlarmsRequest
- AConsumer
that will call methods onListAlarmsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAlarms operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request was invalid.
- ResourceNotFoundException The resource was not found.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDetectors
default CompletableFuture<ListDetectorsResponse> listDetectors(ListDetectorsRequest listDetectorsRequest) Lists detectors (the instances of a detector model).
- Parameters:
listDetectorsRequest
-- Returns:
- A Java Future containing the result of the ListDetectors operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request was invalid.
- ResourceNotFoundException The resource was not found.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDetectors
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 viaListDetectorsRequest.builder()
- Parameters:
listDetectorsRequest
- AConsumer
that will call methods onListDetectorsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListDetectors operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidRequestException The request was invalid.
- ResourceNotFoundException The resource was not found.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aIotEventsDataAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aIotEventsDataAsyncClient
.
-