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

Class GetRepositoriesRequest

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

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

All Implemented Interfaces:

Streamable, Writeable, TaskAwareRequest

public class GetRepositoriesRequest
extends MasterNodeReadRequest<GetRepositoriesRequest>

Get repository request

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

local

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

DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	readFrom(StreamInput in)	Set this object's fields from a StreamInput.
java.lang.String[]	repositories()	The names of the repositories.
GetRepositoriesRequest	repositories(java.lang.String[] repositories)	Sets the list or repositories.
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this object's fields to a StreamOutput.

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

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 java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.io.stream.Streamable

newWriteableReader

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask

Constructor Detail

GetRepositoriesRequest

public GetRepositoriesRequest()

GetRepositoriesRequest

public GetRepositoriesRequest(java.lang.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

repositories

public java.lang.String[] repositories()

The names of the repositories.

Returns:

list of repositories

repositories

public GetRepositoriesRequest repositories(java.lang.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 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 MasterNodeReadRequest<GetRepositoriesRequest>

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

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class MasterNodeReadRequest<GetRepositoriesRequest>

Throws:

java.io.IOException