Package co.elastic.clients.elasticsearch.snapshot

Class RestoreRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<RestoreRequest.Builder>

co.elastic.clients.elasticsearch.snapshot.RestoreRequest.Builder

All Implemented Interfaces:

WithJson<RestoreRequest.Builder>, ObjectBuilder<RestoreRequest>

Enclosing class:

RestoreRequest

public static class RestoreRequest.Builder
extends RequestBase.AbstractBuilder<RestoreRequest.Builder>
implements ObjectBuilder<RestoreRequest>

Builder for RestoreRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RestoreRequest	build()	Builds a RestoreRequest.
final RestoreRequest.Builder	ignoreIndexSettings(String value, String... values)	API name: ignore_index_settings
final RestoreRequest.Builder	ignoreIndexSettings(List<String> list)	API name: ignore_index_settings
final RestoreRequest.Builder	ignoreUnavailable(Boolean value)	API name: ignore_unavailable
final RestoreRequest.Builder	includeAliases(Boolean value)	API name: include_aliases
final RestoreRequest.Builder	includeGlobalState(Boolean value)	API name: include_global_state
final RestoreRequest.Builder	indexSettings(PutIndicesSettingsRequest value)	API name: index_settings
final RestoreRequest.Builder	indexSettings(Function<PutIndicesSettingsRequest.Builder,ObjectBuilder<PutIndicesSettingsRequest>> fn)	API name: index_settings
final RestoreRequest.Builder	indices(String value, String... values)	API name: indices
final RestoreRequest.Builder	indices(List<String> list)	API name: indices
final RestoreRequest.Builder	masterTimeout(Time value)	Explicit operation timeout for connection to master node
final RestoreRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit operation timeout for connection to master node
final RestoreRequest.Builder	partial(Boolean value)	API name: partial
final RestoreRequest.Builder	renamePattern(String value)	API name: rename_pattern
final RestoreRequest.Builder	renameReplacement(String value)	API name: rename_replacement
final RestoreRequest.Builder	repository(String value)	Required - A repository name
protected RestoreRequest.Builder	self()
final RestoreRequest.Builder	snapshot(String value)	Required - A snapshot name
final RestoreRequest.Builder	waitForCompletion(Boolean value)	Should this request wait until the operation has completed before returning

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

ignoreIndexSettings

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

API name: ignore_index_settings

Adds all elements of list to ignoreIndexSettings.

ignoreIndexSettings

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

API name: ignore_index_settings

Adds one or more values to ignoreIndexSettings.

ignoreUnavailable

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

API name: ignore_unavailable

includeAliases

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

API name: include_aliases

includeGlobalState

public final RestoreRequest.Builder includeGlobalState(@Nullable
 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(Function<PutIndicesSettingsRequest.Builder,ObjectBuilder<PutIndicesSettingsRequest>> fn)

API name: index_settings

indices

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

API name: indices

Adds all elements of list to indices.

indices

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

API name: indices

Adds one or more values to indices.

masterTimeout

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

Explicit operation timeout for connection to master node

API name: master_timeout

masterTimeout

public final RestoreRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Explicit operation timeout for connection to master node

API name: master_timeout

partial

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

API name: partial

renamePattern

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

API name: rename_pattern

renameReplacement

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

API name: rename_replacement

repository

public final RestoreRequest.Builder repository(String value)

Required - A repository name

API name: repository

snapshot

public final RestoreRequest.Builder snapshot(String value)

Required - A snapshot name

API name: snapshot

waitForCompletion

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

Should this request wait until the operation has completed before returning

API name: wait_for_completion

self

protected RestoreRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<RestoreRequest.Builder>

build

public RestoreRequest build()

Builds a RestoreRequest.

Specified by:

build in interface ObjectBuilder<RestoreRequest>

Throws:

NullPointerException - if some of the required fields are null.