Package org.opensearch.client.opensearch.ingestion

Class ResumeRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.ingestion.ResumeRequest

All Implemented Interfaces:

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

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

Use this API to resume ingestion for the given index.

Nested Class Summary

Nested Classes

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

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 final JsonpDeserializer<ResumeRequest>	_DESERIALIZER	Json deserializer for ResumeRequest
static final Endpoint<ResumeRequest,ResumeResponse,ErrorResponse>	_ENDPOINT	Endpoint "ingestion.resume".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static ResumeRequest.Builder	builder()
final Time	clusterManagerTimeout()	Time to wait for cluster manager connection.
boolean	equals(Object o)
int	hashCode()
final String	index()	Required - Index for which ingestion should be resumed.
static ResumeRequest	of(Function<ResumeRequest.Builder,ObjectBuilder<ResumeRequest>> fn)
final List<ResetSettings>	resetSettings()	Reset settings to be applied before resuming ingestion on a shard.
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	setupResumeRequestDeserializer(ObjectDeserializer<ResumeRequest.Builder> op)
final Time	timeout()	Timeout for the request.
ResumeRequest.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._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<ResumeRequest> _DESERIALIZER

Json deserializer for ResumeRequest

_ENDPOINT

public static final Endpoint<ResumeRequest,ResumeResponse,ErrorResponse> _ENDPOINT

Endpoint "ingestion.resume".

Method Details

of

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

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

Time to wait for cluster manager connection.

API name: cluster_manager_timeout

index

@Nonnull
public final String index()

Required - Index for which ingestion should be resumed.

API name: index

resetSettings

@Nonnull
public final List<ResetSettings> resetSettings()

Reset settings to be applied before resuming ingestion on a shard. This is optional.

API name: reset_settings

timeout

@Nullable
public final Time timeout()

Timeout for the request.

API name: timeout

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 ResumeRequest.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<ResumeRequest.Builder,ResumeRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static ResumeRequest.Builder builder()

setupResumeRequestDeserializer

protected static void setupResumeRequestDeserializer(ObjectDeserializer<ResumeRequest.Builder> op)

applyQueryParameters

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

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object