Package org.opensearch.client.opensearch.snapshot

Class RestoreRequest.Builder

java.lang.Object

org.opensearch.client.opensearch.snapshot.RestoreRequest.Builder

All Implemented Interfaces:

ObjectBuilder<RestoreRequest>

Enclosing class:

RestoreRequest

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

Builder for RestoreRequest.

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
RestoreRequest.Builder	addIgnoreIndexSettings(java.lang.String value)	Add a value to ignoreIndexSettings(List), creating the list if needed.
RestoreRequest.Builder	addIndices(java.lang.String value)	Add a value to indices(List), creating the list if needed.
RestoreRequest	build()	Builds a RestoreRequest.
RestoreRequest.Builder	ignoreIndexSettings(java.lang.String... value)	API name: ignore_index_settings
RestoreRequest.Builder	ignoreIndexSettings(java.util.List<java.lang.String> value)	API name: ignore_index_settings
RestoreRequest.Builder	ignoreUnavailable(java.lang.Boolean value)	API name: ignore_unavailable
RestoreRequest.Builder	includeAliases(java.lang.Boolean value)	API name: include_aliases
RestoreRequest.Builder	includeGlobalState(java.lang.Boolean value)	API name: include_global_state
RestoreRequest.Builder	indexSettings(jakarta.json.JsonValue value)	API name: index_settings
RestoreRequest.Builder	indices(java.lang.String... value)	API name: indices
RestoreRequest.Builder	indices(java.util.List<java.lang.String> value)	API name: indices
RestoreRequest.Builder	masterTimeout(jakarta.json.JsonValue value)	API name: master_timeout
RestoreRequest.Builder	partial(java.lang.Boolean value)	API name: partial
RestoreRequest.Builder	renamePattern(java.lang.String value)	API name: rename_pattern
RestoreRequest.Builder	renameReplacement(java.lang.String value)	API name: rename_replacement
RestoreRequest.Builder	repository(java.lang.String value)	API name: repository
RestoreRequest.Builder	snapshot(java.lang.String value)	API name: snapshot
RestoreRequest.Builder	waitForCompletion(java.lang.Boolean value)	API name: wait_for_completion

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 RestoreRequest.Builder repository(java.lang.String value)

API name: repository

snapshot

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

API name: snapshot

masterTimeout

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

API name: master_timeout

waitForCompletion

public RestoreRequest.Builder waitForCompletion(@Nullable java.lang.Boolean value)

API name: wait_for_completion

ignoreIndexSettings

public RestoreRequest.Builder ignoreIndexSettings(@Nullable java.util.List<java.lang.String> value)

API name: ignore_index_settings

ignoreIndexSettings

public RestoreRequest.Builder ignoreIndexSettings(java.lang.String... value)

API name: ignore_index_settings

addIgnoreIndexSettings

public RestoreRequest.Builder addIgnoreIndexSettings(java.lang.String value)

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

ignoreUnavailable

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

API name: ignore_unavailable

includeAliases

public RestoreRequest.Builder includeAliases(@Nullable java.lang.Boolean value)

API name: include_aliases

includeGlobalState

public RestoreRequest.Builder includeGlobalState(@Nullable java.lang.Boolean value)

API name: include_global_state

indexSettings

public RestoreRequest.Builder indexSettings(@Nullable jakarta.json.JsonValue value)

API name: index_settings

indices

public RestoreRequest.Builder indices(@Nullable java.util.List<java.lang.String> value)

API name: indices

indices

public RestoreRequest.Builder indices(java.lang.String... value)

API name: indices

addIndices

public RestoreRequest.Builder addIndices(java.lang.String value)

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

partial

public RestoreRequest.Builder partial(@Nullable java.lang.Boolean value)

API name: partial

renamePattern

public RestoreRequest.Builder renamePattern(@Nullable java.lang.String value)

API name: rename_pattern

renameReplacement

public RestoreRequest.Builder renameReplacement(@Nullable java.lang.String value)

API name: rename_replacement

build

public RestoreRequest build()

Builds a RestoreRequest.

Specified by:

build in interface ObjectBuilder<RestoreRequest>

Throws:

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