Package org.opensearch.client.opensearch.snapshot

Class DeleteRepositoryRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.snapshot.DeleteRepositoryRequest

All Implemented Interfaces:

ToCopyableBuilder<DeleteRepositoryRequest.Builder,DeleteRepositoryRequest>

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

Deletes a snapshot repository.

Nested Class Summary

Nested Classes

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

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

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static DeleteRepositoryRequest.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.
final List<String>	name()	Required - The name of the snapshot repository to unregister.
static DeleteRepositoryRequest	of(Function<DeleteRepositoryRequest.Builder,ObjectBuilder<DeleteRepositoryRequest>> fn)
final Time	timeout()	The amount of time to wait for a response.
DeleteRepositoryRequest.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<DeleteRepositoryRequest,DeleteRepositoryResponse,ErrorResponse> _ENDPOINT

Endpoint "snapshot.delete_repository".

Method Details

of

public static DeleteRepositoryRequest of(Function<DeleteRepositoryRequest.Builder,ObjectBuilder<DeleteRepositoryRequest>> 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.

Explicit operation timeout for connection to cluster-manager node

API name: master_timeout

name

@Nonnull
public final List<String> name()

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

API name: repository

timeout

@Nullable
public final Time timeout()

The amount of time to wait for a response.

API name: timeout

toBuilder

@Nonnull
public DeleteRepositoryRequest.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<DeleteRepositoryRequest.Builder,DeleteRepositoryRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static DeleteRepositoryRequest.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