Package org.opensearch.client.opensearch.search_pipeline

Class GetSearchPipelineRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.search_pipeline.GetSearchPipelineRequest

All Implemented Interfaces:

ToCopyableBuilder<GetSearchPipelineRequest.Builder,GetSearchPipelineRequest>

@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class GetSearchPipelineRequest
extends RequestBase
implements ToCopyableBuilder<GetSearchPipelineRequest.Builder,GetSearchPipelineRequest>

Retrieves information about a specified search pipeline.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetSearchPipelineRequest.Builder	Builder for GetSearchPipelineRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<GetSearchPipelineRequest,GetSearchPipelineResponse,ErrorResponse>	_ENDPOINT	Endpoint "search_pipeline.get".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static GetSearchPipelineRequest.Builder	builder()
final Time	clusterManagerTimeout()	operation timeout for connection to cluster-manager node.
boolean	equals(Object o)
int	hashCode()
final String	id()	Comma-separated list of search pipeline ids.
static GetSearchPipelineRequest	of(Function<GetSearchPipelineRequest.Builder,ObjectBuilder<GetSearchPipelineRequest>> fn)
GetSearchPipelineRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

errorTrace, human

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_ENDPOINT

public static final Endpoint<GetSearchPipelineRequest,GetSearchPipelineResponse,ErrorResponse> _ENDPOINT

Endpoint "search_pipeline.get".

Method Details

of

public static GetSearchPipelineRequest of(Function<GetSearchPipelineRequest.Builder,ObjectBuilder<GetSearchPipelineRequest>> fn)

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

id

@Nullable
public final String id()

Comma-separated list of search pipeline ids. Wildcards supported.

API name: id

toBuilder

@Nonnull
public GetSearchPipelineRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetSearchPipelineRequest.Builder,GetSearchPipelineRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static GetSearchPipelineRequest.Builder builder()

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object