Class GetIndexTemplatesRequest
java.lang.Object
org.opensearch.transport.TransportMessage
org.opensearch.transport.TransportRequest
org.opensearch.action.ActionRequest
org.opensearch.action.support.master.MasterNodeRequest<Request>
org.opensearch.action.support.master.MasterNodeReadRequest<GetIndexTemplatesRequest>
org.opensearch.action.admin.indices.template.get.GetIndexTemplatesRequest
- All Implemented Interfaces:
Writeable
,TaskAwareRequest
public class GetIndexTemplatesRequest extends MasterNodeReadRequest<GetIndexTemplatesRequest>
Request that allows to retrieve index templates
-
Nested Class Summary
Nested classes/interfaces inherited from class org.opensearch.transport.TransportRequest
TransportRequest.Empty
Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
Fields inherited from class org.opensearch.action.support.master.MasterNodeRequest
DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout
-
Constructor Summary
Constructors Constructor Description GetIndexTemplatesRequest()
GetIndexTemplatesRequest(java.lang.String... names)
GetIndexTemplatesRequest(StreamInput in)
-
Method Summary
Modifier and Type Method Description java.lang.String[]
names()
The names of the index templates.GetIndexTemplatesRequest
names(java.lang.String... names)
Sets the names of the index templates.ActionRequestValidationException
validate()
void
writeTo(StreamOutput out)
Write this into the StreamOutput.Methods inherited from class org.opensearch.action.support.master.MasterNodeReadRequest
local, local
Methods inherited from class org.opensearch.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.opensearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTask
-
Constructor Details
-
GetIndexTemplatesRequest
public GetIndexTemplatesRequest() -
GetIndexTemplatesRequest
public GetIndexTemplatesRequest(java.lang.String... names) -
GetIndexTemplatesRequest
- 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<GetIndexTemplatesRequest>
- Throws:
java.io.IOException
-
validate
- Specified by:
validate
in classActionRequest
-
names
Sets the names of the index templates. -
names
public java.lang.String[] names()The names of the index templates.
-