Package org.opensearch.client.opensearch.snapshot

Class CreateRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.snapshot.CreateRequest

All Implemented Interfaces:

ToJsonp

public final class CreateRequest
extends RequestBase
implements ToJsonp

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateRequest.Builder	Builder for CreateRequest.

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<CreateRequest>	DESERIALIZER	Json deserializer for CreateRequest
static Endpoint<CreateRequest,CreateResponse,OpenSearchError>	ENDPOINT	Endpoint "snapshot.create".

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CreateRequest(CreateRequest.Builder builder)

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	ignoreUnavailable()	API name: ignore_unavailable
java.lang.Boolean	includeGlobalState()	API name: include_global_state
java.util.List<java.lang.String>	indices()	API name: indices
jakarta.json.JsonValue	masterTimeout()	API name: master_timeout
java.util.Map<java.lang.String,jakarta.json.JsonValue>	metadata()	API name: metadata
java.lang.Boolean	partial()	API name: partial
java.lang.String	repository()	API name: repository
protected static void	setupCreateRequestDeserializer(DelegatingDeserializer<CreateRequest.Builder> op)
java.lang.String	snapshot()	API name: snapshot
void	toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
java.lang.Boolean	waitForCompletion()	API name: wait_for_completion

Methods inherited from class java.lang.Object

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

Field Details

DESERIALIZER

public static final JsonpDeserializer<CreateRequest> DESERIALIZER

Json deserializer for CreateRequest

ENDPOINT

public static final Endpoint<CreateRequest,CreateResponse,OpenSearchError> ENDPOINT

Endpoint "snapshot.create".

Constructor Details

CreateRequest

protected CreateRequest(CreateRequest.Builder builder)

Method Details

repository

public java.lang.String repository()

API name: repository

snapshot

public java.lang.String snapshot()

API name: snapshot

masterTimeout

@Nullable public jakarta.json.JsonValue masterTimeout()

API name: master_timeout

waitForCompletion

@Nullable public java.lang.Boolean waitForCompletion()

API name: wait_for_completion

ignoreUnavailable

@Nullable public java.lang.Boolean ignoreUnavailable()

API name: ignore_unavailable

includeGlobalState

@Nullable public java.lang.Boolean includeGlobalState()

API name: include_global_state

indices

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

API name: indices

metadata

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

API name: metadata

partial

@Nullable public java.lang.Boolean partial()

API name: partial

toJsonp

public void toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

toJsonp in interface ToJsonp

toJsonpInternal

protected void toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

setupCreateRequestDeserializer

protected static void setupCreateRequestDeserializer(DelegatingDeserializer<CreateRequest.Builder> op)