AbstractAWSIoTEventsData (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ioteventsdata.AbstractAWSIoTEventsData

All Implemented Interfaces:

AWSIoTEventsData

Direct Known Subclasses:

AbstractAWSIoTEventsDataAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSIoTEventsData
extends Object
implements AWSIoTEventsData
```
Abstract implementation of AWSIoTEventsData. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.ioteventsdata.AWSIoTEventsData
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchAcknowledgeAlarmResult`	`batchAcknowledgeAlarm(BatchAcknowledgeAlarmRequest request)` Acknowledges one or more alarms.
`BatchDisableAlarmResult`	`batchDisableAlarm(BatchDisableAlarmRequest request)` Disables one or more alarms.
`BatchEnableAlarmResult`	`batchEnableAlarm(BatchEnableAlarmRequest request)` Enables one or more alarms.
`BatchPutMessageResult`	`batchPutMessage(BatchPutMessageRequest request)` Sends a set of messages to the AWS IoT Events system.
`BatchResetAlarmResult`	`batchResetAlarm(BatchResetAlarmRequest request)` Resets one or more alarms.
`BatchSnoozeAlarmResult`	`batchSnoozeAlarm(BatchSnoozeAlarmRequest request)` Changes one or more alarms to the snooze mode.
`BatchUpdateDetectorResult`	`batchUpdateDetector(BatchUpdateDetectorRequest request)` Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.
`DescribeAlarmResult`	`describeAlarm(DescribeAlarmRequest request)` Retrieves information about an alarm.
`DescribeDetectorResult`	`describeDetector(DescribeDetectorRequest request)` Returns information about the specified detector (instance).
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`ListAlarmsResult`	`listAlarms(ListAlarmsRequest request)` Lists one or more alarms.
`ListDetectorsResult`	`listDetectors(ListDetectorsRequest request)` Lists detectors (the instances of a detector model).
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - batchAcknowledgeAlarm
```
public BatchAcknowledgeAlarmResult batchAcknowledgeAlarm(BatchAcknowledgeAlarmRequest request)
```
    Description copied from interface: AWSIoTEventsData
    
    Acknowledges one or more alarms. The alarms change to the ACKNOWLEDGED state after you acknowledge them.
    
    Specified by:
    
    batchAcknowledgeAlarm in interface AWSIoTEventsData
    
    Returns:
    
    Result of the BatchAcknowledgeAlarm operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchDisableAlarm
```
public BatchDisableAlarmResult batchDisableAlarm(BatchDisableAlarmRequest request)
```
    Description copied from interface: AWSIoTEventsData
    
    Disables one or more alarms. The alarms change to the DISABLED state after you disable them.
    
    Specified by:
    
    batchDisableAlarm in interface AWSIoTEventsData
    
    Returns:
    
    Result of the BatchDisableAlarm operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchEnableAlarm
```
public BatchEnableAlarmResult batchEnableAlarm(BatchEnableAlarmRequest request)
```
    Description copied from interface: AWSIoTEventsData
    
    Enables one or more alarms. The alarms change to the NORMAL state after you enable them.
    
    Specified by:
    
    batchEnableAlarm in interface AWSIoTEventsData
    
    Returns:
    
    Result of the BatchEnableAlarm operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchPutMessage
```
public BatchPutMessageResult batchPutMessage(BatchPutMessageRequest request)
```
    Description copied from interface: AWSIoTEventsData
    
    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:
    
    batchPutMessage in interface AWSIoTEventsData
    
    Returns:
    
    Result of the BatchPutMessage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchResetAlarm
```
public BatchResetAlarmResult batchResetAlarm(BatchResetAlarmRequest request)
```
    Description copied from interface: AWSIoTEventsData
    
    Resets one or more alarms. The alarms return to the NORMAL state after you reset them.
    
    Specified by:
    
    batchResetAlarm in interface AWSIoTEventsData
    
    Returns:
    
    Result of the BatchResetAlarm operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchSnoozeAlarm
```
public BatchSnoozeAlarmResult batchSnoozeAlarm(BatchSnoozeAlarmRequest request)
```
    Description copied from interface: AWSIoTEventsData
    
    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.
    
    Specified by:
    
    batchSnoozeAlarm in interface AWSIoTEventsData
    
    Returns:
    
    Result of the BatchSnoozeAlarm operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchUpdateDetector
```
public BatchUpdateDetectorResult batchUpdateDetector(BatchUpdateDetectorRequest request)
```
    Description copied from interface: AWSIoTEventsData
    
    Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.
    
    Specified by:
    
    batchUpdateDetector in interface AWSIoTEventsData
    
    Returns:
    
    Result of the BatchUpdateDetector operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeAlarm
```
public DescribeAlarmResult describeAlarm(DescribeAlarmRequest request)
```
    Description copied from interface: AWSIoTEventsData
    
    Retrieves information about an alarm.
    
    Specified by:
    
    describeAlarm in interface AWSIoTEventsData
    
    Returns:
    
    Result of the DescribeAlarm operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDetector
```
public DescribeDetectorResult describeDetector(DescribeDetectorRequest request)
```
    Description copied from interface: AWSIoTEventsData
    
    Returns information about the specified detector (instance).
    
    Specified by:
    
    describeDetector in interface AWSIoTEventsData
    
    Returns:
    
    Result of the DescribeDetector operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAlarms
```
public ListAlarmsResult listAlarms(ListAlarmsRequest request)
```
    Description copied from interface: AWSIoTEventsData
    
    Lists one or more alarms. The operation returns only the metadata associated with each alarm.
    
    Specified by:
    
    listAlarms in interface AWSIoTEventsData
    
    Returns:
    
    Result of the ListAlarms operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDetectors
```
public ListDetectorsResult listDetectors(ListDetectorsRequest request)
```
    Description copied from interface: AWSIoTEventsData
    
    Lists detectors (the instances of a detector model).
    
    Specified by:
    
    listDetectors in interface AWSIoTEventsData
    
    Returns:
    
    Result of the ListDetectors operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSIoTEventsData
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSIoTEventsData
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSIoTEventsData
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSIoTEventsData
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAWSIoTEventsData

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

batchAcknowledgeAlarm

batchDisableAlarm

batchEnableAlarm

batchPutMessage

batchResetAlarm

batchSnoozeAlarm

batchUpdateDetector

describeAlarm

describeDetector

listAlarms

listDetectors

shutdown

getCachedResponseMetadata