38 "desc":
"ElasticSearch document create API data provider",
39 "type":
"ElasticSearchDocumentCreateDataProvider",
41 "supports_request": True,
46 AbstractDataProvider::DataProviderSummaryInfoKeys
117 "desc":
"The name of the index to use",
120 "type": IntOrNothingType,
121 "desc":
"Only perform the operation if the document has this sequence number",
124 "type": IntOrNothingType,
125 "desc":
"Only perform the operation if the document has this primary term",
128 "type": StringOrNothingType,
129 "desc":
"Set to create to only index the document if it does not already exist (put if absent). If a "
130 "document with the specified `_id` already exists, the indexing operation will fail. Same as "
131 "using the `<index>/_create` endpoint. Valid values: `index`, `create`. If document id is "
132 "specified, it defaults to `index`. Otherwise, it defaults to `create`",
135 "type": StringOrNothingType,
136 "desc":
"ID of the pipeline to use to preprocess incoming documents. If the index has a default "
137 "ingest pipeline specified, then setting the value to _none disables the default ingest pipeline "
138 "for this request. If a final pipeline is configured it will always run, regardless of the value "
142 "type": StringOrNothingType,
143 "desc":
"If `true` (default: `false`), Elasticsearch refreshes the affected shards to make this operation visible to "
144 "search, if `wait_for` then wait for a refresh to make this operation visible to search, if "
145 "`false` do nothing with refreshes. Valid values: `true`, `false`, `wait_for`",
148 "type": StringOrNothingType,
149 "desc":
"Custom value used to route operations to a specific shard",
152 "type": StringOrNothingType,
153 "desc":
"Period to wait for a response (default: `1m`). If no response is received before the "
154 "timeout expires, the request fails and returns an error",
157 "type": IntOrNothingType,
158 "desc":
"Explicit version number for concurrency control. The specified version must match the "
159 "current version of the document for the request to succeed",
162 "type": StringOrNothingType,
163 "desc":
"Specific version type: `external`, `external_gte`",
165 "wait_for_active_shards": {
166 "type": StringOrNothingType,
167 "desc":
"The number of shard copies that must be active before proceeding with the operation "
168 "(default `1`). Set to `all` or any positive integer up to the total number of shards in the "
169 "index (number_of_replicas+1)",
173 "desc":
"If `true` (default `false`), the destination must be an index alias",
193 "desc":
"Indicates how many shard copies (primary and replica shards) the index operation should be "
198 "desc":
"Indicates the number of shard copies the index operation succeeded on. When the index "
199 "operation is successful, `successful` is at least 1.\n\n"
200 "Replica shards might not all be started when an indexing operation returns successfully; by "
201 "default, only the primary is required. Set `wait_for_active_shards` to change this default "
206 "desc":
"An array that contains replication-related errors in the case an index operation failed on "
207 "a replica shard. `0` indicates there were no failures.",
227 "desc":
"The name of the index the document was added to",
231 "desc":
"The unique identifier for the added document",
235 "desc":
"The document version. Incremented each time the document is updated",
239 "desc":
"The result of the indexing operation, `created` or `updated`",
243 "desc":
"Provides information about the replication process of the index operation",
247 "desc":
"The sequence number assigned to the document for the indexing operation. Sequence numbers "
248 "are used to ensure an older version of a document doesn’t overwrite a newer version",
252 "desc":
"The primary term assigned to the document for the indexing operation",
255 "type": StringOrNothingType,
256 "desc":
"The document type. Elasticsearch indices now support a single document type, `_doc`"
The AWS REST client base data provider class.
Definition: ElasticSearchDataProviderBase.qc.dox.h:28
const ConstructorOptions
Constructor options.
Definition: ElasticSearchDataProvider.qc.dox.h:61
The ElasticSearch document create API data provider.
Definition: ElasticSearchDocumentCreateDataProvider.qc.dox.h:32
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
*string getDesc()
Returns the data provider description.
const ResponseType
Response type.
Definition: ElasticSearchDocumentCreateDataProvider.qc.dox.h:53
constructor(RestClient::RestClient rest)
Creates the object from a REST connection.
const RequestType
Request type.
Definition: ElasticSearchDocumentCreateDataProvider.qc.dox.h:50
const QueryArgs
Query args.
Definition: ElasticSearchDocumentCreateDataProvider.qc.dox.h:56
*DataProvider::AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
string getName()
Returns the data provider name.
hash< DataProvider::DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
const ProviderInfo
Provider info.
Definition: ElasticSearchDocumentCreateDataProvider.qc.dox.h:36
*DataProvider::AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
constructor(*hash< auto > options)
Creates the object from constructor options.
const ProviderSummaryInfo
Provider summary info.
Definition: ElasticSearchDocumentCreateDataProvider.qc.dox.h:45
Create document request data type.
Definition: ElasticSearchDocumentCreateDataProvider.qc.dox.h:108
const Fields
Field descriptions.
Definition: ElasticSearchDocumentCreateDataProvider.qc.dox.h:113
constructor()
Creates the object.
Document create API response.
Definition: ElasticSearchDocumentCreateDataProvider.qc.dox.h:219
constructor()
Creates the object.
const Fields
Field descriptions.
Definition: ElasticSearchDocumentCreateDataProvider.qc.dox.h:224
Shard data type.
Definition: ElasticSearchDocumentCreateDataProvider.qc.dox.h:185
constructor()
Creates the object.
const Fields
Field descriptions.
Definition: ElasticSearchDocumentCreateDataProvider.qc.dox.h:190
Boolean string type.
Definition: ElasticSearchDataProvider.qc.dox.h:141
Qore ElasticSearchDataProvider module definition.
Definition: ElasticSearchAcknowledgedDataType.qc.dox.h:26