Class Function (2.23.0)

Version latest

• 2.23.0 (latest)
• 2.22.0
• 2.21.0
• 2.20.2
• 2.19.0
• 2.18.0
• 2.17.2
• 2.16.1
• 2.15.0
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.1
• 2.10.1
• 2.9.1
• 2.8.0
• 2.7.3
• 2.6.1
• 2.5.3
• 2.4.0
• 2.3.4
• 2.2.0
• 2.1.3
• 2.0.2
• 1.9.2
• 1.8.1
• 1.7.0
• 1.6.2
• 1.5.0
• 1.4.0
• 1.3.0

Function(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents an unevaluated scalar expression.

For example, the expression like(user_name, "%alice%") is represented as:

::

name: "like" args { field_reference: "user_name" } args { string_value: "%alice%" }

Attributes
Name	Description
name	str Required. The name of the function to evaluate. **Requires:** - must be in snake case (lower case with underscore separator).
args	MutableSequence[google.cloud.firestore_v1.types.Value] Optional. Ordered list of arguments the given function expects.
options	MutableMapping[str, google.cloud.firestore_v1.types.Value] Optional. Optional named arguments that certain functions may support.

Classes

OptionsEntry

OptionsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.