Interface IBulkUpdateOperation<TDocument, TPartialDocument>
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public interface IBulkUpdateOperation<TDocument, TPartialDocument> : IBulkOperation where TDocument : class where TPartialDocument : class
Type Parameters
| Name | Description |
|---|---|
| TDocument | |
| TPartialDocument |
Properties
| Edit this page View SourceDoc
The partial update document to be merged on to the existing object.
Declaration
TPartialDocument Doc { get; set; }
Property Value
| Type | Description |
|---|---|
| TPartialDocument |
DocAsUpsert
Instead of sending a partial doc with Doc plus an upsert doc
with Upsert, setting DocAsUpsert to true will
use the contents of doc as the upsert value.
Declaration
bool? DocAsUpsert { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? |
IdFrom
Infers the id of the object to update from the provided object. See Doc to apply a partial object merge.
Declaration
TDocument IdFrom { get; set; }
Property Value
| Type | Description |
|---|---|
| TDocument |
IfPrimaryTerm
Declaration
long? IfPrimaryTerm { get; set; }
Property Value
| Type | Description |
|---|---|
| long? |
IfSequenceNumber
Declaration
long? IfSequenceNumber { get; set; }
Property Value
| Type | Description |
|---|---|
| long? |
Script
A script to specify the update.
Declaration
IScript Script { get; set; }
Property Value
| Type | Description |
|---|---|
| IScript |
ScriptedUpsert
If you would like your script to run regardless of whether the document exists or not — i.e. the script handles initializing the document instead of the upsert element — then set scripted_upsert to true
Declaration
bool? ScriptedUpsert { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? |
Source
True or false to return the _source field or not, or a list of fields to return.
Declaration
[DataMember(Name = "_source")]
Union<bool, ISourceFilter> Source { get; set; }
Property Value
| Type | Description |
|---|---|
| Union<bool, ISourceFilter> |
Upsert
A document to upsert when the specified document to be updated is not found
Declaration
TDocument Upsert { get; set; }
Property Value
| Type | Description |
|---|---|
| TDocument |