@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface OsisAsyncClient extends AwsClient
builder() method.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static OsisAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
OsisAsyncClient. |
static OsisAsyncClient |
create()
Create a
OsisAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreatePipelineResponse> |
createPipeline(Consumer<CreatePipelineRequest.Builder> createPipelineRequest)
Creates an OpenSearch Ingestion pipeline.
|
default CompletableFuture<CreatePipelineResponse> |
createPipeline(CreatePipelineRequest createPipelineRequest)
Creates an OpenSearch Ingestion pipeline.
|
default CompletableFuture<DeletePipelineResponse> |
deletePipeline(Consumer<DeletePipelineRequest.Builder> deletePipelineRequest)
Deletes an OpenSearch Ingestion pipeline.
|
default CompletableFuture<DeletePipelineResponse> |
deletePipeline(DeletePipelineRequest deletePipelineRequest)
Deletes an OpenSearch Ingestion pipeline.
|
default CompletableFuture<GetPipelineResponse> |
getPipeline(Consumer<GetPipelineRequest.Builder> getPipelineRequest)
Retrieves information about an OpenSearch Ingestion pipeline.
|
default CompletableFuture<GetPipelineResponse> |
getPipeline(GetPipelineRequest getPipelineRequest)
Retrieves information about an OpenSearch Ingestion pipeline.
|
default CompletableFuture<GetPipelineBlueprintResponse> |
getPipelineBlueprint(Consumer<GetPipelineBlueprintRequest.Builder> getPipelineBlueprintRequest)
Retrieves information about a specific blueprint for OpenSearch Ingestion.
|
default CompletableFuture<GetPipelineBlueprintResponse> |
getPipelineBlueprint(GetPipelineBlueprintRequest getPipelineBlueprintRequest)
Retrieves information about a specific blueprint for OpenSearch Ingestion.
|
default CompletableFuture<GetPipelineChangeProgressResponse> |
getPipelineChangeProgress(Consumer<GetPipelineChangeProgressRequest.Builder> getPipelineChangeProgressRequest)
Returns progress information for the current change happening on an OpenSearch Ingestion pipeline.
|
default CompletableFuture<GetPipelineChangeProgressResponse> |
getPipelineChangeProgress(GetPipelineChangeProgressRequest getPipelineChangeProgressRequest)
Returns progress information for the current change happening on an OpenSearch Ingestion pipeline.
|
default CompletableFuture<ListPipelineBlueprintsResponse> |
listPipelineBlueprints(Consumer<ListPipelineBlueprintsRequest.Builder> listPipelineBlueprintsRequest)
Retrieves a list of all available blueprints for Data Prepper.
|
default CompletableFuture<ListPipelineBlueprintsResponse> |
listPipelineBlueprints(ListPipelineBlueprintsRequest listPipelineBlueprintsRequest)
Retrieves a list of all available blueprints for Data Prepper.
|
default CompletableFuture<ListPipelinesResponse> |
listPipelines(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)
Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region.
|
default CompletableFuture<ListPipelinesResponse> |
listPipelines(ListPipelinesRequest listPipelinesRequest)
Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region.
|
default ListPipelinesPublisher |
listPipelinesPaginator(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)
Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region.
|
default ListPipelinesPublisher |
listPipelinesPaginator(ListPipelinesRequest listPipelinesRequest)
Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all resource tags associated with an OpenSearch Ingestion pipeline.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all resource tags associated with an OpenSearch Ingestion pipeline.
|
default OsisServiceClientConfiguration |
serviceClientConfiguration() |
default CompletableFuture<StartPipelineResponse> |
startPipeline(Consumer<StartPipelineRequest.Builder> startPipelineRequest)
Starts an OpenSearch Ingestion pipeline.
|
default CompletableFuture<StartPipelineResponse> |
startPipeline(StartPipelineRequest startPipelineRequest)
Starts an OpenSearch Ingestion pipeline.
|
default CompletableFuture<StopPipelineResponse> |
stopPipeline(Consumer<StopPipelineRequest.Builder> stopPipelineRequest)
Stops an OpenSearch Ingestion pipeline.
|
default CompletableFuture<StopPipelineResponse> |
stopPipeline(StopPipelineRequest stopPipelineRequest)
Stops an OpenSearch Ingestion pipeline.
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Tags an OpenSearch Ingestion pipeline.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Tags an OpenSearch Ingestion pipeline.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes one or more tags from an OpenSearch Ingestion pipeline.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from an OpenSearch Ingestion pipeline.
|
default CompletableFuture<UpdatePipelineResponse> |
updatePipeline(Consumer<UpdatePipelineRequest.Builder> updatePipelineRequest)
Updates an OpenSearch Ingestion pipeline.
|
default CompletableFuture<UpdatePipelineResponse> |
updatePipeline(UpdatePipelineRequest updatePipelineRequest)
Updates an OpenSearch Ingestion pipeline.
|
default CompletableFuture<ValidatePipelineResponse> |
validatePipeline(Consumer<ValidatePipelineRequest.Builder> validatePipelineRequest)
Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation.
|
default CompletableFuture<ValidatePipelineResponse> |
validatePipeline(ValidatePipelineRequest validatePipelineRequest)
Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<CreatePipelineResponse> createPipeline(CreatePipelineRequest createPipelineRequest)
Creates an OpenSearch Ingestion pipeline. For more information, see Creating Amazon OpenSearch Ingestion pipelines.
createPipelineRequest - default CompletableFuture<CreatePipelineResponse> createPipeline(Consumer<CreatePipelineRequest.Builder> createPipelineRequest)
Creates an OpenSearch Ingestion pipeline. For more information, see Creating Amazon OpenSearch Ingestion pipelines.
This is a convenience which creates an instance of the CreatePipelineRequest.Builder avoiding the need to
create one manually via CreatePipelineRequest.builder()
createPipelineRequest - A Consumer that will call methods on
CreatePipelineRequest.Builder to create a request.default CompletableFuture<DeletePipelineResponse> deletePipeline(DeletePipelineRequest deletePipelineRequest)
Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon OpenSearch Ingestion pipelines.
deletePipelineRequest - default CompletableFuture<DeletePipelineResponse> deletePipeline(Consumer<DeletePipelineRequest.Builder> deletePipelineRequest)
Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon OpenSearch Ingestion pipelines.
This is a convenience which creates an instance of the DeletePipelineRequest.Builder avoiding the need to
create one manually via DeletePipelineRequest.builder()
deletePipelineRequest - A Consumer that will call methods on
DeletePipelineRequest.Builder to create a request.default CompletableFuture<GetPipelineResponse> getPipeline(GetPipelineRequest getPipelineRequest)
Retrieves information about an OpenSearch Ingestion pipeline.
getPipelineRequest - default CompletableFuture<GetPipelineResponse> getPipeline(Consumer<GetPipelineRequest.Builder> getPipelineRequest)
Retrieves information about an OpenSearch Ingestion pipeline.
This is a convenience which creates an instance of the GetPipelineRequest.Builder avoiding the need to
create one manually via GetPipelineRequest.builder()
getPipelineRequest - A Consumer that will call methods on
GetPipelineRequest.Builder to create a request.default CompletableFuture<GetPipelineBlueprintResponse> getPipelineBlueprint(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.
getPipelineBlueprintRequest - default CompletableFuture<GetPipelineBlueprintResponse> getPipelineBlueprint(Consumer<GetPipelineBlueprintRequest.Builder> 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.
This is a convenience which creates an instance of the GetPipelineBlueprintRequest.Builder avoiding the
need to create one manually via GetPipelineBlueprintRequest.builder()
getPipelineBlueprintRequest - A Consumer that will call methods on
GetPipelineBlueprintRequest.Builder to create a
request.default CompletableFuture<GetPipelineChangeProgressResponse> getPipelineChangeProgress(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.
getPipelineChangeProgressRequest - default CompletableFuture<GetPipelineChangeProgressResponse> getPipelineChangeProgress(Consumer<GetPipelineChangeProgressRequest.Builder> 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.
This is a convenience which creates an instance of the GetPipelineChangeProgressRequest.Builder avoiding
the need to create one manually via GetPipelineChangeProgressRequest.builder()
getPipelineChangeProgressRequest - A Consumer that will call methods on
GetPipelineChangeProgressRequest.Builder to create a
request.default CompletableFuture<ListPipelineBlueprintsResponse> listPipelineBlueprints(ListPipelineBlueprintsRequest listPipelineBlueprintsRequest)
Retrieves a list of all available blueprints for Data Prepper. For more information, see Using blueprints to create a pipeline.
listPipelineBlueprintsRequest - default CompletableFuture<ListPipelineBlueprintsResponse> listPipelineBlueprints(Consumer<ListPipelineBlueprintsRequest.Builder> listPipelineBlueprintsRequest)
Retrieves a list of all available blueprints for Data Prepper. For more information, see Using blueprints to create a pipeline.
This is a convenience which creates an instance of the ListPipelineBlueprintsRequest.Builder avoiding the
need to create one manually via ListPipelineBlueprintsRequest.builder()
listPipelineBlueprintsRequest - A Consumer that will call methods on
ListPipelineBlueprintsRequest.Builder to create a
request.default CompletableFuture<ListPipelinesResponse> listPipelines(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.
listPipelinesRequest - default CompletableFuture<ListPipelinesResponse> listPipelines(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)
Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more information, see Viewing Amazon OpenSearch Ingestion pipelines.
This is a convenience which creates an instance of the ListPipelinesRequest.Builder avoiding the need to
create one manually via ListPipelinesRequest.builder()
listPipelinesRequest - A Consumer that will call methods on
ListPipelinesRequest.Builder to create a request.default ListPipelinesPublisher listPipelinesPaginator(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.
This is a variant of listPipelines(software.amazon.awssdk.services.osis.model.ListPipelinesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.osis.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.osis.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.osis.model.ListPipelinesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.osis.model.ListPipelinesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPipelines(software.amazon.awssdk.services.osis.model.ListPipelinesRequest) operation.
listPipelinesRequest - default ListPipelinesPublisher listPipelinesPaginator(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)
Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more information, see Viewing Amazon OpenSearch Ingestion pipelines.
This is a variant of listPipelines(software.amazon.awssdk.services.osis.model.ListPipelinesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.osis.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.osis.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.osis.model.ListPipelinesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.osis.model.ListPipelinesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPipelines(software.amazon.awssdk.services.osis.model.ListPipelinesRequest) operation.
This is a convenience which creates an instance of the ListPipelinesRequest.Builder avoiding the need to
create one manually via ListPipelinesRequest.builder()
listPipelinesRequest - A Consumer that will call methods on
ListPipelinesRequest.Builder to create a request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to create a request.default CompletableFuture<StartPipelineResponse> startPipeline(StartPipelineRequest startPipelineRequest)
Starts an OpenSearch Ingestion pipeline. For more information, see Starting an OpenSearch Ingestion pipeline.
startPipelineRequest - default CompletableFuture<StartPipelineResponse> startPipeline(Consumer<StartPipelineRequest.Builder> startPipelineRequest)
Starts an OpenSearch Ingestion pipeline. For more information, see Starting an OpenSearch Ingestion pipeline.
This is a convenience which creates an instance of the StartPipelineRequest.Builder avoiding the need to
create one manually via StartPipelineRequest.builder()
startPipelineRequest - A Consumer that will call methods on
StartPipelineRequest.Builder to create a request.default CompletableFuture<StopPipelineResponse> stopPipeline(StopPipelineRequest stopPipelineRequest)
Stops an OpenSearch Ingestion pipeline. For more information, see Stopping an OpenSearch Ingestion pipeline.
stopPipelineRequest - default CompletableFuture<StopPipelineResponse> stopPipeline(Consumer<StopPipelineRequest.Builder> stopPipelineRequest)
Stops an OpenSearch Ingestion pipeline. For more information, see Stopping an OpenSearch Ingestion pipeline.
This is a convenience which creates an instance of the StopPipelineRequest.Builder avoiding the need to
create one manually via StopPipelineRequest.builder()
stopPipelineRequest - A Consumer that will call methods on
StopPipelineRequest.Builder to create a request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on
TagResourceRequest.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on
UntagResourceRequest.Builder to create a request.default CompletableFuture<UpdatePipelineResponse> updatePipeline(UpdatePipelineRequest updatePipelineRequest)
Updates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon OpenSearch Ingestion pipelines.
updatePipelineRequest - default CompletableFuture<UpdatePipelineResponse> updatePipeline(Consumer<UpdatePipelineRequest.Builder> updatePipelineRequest)
Updates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon OpenSearch Ingestion pipelines.
This is a convenience which creates an instance of the UpdatePipelineRequest.Builder avoiding the need to
create one manually via UpdatePipelineRequest.builder()
updatePipelineRequest - A Consumer that will call methods on
UpdatePipelineRequest.Builder to create a request.default CompletableFuture<ValidatePipelineResponse> validatePipeline(ValidatePipelineRequest validatePipelineRequest)
Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For more information, see Creating Amazon OpenSearch Ingestion pipelines.
validatePipelineRequest - default CompletableFuture<ValidatePipelineResponse> validatePipeline(Consumer<ValidatePipelineRequest.Builder> validatePipelineRequest)
Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For more information, see Creating Amazon OpenSearch Ingestion pipelines.
This is a convenience which creates an instance of the ValidatePipelineRequest.Builder avoiding the need
to create one manually via ValidatePipelineRequest.builder()
validatePipelineRequest - A Consumer that will call methods on
ValidatePipelineRequest.Builder to create a request.default OsisServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic OsisAsyncClient create()
OsisAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static OsisAsyncClientBuilder builder()
OsisAsyncClient.Copyright © 2023. All rights reserved.