Package org.opensearch.client.opensearch.snapshot

Class CleanupRepositoryRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.snapshot.CleanupRepositoryRequest

All Implemented Interfaces:

ToCopyableBuilder<CleanupRepositoryRequest.Builder,CleanupRepositoryRequest>

@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class CleanupRepositoryRequest
extends RequestBase
implements ToCopyableBuilder<CleanupRepositoryRequest.Builder,CleanupRepositoryRequest>

Removes any stale data from a snapshot repository.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._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
protected void	applyQueryParameters(Map<String,String> params)
static CleanupRepositoryRequest.Builder	builder()
final Time	clusterManagerTimeout()	The amount of time to wait for a response from the cluster manager node.
boolean	equals(Object o)
int	hashCode()
final Time	masterTimeout()	Deprecated.
static CleanupRepositoryRequest	of(Function<CleanupRepositoryRequest.Builder,ObjectBuilder<CleanupRepositoryRequest>> fn)
final String	repository()	Required - Snapshot repository to clean up.
final Time	timeout()	The amount of time to wait for a response.
CleanupRepositoryRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

errorTrace, human

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

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)

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

API name: cluster_manager_timeout

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

Period to wait for a connection to the cluster-manager node.

API name: master_timeout

repository

@Nonnull
public final String repository()

Required - Snapshot repository to clean up.

API name: repository

timeout

@Nullable
public final Time timeout()

The amount of time to wait for a response.

API name: timeout

toBuilder

@Nonnull
public CleanupRepositoryRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CleanupRepositoryRequest.Builder,CleanupRepositoryRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static CleanupRepositoryRequest.Builder builder()

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object