Skip to main content

rulesets

Overview

Namerulesets
TypeResource
Idfirebase.firebaserules.rulesets

Fields

NameDatatypeDescription
namestringOutput only. Name of the Ruleset. The ruleset_id is auto generated by the service. Format: projects/{project_id}/rulesets/{ruleset_id}
sourceobjectSource is one or more File messages comprising a logical set of rules.
createTimestringOutput only. Time the Ruleset was created.
metadataobjectMetadata for a Ruleset.

Methods

NameAccessible byRequired ParamsDescription
projects_rulesets_getSELECTprojectsId, rulesetsIdGet a Ruleset by name including the full Source contents.
projects_rulesets_listSELECTprojectsIdList Ruleset metadata only and optionally filter the results by Ruleset name. The full Source contents of a Ruleset may be retrieved with GetRuleset.
projects_rulesets_createINSERTprojectsIdCreate 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.
projects_rulesets_deleteDELETEprojectsId, rulesetsIdDelete a Ruleset by resource name. If the Ruleset is referenced by a Release the operation will fail.