Package org.opensearch.client.opensearch.snapshot

Class CreateRequest.Builder

java.lang.Object

org.opensearch.client.opensearch.snapshot.CreateRequest.Builder

All Implemented Interfaces:

ObjectBuilder<CreateRequest>

Enclosing class:

CreateRequest

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

Builder for CreateRequest.

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
CreateRequest.Builder	addIndices(java.lang.String value)	Add a value to indices(List), creating the list if needed.
CreateRequest	build()	Builds a CreateRequest.
CreateRequest.Builder	ignoreUnavailable(java.lang.Boolean value)	API name: ignore_unavailable
CreateRequest.Builder	includeGlobalState(java.lang.Boolean value)	API name: include_global_state
CreateRequest.Builder	indices(java.lang.String... value)	API name: indices
CreateRequest.Builder	indices(java.util.List<java.lang.String> value)	API name: indices
CreateRequest.Builder	masterTimeout(jakarta.json.JsonValue value)	API name: master_timeout
CreateRequest.Builder	metadata(java.util.Map<java.lang.String,jakarta.json.JsonValue> value)	API name: metadata
CreateRequest.Builder	partial(java.lang.Boolean value)	API name: partial
CreateRequest.Builder	putMetadata(java.lang.String key, jakarta.json.JsonValue value)	Add a key/value to metadata(Map), creating the map if needed.
CreateRequest.Builder	repository(java.lang.String value)	API name: repository
CreateRequest.Builder	snapshot(java.lang.String value)	API name: snapshot
CreateRequest.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 CreateRequest.Builder repository(java.lang.String value)

API name: repository

snapshot

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

API name: snapshot

masterTimeout

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

API name: master_timeout

waitForCompletion

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

API name: wait_for_completion

ignoreUnavailable

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

API name: ignore_unavailable

includeGlobalState

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

API name: include_global_state

indices

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

API name: indices

indices

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

API name: indices

addIndices

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

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

metadata

public CreateRequest.Builder metadata(@Nullable java.util.Map<java.lang.String,jakarta.json.JsonValue> value)

API name: metadata

putMetadata

public CreateRequest.Builder putMetadata(java.lang.String key, jakarta.json.JsonValue value)

Add a key/value to metadata(Map), creating the map if needed.

partial

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

API name: partial

build

public CreateRequest build()

Builds a CreateRequest.

Specified by:

build in interface ObjectBuilder<CreateRequest>

Throws:

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