U >i@sdZGdddeZedZedZGdddeZGdddeZGd d d eZGd d d eZGd ddeZ GdddeZ GdddeZ dS)z4Helpful constants to use for Google Cloud Firestore.c@s:eZdZdZdZddddZddZd d Zd d ZdS) Sentinelz1Sentinel objects used to signal special handling. descriptionNreturncCs ||_dSNr)selfrrH/tmp/pip-unpacked-wheel-599y42ri/google/cloud/firestore_v1/transforms.py__init__szSentinel.__init__cCs d|jS)Nz Sentinel: {})formatrrrrr __repr__szSentinel.__repr__cCs|Srrr rrr __copy__szSentinel.__copy__cCs|Srr)rmemorrr __deepcopy__!szSentinel.__deepcopy__) __name__ __module__ __qualname____doc__ __slots__r r rrrrrr rs rz+Value used to delete a field in a document.z;Value used to set a document field to the server timestamp.c@s6eZdZdZdZddddZddZed d ZdS) _ValueListzcRead-only list of values. Args: values (List | Tuple): values held in the helper. _valuesNrcCs8t|ttfstdt|dkr*tdt||_dS)Nz!'values' must be a list or tuple.z'values' must be non-empty.) isinstancelisttuple ValueErrorlenr)rvaluesrrr r 7s  z_ValueList.__init__cCst||jstS|j|jkSr)r __class__NotImplementedrrotherrrr __eq__@s z_ValueList.__eq__cCs|jS)zgValues to append. Returns (List): values to be appended by the transform. rr rrr rEsz_ValueList.values) rrrrslotsr r$propertyrrrrr r.s  rc@seZdZdZdS) 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. Nrrrrrrrr r'Osr'c@seZdZdZdS) 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(rrrr r)Zsr)c@s2eZdZdZddddZeddZdd ZdS) _NumericValuezeHold a single integer / float value. Args: value (float): value held in the helper. NrcCs t|ttfstd||_dS)NzPass an integer / float value.)rintfloatr_value)rvaluerrr r lsz_NumericValue.__init__cCs|jS)zlValue used by the transform. Returns: (Lloat) value passed in the constructor. )r-r rrr r.rsz_NumericValue.valuecCst||jstS|j|jkSr)rr r!r-r"rrr r${s z_NumericValue.__eq__)rrrrr r&r.r$rrrr r*es  r*c@seZdZdZdS) Incrementa|Field 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 (float): value used to increment the field. Nr(rrrr r/sr/c@seZdZdZdS)MaximumapField 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 (float): value used to bound the field. Nr(rrrr r0sr0c@seZdZdZdS)MinimumapField 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 (float): value used to bound the field. Nr(rrrr r1sr1N) robjectrZ DELETE_FIELDZSERVER_TIMESTAMPrr'r)r*r/r0r1rrrr s!