Cloud Firestore V1 Client - Class FieldReference (1.47.2)

Version latest

• 1.47.2 (latest)
• 1.47.1
• 1.46.0
• 1.45.2
• 1.44.1
• 1.43.3
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.7
• 1.36.1
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.28.0
• 1.27.3

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

A reference to a field in a document, ex: stats.operations.

Generated from protobuf message google.firestore.v1.StructuredQuery.FieldReference

Namespace

Google \ Cloud \ Firestore \ V1 \ StructuredQuery

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ field_path	string A reference to a field in a document. Requires: * * MUST be a dot-delimited (.) string of segments, where each segment conforms to document field name limitations.

getFieldPath

A reference to a field in a document.

Requires:

• MUST be a dot-delimited (.) string of segments, where each segment conforms to document field name limitations.

Returns
Type	Description
string

setFieldPath

A reference to a field in a document.

Requires:

• MUST be a dot-delimited (.) string of segments, where each segment conforms to document field name limitations.

Parameter
Name	Description
var	string

Returns
Type	Description
$this