com.amazonaws.services.osis.AmazonOSISAsync Maven / Gradle / Ivy
Show all versions of aws-java-sdk-osis Show documentation
/*
* Copyright 2019-2024 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.osis;
import javax.annotation.Generated;
import com.amazonaws.services.osis.model.*;
/**
* Interface for accessing Amazon OpenSearch Ingestion 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.osis.AbstractAmazonOSISAsync} instead.
*
*
*
* 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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonOSISAsync extends AmazonOSIS {
/**
*
* Creates an OpenSearch Ingestion pipeline. For more information, see Creating
* Amazon OpenSearch Ingestion pipelines.
*
*
* @param createPipelineRequest
* @return A Java Future containing the result of the CreatePipeline operation returned by the service.
* @sample AmazonOSISAsync.CreatePipeline
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createPipelineAsync(CreatePipelineRequest createPipelineRequest);
/**
*
* Creates an OpenSearch Ingestion pipeline. For more information, see Creating
* Amazon OpenSearch Ingestion pipelines.
*
*
* @param createPipelineRequest
* @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 CreatePipeline operation returned by the service.
* @sample AmazonOSISAsyncHandler.CreatePipeline
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createPipelineAsync(CreatePipelineRequest createPipelineRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon
* OpenSearch Ingestion pipelines.
*
*
* @param deletePipelineRequest
* @return A Java Future containing the result of the DeletePipeline operation returned by the service.
* @sample AmazonOSISAsync.DeletePipeline
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deletePipelineAsync(DeletePipelineRequest deletePipelineRequest);
/**
*
* Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon
* OpenSearch Ingestion pipelines.
*
*
* @param deletePipelineRequest
* @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 DeletePipeline operation returned by the service.
* @sample AmazonOSISAsyncHandler.DeletePipeline
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deletePipelineAsync(DeletePipelineRequest deletePipelineRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves information about an OpenSearch Ingestion pipeline.
*
*
* @param getPipelineRequest
* @return A Java Future containing the result of the GetPipeline operation returned by the service.
* @sample AmazonOSISAsync.GetPipeline
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getPipelineAsync(GetPipelineRequest getPipelineRequest);
/**
*
* Retrieves information about an OpenSearch Ingestion pipeline.
*
*
* @param getPipelineRequest
* @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 GetPipeline operation returned by the service.
* @sample AmazonOSISAsyncHandler.GetPipeline
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getPipelineAsync(GetPipelineRequest getPipelineRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param getPipelineBlueprintRequest
* @return A Java Future containing the result of the GetPipelineBlueprint operation returned by the service.
* @sample AmazonOSISAsync.GetPipelineBlueprint
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getPipelineBlueprintAsync(GetPipelineBlueprintRequest getPipelineBlueprintRequest);
/**
*
* 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.
*
*
* @param getPipelineBlueprintRequest
* @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 GetPipelineBlueprint operation returned by the service.
* @sample AmazonOSISAsyncHandler.GetPipelineBlueprint
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getPipelineBlueprintAsync(GetPipelineBlueprintRequest getPipelineBlueprintRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param getPipelineChangeProgressRequest
* @return A Java Future containing the result of the GetPipelineChangeProgress operation returned by the service.
* @sample AmazonOSISAsync.GetPipelineChangeProgress
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getPipelineChangeProgressAsync(
GetPipelineChangeProgressRequest getPipelineChangeProgressRequest);
/**
*
* 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.
*
*
* @param getPipelineChangeProgressRequest
* @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 GetPipelineChangeProgress operation returned by the service.
* @sample AmazonOSISAsyncHandler.GetPipelineChangeProgress
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getPipelineChangeProgressAsync(
GetPipelineChangeProgressRequest getPipelineChangeProgressRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves a list of all available blueprints for Data Prepper. For more information, see Using blueprints to create a pipeline.
*
*
* @param listPipelineBlueprintsRequest
* @return A Java Future containing the result of the ListPipelineBlueprints operation returned by the service.
* @sample AmazonOSISAsync.ListPipelineBlueprints
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listPipelineBlueprintsAsync(ListPipelineBlueprintsRequest listPipelineBlueprintsRequest);
/**
*
* Retrieves a list of all available blueprints for Data Prepper. For more information, see Using blueprints to create a pipeline.
*
*
* @param listPipelineBlueprintsRequest
* @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 ListPipelineBlueprints operation returned by the service.
* @sample AmazonOSISAsyncHandler.ListPipelineBlueprints
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listPipelineBlueprintsAsync(ListPipelineBlueprintsRequest listPipelineBlueprintsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more
* information, see Viewing Amazon
* OpenSearch Ingestion pipelines.
*
*
* @param listPipelinesRequest
* @return A Java Future containing the result of the ListPipelines operation returned by the service.
* @sample AmazonOSISAsync.ListPipelines
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listPipelinesAsync(ListPipelinesRequest listPipelinesRequest);
/**
*
* Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more
* information, see Viewing Amazon
* OpenSearch Ingestion pipelines.
*
*
* @param listPipelinesRequest
* @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 ListPipelines operation returned by the service.
* @sample AmazonOSISAsyncHandler.ListPipelines
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listPipelinesAsync(ListPipelinesRequest listPipelinesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon
* OpenSearch Ingestion pipelines.
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AmazonOSISAsync.ListTagsForResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon
* OpenSearch Ingestion pipelines.
*
*
* @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 AmazonOSISAsyncHandler.ListTagsForResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Starts an OpenSearch Ingestion pipeline. For more information, see Starting an OpenSearch Ingestion pipeline.
*
*
* @param startPipelineRequest
* @return A Java Future containing the result of the StartPipeline operation returned by the service.
* @sample AmazonOSISAsync.StartPipeline
* @see AWS API
* Documentation
*/
java.util.concurrent.Future startPipelineAsync(StartPipelineRequest startPipelineRequest);
/**
*
* Starts an OpenSearch Ingestion pipeline. For more information, see Starting an OpenSearch Ingestion pipeline.
*
*
* @param startPipelineRequest
* @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 StartPipeline operation returned by the service.
* @sample AmazonOSISAsyncHandler.StartPipeline
* @see AWS API
* Documentation
*/
java.util.concurrent.Future startPipelineAsync(StartPipelineRequest startPipelineRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Stops an OpenSearch Ingestion pipeline. For more information, see Stopping an OpenSearch Ingestion pipeline.
*
*
* @param stopPipelineRequest
* @return A Java Future containing the result of the StopPipeline operation returned by the service.
* @sample AmazonOSISAsync.StopPipeline
* @see AWS API
* Documentation
*/
java.util.concurrent.Future stopPipelineAsync(StopPipelineRequest stopPipelineRequest);
/**
*
* Stops an OpenSearch Ingestion pipeline. For more information, see Stopping an OpenSearch Ingestion pipeline.
*
*
* @param stopPipelineRequest
* @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 StopPipeline operation returned by the service.
* @sample AmazonOSISAsyncHandler.StopPipeline
* @see AWS API
* Documentation
*/
java.util.concurrent.Future stopPipelineAsync(StopPipelineRequest stopPipelineRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon
* OpenSearch Ingestion pipelines.
*
*
* @param tagResourceRequest
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AmazonOSISAsync.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest);
/**
*
* Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon
* OpenSearch Ingestion pipelines.
*
*
* @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 AmazonOSISAsyncHandler.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon
* OpenSearch Ingestion pipelines.
*
*
* @param untagResourceRequest
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AmazonOSISAsync.UntagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest);
/**
*
* Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon
* OpenSearch Ingestion pipelines.
*
*
* @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 AmazonOSISAsyncHandler.UntagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon
* OpenSearch Ingestion pipelines.
*
*
* @param updatePipelineRequest
* @return A Java Future containing the result of the UpdatePipeline operation returned by the service.
* @sample AmazonOSISAsync.UpdatePipeline
* @see AWS API
* Documentation
*/
java.util.concurrent.Future updatePipelineAsync(UpdatePipelineRequest updatePipelineRequest);
/**
*
* Updates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon
* OpenSearch Ingestion pipelines.
*
*
* @param updatePipelineRequest
* @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 UpdatePipeline operation returned by the service.
* @sample AmazonOSISAsyncHandler.UpdatePipeline
* @see AWS API
* Documentation
*/
java.util.concurrent.Future updatePipelineAsync(UpdatePipelineRequest updatePipelineRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For more information,
* see Creating
* Amazon OpenSearch Ingestion pipelines.
*
*
* @param validatePipelineRequest
* @return A Java Future containing the result of the ValidatePipeline operation returned by the service.
* @sample AmazonOSISAsync.ValidatePipeline
* @see AWS API
* Documentation
*/
java.util.concurrent.Future validatePipelineAsync(ValidatePipelineRequest validatePipelineRequest);
/**
*
* Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For more information,
* see Creating
* Amazon OpenSearch Ingestion pipelines.
*
*
* @param validatePipelineRequest
* @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 ValidatePipeline operation returned by the service.
* @sample AmazonOSISAsyncHandler.ValidatePipeline
* @see AWS API
* Documentation
*/
java.util.concurrent.Future validatePipelineAsync(ValidatePipelineRequest validatePipelineRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}