package cel.expr.conformance

Get desktop application:
View/edit binary Protocol Buffers messages

Access a CEL implementation from another process or machine. A CEL implementation is decomposed as a parser, a static checker, and an evaluator. Every CEL implementation is expected to provide a server for this API. The API will be used for conformance testing and other utilities.

• rpc Parse (ParseRequest, ParseResponse)

  conformance_service.proto:37

  Transforms CEL source text into a parsed representation.

  message ParseRequest

  conformance_service.proto:52

  Request message for the Parse method.

  • string cel_source = 1

    Required. Source text in CEL syntax.

  • string syntax_version = 2

    Tag for version of CEL syntax, for future use.

  • string source_location = 3

    File or resource for source text, used in [SourceInfo][google.api.SourceInfo].

  • bool disable_macros = 4

    Prevent macro expansion. See "Macros" in Language Defiinition.

  message ParseResponse

  conformance_service.proto:67

  Response message for the Parse method.

  • optional ParsedExpr parsed_expr = 1

    The parsed representation, or unset if parsing failed.

  • repeated google.rpc.Status issues = 2

    Any number of issues with [StatusDetails][] as the details.

• rpc Check (CheckRequest, CheckResponse)

  conformance_service.proto:42

  Runs static checks on a parsed CEL representation and return an annotated representation, or a set of issues.

  message CheckRequest

  conformance_service.proto:76

  Request message for the Check method.

  • optional ParsedExpr parsed_expr = 1

    Required. The parsed representation of the CEL program.

  • repeated Decl type_env = 2

    Declarations of types for external variables and functions. Required if program uses external variables or functions not in the default environment.

  • string container = 3

    The protocol buffer context. See "Name Resolution" in the Language Definition.

  • bool no_std_env = 4

    If true, use only the declarations in [type_env][google.api.expr.conformance.v1alpha1.CheckRequest.type_env]. If false (default), add declarations for the standard definitions to the type environment. See "Standard Definitions" in the Language Definition.

  message CheckResponse

  conformance_service.proto:96

  Response message for the Check method.

  • optional CheckedExpr checked_expr = 1

    The annotated representation, or unset if checking failed.

  • repeated google.rpc.Status issues = 2

    Any number of issues with [StatusDetails][] as the details.

• rpc Eval (EvalRequest, EvalResponse)

  conformance_service.proto:47

  Evaluates a parsed or annotation CEL representation given values of external bindings.

  message EvalRequest

  conformance_service.proto:105

  Request message for the Eval method.

  • oneof expr_kind

    Required. Either the parsed or annotated representation of the CEL program.

    • ParsedExpr parsed_expr = 1

      Evaluate based on the parsed representation.

    • CheckedExpr checked_expr = 2

      Evaluate based on the checked representation.

  • map<string, ExprValue> bindings = 3

    Bindings for the external variables. The types SHOULD be compatible with the type environment in [CheckRequest][google.api.expr.conformance.v1alpha1.CheckRequest], if checked.

  • string container = 4

    SHOULD be the same container as used in [CheckRequest][google.api.expr.conformance.v1alpha1.CheckRequest], if checked.

  message EvalResponse

  conformance_service.proto:124

  Response message for the Eval method.

  • optional ExprValue result = 1

    The execution result, or unset if execution couldn't start.

  • repeated google.rpc.Status issues = 2

    Any number of issues with [StatusDetails][] as the details. Note that CEL execution errors are reified into [ExprValue][]. Nevertheless, we'll allow out-of-band issues to be raised, which also makes the replies more regular.

Representation of a CEL Environment, defining what features and extensions are available for conformance testing.

Used in: test.TestCase

• string name = 1

  Name of the environment

• string description = 2

  Description for the current environment

• string container = 3

  Sets the namespace (container) for the expression. This is used to simplify resolution. For example with container `google.rpc.context` an identifier of `google.rpc.context.AttributeContext` could be referred to simply as `AttributeContext` in the CEL expression.

• repeated Environment.Import imports = 4

  List of abbreviations to be added to the CEL environment

• optional LibrarySubset stdlib = 5

  Set of options to subset a subsettable library

• repeated Extension extensions = 6

  List of extensions to enable in the CEL environment.

• optional Environment.ContextVariable context_variable = 7

  If set, adds a context declaration from a proto message. Context messages have all of their top-level fields available as variables in the type checker.

• repeated Decl declarations = 8

  List of declarations to be configured in the CEL environment. Note: The CEL environment can be configured with either the context_variable or a set of ident_decls provided as part of declarations. Providing both will result in an error.

