Google API Common Protos Client - Class Expr (4.8.1)

Reference documentation and code samples for the Google API Common Protos Client class 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.

Generated from protobuf message google.type.Expr

Namespace

Google \ Type

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ 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.

getExpression

Textual representation of an expression in Common Expression Language syntax.

Returns
Type Description
string

setExpression

Textual representation of an expression in Common Expression Language syntax.

Parameter
Name Description
var string
Returns
Type Description
$this

getTitle

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.

Returns
Type Description
string

setTitle

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

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

Returns
Type Description
string

setDescription

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

Parameter
Name Description
var string
Returns
Type Description
$this

getLocation

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

Returns
Type Description
string

setLocation

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

Parameter
Name Description
var string
Returns
Type Description
$this