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
java.util.concurrent.CompletableFuture<DeleteSearchPipelineResponse>	delete(java.util.function.Function<DeleteSearchPipelineRequest.Builder,ObjectBuilder<DeleteSearchPipelineRequest>> fn)	Deletes the specified search pipeline.
java.util.concurrent.CompletableFuture<DeleteSearchPipelineResponse>	delete(DeleteSearchPipelineRequest request)	Deletes the specified search pipeline.
java.util.concurrent.CompletableFuture<GetSearchPipelineResponse>	get()	Retrieves information about a specified search pipeline.
java.util.concurrent.CompletableFuture<GetSearchPipelineResponse>	get(java.util.function.Function<GetSearchPipelineRequest.Builder,ObjectBuilder<GetSearchPipelineRequest>> fn)	Retrieves information about a specified search pipeline.
java.util.concurrent.CompletableFuture<GetSearchPipelineResponse>	get(GetSearchPipelineRequest request)	Retrieves information about a specified search pipeline.
java.util.concurrent.CompletableFuture<PutSearchPipelineResponse>	put(java.util.function.Function<PutSearchPipelineRequest.Builder,ObjectBuilder<PutSearchPipelineRequest>> fn)	Creates or replaces the specified search pipeline.
java.util.concurrent.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 Detail

OpenSearchSearchPipelineAsyncClient

public OpenSearchSearchPipelineAsyncClient(OpenSearchTransport transport)

OpenSearchSearchPipelineAsyncClient

public OpenSearchSearchPipelineAsyncClient(OpenSearchTransport transport,
                                           @Nullable
                                           TransportOptions transportOptions)

Method Detail

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 java.util.concurrent.CompletableFuture<DeleteSearchPipelineResponse> delete(DeleteSearchPipelineRequest request)
                                                                            throws java.io.IOException,
                                                                                   OpenSearchException

Deletes the specified search pipeline.

Throws:

java.io.IOException

OpenSearchException

delete

public final java.util.concurrent.CompletableFuture<DeleteSearchPipelineResponse> delete(java.util.function.Function<DeleteSearchPipelineRequest.Builder,ObjectBuilder<DeleteSearchPipelineRequest>> fn)
                                                                                  throws java.io.IOException,
                                                                                         OpenSearchException

Deletes the specified search pipeline.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

get

public java.util.concurrent.CompletableFuture<GetSearchPipelineResponse> get(GetSearchPipelineRequest request)
                                                                      throws java.io.IOException,
                                                                             OpenSearchException

Retrieves information about a specified search pipeline.

Throws:

java.io.IOException

OpenSearchException

get

public final java.util.concurrent.CompletableFuture<GetSearchPipelineResponse> get(java.util.function.Function<GetSearchPipelineRequest.Builder,ObjectBuilder<GetSearchPipelineRequest>> fn)
                                                                            throws java.io.IOException,
                                                                                   OpenSearchException

Retrieves information about a specified search pipeline.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

get

public final java.util.concurrent.CompletableFuture<GetSearchPipelineResponse> get()
                                                                            throws java.io.IOException,
                                                                                   OpenSearchException

Retrieves information about a specified search pipeline.

Throws:

java.io.IOException

OpenSearchException

put

public java.util.concurrent.CompletableFuture<PutSearchPipelineResponse> put(PutSearchPipelineRequest request)
                                                                      throws java.io.IOException,
                                                                             OpenSearchException

Creates or replaces the specified search pipeline.

Throws:

java.io.IOException

OpenSearchException

put

public final java.util.concurrent.CompletableFuture<PutSearchPipelineResponse> put(java.util.function.Function<PutSearchPipelineRequest.Builder,ObjectBuilder<PutSearchPipelineRequest>> fn)
                                                                            throws java.io.IOException,
                                                                                   OpenSearchException

Creates or replaces the specified search pipeline.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException