Package co.elastic.clients.elasticsearch.snapshot

Class CleanupRepositoryRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.snapshot.CleanupRepositoryRequest

public class CleanupRepositoryRequest
extends RequestBase

Clean up the snapshot repository. Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<CleanupRepositoryRequest,CleanupRepositoryResponse,ErrorResponse>	_ENDPOINT	Endpoint "snapshot.cleanup_repository".

Method Summary

Modifier and Type	Method	Description
final Time	masterTimeout()	The period to wait for a connection to the master node.
final String	name()	Required - The name of the snapshot repository to clean up.
static CleanupRepositoryRequest	of(Function<CleanupRepositoryRequest.Builder,ObjectBuilder<CleanupRepositoryRequest>> 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<CleanupRepositoryRequest,CleanupRepositoryResponse,ErrorResponse> _ENDPOINT

Endpoint "snapshot.cleanup_repository".

Method Details

of

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

masterTimeout

@Nullable
public final Time masterTimeout()

The period to wait for a connection to 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 String name()

Required - The name of the snapshot repository to clean up.

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