AbstractAmazonPipes (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.pipes.AbstractAmazonPipes

All Implemented Interfaces:

AmazonPipes

Direct Known Subclasses:

AbstractAmazonPipesAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonPipes
extends Object
implements AmazonPipes
```
Abstract implementation of AmazonPipes. 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.pipes.AmazonPipes
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreatePipeResult`	`createPipe(CreatePipeRequest request)` Create a pipe.
`DeletePipeResult`	`deletePipe(DeletePipeRequest request)` Delete an existing pipe.
`DescribePipeResult`	`describePipe(DescribePipeRequest request)` Get the information about an existing pipe.
`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.
`ListPipesResult`	`listPipes(ListPipesRequest request)` Get the pipes associated with this account.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Displays the tags associated with a pipe.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartPipeResult`	`startPipe(StartPipeRequest request)` Start an existing pipe.
`StopPipeResult`	`stopPipe(StopPipeRequest request)` Stop an existing pipe.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Assigns one or more tags (key-value pairs) to the specified pipe.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes one or more tags from the specified pipes.
`UpdatePipeResult`	`updatePipe(UpdatePipeRequest request)` Update an existing pipe.

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

- Method Detail
  - createPipe
```
public CreatePipeResult createPipe(CreatePipeRequest request)
```
    Description copied from interface: AmazonPipes
    
    Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.
    
    Specified by:
    
    createPipe in interface AmazonPipes
    
    Returns:
    
    Result of the CreatePipe operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deletePipe
```
public DeletePipeResult deletePipe(DeletePipeRequest request)
```
    Description copied from interface: AmazonPipes
    
    Delete an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
    
    Specified by:
    
    deletePipe in interface AmazonPipes
    
    Returns:
    
    Result of the DeletePipe operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describePipe
```
public DescribePipeResult describePipe(DescribePipeRequest request)
```
    Description copied from interface: AmazonPipes
    
    Get the information about an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
    
    Specified by:
    
    describePipe in interface AmazonPipes
    
    Returns:
    
    Result of the DescribePipe operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listPipes
```
public ListPipesResult listPipes(ListPipesRequest request)
```
    Description copied from interface: AmazonPipes
    
    Get the pipes associated with this account. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
    
    Specified by:
    
    listPipes in interface AmazonPipes
    
    Returns:
    
    Result of the ListPipes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AmazonPipes
    
    Displays the tags associated with a pipe.
    
    Specified by:
    
    listTagsForResource in interface AmazonPipes
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startPipe
```
public StartPipeResult startPipe(StartPipeRequest request)
```
    Description copied from interface: AmazonPipes
    
    Start an existing pipe.
    
    Specified by:
    
    startPipe in interface AmazonPipes
    
    Returns:
    
    Result of the StartPipe operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopPipe
```
public StopPipeResult stopPipe(StopPipeRequest request)
```
    Description copied from interface: AmazonPipes
    
    Stop an existing pipe.
    
    Specified by:
    
    stopPipe in interface AmazonPipes
    
    Returns:
    
    Result of the StopPipe operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AmazonPipes
    
    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.
    
    Specified by:
    
    tagResource in interface AmazonPipes
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AmazonPipes
    
    Removes one or more tags from the specified pipes.
    
    Specified by:
    
    untagResource in interface AmazonPipes
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updatePipe
```
public UpdatePipeResult updatePipe(UpdatePipeRequest request)
```
    Description copied from interface: AmazonPipes
    
    Update an existing pipe. When you call UpdatePipe, only the fields that are included in the request are changed, the rest are unchanged. The exception to this is if you modify any Amazon Web Services-service specific fields in the SourceParameters, EnrichmentParameters, or TargetParameters objects. The fields in these objects are updated atomically as one and override existing values. This is by design and means that if you don't specify an optional field in one of these Parameters objects, that field will be set to its system-default value after the update.
    
    For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
    
    Specified by:
    
    updatePipe in interface AmazonPipes
    
    Returns:
    
    Result of the UpdatePipe operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonPipes
    
    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 AmazonPipes
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonPipes
    
    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 AmazonPipes
    
    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 AbstractAmazonPipes

Field Summary

Fields inherited from interface com.amazonaws.services.pipes.AmazonPipes

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createPipe

deletePipe

describePipe

listPipes

listTagsForResource

startPipe

stopPipe

tagResource

untagResource

updatePipe

shutdown

getCachedResponseMetadata