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

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<PitSegmentsRequest.Builder,PitSegmentsRequest>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class PitSegmentsRequest
extends CatRequestBase
implements PlainJsonSerializable, ToCopyableBuilder<PitSegmentsRequest.Builder,PitSegmentsRequest>

Lists one or several CAT point-in-time 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.AbstractBuilder<BuilderT extends CatRequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<PitSegmentsRequest>	_DESERIALIZER	Json deserializer for PitSegmentsRequest
static final Endpoint<PitSegmentsRequest,PitSegmentsResponse,ErrorResponse>	_ENDPOINT	Endpoint "cat.pit_segments".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static PitSegmentsRequest.Builder	builder()
final Bytes	bytes()	The units used to display byte values.
boolean	equals(Object o)
int	hashCode()
static PitSegmentsRequest	of(Function<PitSegmentsRequest.Builder,ObjectBuilder<PitSegmentsRequest>> fn)
final List<String>	pitId()	Required - API name: pit_id
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupPitSegmentsRequestDeserializer(ObjectDeserializer<PitSegmentsRequest.Builder> op)
PitSegmentsRequest.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.cat.CatRequestBase

headers, sort

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.json.PlainJsonSerializable

toJsonString

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

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<PitSegmentsRequest> _DESERIALIZER

Json deserializer for PitSegmentsRequest

_ENDPOINT

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

Endpoint "cat.pit_segments".

Method Details

of

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

bytes

@Nullable
public final Bytes bytes()

The units used to display byte values.

API name: bytes

pitId

@Nonnull
public final List<String> pitId()

Required - API name: pit_id

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toBuilder

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

Returns:

a new builder instance.

builder

@Nonnull
public static PitSegmentsRequest.Builder builder()

setupPitSegmentsRequestDeserializer

protected static void setupPitSegmentsRequestDeserializer(ObjectDeserializer<PitSegmentsRequest.Builder> op)

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class CatRequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object