Package org.opensearch.client.opensearch.search_pipeline

Class OpenSearchSearchPipelineAsyncClient

java.lang.Object

org.opensearch.client.ApiClient<OpenSearchTransport,OpenSearchSearchPipelineAsyncClient>

org.opensearch.client.opensearch.search_pipeline.OpenSearchSearchPipelineAsyncClient

@Generated("org.opensearch.client.codegen.CodeGenerator")
public class OpenSearchSearchPipelineAsyncClient
extends ApiClient<OpenSearchTransport,OpenSearchSearchPipelineAsyncClient>

Client for the search_pipeline namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
OpenSearchSearchPipelineAsyncClient(OpenSearchTransport transport)
OpenSearchSearchPipelineAsyncClient(OpenSearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
final CompletableFuture<DeleteSearchPipelineResponse>	delete(Function<DeleteSearchPipelineRequest.Builder,ObjectBuilder<DeleteSearchPipelineRequest>> fn)	Deletes the specified search pipeline.
CompletableFuture<DeleteSearchPipelineResponse>	delete(DeleteSearchPipelineRequest request)	Deletes the specified search pipeline.
final CompletableFuture<GetSearchPipelineResponse>	get()	Retrieves information about a specified search pipeline.
final CompletableFuture<GetSearchPipelineResponse>	get(Function<GetSearchPipelineRequest.Builder,ObjectBuilder<GetSearchPipelineRequest>> fn)	Retrieves information about a specified search pipeline.
CompletableFuture<GetSearchPipelineResponse>	get(GetSearchPipelineRequest request)	Retrieves information about a specified search pipeline.
final CompletableFuture<PutSearchPipelineResponse>	put(Function<PutSearchPipelineRequest.Builder,ObjectBuilder<PutSearchPipelineRequest>> fn)	Creates or replaces the specified search pipeline.
CompletableFuture<PutSearchPipelineResponse>	put(PutSearchPipelineRequest request)	Creates or replaces the specified search pipeline.
OpenSearchSearchPipelineAsyncClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class org.opensearch.client.ApiClient

_transport, _transportOptions, getDeserializer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OpenSearchSearchPipelineAsyncClient

public OpenSearchSearchPipelineAsyncClient(OpenSearchTransport transport)

OpenSearchSearchPipelineAsyncClient

public OpenSearchSearchPipelineAsyncClient(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public OpenSearchSearchPipelineAsyncClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchSearchPipelineAsyncClient>

delete

public CompletableFuture<DeleteSearchPipelineResponse> delete(DeleteSearchPipelineRequest request)
                                                       throws IOException,
OpenSearchException

Deletes the specified search pipeline.

Throws:

IOException

OpenSearchException

delete

public final CompletableFuture<DeleteSearchPipelineResponse> delete(Function<DeleteSearchPipelineRequest.Builder,ObjectBuilder<DeleteSearchPipelineRequest>> fn)
                                                             throws IOException,
OpenSearchException

Deletes the specified search pipeline.

Parameters:

fn - a function that initializes a builder to create the DeleteSearchPipelineRequest

Throws:

IOException

OpenSearchException

get

public CompletableFuture<GetSearchPipelineResponse> get(GetSearchPipelineRequest request)
                                                 throws IOException,
OpenSearchException

Retrieves information about a specified search pipeline.

Throws:

IOException

OpenSearchException

get

public final CompletableFuture<GetSearchPipelineResponse> get(Function<GetSearchPipelineRequest.Builder,ObjectBuilder<GetSearchPipelineRequest>> fn)
                                                       throws IOException,
OpenSearchException

Retrieves information about a specified search pipeline.

Parameters:

fn - a function that initializes a builder to create the GetSearchPipelineRequest

Throws:

IOException

OpenSearchException

get

public final CompletableFuture<GetSearchPipelineResponse> get()
                                                       throws IOException,
OpenSearchException

Retrieves information about a specified search pipeline.

Throws:

IOException

OpenSearchException

put

public CompletableFuture<PutSearchPipelineResponse> put(PutSearchPipelineRequest request)
                                                 throws IOException,
OpenSearchException

Creates or replaces the specified search pipeline.

Throws:

IOException

OpenSearchException

put

public final CompletableFuture<PutSearchPipelineResponse> put(Function<PutSearchPipelineRequest.Builder,ObjectBuilder<PutSearchPipelineRequest>> fn)
                                                       throws IOException,
OpenSearchException

Creates or replaces the specified search pipeline.

Parameters:

fn - a function that initializes a builder to create the PutSearchPipelineRequest

Throws:

IOException

OpenSearchException