Package org.opensearch.client.opensearch.snapshot

Class RestoreRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

All Implemented Interfaces:

ObjectBuilder<RestoreRequest>

Enclosing class:

RestoreRequest

public static class RestoreRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<RestoreRequest>

Builder for RestoreRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RestoreRequest	build()	Builds a RestoreRequest.
RestoreRequest.Builder	clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit operation timeout for connection to cluster-manager node
RestoreRequest.Builder	clusterManagerTimeout(Time value)	Explicit operation timeout for connection to cluster-manager node
RestoreRequest.Builder	ignoreIndexSettings(java.lang.String value, java.lang.String... values)	API name: ignore_index_settings
RestoreRequest.Builder	ignoreIndexSettings(java.util.List<java.lang.String> list)	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(java.util.function.Function<PutIndicesSettingsRequest.Builder,ObjectBuilder<PutIndicesSettingsRequest>> fn)	API name: index_settings
RestoreRequest.Builder	indexSettings(PutIndicesSettingsRequest value)	API name: index_settings
RestoreRequest.Builder	indices(java.lang.String value, java.lang.String... values)	API name: indices
RestoreRequest.Builder	indices(java.util.List<java.lang.String> list)	API name: indices
RestoreRequest.Builder	masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
RestoreRequest.Builder	masterTimeout(Time value)	Deprecated.
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)	Required - A repository name
RestoreRequest.Builder	snapshot(java.lang.String value)	Required - A snapshot name
RestoreRequest.Builder	waitForCompletion(java.lang.Boolean value)	Should this request wait until the operation has completed before returning

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

ignoreIndexSettings

public final RestoreRequest.Builder ignoreIndexSettings(java.util.List<java.lang.String> list)

API name: ignore_index_settings

Adds all elements of list to ignoreIndexSettings.

ignoreIndexSettings

public final RestoreRequest.Builder ignoreIndexSettings(java.lang.String value,
                                                        java.lang.String... values)

API name: ignore_index_settings

Adds one or more values to ignoreIndexSettings.

ignoreUnavailable

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

API name: ignore_unavailable

includeAliases

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

API name: include_aliases

includeGlobalState

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

API name: include_global_state

indexSettings

public final RestoreRequest.Builder indexSettings(@Nullable
                                                  PutIndicesSettingsRequest value)

API name: index_settings

indexSettings

public final RestoreRequest.Builder indexSettings(java.util.function.Function<PutIndicesSettingsRequest.Builder,ObjectBuilder<PutIndicesSettingsRequest>> fn)

API name: index_settings

indices

public final RestoreRequest.Builder indices(java.util.List<java.lang.String> list)

API name: indices

Adds all elements of list to indices.

indices

public final RestoreRequest.Builder indices(java.lang.String value,
                                            java.lang.String... values)

API name: indices

Adds one or more values to indices.

masterTimeout

@Deprecated
public final RestoreRequest.Builder masterTimeout(@Nullable
                                                  Time value)

Deprecated.

Explicit operation timeout for connection to master node

API name: master_timeout

masterTimeout

@Deprecated
public final RestoreRequest.Builder masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Deprecated.

Explicit operation timeout for connection to master node

API name: master_timeout

clusterManagerTimeout

public final RestoreRequest.Builder clusterManagerTimeout(@Nullable
                                                          Time value)

Explicit operation timeout for connection to cluster-manager node

API name: cluster_manager_timeout

clusterManagerTimeout

public final RestoreRequest.Builder clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Explicit operation timeout for connection to cluster-manager node

API name: cluster_manager_timeout

partial

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

API name: partial

renamePattern

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

API name: rename_pattern

renameReplacement

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

API name: rename_replacement

repository

public final RestoreRequest.Builder repository(java.lang.String value)

Required - A repository name

API name: repository

snapshot

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

Required - A snapshot name

API name: snapshot

waitForCompletion

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

Should this request wait until the operation has completed before returning

API name: wait_for_completion

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.