@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonOSISAsyncClient extends AmazonOSISClient implements AmazonOSISAsync
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Use the Amazon OpenSearch Ingestion API to create and manage ingestion pipelines. OpenSearch Ingestion is a fully managed data collector that delivers real-time log and trace data to OpenSearch Service domains. For more information, see Getting data into your cluster using OpenSearch Ingestion.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
builder, createPipeline, deletePipeline, getCachedResponseMetadata, getPipeline, getPipelineBlueprint, getPipelineChangeProgress, listPipelineBlueprints, listPipelines, listTagsForResource, startPipeline, stopPipeline, tagResource, untagResource, updatePipeline, validatePipeline
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createPipeline, deletePipeline, getCachedResponseMetadata, getPipeline, getPipelineBlueprint, getPipelineChangeProgress, listPipelineBlueprints, listPipelines, listTagsForResource, startPipeline, stopPipeline, tagResource, untagResource, updatePipeline, validatePipeline
public static AmazonOSISAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CreatePipelineResult> createPipelineAsync(CreatePipelineRequest request)
AmazonOSISAsync
Creates an OpenSearch Ingestion pipeline. For more information, see Creating Amazon OpenSearch Ingestion pipelines.
createPipelineAsync
in interface AmazonOSISAsync
public Future<CreatePipelineResult> createPipelineAsync(CreatePipelineRequest request, AsyncHandler<CreatePipelineRequest,CreatePipelineResult> asyncHandler)
AmazonOSISAsync
Creates an OpenSearch Ingestion pipeline. For more information, see Creating Amazon OpenSearch Ingestion pipelines.
createPipelineAsync
in interface AmazonOSISAsync
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.public Future<DeletePipelineResult> deletePipelineAsync(DeletePipelineRequest request)
AmazonOSISAsync
Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon OpenSearch Ingestion pipelines.
deletePipelineAsync
in interface AmazonOSISAsync
public Future<DeletePipelineResult> deletePipelineAsync(DeletePipelineRequest request, AsyncHandler<DeletePipelineRequest,DeletePipelineResult> asyncHandler)
AmazonOSISAsync
Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon OpenSearch Ingestion pipelines.
deletePipelineAsync
in interface AmazonOSISAsync
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.public Future<GetPipelineResult> getPipelineAsync(GetPipelineRequest request)
AmazonOSISAsync
Retrieves information about an OpenSearch Ingestion pipeline.
getPipelineAsync
in interface AmazonOSISAsync
public Future<GetPipelineResult> getPipelineAsync(GetPipelineRequest request, AsyncHandler<GetPipelineRequest,GetPipelineResult> asyncHandler)
AmazonOSISAsync
Retrieves information about an OpenSearch Ingestion pipeline.
getPipelineAsync
in interface AmazonOSISAsync
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.public Future<GetPipelineBlueprintResult> getPipelineBlueprintAsync(GetPipelineBlueprintRequest request)
AmazonOSISAsync
Retrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints are templates for the
configuration needed for a CreatePipeline
request. For more information, see Using blueprints to create a pipeline.
getPipelineBlueprintAsync
in interface AmazonOSISAsync
public Future<GetPipelineBlueprintResult> getPipelineBlueprintAsync(GetPipelineBlueprintRequest request, AsyncHandler<GetPipelineBlueprintRequest,GetPipelineBlueprintResult> asyncHandler)
AmazonOSISAsync
Retrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints are templates for the
configuration needed for a CreatePipeline
request. For more information, see Using blueprints to create a pipeline.
getPipelineBlueprintAsync
in interface AmazonOSISAsync
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.public Future<GetPipelineChangeProgressResult> getPipelineChangeProgressAsync(GetPipelineChangeProgressRequest request)
AmazonOSISAsync
Returns progress information for the current change happening on an OpenSearch Ingestion pipeline. Currently, this operation only returns information when a pipeline is being created.
For more information, see Tracking the status of pipeline creation.
getPipelineChangeProgressAsync
in interface AmazonOSISAsync
public Future<GetPipelineChangeProgressResult> getPipelineChangeProgressAsync(GetPipelineChangeProgressRequest request, AsyncHandler<GetPipelineChangeProgressRequest,GetPipelineChangeProgressResult> asyncHandler)
AmazonOSISAsync
Returns progress information for the current change happening on an OpenSearch Ingestion pipeline. Currently, this operation only returns information when a pipeline is being created.
For more information, see Tracking the status of pipeline creation.
getPipelineChangeProgressAsync
in interface AmazonOSISAsync
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.public Future<ListPipelineBlueprintsResult> listPipelineBlueprintsAsync(ListPipelineBlueprintsRequest request)
AmazonOSISAsync
Retrieves a list of all available blueprints for Data Prepper. For more information, see Using blueprints to create a pipeline.
listPipelineBlueprintsAsync
in interface AmazonOSISAsync
public Future<ListPipelineBlueprintsResult> listPipelineBlueprintsAsync(ListPipelineBlueprintsRequest request, AsyncHandler<ListPipelineBlueprintsRequest,ListPipelineBlueprintsResult> asyncHandler)
AmazonOSISAsync
Retrieves a list of all available blueprints for Data Prepper. For more information, see Using blueprints to create a pipeline.
listPipelineBlueprintsAsync
in interface AmazonOSISAsync
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.public Future<ListPipelinesResult> listPipelinesAsync(ListPipelinesRequest request)
AmazonOSISAsync
Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more information, see Viewing Amazon OpenSearch Ingestion pipelines.
listPipelinesAsync
in interface AmazonOSISAsync
public Future<ListPipelinesResult> listPipelinesAsync(ListPipelinesRequest request, AsyncHandler<ListPipelinesRequest,ListPipelinesResult> asyncHandler)
AmazonOSISAsync
Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more information, see Viewing Amazon OpenSearch Ingestion pipelines.
listPipelinesAsync
in interface AmazonOSISAsync
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.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonOSISAsync
Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
listTagsForResourceAsync
in interface AmazonOSISAsync
public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonOSISAsync
Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
listTagsForResourceAsync
in interface AmazonOSISAsync
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.public Future<StartPipelineResult> startPipelineAsync(StartPipelineRequest request)
AmazonOSISAsync
Starts an OpenSearch Ingestion pipeline. For more information, see Starting an OpenSearch Ingestion pipeline.
startPipelineAsync
in interface AmazonOSISAsync
public Future<StartPipelineResult> startPipelineAsync(StartPipelineRequest request, AsyncHandler<StartPipelineRequest,StartPipelineResult> asyncHandler)
AmazonOSISAsync
Starts an OpenSearch Ingestion pipeline. For more information, see Starting an OpenSearch Ingestion pipeline.
startPipelineAsync
in interface AmazonOSISAsync
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.public Future<StopPipelineResult> stopPipelineAsync(StopPipelineRequest request)
AmazonOSISAsync
Stops an OpenSearch Ingestion pipeline. For more information, see Stopping an OpenSearch Ingestion pipeline.
stopPipelineAsync
in interface AmazonOSISAsync
public Future<StopPipelineResult> stopPipelineAsync(StopPipelineRequest request, AsyncHandler<StopPipelineRequest,StopPipelineResult> asyncHandler)
AmazonOSISAsync
Stops an OpenSearch Ingestion pipeline. For more information, see Stopping an OpenSearch Ingestion pipeline.
stopPipelineAsync
in interface AmazonOSISAsync
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.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonOSISAsync
Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
tagResourceAsync
in interface AmazonOSISAsync
public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonOSISAsync
Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
tagResourceAsync
in interface AmazonOSISAsync
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.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonOSISAsync
Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
untagResourceAsync
in interface AmazonOSISAsync
public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonOSISAsync
Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
untagResourceAsync
in interface AmazonOSISAsync
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.public Future<UpdatePipelineResult> updatePipelineAsync(UpdatePipelineRequest request)
AmazonOSISAsync
Updates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon OpenSearch Ingestion pipelines.
updatePipelineAsync
in interface AmazonOSISAsync
public Future<UpdatePipelineResult> updatePipelineAsync(UpdatePipelineRequest request, AsyncHandler<UpdatePipelineRequest,UpdatePipelineResult> asyncHandler)
AmazonOSISAsync
Updates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon OpenSearch Ingestion pipelines.
updatePipelineAsync
in interface AmazonOSISAsync
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.public Future<ValidatePipelineResult> validatePipelineAsync(ValidatePipelineRequest request)
AmazonOSISAsync
Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For more information, see Creating Amazon OpenSearch Ingestion pipelines.
validatePipelineAsync
in interface AmazonOSISAsync
public Future<ValidatePipelineResult> validatePipelineAsync(ValidatePipelineRequest request, AsyncHandler<ValidatePipelineRequest,ValidatePipelineResult> asyncHandler)
AmazonOSISAsync
Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For more information, see Creating Amazon OpenSearch Ingestion pipelines.
validatePipelineAsync
in interface AmazonOSISAsync
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.public void shutdown()
getExecutorService().shutdown()
followed by getExecutorService().awaitTermination()
prior to
calling this method.shutdown
in interface AmazonOSIS
shutdown
in class AmazonOSISClient