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, Streamable, 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

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 and Description
DeleteRepositoryRequest()
DeleteRepositoryRequest(java.lang.String name) Constructs a new unregister repository request with the provided name.

Method Summary

Modifier and Type	Method and Description
java.lang.String	name() The name of the repository.
DeleteRepositoryRequest	name(java.lang.String name) Sets the name of the repository to unregister.
void	readFrom(StreamInput in) Set this object's fields from a StreamInput.
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out) Write this object's fields to a StreamOutput.

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

ackTimeout, readTimeout, timeout, timeout, timeout, writeTimeout

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

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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 Detail

DeleteRepositoryRequest

public DeleteRepositoryRequest()

DeleteRepositoryRequest

public DeleteRepositoryRequest(java.lang.String name)

Constructs a new unregister repository request with the provided name.

Parameters:

name - name of the repository

Method Detail

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

name

public DeleteRepositoryRequest name(java.lang.String name)

Sets the name of the repository to unregister.

Parameters:

name - name of the repository

name

public java.lang.String name()

The name of the repository.

Returns:

the name of the repository

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class AcknowledgedRequest<DeleteRepositoryRequest>

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class AcknowledgedRequest<DeleteRepositoryRequest>

Throws:

java.io.IOException