Class SimulateIndexTemplateRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.SimulateIndexTemplateRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class SimulateIndexTemplateRequest extends RequestBase implements JsonpSerializable
Simulate matching the given index name against the index templates in the
system
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SimulateIndexTemplateRequest.Builder
Builder forSimulateIndexTemplateRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<SimulateIndexTemplateRequest>
_DESERIALIZER
Json deserializer forSimulateIndexTemplateRequest
static Endpoint<SimulateIndexTemplateRequest,SimulateIndexTemplateResponse,ErrorResponse>
_ENDPOINT
Endpoint "indices.simulate_index_template
". -
Method Summary
Modifier and Type Method Description java.lang.Boolean
allowAutoCreate()
API name:allow_auto_create
java.util.List<java.lang.String>
composedOf()
API name:composed_of
java.lang.Boolean
create()
Iftrue
, the template passed in the body is only used if no existing templates match the same index patterns.DataStreamVisibility
dataStream()
API name:data_stream
java.util.List<java.lang.String>
indexPatterns()
API name:index_patterns
Time
masterTimeout()
Period to wait for a connection to the master node.java.util.Map<java.lang.String,JsonData>
meta()
API name:_meta
java.lang.String
name()
Required - Index or template name to simulatestatic SimulateIndexTemplateRequest
of(java.util.function.Function<SimulateIndexTemplateRequest.Builder,ObjectBuilder<SimulateIndexTemplateRequest>> fn)
java.lang.Integer
priority()
API name:priority
void
serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
Serialize this object to JSON.protected void
serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void
setupSimulateIndexTemplateRequestDeserializer(ObjectDeserializer<SimulateIndexTemplateRequest.Builder> op)
IndexTemplateMapping
template()
API name:template
java.lang.Long
version()
API name:version
Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forSimulateIndexTemplateRequest
-
_ENDPOINT
public static final Endpoint<SimulateIndexTemplateRequest,SimulateIndexTemplateResponse,ErrorResponse> _ENDPOINTEndpoint "indices.simulate_index_template
".
-
-
Method Details
-
of
public static SimulateIndexTemplateRequest of(java.util.function.Function<SimulateIndexTemplateRequest.Builder,ObjectBuilder<SimulateIndexTemplateRequest>> fn) -
meta
API name:_meta
-
allowAutoCreate
@Nullable public final java.lang.Boolean allowAutoCreate()API name:allow_auto_create
-
composedOf
public final java.util.List<java.lang.String> composedOf()API name:composed_of
-
create
@Nullable public final java.lang.Boolean create()Iftrue
, the template passed in the body is only used if no existing templates match the same index patterns. Iffalse
, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation.API name:
create
-
dataStream
API name:data_stream
-
indexPatterns
public final java.util.List<java.lang.String> indexPatterns()API name:index_patterns
-
masterTimeout
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.API name:
master_timeout
-
name
public final java.lang.String name()Required - Index or template name to simulateAPI name:
name
-
priority
@Nullable public final java.lang.Integer priority()API name:priority
-
template
API name:template
-
version
@Nullable public final java.lang.Long version()API name:version
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupSimulateIndexTemplateRequestDeserializer
protected static void setupSimulateIndexTemplateRequestDeserializer(ObjectDeserializer<SimulateIndexTemplateRequest.Builder> op)
-