Package co.elastic.clients.elasticsearch.ingest

Class GetPipelineRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetPipelineRequest.Builder>

co.elastic.clients.elasticsearch.ingest.GetPipelineRequest.Builder

All Implemented Interfaces:

WithJson<GetPipelineRequest.Builder>, ObjectBuilder<GetPipelineRequest>

Enclosing class:

GetPipelineRequest

public static class GetPipelineRequest.Builder
extends RequestBase.AbstractBuilder<GetPipelineRequest.Builder>
implements ObjectBuilder<GetPipelineRequest>

Builder for GetPipelineRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetPipelineRequest	build()	Builds a GetPipelineRequest.
final GetPipelineRequest.Builder	id(String value)	Comma-separated list of pipeline IDs to retrieve.
final GetPipelineRequest.Builder	masterTimeout(Time value)	Period to wait for a connection to the master node.
final GetPipelineRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a connection to the master node.
protected GetPipelineRequest.Builder	self()
final GetPipelineRequest.Builder	summary(Boolean value)	Return pipelines without their definitions (default: false)

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

id

public final GetPipelineRequest.Builder id(@Nullable
 String value)

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

public final GetPipelineRequest.Builder masterTimeout(@Nullable
 Time value)

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

masterTimeout

public final GetPipelineRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

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

public final GetPipelineRequest.Builder summary(@Nullable
 Boolean value)

Return pipelines without their definitions (default: false)

API name: summary

self

protected GetPipelineRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetPipelineRequest.Builder>

build

public GetPipelineRequest build()

Builds a GetPipelineRequest.

Specified by:

build in interface ObjectBuilder<GetPipelineRequest>

Throws:

NullPointerException - if some of the required fields are null.