Expr class

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.

Inheritance

Object
GeneratedMessage
Expr

Constructors

Expr({String? expression, String? title, String? description, String? location}): factory
Expr.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY]): factory
Expr.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY]): factory

Properties

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.
getter/setter pair
eventPlugin → EventPlugin?: Subclasses can override this getter to be notified of changes to protobuf fields.
no setterinherited
expression ↔ String: Textual representation of an expression in Common Expression Language syntax.
getter/setter pair
hashCode → int: Calculates a hash code based on the contents of the protobuf.
no setterinherited
info_ → BuilderInfo: no setteroverride
isFrozen → bool: Returns true if this message is marked read-only. Otherwise false.
no setterinherited
location ↔ String: Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
getter/setter pair
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
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.
getter/setter pair
unknownFields → UnknownFieldSet: no setterinherited

Methods

addExtension(Extension extension, Object? value) → void: Adds an extension field value to a repeated field.
inherited
check() → void: inherited
clear() → void: Clears all data that was set in this message.
inherited
clearDescription() → void
clearExpression() → void
clearExtension(Extension extension) → void: Clears an extension field and also removes the extension.
inherited
clearField(int tagNumber) → void: Clears the contents of a given field.
inherited
clearLocation() → void
clearTitle() → void
clone() → Expr: Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
override
copyWith(void updates(Expr)) → Expr: Apply updates to a copy of this message.
override
createEmptyInstance() → Expr: Creates an empty instance of the same message type as this.
override
createMapField<K, V>(int tagNumber, MapFieldInfo<K, V> fi) → Map<K, V>: Creates a Map representing a map field.
inherited
createRepeatedField<T>(int tagNumber, FieldInfo<T> fi) → List<T>: Creates List implementing a mutable repeated field.
inherited
extensionsAreInitialized() → bool: inherited
freeze() → GeneratedMessage: Make this message read-only.
inherited
getDefaultForField(int tagNumber) → dynamic: Returns the default value for the given field.
inherited
getExtension(Extension extension) → dynamic: Returns the value of extension.
inherited
getField(int tagNumber) → dynamic: Returns the value of the field associated with tagNumber, or the default value if it is not set.
inherited
getFieldOrNull(int tagNumber) → dynamic: Returns the value of a field, ignoring any defaults.
inherited
getTagNumber(String fieldName) → int?: inherited
hasDescription() → bool
hasExpression() → bool
hasExtension(Extension extension) → bool: Returns true if a value of extension is present.
inherited
hasField(int tagNumber) → bool: Whether this message has a field associated with tagNumber.
inherited
hasLocation() → bool
hasRequiredFields() → bool: Whether the message has required fields.
inherited
hasTitle() → bool
isInitialized() → bool: Whether all required fields in the message and embedded messages are set.
inherited
mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void: Merges serialized protocol buffer data into this message.
inherited
mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void: inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void: Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.
inherited
mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void: Merges field values from a JSON object represented as a Dart map.
inherited
mergeFromMessage(GeneratedMessage other) → void: Merges the contents of the other into this message.
inherited
mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void: Merges field values from json, a JSON object using proto3 encoding.
inherited
mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void: inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
setExtension(Extension extension, Object value) → void: Sets the value of a non-repeated extension field to value.
inherited
setField(int tagNumber, Object value) → void: Sets the value of a field by its tagNumber.
inherited
toBuilder() → GeneratedMessage: Creates a writable, shallow copy of this message.
inherited
toDebugString() → String: Returns a String representation of this message.
inherited
toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?: Returns an Object representing Proto3 JSON serialization of this.
inherited
toString() → String: Returns a String representation of this message.
inherited
writeToBuffer() → Uint8List: inherited
writeToCodedBufferWriter(CodedBufferWriter output) → void: inherited
writeToJson() → String: Returns a JSON string that encodes this message.
inherited
writeToJsonMap() → Map<String, dynamic>: Returns the JSON encoding of this message as a Dart Map.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

create() → Expr
createRepeated() → PbList<Expr>
getDefault() → Expr