REST Resource: projects.locations.repositories.rules

Resource: Rule

A rule defines the deny or allow action of the operation it applies to and the conditions required for the rule to apply. You can set one rule for an entire repository and one rule for each package within.

JSON representation 
{
  "name": string,
  "action": enum (Action),
  "operation": enum (Operation),
  "condition": {
    object (Expr)
  },
  "packageId": string
}
Fields
name

string

The name of the rule, for example: projects/p1/locations/us-central1/repositories/repo1/rules/rule1.
action

enum (Action)

The action this rule takes.
operation

enum (Operation)
condition

object (Expr)

Optional. A CEL expression for conditions that must be met in order for the rule to apply. If not provided, the rule matches all objects.
packageId

string

The package ID the rule applies to. If empty, this rule applies to all packages inside the repository.

Action

Defines the action of the rule.

Enums
ACTION_UNSPECIFIED Action not specified.
ALLOW Allow the operation.
DENY Deny the operation.

Operation

The operation the rule applies to.

Enums
OPERATION_UNSPECIFIED Operation not specified.
DOWNLOAD Download operation.

Expr

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.

Example (Comparison):

title: "Summary size limit"
description: "Determines if a summary is less than 100 chars"
expression: "document.summary.size() < 100"

Example (Equality):

title: "Requestor is owner"
description: "Determines if requestor is the document owner"
expression: "document.owner == request.auth.claims.email"

Example (Logic):

title: "Public documents"
description: "Determine whether the document should be publicly visible"
expression: "document.type != 'private' && document.type != 'internal'"

Example (Data Manipulation):

title: "Notification string"
description: "Create a notification string with a timestamp."
expression: "'New message received at ' + string(document.create_time)"

The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

JSON representation 
{
  "expression": string,
  "title": string,
  "description": string,
  "location": string
}
Fields
expression

string

Textual representation of an expression in Common Expression Language syntax.
title

string

Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
description

string

Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
location

string

Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

Methods

create

 Creates a rule.

delete

 Deletes a rule.

get

 Gets a rule.

list

 Lists rules.

patch

 Updates a rule.