Package org.opensearch.client.opensearch.cat

Class PitSegmentsRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.cat.CatRequestBase

org.opensearch.client.opensearch.cat.PitSegmentsRequest

public class PitSegmentsRequest
extends CatRequestBase

Provides low-level information about the disk utilization of a PIT by describing its Lucene segments

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch.cat.CatRequestBase

CatRequestBase.CatRequestBaseBuilder<BuilderT extends CatRequestBase.CatRequestBaseBuilder>

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 Endpoint<PitSegmentsRequest,SegmentsResponse,ErrorResponse>	_ENDPOINT	Endpoint "point_in_time_segments"

Constructor Summary

Constructors

Constructor	Description
PitSegmentsRequest(PitSegmentsRequest.Builder builder)

Method Summary

Modifier and Type	Method	Description
static PitSegmentsRequest	of(java.util.function.Function<PitSegmentsRequest.Builder,ObjectBuilder<PitSegmentsRequest>> fn)
java.util.List<java.lang.String>	pitId()	A list of Pit IDs to get segments

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

headers, queryParameters, sort

Methods inherited from class java.lang.Object

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

Field Detail

_ENDPOINT

public static final Endpoint<PitSegmentsRequest,SegmentsResponse,ErrorResponse> _ENDPOINT

Endpoint "point_in_time_segments"

Constructor Detail

PitSegmentsRequest

public PitSegmentsRequest(PitSegmentsRequest.Builder builder)

Method Detail

of

public static PitSegmentsRequest of(java.util.function.Function<PitSegmentsRequest.Builder,ObjectBuilder<PitSegmentsRequest>> fn)

pitId

@Nullable
public final java.util.List<java.lang.String> pitId()

A list of Pit IDs to get segments

API name - pit_id