elasticsearch-js/docs/reference/api/CreateRequest.md

Interface CreateRequest

Name	Type	Description
body	string	({ [key: string]: any; } & { id?: never; index?: never; if_primary_term?: never; if_seq_no?: never; include_source_on_error?: never; op_type?: never; pipeline?: never; refresh?: never; require_alias?: never; require_data_stream?: never; routing?: never; timeout?: never; version?: never; version_type?: never; wait_for_active_shards?: never; document?: never; })
document	TDocument
id	Id	A unique identifier for the document. To automatically generate a document ID, use the POST /<target>/_doc/ request format.
if_primary_term	long	Only perform the operation if the document has this primary term.
if_seq_no	SequenceNumber	Only perform the operation if the document has this sequence number.
include_source_on_error	boolean	True or false if to include the document source in the error message in case of parsing errors.
index	IndexName	The name of the data stream or index to target. If the target doesn't exist and matches the name or wildcard ( *) pattern of an index template with a data_stream definition, this request creates the data stream. If the target doesn't exist and doesn’t match a data stream template, this request creates the index.
op_type	OpType	Set to create to only index the document if it does not already exist (put if absent). If a document with the specified _id already exists, the indexing operation will fail. The behavior is the same as using the <index>/_create endpoint. If a document ID is specified, this paramater defaults to index. Otherwise, it defaults to create. If the request targets a data stream, an op_type of create is required.
pipeline	string	The ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, setting the value to _none turns off the default ingest pipeline for this request. If a final pipeline is configured, it will always run regardless of the value of this parameter.
querystring	{ [key: string]: any; } & { id?: never; index?: never; if_primary_term?: never; if_seq_no?: never; include_source_on_error?: never; op_type?: never; pipeline?: never; refresh?: never; require_alias?: never; require_data_stream?: never; routing?: never; timeout?: never; version?: never; version_type?: never; wait_for_active_shards?: never; document?: never; }	All values in querystring will be added to the request querystring.
refresh	Refresh	If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If wait_for, it waits for a refresh to make this operation visible to search. If false, it does nothing with refreshes.
require_alias	boolean	If true, the destination must be an index alias.
require_data_stream	boolean	If true, the request's actions must target a data stream (existing or to be created).
routing	Routing	A custom value that is used to route operations to a specific shard.
timeout	Duration	The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. Elasticsearch waits for at least the specified timeout period before failing. The actual wait time could be longer, particularly when multiple waits occur. This parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs. Some reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation. By default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error. The actual wait time could be longer, particularly when multiple waits occur.
version_type	VersionType	The version type.
version	VersionNumber	The explicit version number for concurrency control. It must be a non-negative long number.
wait_for_active_shards	WaitForActiveShards	The number of shard copies that must be active before proceeding with the operation. You can set it to all or any positive integer up to the total number of shards in the index ( number_of_replicas+1). The default value of 1 means it waits for each primary shard to be active.