Package co.elastic.clients.elasticsearch.ingest

Class GetPipelineRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ingest.GetPipelineRequest

public class GetPipelineRequest
extends RequestBase

Returns information about one or more ingest pipelines. This API returns a local reference of the pipeline.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._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
final String	id()	Comma-separated list of pipeline IDs to retrieve.
final Time	masterTimeout()	Period to wait for a connection to the master node.
static GetPipelineRequest	of(Function<GetPipelineRequest.Builder,ObjectBuilder<GetPipelineRequest>> fn)
final Boolean	summary()	Return pipelines without their definitions (default: false)

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

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)

id

@Nullable
public final String id()

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

@Nullable
public final Time masterTimeout()

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

API name: master_timeout

summary

@Nullable
public final Boolean summary()

Return pipelines without their definitions (default: false)

API name: summary