nebius.base.fieldmask

module documentation

(source)

Helpers for injecting protobuf-derived reset masks into metadata.

Function	`ensure_reset_mask_in_metadata`	Ensure the reset mask header is present in request metadata.
Constant	`RESET_MASK_HEADER`	Metadata header name used for reset masks.

def ensure_reset_mask_in_metadata(msg: Message, metadata: Iterable[tuple[str, str]] | None) -> Metadata: (source) ¶

Ensure the reset mask header is present in request metadata.

This helper builds a nebius.base.metadata.Metadata instance from the provided iterable and populates the X-ResetMask header when it is missing. The mask is derived from the protobuf message by calling nebius.base.protos.pb_classes.Message.get_full_update_reset_mask.

Example

Use the helper before sending an update request:

from nebius.base.fieldmask_protobuf import ensure_reset_mask_in_metadata

md = ensure_reset_mask_in_metadata(request, metadata=None)
await service.update(request, metadata=md)

Parameters
msg:`Message`	Protobuf message used to derive the full update reset mask.
metadata:`Iterable[tuple[str, str]] \| None`	Existing metadata entries or `None`.
Returns
`Metadata`	A `Metadata` instance containing the reset mask header.

RESET_MASK_HEADER: str = (source) ¶

Metadata header name used for reset masks.

Value

'X-ResetMask'