firebaserules.v1 library Null safety

Firebase Rules API - v1

Creates and manages rules that determine when a Firebase Rules-enabled service should permit a request.

For more information, see firebase.google.com/docs/storage/security

Create an instance of FirebaseRulesApi to access these resources:

Classes

Arg
Arg matchers for the mock function.
ExpressionReport
Describes where in a file an expression is found and what it was evaluated to over the course of its use.
File
File containing source content.
FirebaseRulesApi
Creates and manages rules that determine when a Firebase Rules-enabled service should permit a request.
FunctionCall
Represents a service-defined function call that was invoked during test execution.
FunctionMock
Mock function definition.
GetReleaseExecutableResponse
The response for FirebaseRulesService.GetReleaseExecutable
Issue
Issues include warnings, errors, and deprecation notices.
ListReleasesResponse
The response for FirebaseRulesService.ListReleases.
ListRulesetsResponse
The response for FirebaseRulesService.ListRulesets.
Metadata
Metadata for a Ruleset.
ProjectsReleasesResource
ProjectsResource
ProjectsRulesetsResource
Release
Release is a named reference to a Ruleset.
Result
Possible result values from the function mock invocation.
Ruleset
Ruleset is an immutable copy of Source with a globally unique identifier and a creation time.
Source
Source is one or more File messages comprising a logical set of rules.
SourcePosition
Position in the Source content including its line, column number, and an index of the File in the Source message.
TestCase
TestCase messages provide the request context and an expectation as to whether the given context will be allowed or denied.
TestResult
Test result message containing the state of the test as well as a description and source position for test failures.
TestRulesetRequest
The request for FirebaseRulesService.TestRuleset.
TestRulesetResponse
The response for FirebaseRulesService.TestRuleset.
TestSuite
TestSuite is a collection of TestCase instances that validate the logical correctness of a Ruleset.
UpdateReleaseRequest
The request for FirebaseRulesService.UpdateRelease.
ValueCount
Tuple for how many times an Expression was evaluated to a particular ExpressionValue.
VisitedExpression
Store the position and access outcome for an expression visited in rules.

Typedefs

Empty = $Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.