Firestore v1 API - Class Function (4.1.0)

public sealed class Function : IMessage<Function>, IEquatable<Function>, IDeepCloneable<Function>, IBufferMessage, IMessage

Reference documentation and code samples for the Firestore v1 API class Function.

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%" }

Inheritance

object > Function

Namespace

Google.Cloud.Firestore.V1

Assembly

Google.Cloud.Firestore.V1.dll

Constructors

Function()

public Function()

Function(Function)

public Function(Function other)
Parameter
Name Description
other Function

Properties

Args

public RepeatedField<Value> Args { get; }

Optional. Ordered list of arguments the given function expects.

Property Value
Type Description
RepeatedFieldValue

Name

public string Name { get; set; }

Required. The name of the function to evaluate.

Requires:

  • must be in snake case (lower case with underscore separator).
Property Value
Type Description
string

Options

public MapField<string, Value> Options { get; }

Optional. Optional named arguments that certain functions may support.

Property Value
Type Description
MapFieldstringValue