Package co.elastic.clients.elasticsearch.snapshot

Class DeleteRepositoryRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.snapshot.DeleteRepositoryRequest

public class DeleteRepositoryRequest
extends RequestBase

Delete snapshot repositories. When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots. The snapshots themselves are left untouched and in place.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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 Endpoint<DeleteRepositoryRequest,DeleteRepositoryResponse,ErrorResponse>	_ENDPOINT	Endpoint "snapshot.delete_repository".

Method Summary

Modifier and Type	Method	Description
final Time	masterTimeout()	The period to wait for the master node.
final List<String>	name()	Required - The ame of the snapshot repositories to unregister.
static DeleteRepositoryRequest	of(Function<DeleteRepositoryRequest.Builder,ObjectBuilder<DeleteRepositoryRequest>> fn)
final Time	timeout()	The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.

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

_ENDPOINT

public static final Endpoint<DeleteRepositoryRequest,DeleteRepositoryResponse,ErrorResponse> _ENDPOINT

Endpoint "snapshot.delete_repository".

Method Details

of

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

masterTimeout

@Nullable
public final Time masterTimeout()

The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to -1.

API name: master_timeout

name

public final List<String> name()

Required - The ame of the snapshot repositories to unregister. Wildcard (*) patterns are supported.

API name: repository

timeout

@Nullable
public final Time timeout()

The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. To indicate that the request should never timeout, set it to -1.

API name: timeout