REST Resource: projects.rulesets

Resource: Ruleset

Ruleset is an immutable copy of Source with a globally unique identifier and a creation time.

JSON representation 
{
  "name": string,
  "source": {
    object (Source)
  },
  "createTime": string,
  "metadata": {
    object (Metadata)
  },
  "attachment_point": string
}
Fields
name

string

Output only. Name of the Ruleset. The ruleset_id is auto generated by the service. Format: projects/{project_id}/rulesets/{ruleset_id}
source

object (Source)

Source for the Ruleset.
createTime

string (Timestamp format)

Output only. Time the Ruleset was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
metadata

object (Metadata)

Output only. The metadata for this ruleset.
attachment_point

string

Intended resource to which this Ruleset should be released. May be left blank to signify the resource associated with the default release. Expected format: firestore.googleapis.com/projects/<project number>/databases/<uuid>

Source

Source is one or more File messages comprising a logical set of rules.

JSON representation 
{
  "files": [
    {
      object (File)
    }
  ]
}
Fields
files[]

object (File)

File set constituting the Source bundle.

File

File containing source content.

JSON representation 
{
  "content": string,
  "name": string,
  "fingerprint": string
}
Fields
content

string

Rules language statements. Use \n for line breaks.
name

string

File name.
fingerprint

string (bytes format)

Fingerprint (e.g. github sha) associated with the File.

A base64-encoded string.

Metadata

Metadata for a Ruleset.

JSON representation 
{
  "services": [
    string
  ]
}
Fields
services[]

string

Services that this ruleset has declarations for (e.g., "cloud.firestore"). There may be 0+ of these.

Methods

create

 Create a Ruleset from Source.

delete

 Delete a Ruleset by resource name.

get

 Get a Ruleset by name including the full Source contents.

list

 List Ruleset metadata only and optionally filter the results by Ruleset name.