REST Resource: projects.rulesets
Stay organized with collections
Save and categorize content based on your preferences.
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.
|
Methods |
|
|
Create a Ruleset from Source. |
|
|
Delete a Ruleset by resource name. |
|
|
Get a Ruleset by name including the full Source contents. |
|
|
List Ruleset metadata only and optionally filter the results by Ruleset name. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-10-23 UTC.
[null,null,["Last updated 2023-10-23 UTC."],[],[],null,["# REST Resource: projects.rulesets\n\n- [Resource: Ruleset](#Ruleset)\n - [JSON representation](#Ruleset.SCHEMA_REPRESENTATION)\n- [Source](#Source)\n - [JSON representation](#Source.SCHEMA_REPRESENTATION)\n- [File](#File)\n - [JSON representation](#File.SCHEMA_REPRESENTATION)\n- [Metadata](#Metadata)\n - [JSON representation](#Metadata.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Ruleset\n-----------------\n\n`Ruleset` is an immutable copy of `Source` with a globally unique identifier and a creation time.\n\n| JSON representation ||\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"name\": string, \"source\": { object (/docs/reference/rules/rest/v1/projects.rulesets#Source) }, \"createTime\": string, \"metadata\": { object (/docs/reference/rules/rest/v1/projects.rulesets#Metadata) }, \"attachment_point\": string } ``` |\n\n| Fields ||\n|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. Name of the `Ruleset`. The ruleset_id is auto generated by the service. Format: `projects/{project_id}/rulesets/{ruleset_id}` |\n| `source` | `object (`[Source](/docs/reference/rules/rest/v1/projects.rulesets#Source)`)` `Source` for the `Ruleset`. |\n| `createTime` | `string (`[Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.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\"`. |\n| `metadata` | `object (`[Metadata](/docs/reference/rules/rest/v1/projects.rulesets#Metadata)`)` Output only. The metadata for this ruleset. |\n| `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/\u003cproject number\u003e/databases/\u003cuuid\u003e ` ` ` |\n\nSource\n------\n\n`Source` is one or more `File` messages comprising a logical set of rules.\n\n| JSON representation ||\n|--------------------------------------------------------------------------------------------|---|\n| ``` { \"files\": [ { object (/docs/reference/rules/rest/v1/projects.rulesets#File) } ] } ``` |\n\n| Fields ||\n|-----------|------------------------------------------------------------------------------------------------------------------------|\n| `files[]` | `object (`[File](/docs/reference/rules/rest/v1/projects.rulesets#File)`)` `File` set constituting the `Source` bundle. |\n\nFile\n----\n\n`File` containing source content.\n\n| JSON representation ||\n|----------------------------------------------------------------------|---|\n| ``` { \"content\": string, \"name\": string, \"fingerprint\": string } ``` |\n\n| Fields ||\n|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `content` | `string` Rules language statements. Use `\\n` for line breaks. |\n| `name` | `string` File name. |\n| `fingerprint` | `string (`[bytes](https://developers.google.com/discovery/v1/type-format)` format)` Fingerprint (e.g. github sha) associated with the `File`. A base64-encoded string. |\n\nMetadata\n--------\n\nMetadata for a Ruleset.\n\n| JSON representation ||\n|------------------------------------|---|\n| ``` { \"services\": [ string ] } ``` |\n\n| Fields ||\n|--------------|---------------------------------------------------------------------------------------------------------------|\n| `services[]` | `string` Services that this ruleset has declarations for (e.g., \"cloud.firestore\"). There may be 0+ of these. |\n\n| Methods ------- ||\n|----------------------------------------------------------------------|-----------------------------------------------------------------------------------|\n| ### [create](/docs/reference/rules/rest/v1/projects.rulesets/create) | Create a `Ruleset` from `Source`. |\n| ### [delete](/docs/reference/rules/rest/v1/projects.rulesets/delete) | Delete a `Ruleset` by resource name. |\n| ### [get](/docs/reference/rules/rest/v1/projects.rulesets/get) | Get a `Ruleset` by name including the full `Source` contents. |\n| ### [list](/docs/reference/rules/rest/v1/projects.rulesets/list) | List `Ruleset` metadata only and optionally filter the results by `Ruleset` name. |"]]
