Struct Push Scope Params | NVIDIA NeMo Relay

Generated from cargo doc --no-deps -p nemo-relay -p nemo-relay-adaptive -p nemo-relay-ffi.

pub struct PushScopeParams<'a> {
    pub name: &'a str,
    pub scope_type: ScopeType,
    pub parent: Option<&'a ScopeHandle>,
    pub attributes: ScopeAttributes,
    pub data: Option<Json>,
    pub metadata: Option<Json>,
    pub input: Option<Json>,
    pub timestamp: Option<DateTime<Utc>>,
}

Builder parameters for push_scope.

Fields

`name: &'a str`

Human-readable scope name recorded on emitted lifecycle events.

`scope_type: ScopeType`

Semantic category for the new scope.

`parent: Option<&'a ScopeHandle>`

Optional explicit parent scope.

`attributes: ScopeAttributes`

Scope attribute bitflags applied to the new scope.

`data: Option<Json>`

Optional application payload stored on the scope handle.

`metadata: Option<Json>`

Optional JSON metadata recorded on the emitted start event.

`input: Option<Json>`

Optional JSON payload exported as the scope start event data.

`timestamp: Option<DateTime<Utc>>`

Optional timestamp recorded on the emitted start event.

Implementations

`impl<'a> PushScopeParams<'a>`

impl<'a> PushScopeParams<'a>

`builder`

pub fn builder() -> PushScopeParamsBuilder<'a, ((), (), (), (), (), (), (), ())>

Create a builder for building PushScopeParams. On the builder, call .name(...), .scope_type(...), .parent(...)(optional), .attributes(...)(optional), .data(...)(optional), .metadata(...)(optional), .input(...)(optional), .timestamp(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of PushScopeParams.