o ˷eM@sdZGdddeZedZedZGdddeZGdddeZGd d d eZGd d d eZGd ddeZ GdddeZ GdddeZ dS)z4Helpful constants to use for Google Cloud Firestore.c@s&eZdZdZdZd ddZddZdS) Sentinelz1Sentinel objects used to signal special handling. descriptionreturnNcCs ||_dSNr)selfrr[/var/www/ideatree/venv/lib/python3.10/site-packages/google/cloud/firestore_v1/transforms.py__init__s zSentinel.__init__cCs d|jS)Nz Sentinel: {})formatrrrrr__repr__s zSentinel.__repr__rN)__name__ __module__ __qualname____doc__ __slots__r r rrrrrs   rz+Value used to delete a field in a document.z;Value used to set a document field to the server timestamp.c@s2eZdZdZdZd ddZddZed d ZdS) _ValueListzcRead-only list of values. Args: values (List | Tuple): values held in the helper. _valuesrNcCs8t|ttfs tdt|dkrtdt||_dS)Nz!'values' must be a list or tuple.z'values' must be non-empty.) isinstancelisttuple ValueErrorlenr)rvaluesrrrr /s  z_ValueList.__init__cCt||jstS|j|jkSr)r __class__NotImplementedrrotherrrr__eq__8  z_ValueList.__eq__cC|jS)zgValues to append. Returns (List): values to be appended by the transform. rr rrrr=z_ValueList.valuesr ) rrrrslotsr r"propertyrrrrrr&s  rc@eZdZdZdS) ArrayUniona{Field transform: appends missing values to an array field. See: https://cloud.google.com/firestore/docs/reference/rpc/google.firestore.v1#google.firestore.v1.DocumentTransform.FieldTransform.FIELDS.google.firestore.v1.ArrayValue.google.firestore.v1.DocumentTransform.FieldTransform.append_missing_elements Args: values (List | Tuple): values to append. Nrrrrrrrrr)Gr)c@r() ArrayRemovearField transform: remove values from an array field. See: https://cloud.google.com/firestore/docs/reference/rpc/google.firestore.v1#google.firestore.v1.DocumentTransform.FieldTransform.FIELDS.google.firestore.v1.ArrayValue.google.firestore.v1.DocumentTransform.FieldTransform.remove_all_from_array Args: values (List | Tuple): values to remove. Nr*rrrrr,Rr+r,c@s.eZdZdZd ddZeddZdd ZdS) _NumericValuezkHold a single integer / float value. Args: value (int | float): value held in the helper. rNcCs t|ttfs td||_dS)NzPass an integer / float value.)rintfloatr_value)rvaluerrrr ds z_NumericValue.__init__cCr$)zvValue used by the transform. Returns: (Integer | Float) value passed in the constructor. )r0r rrrr1jr%z_NumericValue.valuecCrr)rrrr0r rrrr"sr#z_NumericValue.__eq__r )rrrrr r'r1r"rrrrr-]s    r-c@r() IncrementaField transform: increment a numeric field with specified value. See: https://cloud.google.com/firestore/docs/reference/rpc/google.firestore.v1#google.firestore.v1.DocumentTransform.FieldTransform.FIELDS.google.firestore.v1.ArrayValue.google.firestore.v1.DocumentTransform.FieldTransform.increment Args: value (int | float): value used to increment the field. Nr*rrrrr2yr+r2c@r()MaximumavField transform: bound numeric field with specified value. See: https://cloud.google.com/firestore/docs/reference/rpc/google.firestore.v1#google.firestore.v1.DocumentTransform.FieldTransform.FIELDS.google.firestore.v1.ArrayValue.google.firestore.v1.DocumentTransform.FieldTransform.maximum Args: value (int | float): value used to bound the field. Nr*rrrrr3r+r3c@r()MinimumavField transform: bound numeric field with specified value. See: https://cloud.google.com/firestore/docs/reference/rpc/google.firestore.v1#google.firestore.v1.DocumentTransform.FieldTransform.FIELDS.google.firestore.v1.ArrayValue.google.firestore.v1.DocumentTransform.FieldTransform.minimum Args: value (int | float): value used to bound the field. Nr*rrrrr4r+r4N) robjectr DELETE_FIELDSERVER_TIMESTAMPrr)r,r-r2r3r4rrrrs !