com.amazonaws.services.pipes.AmazonPipesAsync Maven / Gradle / Ivy
Show all versions of aws-java-sdk-pipes Show documentation
/*
* Copyright 2018-2023 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.pipes;
import javax.annotation.Generated;
import com.amazonaws.services.pipes.model.*;
/**
* Interface for accessing Amazon EventBridge Pipes 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.pipes.AbstractAmazonPipesAsync} instead.
*
*
*
* Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need for specialized knowledge and
* integration code when developing event driven architectures. This helps ensures consistency across your company’s
* applications. With Pipes, the target can be any available EventBridge target. To set up a pipe, you select the event
* source, add optional event filtering, define optional enrichment, and select the target for the event data.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonPipesAsync extends AmazonPipes {
/**
*
* Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized
* knowledge and integration code.
*
*
* @param createPipeRequest
* @return A Java Future containing the result of the CreatePipe operation returned by the service.
* @sample AmazonPipesAsync.CreatePipe
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createPipeAsync(CreatePipeRequest createPipeRequest);
/**
*
* Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized
* knowledge and integration code.
*
*
* @param createPipeRequest
* @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 CreatePipe operation returned by the service.
* @sample AmazonPipesAsyncHandler.CreatePipe
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createPipeAsync(CreatePipeRequest createPipeRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Delete an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the
* Amazon EventBridge User Guide.
*
*
* @param deletePipeRequest
* @return A Java Future containing the result of the DeletePipe operation returned by the service.
* @sample AmazonPipesAsync.DeletePipe
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deletePipeAsync(DeletePipeRequest deletePipeRequest);
/**
*
* Delete an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the
* Amazon EventBridge User Guide.
*
*
* @param deletePipeRequest
* @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 DeletePipe operation returned by the service.
* @sample AmazonPipesAsyncHandler.DeletePipe
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deletePipeAsync(DeletePipeRequest deletePipeRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Get the information about an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the
* Amazon EventBridge User Guide.
*
*
* @param describePipeRequest
* @return A Java Future containing the result of the DescribePipe operation returned by the service.
* @sample AmazonPipesAsync.DescribePipe
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describePipeAsync(DescribePipeRequest describePipeRequest);
/**
*
* Get the information about an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the
* Amazon EventBridge User Guide.
*
*
* @param describePipeRequest
* @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 DescribePipe operation returned by the service.
* @sample AmazonPipesAsyncHandler.DescribePipe
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describePipeAsync(DescribePipeRequest describePipeRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Get the pipes associated with this account. For more information about pipes, see Amazon EventBridge Pipes in the
* Amazon EventBridge User Guide.
*
*
* @param listPipesRequest
* @return A Java Future containing the result of the ListPipes operation returned by the service.
* @sample AmazonPipesAsync.ListPipes
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listPipesAsync(ListPipesRequest listPipesRequest);
/**
*
* Get the pipes associated with this account. For more information about pipes, see Amazon EventBridge Pipes in the
* Amazon EventBridge User Guide.
*
*
* @param listPipesRequest
* @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 ListPipes operation returned by the service.
* @sample AmazonPipesAsyncHandler.ListPipes
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listPipesAsync(ListPipesRequest listPipesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Displays the tags associated with a pipe.
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AmazonPipesAsync.ListTagsForResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Displays the tags associated with a pipe.
*
*
* @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 AmazonPipesAsyncHandler.ListTagsForResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Start an existing pipe.
*
*
* @param startPipeRequest
* @return A Java Future containing the result of the StartPipe operation returned by the service.
* @sample AmazonPipesAsync.StartPipe
* @see AWS API
* Documentation
*/
java.util.concurrent.Future startPipeAsync(StartPipeRequest startPipeRequest);
/**
*
* Start an existing pipe.
*
*
* @param startPipeRequest
* @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 StartPipe operation returned by the service.
* @sample AmazonPipesAsyncHandler.StartPipe
* @see AWS API
* Documentation
*/
java.util.concurrent.Future startPipeAsync(StartPipeRequest startPipeRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Stop an existing pipe.
*
*
* @param stopPipeRequest
* @return A Java Future containing the result of the StopPipe operation returned by the service.
* @sample AmazonPipesAsync.StopPipe
* @see AWS API
* Documentation
*/
java.util.concurrent.Future stopPipeAsync(StopPipeRequest stopPipeRequest);
/**
*
* Stop an existing pipe.
*
*
* @param stopPipeRequest
* @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 StopPipe operation returned by the service.
* @sample AmazonPipesAsyncHandler.StopPipe
* @see AWS API
* Documentation
*/
java.util.concurrent.Future stopPipeAsync(StopPipeRequest stopPipeRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Assigns one or more tags (key-value pairs) to the specified pipe. Tags can help you organize and categorize your
* resources. You can also use them to scope user permissions by granting a user permission to access or change only
* resources with certain tag values.
*
*
* Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of
* characters.
*
*
* You can use the TagResource action with a pipe that already has tags. If you specify a new tag key,
* this tag is appended to the list of tags associated with the pipe. If you specify a tag key that is already
* associated with the pipe, the new tag value that you specify replaces the previous value for that tag.
*
*
* You can associate as many as 50 tags with a pipe.
*
*
* @param tagResourceRequest
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AmazonPipesAsync.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest);
/**
*
* Assigns one or more tags (key-value pairs) to the specified pipe. Tags can help you organize and categorize your
* resources. You can also use them to scope user permissions by granting a user permission to access or change only
* resources with certain tag values.
*
*
* Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of
* characters.
*
*
* You can use the TagResource action with a pipe that already has tags. If you specify a new tag key,
* this tag is appended to the list of tags associated with the pipe. If you specify a tag key that is already
* associated with the pipe, the new tag value that you specify replaces the previous value for that tag.
*
*
* You can associate as many as 50 tags with a pipe.
*
*
* @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 AmazonPipesAsyncHandler.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Removes one or more tags from the specified pipes.
*
*
* @param untagResourceRequest
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AmazonPipesAsync.UntagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest);
/**
*
* Removes one or more tags from the specified pipes.
*
*
* @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 AmazonPipesAsyncHandler.UntagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Update an existing pipe. When you call UpdatePipe, EventBridge only the updates fields you have
* specified in the request; the rest remain unchanged. The exception to this is if you modify any Amazon Web
* Services-service specific fields in the SourceParameters, EnrichmentParameters, or
* TargetParameters objects. For example, DynamoDBStreamParameters or
* EventBridgeEventBusParameters. EventBridge updates the fields in these objects atomically as one and
* overrides existing values. This is by design, and means that if you don't specify an optional field in one of
* these Parameters objects, EventBridge sets that field to its system-default value during the update.
*
*
* For more information about pipes, see Amazon EventBridge Pipes in
* the Amazon EventBridge User Guide.
*
*
* @param updatePipeRequest
* @return A Java Future containing the result of the UpdatePipe operation returned by the service.
* @sample AmazonPipesAsync.UpdatePipe
* @see AWS API
* Documentation
*/
java.util.concurrent.Future updatePipeAsync(UpdatePipeRequest updatePipeRequest);
/**
*
* Update an existing pipe. When you call UpdatePipe, EventBridge only the updates fields you have
* specified in the request; the rest remain unchanged. The exception to this is if you modify any Amazon Web
* Services-service specific fields in the SourceParameters, EnrichmentParameters, or
* TargetParameters objects. For example, DynamoDBStreamParameters or
* EventBridgeEventBusParameters. EventBridge updates the fields in these objects atomically as one and
* overrides existing values. This is by design, and means that if you don't specify an optional field in one of
* these Parameters objects, EventBridge sets that field to its system-default value during the update.
*
*
* For more information about pipes, see Amazon EventBridge Pipes in
* the Amazon EventBridge User Guide.
*
*
* @param updatePipeRequest
* @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 UpdatePipe operation returned by the service.
* @sample AmazonPipesAsyncHandler.UpdatePipe
* @see AWS API
* Documentation
*/
java.util.concurrent.Future updatePipeAsync(UpdatePipeRequest updatePipeRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}