Struct PartialArg 

#[non_exhaustive]
pub struct PartialArg {
    pub json_path: String,
    pub will_continue: bool,
    pub delta: Option<Delta>,
    /* private fields */
}

Available on crate features data-foundry-service or gen-ai-cache-service or gen-ai-tuning-service or llm-utility-service or prediction-service or vertex-rag-service only.

Partial argument value of the function call.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

json_path: String

Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. “$.foo.bar[0].data”.

will_continue: bool

Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow.

delta: Option<Delta>

The delta of field value being streamed.

Implementations

impl PartialArg

pub fn new() -> Self

pub fn set_json_path<T: Into<String>>(self, v: T) -> Self

Sets the value of json_path.

Example

let x = PartialArg::new().set_json_path("example");

pub fn set_will_continue<T: Into<bool>>(self, v: T) -> Self

Sets the value of will_continue.

Example

let x = PartialArg::new().set_will_continue(true);

pub fn set_delta<T: Into<Option<Delta>>>(self, v: T) -> Self

Sets the value of delta.

Note that all the setters affecting delta are mutually exclusive.

Example

use wkt::NullValue;
let x = PartialArg::new().set_delta(Some(
    google_cloud_aiplatform_v1::model::partial_arg::Delta::NullValue(NullValue)));

pub fn null_value(&self) -> Option<&NullValue>

The value of delta if it holds a NullValue, None if the field is not set or holds a different branch.

pub fn set_null_value<T: Into<NullValue>>(self, v: T) -> Self

Sets the value of delta to hold a NullValue.

Note that all the setters affecting delta are mutually exclusive.

Example

use wkt::NullValue;
let x = PartialArg::new().set_null_value(NullValue);
assert!(x.null_value().is_some());
assert!(x.number_value().is_none());
assert!(x.string_value().is_none());
assert!(x.bool_value().is_none());

pub fn number_value(&self) -> Option<&f64>

The value of delta if it holds a NumberValue, None if the field is not set or holds a different branch.

pub fn set_number_value<T: Into<f64>>(self, v: T) -> Self

Sets the value of delta to hold a NumberValue.

Note that all the setters affecting delta are mutually exclusive.

Example

let x = PartialArg::new().set_number_value(42.0);
assert!(x.number_value().is_some());
assert!(x.null_value().is_none());
assert!(x.string_value().is_none());
assert!(x.bool_value().is_none());

pub fn string_value(&self) -> Option<&String>

The value of delta if it holds a StringValue, None if the field is not set or holds a different branch.

pub fn set_string_value<T: Into<String>>(self, v: T) -> Self

Sets the value of delta to hold a StringValue.

Note that all the setters affecting delta are mutually exclusive.

Example

let x = PartialArg::new().set_string_value("example");
assert!(x.string_value().is_some());
assert!(x.null_value().is_none());
assert!(x.number_value().is_none());
assert!(x.bool_value().is_none());

pub fn bool_value(&self) -> Option<&bool>

The value of delta if it holds a BoolValue, None if the field is not set or holds a different branch.

pub fn set_bool_value<T: Into<bool>>(self, v: T) -> Self

Sets the value of delta to hold a BoolValue.

Note that all the setters affecting delta are mutually exclusive.

Example

let x = PartialArg::new().set_bool_value(true);
assert!(x.bool_value().is_some());
assert!(x.null_value().is_none());
assert!(x.number_value().is_none());
assert!(x.string_value().is_none());

Trait Implementations

impl Clone for PartialArg

fn clone(&self) -> PartialArg

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PartialArg

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

Formats the value using the given formatter.

impl Default for PartialArg

fn default() -> PartialArg

Returns the “default value” for a type.

impl Message for PartialArg

fn typename() -> &'static str

The typename of this message.

impl PartialEq for PartialArg

fn eq(&self, other: &PartialArg) -> 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 StructuralPartialEq for PartialArg