Package org.opensearch.client.opensearch.ingest

Class GetPipelineRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.ingest.GetPipelineRequest

All Implemented Interfaces:

ToCopyableBuilder<GetPipelineRequest.Builder,GetPipelineRequest>

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

Returns an ingest pipeline.

Nested Class Summary

Nested Classes

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

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<GetPipelineRequest,GetPipelineResponse,ErrorResponse>	_ENDPOINT	Endpoint "ingest.get_pipeline".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static GetPipelineRequest.Builder	builder()
final Time	clusterManagerTimeout()	The amount of time allowed to establish a connection to the cluster manager node.
boolean	equals(Object o)
int	hashCode()
final String	id()	A comma-separated list of pipeline IDs to retrieve.
final Time	masterTimeout()	Deprecated.
static GetPipelineRequest	of(Function<GetPipelineRequest.Builder,ObjectBuilder<GetPipelineRequest>> fn)
GetPipelineRequest.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<GetPipelineRequest,GetPipelineResponse,ErrorResponse> _ENDPOINT

Endpoint "ingest.get_pipeline".

Method Details

of

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

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

The amount of time allowed to establish a connection to the cluster manager node.

API name: cluster_manager_timeout

id

@Nullable
public final String id()

A comma-separated list of pipeline IDs to retrieve. Wildcard (*) expressions are supported. To get all ingest pipelines, omit this parameter or use *.

API name: id

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

toBuilder

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

Returns:

a new builder instance.

builder

@Nonnull
public static GetPipelineRequest.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