Package org.opensearch.client.opensearch.ingestion

Class GetStateRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.ingestion.GetStateRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

GetStateRequest

public static class GetStateRequest.Builder
extends RequestBase.AbstractBuilder<GetStateRequest.Builder>
implements CopyableBuilder<GetStateRequest.Builder,GetStateRequest>

Builder for GetStateRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetStateRequest	build()	Builds a GetStateRequest.
GetStateRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final GetStateRequest.Builder	index(String value)	Required - Index for which ingestion state should be retrieved.
final GetStateRequest.Builder	nextToken(String value)	Token to retrieve the next page of results.
protected GetStateRequest.Builder	self()
final GetStateRequest.Builder	size(Integer value)	Number of results to return per page.
final GetStateRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Timeout for the request.
final GetStateRequest.Builder	timeout(Time value)	Timeout for the request.

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

Returns:

a new builder instance.

self

@Nonnull
protected GetStateRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetStateRequest.Builder>

index

@Nonnull
public final GetStateRequest.Builder index(String value)

Required - Index for which ingestion state should be retrieved.

API name: index

nextToken

@Nonnull
public final GetStateRequest.Builder nextToken(@Nullable
 String value)

Token to retrieve the next page of results.

API name: next_token

size

@Nonnull
public final GetStateRequest.Builder size(@Nullable
 Integer value)

Number of results to return per page.

API name: size

timeout

@Nonnull
public final GetStateRequest.Builder timeout(@Nullable
 Time value)

Timeout for the request.

API name: timeout

timeout

@Nonnull
public final GetStateRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Timeout for the request.

API name: timeout

build

@Nonnull
public GetStateRequest build()

Builds a GetStateRequest.

Specified by:

build in interface ObjectBuilder<GetStateRequest>

Throws:

NullPointerException - if some of the required fields are null.