StageOptions interface

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Options defining how a Stage is evaluated.

Signature:

exportdeclareinterfaceStageOptions

Properties

PropertyTypeDescription
rawOptions{ [name: string]: unknown; }(Public Preview) An escape hatch to set options not known at SDK build time. These values will be passed directly to the Firestore backend and not used by the SDK.The option name will be used as provided. And must match the name format used by the backend (hint: use a snake_case_name).Raw option values can be any type supported by Firestore (for example: string, boolean, number, map, …). Value types not known to the SDK will be rejected.Values specified in rawOptions will take precedence over any options with the same name set by the SDK.rawOptions supports dot notation, if you want to override a nested option.

StageOptions.rawOptions

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

An escape hatch to set options not known at SDK build time. These values will be passed directly to the Firestore backend and not used by the SDK.

The option name will be used as provided. And must match the name format used by the backend (hint: use a snake_case_name).

Raw option values can be any type supported by Firestore (for example: string, boolean, number, map, …). Value types not known to the SDK will be rejected.

Values specified in rawOptions will take precedence over any options with the same name set by the SDK.

rawOptions supports dot notation, if you want to override a nested option.

Signature:

rawOptions?:{[name:string]:unknown;};

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-01-15 UTC.