org.elasticsearch.action.admin.cluster.repositories.get

Class GetRepositoriesRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<Request>

org.elasticsearch.action.support.ChildTaskActionRequest<T>

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

org.elasticsearch.action.support.master.MasterNodeReadRequest<GetRepositoriesRequest>

org.elasticsearch.action.admin.cluster.repositories.get.GetRepositoriesRequest

All Implemented Interfaces:

HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class GetRepositoriesRequest
extends MasterNodeReadRequest<GetRepositoriesRequest>

Get repository request

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.MasterNodeReadRequest

local

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

DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
GetRepositoriesRequest()
GetRepositoriesRequest(String[] repositories) Constructs a new get repositories request with a list of repositories.

Method Summary

Methods

Modifier and Type	Method and Description
void	readFrom(StreamInput in)
String[]	repositories() The names of the repositories.
GetRepositoriesRequest	repositories(String[] repositories) Sets the list or repositories.
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

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

local, local

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

masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

Methods inherited from class org.elasticsearch.action.support.ChildTaskActionRequest

createTask, createTask, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportRequest

getDescription

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

Methods inherited from class java.lang.Object

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

Constructor Detail

GetRepositoriesRequest

public GetRepositoriesRequest()

GetRepositoriesRequest

public GetRepositoriesRequest(String[] repositories)

Constructs a new get repositories request with a list of repositories.

If the list of repositories is empty or it contains a single element "_all", all registered repositories are returned.

Parameters:

repositories - list of repositories

Method Detail

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<GetRepositoriesRequest>

repositories

public String[] repositories()

The names of the repositories.

Returns:

list of repositories

repositories

public GetRepositoriesRequest repositories(String[] repositories)

Sets the list or repositories.

If the list of repositories is empty or it contains a single element "_all", all registered repositories are returned.

Parameters:

repositories - list of repositories

Returns:

this request

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class MasterNodeReadRequest<GetRepositoriesRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class MasterNodeReadRequest<GetRepositoriesRequest>

Throws:

IOException