Cloud Firestore V1 Client - Class PBFunction (1.55.0)

Reference documentation and code samples for the Cloud Firestore V1 Client class PBFunction.

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

Generated from protobuf message google.firestore.v1.Function

Namespace

Google \ Cloud \ Firestore \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Required. The name of the function to evaluate. Requires: * * must be in snake case (lower case with underscore separator).
↳ args array<Value>

Optional. Ordered list of arguments the given function expects.
↳ options array|Google\Protobuf\Internal\MapField

Optional. Optional named arguments that certain functions may support.

getName

Required. The name of the function to evaluate.

Requires:

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

setName

Required. The name of the function to evaluate.

Requires:

  • must be in snake case (lower case with underscore separator).
Parameter
Name Description
var string
Returns
Type Description
$this

getArgs

Optional. Ordered list of arguments the given function expects.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setArgs

Optional. Ordered list of arguments the given function expects.

Parameter
Name Description
var array<Value>
Returns
Type Description
$this

getOptions

Optional. Optional named arguments that certain functions may support.

Returns
Type Description
Google\Protobuf\Internal\MapField

setOptions

Optional. Optional named arguments that certain functions may support.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this