firebaserules library

Classes

File
File containing source content.
FileResponse
File containing source content.
GetReleaseArgs
Arguments for getRelease. Arguments for getRelease.
GetReleaseResult
Result data returned by getRelease.
GetRulesetArgs
Arguments for getRuleset. Arguments for getRuleset.
GetRulesetResult
Result data returned by getRuleset.
MetadataResponse
Metadata for a Ruleset.
Release
Create a Release. Release names should reflect the developer's deployment practices. For example, the release name may include the environment name, application name, application version, or any other name meaningful to the developer. Once a Release refers to a Ruleset, the rules can be enforced by Firebase Rules-enabled services. More than one Release may be 'live' concurrently. Consider the following three Release names for projects/foo and the Ruleset to which they refer. Release Name -> Ruleset Name * projects/foo/releases/prod -> projects/foo/rulesets/uuid123 * projects/foo/releases/prod/beta -> projects/foo/rulesets/uuid123 * projects/foo/releases/prod/v23 -> projects/foo/rulesets/uuid456 The relationships reflect a Ruleset rollout in progress. The prod and prod/beta releases refer to the same Ruleset. However, prod/v23 refers to a new Ruleset. The Ruleset reference for a Release may be updated using the UpdateRelease method.
ReleaseArgs
The set of arguments for Release. The set of arguments for Release.
Ruleset
Create a Ruleset from Source. The Ruleset is given a unique generated name which is returned to the caller. Source containing syntactic or semantics errors will result in an error response indicating the first error encountered. For a detailed view of Source issues, use TestRuleset. Auto-naming is currently not supported for this resource.
RulesetArgs
The set of arguments for Ruleset. The set of arguments for Ruleset.
Source
Source is one or more File messages comprising a logical set of rules.
SourceResponse
Source is one or more File messages comprising a logical set of rules.

Functions

getRelease(GetReleaseArgs args, {InvokeOptions? options}) → Future<GetReleaseResult>
Get a Release by name. args Arguments passed to this invoke. Arguments for getRelease. options Invoke options controlling this call.
getRuleset(GetRulesetArgs args, {InvokeOptions? options}) → Future<GetRulesetResult>
Get a Ruleset by name including the full Source contents. args Arguments passed to this invoke. Arguments for getRuleset. options Invoke options controlling this call.