Package org.opensearch.client.opensearch.cat

Class PitSegmentsRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<PitSegmentsRequest.Builder>

org.opensearch.client.opensearch.cat.CatRequestBase.AbstractBuilder<PitSegmentsRequest.Builder>

org.opensearch.client.opensearch.cat.PitSegmentsRequest.Builder

All Implemented Interfaces:

CopyableBuilder<PitSegmentsRequest.Builder,PitSegmentsRequest>, MutableBuilder<PitSegmentsRequest.Builder,PitSegmentsRequest>, ObjectBuilder<PitSegmentsRequest>

Enclosing class:

PitSegmentsRequest

public static class PitSegmentsRequest.Builder
extends CatRequestBase.AbstractBuilder<PitSegmentsRequest.Builder>
implements CopyableBuilder<PitSegmentsRequest.Builder,PitSegmentsRequest>

Builder for PitSegmentsRequest.

Field Summary

Fields inherited from class org.opensearch.client.opensearch.cat.CatRequestBase.AbstractBuilder

headers, sort

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PitSegmentsRequest	build()	Builds a PitSegmentsRequest.
final PitSegmentsRequest.Builder	bytes(Bytes value)	The units used to display byte values.
PitSegmentsRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final PitSegmentsRequest.Builder	pitId(String value, String... values)	Required - API name: pit_id
final PitSegmentsRequest.Builder	pitId(List<String> list)	Required - API name: pit_id
protected PitSegmentsRequest.Builder	self()

Methods inherited from class org.opensearch.client.opensearch.cat.CatRequestBase.AbstractBuilder

headers, headers, sort, sort

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

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

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

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public PitSegmentsRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<PitSegmentsRequest.Builder,PitSegmentsRequest>

Returns:

a new builder instance.

self

@Nonnull
protected PitSegmentsRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PitSegmentsRequest.Builder>

bytes

@Nonnull
public final PitSegmentsRequest.Builder bytes(@Nullable
 Bytes value)

The units used to display byte values.

API name: bytes

pitId

@Nonnull
public final PitSegmentsRequest.Builder pitId(List<String> list)

Required - API name: pit_id

Adds all elements of list to pitId.

pitId

@Nonnull
public final PitSegmentsRequest.Builder pitId(String value,
 String... values)

Required - API name: pit_id

Adds one or more values to pitId.

build

@Nonnull
public PitSegmentsRequest build()

Builds a PitSegmentsRequest.

Specified by:

build in interface ObjectBuilder<PitSegmentsRequest>

Throws:

NullPointerException - if some of the required fields are null.