com.amazonaws.services.iotevents.AWSIoTEventsAsync Maven / Gradle / Ivy
/*
* Copyright 2016-2021 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.iotevents;
import javax.annotation.Generated;
import com.amazonaws.services.iotevents.model.*;
/**
* Interface for accessing AWS IoT Events 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.iotevents.AbstractAWSIoTEventsAsync} instead.
*
*
*
* AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions
* when such events occur. You can use AWS IoT Events API operations to create, read, update, and delete inputs and
* detector models, and to list their versions.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSIoTEventsAsync extends AWSIoTEvents {
/**
*
* Creates a detector model.
*
*
* @param createDetectorModelRequest
* @return A Java Future containing the result of the CreateDetectorModel operation returned by the service.
* @sample AWSIoTEventsAsync.CreateDetectorModel
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createDetectorModelAsync(CreateDetectorModelRequest createDetectorModelRequest);
/**
*
* Creates a detector model.
*
*
* @param createDetectorModelRequest
* @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 CreateDetectorModel operation returned by the service.
* @sample AWSIoTEventsAsyncHandler.CreateDetectorModel
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createDetectorModelAsync(CreateDetectorModelRequest createDetectorModelRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates an input.
*
*
* @param createInputRequest
* @return A Java Future containing the result of the CreateInput operation returned by the service.
* @sample AWSIoTEventsAsync.CreateInput
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createInputAsync(CreateInputRequest createInputRequest);
/**
*
* Creates an input.
*
*
* @param createInputRequest
* @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 CreateInput operation returned by the service.
* @sample AWSIoTEventsAsyncHandler.CreateInput
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createInputAsync(CreateInputRequest createInputRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes a detector model. Any active instances of the detector model are also deleted.
*
*
* @param deleteDetectorModelRequest
* @return A Java Future containing the result of the DeleteDetectorModel operation returned by the service.
* @sample AWSIoTEventsAsync.DeleteDetectorModel
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deleteDetectorModelAsync(DeleteDetectorModelRequest deleteDetectorModelRequest);
/**
*
* Deletes a detector model. Any active instances of the detector model are also deleted.
*
*
* @param deleteDetectorModelRequest
* @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 DeleteDetectorModel operation returned by the service.
* @sample AWSIoTEventsAsyncHandler.DeleteDetectorModel
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deleteDetectorModelAsync(DeleteDetectorModelRequest deleteDetectorModelRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes an input.
*
*
* @param deleteInputRequest
* @return A Java Future containing the result of the DeleteInput operation returned by the service.
* @sample AWSIoTEventsAsync.DeleteInput
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteInputAsync(DeleteInputRequest deleteInputRequest);
/**
*
* Deletes an input.
*
*
* @param deleteInputRequest
* @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 DeleteInput operation returned by the service.
* @sample AWSIoTEventsAsyncHandler.DeleteInput
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteInputAsync(DeleteInputRequest deleteInputRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Describes a detector model. If the version parameter is not specified, information about the latest
* version is returned.
*
*
* @param describeDetectorModelRequest
* @return A Java Future containing the result of the DescribeDetectorModel operation returned by the service.
* @sample AWSIoTEventsAsync.DescribeDetectorModel
* @see AWS API Documentation
*/
java.util.concurrent.Future describeDetectorModelAsync(DescribeDetectorModelRequest describeDetectorModelRequest);
/**
*
* Describes a detector model. If the version parameter is not specified, information about the latest
* version is returned.
*
*
* @param describeDetectorModelRequest
* @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 DescribeDetectorModel operation returned by the service.
* @sample AWSIoTEventsAsyncHandler.DescribeDetectorModel
* @see AWS API Documentation
*/
java.util.concurrent.Future describeDetectorModelAsync(DescribeDetectorModelRequest describeDetectorModelRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Describes an input.
*
*
* @param describeInputRequest
* @return A Java Future containing the result of the DescribeInput operation returned by the service.
* @sample AWSIoTEventsAsync.DescribeInput
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeInputAsync(DescribeInputRequest describeInputRequest);
/**
*
* Describes an input.
*
*
* @param describeInputRequest
* @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 DescribeInput operation returned by the service.
* @sample AWSIoTEventsAsyncHandler.DescribeInput
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeInputAsync(DescribeInputRequest describeInputRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves the current settings of the AWS IoT Events logging options.
*
*
* @param describeLoggingOptionsRequest
* @return A Java Future containing the result of the DescribeLoggingOptions operation returned by the service.
* @sample AWSIoTEventsAsync.DescribeLoggingOptions
* @see AWS API Documentation
*/
java.util.concurrent.Future describeLoggingOptionsAsync(DescribeLoggingOptionsRequest describeLoggingOptionsRequest);
/**
*
* Retrieves the current settings of the AWS IoT Events logging options.
*
*
* @param describeLoggingOptionsRequest
* @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 DescribeLoggingOptions operation returned by the service.
* @sample AWSIoTEventsAsyncHandler.DescribeLoggingOptions
* @see AWS API Documentation
*/
java.util.concurrent.Future describeLoggingOptionsAsync(DescribeLoggingOptionsRequest describeLoggingOptionsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists all the versions of a detector model. Only the metadata associated with each detector model version is
* returned.
*
*
* @param listDetectorModelVersionsRequest
* @return A Java Future containing the result of the ListDetectorModelVersions operation returned by the service.
* @sample AWSIoTEventsAsync.ListDetectorModelVersions
* @see AWS API Documentation
*/
java.util.concurrent.Future listDetectorModelVersionsAsync(
ListDetectorModelVersionsRequest listDetectorModelVersionsRequest);
/**
*
* Lists all the versions of a detector model. Only the metadata associated with each detector model version is
* returned.
*
*
* @param listDetectorModelVersionsRequest
* @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 ListDetectorModelVersions operation returned by the service.
* @sample AWSIoTEventsAsyncHandler.ListDetectorModelVersions
* @see AWS API Documentation
*/
java.util.concurrent.Future listDetectorModelVersionsAsync(
ListDetectorModelVersionsRequest listDetectorModelVersionsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists the detector models you have created. Only the metadata associated with each detector model is returned.
*
*
* @param listDetectorModelsRequest
* @return A Java Future containing the result of the ListDetectorModels operation returned by the service.
* @sample AWSIoTEventsAsync.ListDetectorModels
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listDetectorModelsAsync(ListDetectorModelsRequest listDetectorModelsRequest);
/**
*
* Lists the detector models you have created. Only the metadata associated with each detector model is returned.
*
*
* @param listDetectorModelsRequest
* @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 ListDetectorModels operation returned by the service.
* @sample AWSIoTEventsAsyncHandler.ListDetectorModels
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listDetectorModelsAsync(ListDetectorModelsRequest listDetectorModelsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists the inputs you have created.
*
*
* @param listInputsRequest
* @return A Java Future containing the result of the ListInputs operation returned by the service.
* @sample AWSIoTEventsAsync.ListInputs
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listInputsAsync(ListInputsRequest listInputsRequest);
/**
*
* Lists the inputs you have created.
*
*
* @param listInputsRequest
* @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 ListInputs operation returned by the service.
* @sample AWSIoTEventsAsyncHandler.ListInputs
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listInputsAsync(ListInputsRequest listInputsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists the tags (metadata) you have assigned to the resource.
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AWSIoTEventsAsync.ListTagsForResource
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Lists the tags (metadata) you have assigned to the resource.
*
*
* @param listTagsForResourceRequest
* @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 ListTagsForResource operation returned by the service.
* @sample AWSIoTEventsAsyncHandler.ListTagsForResource
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Sets or updates the AWS IoT Events logging options.
*
*
* If you update the value of any loggingOptions field, it takes up to one minute for the change to
* take effect. If you change the policy attached to the role you specified in the roleArn field (for
* example, to correct an invalid policy), it takes up to five minutes for that change to take effect.
*
*
* @param putLoggingOptionsRequest
* @return A Java Future containing the result of the PutLoggingOptions operation returned by the service.
* @sample AWSIoTEventsAsync.PutLoggingOptions
* @see AWS
* API Documentation
*/
java.util.concurrent.Future putLoggingOptionsAsync(PutLoggingOptionsRequest putLoggingOptionsRequest);
/**
*
* Sets or updates the AWS IoT Events logging options.
*
*
* If you update the value of any loggingOptions field, it takes up to one minute for the change to
* take effect. If you change the policy attached to the role you specified in the roleArn field (for
* example, to correct an invalid policy), it takes up to five minutes for that change to take effect.
*
*
* @param putLoggingOptionsRequest
* @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 PutLoggingOptions operation returned by the service.
* @sample AWSIoTEventsAsyncHandler.PutLoggingOptions
* @see AWS
* API Documentation
*/
java.util.concurrent.Future putLoggingOptionsAsync(PutLoggingOptionsRequest putLoggingOptionsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
*
*
* @param tagResourceRequest
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AWSIoTEventsAsync.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest);
/**
*
* Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
*
*
* @param tagResourceRequest
* @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 TagResource operation returned by the service.
* @sample AWSIoTEventsAsyncHandler.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Removes the given tags (metadata) from the resource.
*
*
* @param untagResourceRequest
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AWSIoTEventsAsync.UntagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest);
/**
*
* Removes the given tags (metadata) from the resource.
*
*
* @param untagResourceRequest
* @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 UntagResource operation returned by the service.
* @sample AWSIoTEventsAsyncHandler.UntagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created
* as new inputs arrive.
*
*
* @param updateDetectorModelRequest
* @return A Java Future containing the result of the UpdateDetectorModel operation returned by the service.
* @sample AWSIoTEventsAsync.UpdateDetectorModel
* @see AWS
* API Documentation
*/
java.util.concurrent.Future updateDetectorModelAsync(UpdateDetectorModelRequest updateDetectorModelRequest);
/**
*
* Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created
* as new inputs arrive.
*
*
* @param updateDetectorModelRequest
* @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 UpdateDetectorModel operation returned by the service.
* @sample AWSIoTEventsAsyncHandler.UpdateDetectorModel
* @see AWS
* API Documentation
*/
java.util.concurrent.Future updateDetectorModelAsync(UpdateDetectorModelRequest updateDetectorModelRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates an input.
*
*
* @param updateInputRequest
* @return A Java Future containing the result of the UpdateInput operation returned by the service.
* @sample AWSIoTEventsAsync.UpdateInput
* @see AWS API
* Documentation
*/
java.util.concurrent.Future updateInputAsync(UpdateInputRequest updateInputRequest);
/**
*
* Updates an input.
*
*
* @param updateInputRequest
* @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 UpdateInput operation returned by the service.
* @sample AWSIoTEventsAsyncHandler.UpdateInput
* @see AWS API
* Documentation
*/
java.util.concurrent.Future updateInputAsync(UpdateInputRequest updateInputRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy