SensitiveData class

A model for encapsulating sensitive operation data for logging purposes

This class collects context about Firestore operations, making it easier to:

  • Debug issues with specific documents or queries
  • Track operation parameters
  • Monitor performance
  • Audit data access

Example:

final sensitiveData = SensitiveData(
  path: 'users',
  id: 'user-123',
  searchTerm: 'John',
  searchField: 'name',
  searchTermType: TurboSearchTermType.startsWith,
);
log.debug(
  message: 'Searching for user',
  sensitiveData: sensitiveData,
);

Constructors

SensitiveData.new({required String path, String? id, String? whereDescription, TurboTimestampType? createTimeStampType, String? field, bool? isBatch, bool? isMerge, bool? isTransaction, int? limit, List<FieldPath>? mergeFields, String? searchField, String? searchTerm, TurboSearchTermType? searchTermType, String? type, TurboTimestampType? updateTimeStampType, Object? data})
Creates a new sensitive data container
const

Properties

createTimeStampType → TurboTimestampType?
Timestamp type for document creation
final
data → Object?
Additional operation data
final
field → String?
Field name being operated on
final
hashCode → int
The hash code for this object.
no setterinherited
id → String?
The document ID being operated on
final
isBatch → bool?
Whether operation is part of a batch
final
isMerge → bool?
Whether operation is a merge
final
isTransaction → bool?
Whether operation is part of a transaction
final
limit → int?
Query result limit
final
mergeFields → List<FieldPath>?
Fields to merge in update operations
final
path → String
The Firestore path being accessed
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
searchField → String?
Field to search in for search operations
final
searchTerm → String?
Term to search for in search operations
final
searchTermType → TurboSearchTermType?
Type of search being performed
final
type → String?
Operation type identifier
final
updateTimeStampType → TurboTimestampType?
Timestamp type for document updates
final
whereDescription → String?
Description of query conditions
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited