|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.elasticsearch.action.support.master.MasterNodeOperationRequest org.elasticsearch.action.admin.indices.template.put.PutIndexTemplateRequest
public class PutIndexTemplateRequest
A request to create an index template.
Field Summary |
---|
Fields inherited from class org.elasticsearch.action.support.master.MasterNodeOperationRequest |
---|
DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout |
Constructor Summary | |
---|---|
PutIndexTemplateRequest(String name)
Constructs a new put index template request with the provided name. |
Method Summary | |
---|---|
String |
cause()
|
PutIndexTemplateRequest |
cause(String cause)
The cause for this index template creation. |
boolean |
create()
|
PutIndexTemplateRequest |
create(boolean create)
Set to true to force only creation, not an update of an index template. |
PutIndexTemplateRequest |
custom(IndexMetaData.Custom custom)
|
PutIndexTemplateRequest |
mapping(String type,
Map<String,Object> source)
Adds mapping that will be added when the index gets created. |
PutIndexTemplateRequest |
mapping(String type,
String source)
Adds mapping that will be added when the index gets created. |
PutIndexTemplateRequest |
mapping(String type,
XContentBuilder source)
Adds mapping that will be added when the index gets created. |
String |
name()
The name of the index template. |
PutIndexTemplateRequest |
name(String name)
Sets the name of the index template. |
int |
order()
|
PutIndexTemplateRequest |
order(int order)
|
void |
readFrom(StreamInput in)
|
PutIndexTemplateRequest |
settings(Map<String,Object> source)
The settings to crete the index template with (either json/yaml/properties format). |
PutIndexTemplateRequest |
settings(Settings.Builder settings)
The settings to create the index template with. |
PutIndexTemplateRequest |
settings(Settings settings)
The settings to create the index template with. |
PutIndexTemplateRequest |
settings(String source)
The settings to create the index template with (either json/yaml/properties format). |
PutIndexTemplateRequest |
source(byte[] source)
The template source definition. |
PutIndexTemplateRequest |
source(byte[] source,
int offset,
int length)
The template source definition. |
PutIndexTemplateRequest |
source(BytesReference source)
The template source definition. |
PutIndexTemplateRequest |
source(Map templateSource)
The template source definition. |
PutIndexTemplateRequest |
source(String templateSource)
The template source definition. |
PutIndexTemplateRequest |
source(XContentBuilder templateBuilder)
The template source definition. |
String |
template()
|
PutIndexTemplateRequest |
template(String template)
|
PutIndexTemplateRequest |
timeout(String timeout)
Timeout to wait till the put mapping gets acknowledged of all current cluster nodes. |
PutIndexTemplateRequest |
timeout(TimeValue timeout)
Timeout to wait till the put mapping gets acknowledged of all current cluster nodes. |
ActionRequestValidationException |
validate()
|
void |
writeTo(StreamOutput out)
|
Methods inherited from class org.elasticsearch.action.support.master.MasterNodeOperationRequest |
---|
listenerThreaded, listenerThreaded, masterNodeTimeout, masterNodeTimeout, masterNodeTimeout |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PutIndexTemplateRequest(String name)
Method Detail |
---|
public ActionRequestValidationException validate()
public PutIndexTemplateRequest name(String name)
public String name()
public PutIndexTemplateRequest template(String template)
public String template()
public PutIndexTemplateRequest order(int order)
public int order()
public PutIndexTemplateRequest create(boolean create)
IndexTemplateAlreadyExistsException
.
public boolean create()
public PutIndexTemplateRequest settings(Settings settings)
public PutIndexTemplateRequest settings(Settings.Builder settings)
public PutIndexTemplateRequest settings(String source)
public PutIndexTemplateRequest settings(Map<String,Object> source)
public PutIndexTemplateRequest mapping(String type, String source)
type
- The mapping typesource
- The mapping sourcepublic PutIndexTemplateRequest cause(String cause)
public String cause()
public PutIndexTemplateRequest mapping(String type, XContentBuilder source)
type
- The mapping typesource
- The mapping sourcepublic PutIndexTemplateRequest mapping(String type, Map<String,Object> source)
type
- The mapping typesource
- The mapping sourcepublic PutIndexTemplateRequest source(XContentBuilder templateBuilder)
public PutIndexTemplateRequest source(Map templateSource)
public PutIndexTemplateRequest source(String templateSource)
public PutIndexTemplateRequest source(byte[] source)
public PutIndexTemplateRequest source(byte[] source, int offset, int length)
public PutIndexTemplateRequest source(BytesReference source)
public PutIndexTemplateRequest custom(IndexMetaData.Custom custom)
public PutIndexTemplateRequest timeout(TimeValue timeout)
public PutIndexTemplateRequest timeout(String timeout)
public void readFrom(StreamInput in) throws IOException
readFrom
in interface Streamable
readFrom
in class MasterNodeOperationRequest
IOException
public void writeTo(StreamOutput out) throws IOException
writeTo
in interface Streamable
writeTo
in class MasterNodeOperationRequest
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |