Package org.elasticsearch.action.admin.cluster.repositories.delete

Class DeleteRepositoryRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.support.master.MasterNodeRequest<Request>

org.elasticsearch.action.support.master.AcknowledgedRequest<DeleteRepositoryRequest>

org.elasticsearch.action.admin.cluster.repositories.delete.DeleteRepositoryRequest

All Implemented Interfaces:

AckedRequest, Writeable, org.elasticsearch.core.RefCounted, TaskAwareRequest

public class DeleteRepositoryRequest
extends AcknowledgedRequest<DeleteRepositoryRequest>

Unregister repository request.

The unregister repository command just unregisters the repository. No data is getting deleted from the repository.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from class org.elasticsearch.action.support.master.AcknowledgedRequest

DEFAULT_ACK_TIMEOUT, timeout

Fields inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Constructor Summary

Constructors

Constructor	Description
DeleteRepositoryRequest()
DeleteRepositoryRequest(String name)	Constructs a new unregister repository request with the provided name.
DeleteRepositoryRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
String	name()	The name of the repository.
DeleteRepositoryRequest	name(String name)	Sets the name of the repository to unregister.
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.action.support.master.AcknowledgedRequest

ackTimeout, timeout, timeout, timeout

Methods inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask, toString

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.cluster.ack.AckedRequest

masterNodeTimeout

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Constructor Details

DeleteRepositoryRequest

public DeleteRepositoryRequest(StreamInput in)
                        throws IOException

Throws:

IOException

DeleteRepositoryRequest

public DeleteRepositoryRequest()

DeleteRepositoryRequest

public DeleteRepositoryRequest(String name)

Constructs a new unregister repository request with the provided name.

Parameters:

name - name of the repository

Method Details

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

name

public DeleteRepositoryRequest name(String name)

Sets the name of the repository to unregister.

Parameters:

name - name of the repository

name

public String name()

The name of the repository.

Returns:

the name of the repository

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class AcknowledgedRequest<DeleteRepositoryRequest>

Throws:

IOException