Skip to main content

Module read_mask_defaults

Module read_mask_defaults 

Source

Constants§

CHECKPOINT
Default read mask for a checkpoint (get_checkpoint, list_checkpoints).
DYNAMIC_FIELD
Default read mask for a dynamic-field listing (list_dynamic_fields).
EPOCH
Default read mask for an epoch (get_epoch; there is no list_epochs).
EVENT
Default read mask for an event (list_events; there is no get_events).
EXECUTE_TRANSACTION
Default read mask for transaction execution (ExecuteTransaction).
OBJECT
Default read mask for an object (get_object, list_object_versions).
OBJECT_REMOVAL
Default removal_read_mask for each removal in an object’s version listing (list_object_versions).
OWNED_OBJECT
Default read mask for an owned-object listing (list_owned_objects).
PROTOCOL_CONFIG
Default read mask for a protocol config (get_protocol_config).
TRANSACTION
Default read mask for a transaction (get_transaction, list_transactions).

Functions§

validate_field_mask
validate_read_mask for a mask in request field field, which an invalid path’s FieldViolation names.
validate_read_mask
Validate an optional request read_mask against message type M, falling back to default when the request omits one, and return it as a FieldMaskTree. Shared by every read-mask-bearing handler (get, list, and subscribe) so validation and the “no mask -> default” rule stay identical across them. default is an explicit argument because one message type can carry different per-endpoint defaults (e.g. ExecutedTransaction uses TRANSACTION for get/list but EXECUTE_TRANSACTION for execution).