Package org.opensearch.client.opensearch.ingestion

Class GetStateRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.ingestion.GetStateRequest

All Implemented Interfaces:

ToCopyableBuilder<GetStateRequest.Builder,GetStateRequest>

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

Use this API to retrieve the ingestion state for a given index.

Nested Class Summary

Nested Classes

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

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 Endpoint<GetStateRequest,GetStateResponse,ErrorResponse>	_ENDPOINT	Endpoint "ingestion.get_state".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static GetStateRequest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final String	index()	Required - Index for which ingestion state should be retrieved.
final String	nextToken()	Token to retrieve the next page of results.
static GetStateRequest	of(Function<GetStateRequest.Builder,ObjectBuilder<GetStateRequest>> fn)
final Integer	size()	Number of results to return per page.
final Time	timeout()	Timeout for the request.
GetStateRequest.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.util.ToCopyableBuilder

copy

Field Details

_ENDPOINT

public static final Endpoint<GetStateRequest,GetStateResponse,ErrorResponse> _ENDPOINT

Endpoint "ingestion.get_state".

Method Details

of

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

index

@Nonnull
public final String index()

Required - Index for which ingestion state should be retrieved.

API name: index

nextToken

@Nullable
public final String nextToken()

Token to retrieve the next page of results.

API name: next_token

size

@Nullable
public final Integer size()

Number of results to return per page.

API name: size

timeout

@Nullable
public final Time timeout()

Timeout for the request.

API name: timeout

toBuilder

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

Returns:

a new builder instance.

builder

@Nonnull
public static GetStateRequest.Builder builder()

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