Package org.opensearch.client.opensearch.search_pipeline

Class PutSearchPipelineRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.search_pipeline.PutSearchPipelineRequest

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<PutSearchPipelineRequest.Builder,PutSearchPipelineRequest>

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

Creates or replaces the specified search pipeline.

Nested Class Summary

Nested Classes

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

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 JsonpDeserializer<PutSearchPipelineRequest>	_DESERIALIZER	Json deserializer for PutSearchPipelineRequest
static final Endpoint<PutSearchPipelineRequest,PutSearchPipelineResponse,ErrorResponse>	_ENDPOINT	Endpoint "search_pipeline.put".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static PutSearchPipelineRequest.Builder	builder()
final Time	clusterManagerTimeout()	operation timeout for connection to cluster-manager node.
final String	description()	API name: description
boolean	equals(Object o)
int	hashCode()
final String	id()	Required - Pipeline ID.
static PutSearchPipelineRequest	of(Function<PutSearchPipelineRequest.Builder,ObjectBuilder<PutSearchPipelineRequest>> fn)
final List<PhaseResultsProcessor>	phaseResultsProcessors()	API name: phase_results_processors
final List<RequestProcessor>	requestProcessors()	API name: request_processors
final List<ResponseProcessor>	responseProcessors()	API name: response_processors
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupPutSearchPipelineRequestDeserializer(ObjectDeserializer<PutSearchPipelineRequest.Builder> op)
final Time	timeout()	Operation timeout.
PutSearchPipelineRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final Integer	version()	API name: version

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.json.PlainJsonSerializable

toJsonString

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

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<PutSearchPipelineRequest> _DESERIALIZER

Json deserializer for PutSearchPipelineRequest

_ENDPOINT

public static final Endpoint<PutSearchPipelineRequest,PutSearchPipelineResponse,ErrorResponse> _ENDPOINT

Endpoint "search_pipeline.put".

Method Details

of

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

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

description

@Nullable
public final String description()

API name: description

id

@Nonnull
public final String id()

Required - Pipeline ID.

API name: id

phaseResultsProcessors

@Nonnull
public final List<PhaseResultsProcessor> phaseResultsProcessors()

API name: phase_results_processors

requestProcessors

@Nonnull
public final List<RequestProcessor> requestProcessors()

API name: request_processors

responseProcessors

@Nonnull
public final List<ResponseProcessor> responseProcessors()

API name: response_processors

timeout

@Nullable
public final Time timeout()

Operation timeout.

API name: timeout

version

@Nullable
public final Integer version()

API name: version

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toBuilder

@Nonnull
public PutSearchPipelineRequest.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<PutSearchPipelineRequest.Builder,PutSearchPipelineRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static PutSearchPipelineRequest.Builder builder()

setupPutSearchPipelineRequestDeserializer

protected static void setupPutSearchPipelineRequestDeserializer(ObjectDeserializer<PutSearchPipelineRequest.Builder> op)

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