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:
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.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.GetRepositoriesRequest(StreamInput in)
-
Method Summary
Modifier and Type Method Description 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 into the StreamOutput.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.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.tasks.TaskAwareRequest
createTask, getDescription, setParentTask
-
Constructor Details
-
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
-
GetRepositoriesRequest
- Throws:
java.io.IOException
-
-
Method Details
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classMasterNodeReadRequest<GetRepositoriesRequest>
- Throws:
java.io.IOException
-
validate
- Specified by:
validate
in classActionRequest
-
repositories
public java.lang.String[] repositories()The names of the repositories.- Returns:
- list of repositories
-
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
-