Struct UpdateActionBody 

pub struct UpdateActionBody {
    pub doc: Option<Value>,
    pub upsert: Option<Value>,
    pub doc_as_upsert: Option<bool>,
    pub script: Option<Script>,
}

Fields

doc: Option<Value>

upsert: Option<Value>

doc_as_upsert: Option<bool>

script: Option<Script>

Implementations

impl UpdateActionBody

Represents the body of an update action.

This struct provides methods for creating different types of update actions. An update action can be created with a document, a script, or a script with parameters.

Examples

Creating an update action with a document:

use serde_json::json;
use opensearch_client::types::bulk::UpdateActionBody;

let doc = json!({
    "name": "John Doe",
    "age": 30,
});

let update_action = UpdateActionBody::new(doc);

Creating an update action with a script:

use opensearch_client::types::bulk::UpdateActionBody;

let script = r#"ctx._source.age += params.age"#;

let update_action = UpdateActionBody::from_script(script);

Creating an update action with a script and parameters:

use serde_json::json;
use opensearch_client::types::bulk::UpdateActionBody;

let script = r#"ctx._source.age += params.age"#;
let params = json!({
    "age": 5,
});

let update_action = UpdateActionBody::from_script_parameters(script, params);

Creating an update action with a pre-defined script:

use opensearch_client::types::bulk::{UpdateActionBody, Script};

let script = Script {
    source: r#"ctx._source.age += params.age"#.to_string(),
    params: Some(json!({
        "age": 5,
    })),
};

let update_action = UpdateActionBody::with_script(script);

pub fn new(doc: Value) -> Self

Creates a new update action with a document.

Arguments

• doc - The document to be updated.

Returns

The update action body.

pub fn from_script(script: &str) -> Self

Creates a new update action with a script.

Arguments

• script - The script to be executed for the update action.

Returns

The update action body.

pub fn from_script_parameters(script: &str, params: Value) -> Self

Creates a new update action with a script and parameters.

Arguments

• script - The script to be executed for the update action.
• params - The parameters to be passed to the script.

Returns

The update action body.

pub fn with_script(script: Script) -> Self

Creates a new update action with a pre-defined script.

Arguments

• script - The pre-defined script to be executed for the update action.

Returns

The update action body.

pub fn with_doc_upsert(doc: &Value, upsert: &Value) -> Self

Creates a new update action with a document and upsert option.

Arguments

• doc - The document to be updated.
• upsert - The document to be used for upsert if the document does not exist.

Returns

The update action body.

Trait Implementations

impl Clone for UpdateActionBody

fn clone(&self) -> UpdateActionBody

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateActionBody

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for UpdateActionBody

fn default() -> UpdateActionBody

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UpdateActionBody

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for UpdateActionBody

fn eq(&self, other: &UpdateActionBody) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for UpdateActionBody

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for UpdateActionBody