• repeated Validator validators = 9

  List of validators for validating the parsed ast.

• repeated Feature features = 10

  List of feature flags to be enabled or disabled.

• bool disable_standard_cel_declarations = 11

  Disables including the declarations from the standard CEL environment. NOTE: Do not disable the standard CEL declarations unless you are aware of the implications and have discussed your use case on cel-discuss@ or with the members of the cel-governance-team@ Deprecated: Use LibrarySubset to disable standard cel declarations instead: stdlib = LibrarySubset{ disable: true }

• optional google.protobuf.FileDescriptorSet message_type_extension = 12

  If provided, uses the provided FileDescriptorSet to extend types available the CEL expression. All "well-known" protobuf messages (google.protobuf.*) are known to the CEL compiler, but all others must be provided for type checking.

• bool enable_macro_call_tracking = 13

  When macro call tracking is enabled, the resulting SourceInfo in the CheckedExpr will contain a collection of expressions representing the function calls which were replaced by macros. Deprecated: Use Feature to enable macro call tracking Feature{ name: "cel.feature.macro_call_tracking", enabled: true }

ContextVariable represents a message type to be made available as a context variable to the CEL environment.

Used in: Environment

• string type_name = 1

  Fully qualified type name of the context proto.

Import represents a type name that will be abbreviated by its simple name making it easier to reference simple type names from packages other than the expression container. For ex: Import{name: 'google.rpc.Status'} The above import will ensure that `google.rpc.Status` is available by the simple name `Status` within CEL expressions.

Used in: Environment

• string name = 1

  Qualified type name which will be abbreviated

Extension represents a versioned extension library reference to enable in the CEL environment.

Used in: Environment

• string name = 1

  Name of the extension library.

• string version = 2

  Version of the extension library.

Represents a named boolean feature flag supported by CEL. Naming convention followed by features: <domain>.feature.<feature_name> For ex: `cel.feature.cross_type_numeric_comparisons`

Used in: Environment

• string name = 1

  Name of the feature flag.

• bool enabled = 2

  State of the feature flab.

Warnings or errors in service execution are represented by [google.rpc.Status][google.rpc.Status] messages, with the following message in the details field.

• IssueDetails.Severity severity = 1

  The severity of the issue.

• optional SourcePosition position = 2

  Position in the source, if known.

• int64 id = 3

  Expression ID from [Expr][], 0 if unknown.

Severities of issues.

Used in: IssueDetails

• SEVERITY_UNSPECIFIED = 0

  An unspecified severity.

• DEPRECATION = 1

  Deprecation issue for statements and method that may no longer be supported or maintained.

• WARNING = 2

  Warnings such as: unused variables.

• ERROR = 3

  Errors such as: unmatched curly braces or variable redefinition.

LibrarySubset indicates a subset of the macros and functions supported by a subsettable library.

Used in: Environment

• bool disabled = 1

  Indicates whether the library has been disabled, typically only used for default-enabled libraries like stdlib.

• bool disable_macros = 2

  Disables macros for the given library.

• repeated string include_macros = 3

  Specifies a set of macro function names to include in the subset.

• repeated string exclude_macros = 4

  Specifies a set of macro function names to exclude from the subset. Note: if IncludeMacros is non-empty, then ExcludeFunctions is ignored.

• repeated Decl include_functions = 5

  Specifies a set of functions to include in the subset. Note: the overloads specified in the subset need only specify their ID. Note: if IncludeFunctions is non-empty, then ExcludeFunctions is ignored.

• repeated Decl exclude_functions = 6

  Specifies the set of functions to exclude from the subset. Note: the overloads specified in the subset need only specify their ID.

A specific position in source.

Used in: IssueDetails

• string location = 1

  The source location name (e.g. file name).

• int32 offset = 2

  The UTF-8 code unit offset.

• int32 line = 3

  The 1-based index of the starting line in the source text where the issue occurs, or 0 if unknown.

• int32 column = 4

  The 0-based index of the starting position within the line of source text where the issue occurs. Only meaningful if line is nonzero.

Represents a named validator with an optional map-based configuration object. Naming convention followed by validators: <domain>.validator.<validator_name> For ex: `cel.validator.timestamp` Note: the map-keys must directly correspond to the internal representation of the original validator, and should only use primitive scalar types as values at this time.

Used in: Environment

• string name = 1

• map<string, google.protobuf.Value> config = 2

  Additional configurations to be included as part of the validation