Package org.opensearch.client.opensearch.snapshot

Class GetRequest.Builder

java.lang.Object

org.opensearch.client.opensearch.snapshot.GetRequest.Builder

All Implemented Interfaces:

ObjectBuilder<GetRequest>

Enclosing class:

GetRequest

public static class GetRequest.Builder
extends java.lang.Object
implements ObjectBuilder<GetRequest>

Builder for GetRequest.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetRequest.Builder	addSnapshot(java.lang.String value)	Add a value to snapshot(List), creating the list if needed.
GetRequest	build()	Builds a GetRequest.
GetRequest.Builder	human(java.lang.Boolean value)	API name: human
GetRequest.Builder	ignoreUnavailable(java.lang.Boolean value)	API name: ignore_unavailable
GetRequest.Builder	indexDetails(java.lang.Boolean value)	API name: index_details
GetRequest.Builder	masterTimeout(jakarta.json.JsonValue value)	API name: master_timeout
GetRequest.Builder	repository(java.lang.String value)	API name: repository
GetRequest.Builder	snapshot(java.lang.String... value)	API name: snapshot
GetRequest.Builder	snapshot(java.util.List<java.lang.String> value)	API name: snapshot
GetRequest.Builder	verbose(java.lang.Boolean value)	API name: verbose

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

repository

public GetRequest.Builder repository(java.lang.String value)

API name: repository

snapshot

public GetRequest.Builder snapshot(java.util.List<java.lang.String> value)

API name: snapshot

snapshot

public GetRequest.Builder snapshot(java.lang.String... value)

API name: snapshot

addSnapshot

public GetRequest.Builder addSnapshot(java.lang.String value)

Add a value to snapshot(List), creating the list if needed.

ignoreUnavailable

public GetRequest.Builder ignoreUnavailable(@Nullable java.lang.Boolean value)

API name: ignore_unavailable

masterTimeout

public GetRequest.Builder masterTimeout(@Nullable jakarta.json.JsonValue value)

API name: master_timeout

verbose

public GetRequest.Builder verbose(@Nullable java.lang.Boolean value)

API name: verbose

indexDetails

public GetRequest.Builder indexDetails(@Nullable java.lang.Boolean value)

API name: index_details

human

public GetRequest.Builder human(@Nullable java.lang.Boolean value)

API name: human

build

public GetRequest build()

Builds a GetRequest.

Specified by:

build in interface ObjectBuilder<GetRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.