Package co.elastic.clients.elasticsearch.snapshot

Class CreateRepositoryRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.snapshot.CreateRepositoryRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class CreateRepositoryRequest
extends RequestBase
implements JsonpSerializable

Create or update a snapshot repository. IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters. To register a snapshot repository, the cluster's global metadata must be writeable. Ensure there are no cluster blocks (for example, cluster.blocks.read_only and clsuter.blocks.read_only_allow_delete settings) that prevent write access.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<CreateRepositoryRequest>	_DESERIALIZER
static final Endpoint<CreateRepositoryRequest,CreateRepositoryResponse,ErrorResponse>	_ENDPOINT	Endpoint "snapshot.create_repository".

Method Summary

Modifier and Type	Method	Description
protected static JsonpDeserializer<CreateRepositoryRequest>	createCreateRepositoryRequestDeserializer()
final Time	masterTimeout()	Explicit operation timeout for connection to master node
final String	name()	Required - A repository name
static CreateRepositoryRequest	of(Function<CreateRepositoryRequest.Builder,ObjectBuilder<CreateRepositoryRequest>> fn)
final Repository	repository()	Required - Request body.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this value to JSON.
final Time	timeout()	Explicit operation timeout
final Boolean	verify()	Whether to verify the repository after creation

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<CreateRepositoryRequest> _DESERIALIZER

_ENDPOINT

public static final Endpoint<CreateRepositoryRequest,CreateRepositoryResponse,ErrorResponse> _ENDPOINT

Endpoint "snapshot.create_repository".

Method Details

of

public static CreateRepositoryRequest of(Function<CreateRepositoryRequest.Builder,ObjectBuilder<CreateRepositoryRequest>> fn)

masterTimeout

@Nullable
public final Time masterTimeout()

Explicit operation timeout for connection to master node

API name: master_timeout

name

public final String name()

Required - A repository name

API name: repository

timeout

@Nullable
public final Time timeout()

Explicit operation timeout

API name: timeout

verify

@Nullable
public final Boolean verify()

Whether to verify the repository after creation

API name: verify

repository

public final Repository repository()

Required - Request body.

serialize

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

Serialize this value to JSON.

Specified by:

serialize in interface JsonpSerializable

createCreateRepositoryRequestDeserializer

protected static JsonpDeserializer<CreateRepositoryRequest> createCreateRepositoryRequestDeserializer()