Package dev.cel.expr

Class Expr.Comprehension.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Expr.ComprehensionOrBuilder, java.lang.Cloneable
    Enclosing class:
    Expr.Comprehension
    public static final class Expr.Comprehension.Builder
extends com.google.protobuf.GeneratedMessage.Builder<Expr.Comprehension.Builder>
implements Expr.ComprehensionOrBuilder
     A comprehension expression applied to a list or map.

 Comprehensions are not part of the core syntax, but enabled with macros.
 A macro matches a specific call signature within a parsed AST and replaces
 the call with an alternate AST block. Macro expansion happens at parse
 time.

 The following macros are supported within CEL:

 Aggregate type macros may be applied to all elements in a list or all keys
 in a map:

 *  `all`, `exists`, `exists_one` -  test a predicate expression against
 the inputs and return `true` if the predicate is satisfied for all,
 any, or only one value `list.all(x, x < 10)`.
 *  `filter` - test a predicate expression against the inputs and return
 the subset of elements which satisfy the predicate:
 `payments.filter(p, p > 1000)`.
 *  `map` - apply an expression to all elements in the input and return the
 output aggregate type: `[1, 2, 3].map(i, i * i)`.

 The `has(m.x)` macro tests whether the property `x` is present in struct
 `m`. The semantics of this macro depend on the type of `m`. For proto2
 messages `has(m.x)` is defined as 'defined, but not set`. For proto3, the
 macro tests whether the property is set to its default. For map and struct
 types, the macro tests whether the property `x` is defined on `m`.

 Comprehensions for the standard environment macros evaluation can be best
 visualized as the following pseudocode:

 ```
 let `accu_var` = `accu_init`
 for (let `iter_var` in `iter_range`) {
 if (!`loop_condition`) {
 break
 }
 `accu_var` = `loop_step`
 }
 return `result`
 ```

 Comprehensions for the optional V2 macros which support map-to-map
 translation differ slightly from the standard environment macros in that
 they expose both the key or index in addition to the value for each list
 or map entry:

 ```
 let `accu_var` = `accu_init`
 for (let `iter_var`, `iter_var2` in `iter_range`) {
 if (!`loop_condition`) {
 break
 }
 `accu_var` = `loop_step`
 }
 return `result`
 ```
    Protobuf type cel.expr.Expr.Comprehension

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Expr.Comprehension.Builder>

      • clear

        public Expr.Comprehension.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessage.Builder<Expr.Comprehension.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Expr.Comprehension.Builder>

      • getDefaultInstanceForType

        public Expr.Comprehension getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public Expr.Comprehension build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public Expr.Comprehension buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • mergeFrom

        public Expr.Comprehension.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Expr.Comprehension.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Expr.Comprehension.Builder>

      • mergeFrom

        public Expr.Comprehension.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Expr.Comprehension.Builder>
        Throws:
        java.io.IOException

      • getIterVar

        public java.lang.String getIterVar()
         The name of the first iteration variable.
 For the single iteration variable macros, when iter_range is a list, this
 variable is the list element and when the iter_range is a map, this
 variable is the map key.
        string iter_var = 1;
        Specified by:
        getIterVar in interface Expr.ComprehensionOrBuilder
        Returns:
        The iterVar.

      • getIterVarBytes

        public com.google.protobuf.ByteString getIterVarBytes()
         The name of the first iteration variable.
 For the single iteration variable macros, when iter_range is a list, this
 variable is the list element and when the iter_range is a map, this
 variable is the map key.
        string iter_var = 1;
        Specified by:
        getIterVarBytes in interface Expr.ComprehensionOrBuilder
        Returns:
        The bytes for iterVar.

      • setIterVar

        public Expr.Comprehension.Builder setIterVar​(java.lang.String value)
         The name of the first iteration variable.
 For the single iteration variable macros, when iter_range is a list, this
 variable is the list element and when the iter_range is a map, this
 variable is the map key.
        string iter_var = 1;
        Parameters:
        value - The iterVar to set.
        Returns:
        This builder for chaining.

      • clearIterVar

        public Expr.Comprehension.Builder clearIterVar()
         The name of the first iteration variable.
 For the single iteration variable macros, when iter_range is a list, this
 variable is the list element and when the iter_range is a map, this
 variable is the map key.
        string iter_var = 1;
        Returns:
        This builder for chaining.

      • setIterVarBytes

        public Expr.Comprehension.Builder setIterVarBytes​(com.google.protobuf.ByteString value)
         The name of the first iteration variable.
 For the single iteration variable macros, when iter_range is a list, this
 variable is the list element and when the iter_range is a map, this
 variable is the map key.
        string iter_var = 1;
        Parameters:
        value - The bytes for iterVar to set.
        Returns:
        This builder for chaining.

      • getIterVar2

        public java.lang.String getIterVar2()
         The name of the second iteration variable, empty if not set.
 This field is only set for comprehension v2 macros.
        string iter_var2 = 8;
        Specified by:
        getIterVar2 in interface Expr.ComprehensionOrBuilder
        Returns:
        The iterVar2.

      • getIterVar2Bytes

        public com.google.protobuf.ByteString getIterVar2Bytes()
         The name of the second iteration variable, empty if not set.
 This field is only set for comprehension v2 macros.
        string iter_var2 = 8;
        Specified by:
        getIterVar2Bytes in interface Expr.ComprehensionOrBuilder
        Returns:
        The bytes for iterVar2.

      • setIterVar2

        public Expr.Comprehension.Builder setIterVar2​(java.lang.String value)
         The name of the second iteration variable, empty if not set.
 This field is only set for comprehension v2 macros.
        string iter_var2 = 8;
        Parameters:
        value - The iterVar2 to set.
        Returns:
        This builder for chaining.

      • clearIterVar2

        public Expr.Comprehension.Builder clearIterVar2()
         The name of the second iteration variable, empty if not set.
 This field is only set for comprehension v2 macros.
        string iter_var2 = 8;
        Returns:
        This builder for chaining.

      • setIterVar2Bytes

        public Expr.Comprehension.Builder setIterVar2Bytes​(com.google.protobuf.ByteString value)
         The name of the second iteration variable, empty if not set.
 This field is only set for comprehension v2 macros.
        string iter_var2 = 8;
        Parameters:
        value - The bytes for iterVar2 to set.
        Returns:
        This builder for chaining.

      • hasIterRange

        public boolean hasIterRange()
         The range over which the comprehension iterates.
        .cel.expr.Expr iter_range = 2;
        Specified by:
        hasIterRange in interface Expr.ComprehensionOrBuilder
        Returns:
        Whether the iterRange field is set.

      • getIterRange

        public Expr getIterRange()
         The range over which the comprehension iterates.
        .cel.expr.Expr iter_range = 2;
        Specified by:
        getIterRange in interface Expr.ComprehensionOrBuilder
        Returns:
        The iterRange.

      • setIterRange

        public Expr.Comprehension.Builder setIterRange​(Expr value)
         The range over which the comprehension iterates.
        .cel.expr.Expr iter_range = 2;

      • mergeIterRange

        public Expr.Comprehension.Builder mergeIterRange​(Expr value)
         The range over which the comprehension iterates.
        .cel.expr.Expr iter_range = 2;

      • clearIterRange

        public Expr.Comprehension.Builder clearIterRange()
         The range over which the comprehension iterates.
        .cel.expr.Expr iter_range = 2;

      • getIterRangeBuilder

        public Expr.Builder getIterRangeBuilder()
         The range over which the comprehension iterates.
        .cel.expr.Expr iter_range = 2;

      • getAccuVar

        public java.lang.String getAccuVar()
         The name of the variable used for accumulation of the result.
        string accu_var = 3;
        Specified by:
        getAccuVar in interface Expr.ComprehensionOrBuilder
        Returns:
        The accuVar.

      • getAccuVarBytes

        public com.google.protobuf.ByteString getAccuVarBytes()
         The name of the variable used for accumulation of the result.
        string accu_var = 3;
        Specified by:
        getAccuVarBytes in interface Expr.ComprehensionOrBuilder
        Returns:
        The bytes for accuVar.

      • setAccuVar

        public Expr.Comprehension.Builder setAccuVar​(java.lang.String value)
         The name of the variable used for accumulation of the result.
        string accu_var = 3;
        Parameters:
        value - The accuVar to set.
        Returns:
        This builder for chaining.

      • clearAccuVar

        public Expr.Comprehension.Builder clearAccuVar()
         The name of the variable used for accumulation of the result.
        string accu_var = 3;
        Returns:
        This builder for chaining.

      • setAccuVarBytes

        public Expr.Comprehension.Builder setAccuVarBytes​(com.google.protobuf.ByteString value)
         The name of the variable used for accumulation of the result.
        string accu_var = 3;
        Parameters:
        value - The bytes for accuVar to set.
        Returns:
        This builder for chaining.

      • hasAccuInit

        public boolean hasAccuInit()
         The initial value of the accumulator.
        .cel.expr.Expr accu_init = 4;
        Specified by:
        hasAccuInit in interface Expr.ComprehensionOrBuilder
        Returns:
        Whether the accuInit field is set.

      • clearAccuInit

        public Expr.Comprehension.Builder clearAccuInit()
         The initial value of the accumulator.
        .cel.expr.Expr accu_init = 4;

      • getAccuInitBuilder

        public Expr.Builder getAccuInitBuilder()
         The initial value of the accumulator.
        .cel.expr.Expr accu_init = 4;

      • hasLoopCondition

        public boolean hasLoopCondition()
         An expression which can contain iter_var, iter_var2, and accu_var.

 Returns false when the result has been computed and may be used as
 a hint to short-circuit the remainder of the comprehension.
        .cel.expr.Expr loop_condition = 5;
        Specified by:
        hasLoopCondition in interface Expr.ComprehensionOrBuilder
        Returns:
        Whether the loopCondition field is set.

      • getLoopCondition

        public Expr getLoopCondition()
         An expression which can contain iter_var, iter_var2, and accu_var.

 Returns false when the result has been computed and may be used as
 a hint to short-circuit the remainder of the comprehension.
        .cel.expr.Expr loop_condition = 5;
        Specified by:
        getLoopCondition in interface Expr.ComprehensionOrBuilder
        Returns:
        The loopCondition.

      • setLoopCondition

        public Expr.Comprehension.Builder setLoopCondition​(Expr value)
         An expression which can contain iter_var, iter_var2, and accu_var.

 Returns false when the result has been computed and may be used as
 a hint to short-circuit the remainder of the comprehension.
        .cel.expr.Expr loop_condition = 5;

      • setLoopCondition

        public Expr.Comprehension.Builder setLoopCondition​(Expr.Builder builderForValue)
         An expression which can contain iter_var, iter_var2, and accu_var.

 Returns false when the result has been computed and may be used as
 a hint to short-circuit the remainder of the comprehension.
        .cel.expr.Expr loop_condition = 5;

      • mergeLoopCondition

        public Expr.Comprehension.Builder mergeLoopCondition​(Expr value)
         An expression which can contain iter_var, iter_var2, and accu_var.

 Returns false when the result has been computed and may be used as
 a hint to short-circuit the remainder of the comprehension.
        .cel.expr.Expr loop_condition = 5;

      • clearLoopCondition

        public Expr.Comprehension.Builder clearLoopCondition()
         An expression which can contain iter_var, iter_var2, and accu_var.

 Returns false when the result has been computed and may be used as
 a hint to short-circuit the remainder of the comprehension.
        .cel.expr.Expr loop_condition = 5;

      • getLoopConditionBuilder

        public Expr.Builder getLoopConditionBuilder()
         An expression which can contain iter_var, iter_var2, and accu_var.

 Returns false when the result has been computed and may be used as
 a hint to short-circuit the remainder of the comprehension.
        .cel.expr.Expr loop_condition = 5;

      • getLoopConditionOrBuilder

        public ExprOrBuilder getLoopConditionOrBuilder()
         An expression which can contain iter_var, iter_var2, and accu_var.

 Returns false when the result has been computed and may be used as
 a hint to short-circuit the remainder of the comprehension.
        .cel.expr.Expr loop_condition = 5;
        Specified by:
        getLoopConditionOrBuilder in interface Expr.ComprehensionOrBuilder

      • hasLoopStep

        public boolean hasLoopStep()
         An expression which can contain iter_var, iter_var2, and accu_var.

 Computes the next value of accu_var.
        .cel.expr.Expr loop_step = 6;
        Specified by:
        hasLoopStep in interface Expr.ComprehensionOrBuilder
        Returns:
        Whether the loopStep field is set.

      • getLoopStep

        public Expr getLoopStep()
         An expression which can contain iter_var, iter_var2, and accu_var.

 Computes the next value of accu_var.
        .cel.expr.Expr loop_step = 6;
        Specified by:
        getLoopStep in interface Expr.ComprehensionOrBuilder
        Returns:
        The loopStep.

      • setLoopStep

        public Expr.Comprehension.Builder setLoopStep​(Expr value)
         An expression which can contain iter_var, iter_var2, and accu_var.

 Computes the next value of accu_var.
        .cel.expr.Expr loop_step = 6;

      • setLoopStep

        public Expr.Comprehension.Builder setLoopStep​(Expr.Builder builderForValue)
         An expression which can contain iter_var, iter_var2, and accu_var.

 Computes the next value of accu_var.
        .cel.expr.Expr loop_step = 6;

      • mergeLoopStep

        public Expr.Comprehension.Builder mergeLoopStep​(Expr value)
         An expression which can contain iter_var, iter_var2, and accu_var.

 Computes the next value of accu_var.
        .cel.expr.Expr loop_step = 6;

      • clearLoopStep

        public Expr.Comprehension.Builder clearLoopStep()
         An expression which can contain iter_var, iter_var2, and accu_var.

 Computes the next value of accu_var.
        .cel.expr.Expr loop_step = 6;

      • getLoopStepBuilder

        public Expr.Builder getLoopStepBuilder()
         An expression which can contain iter_var, iter_var2, and accu_var.

 Computes the next value of accu_var.
        .cel.expr.Expr loop_step = 6;

      • hasResult

        public boolean hasResult()
         An expression which can contain accu_var.

 Computes the result.
        .cel.expr.Expr result = 7;
        Specified by:
        hasResult in interface Expr.ComprehensionOrBuilder
        Returns:
        Whether the result field is set.

      • getResult

        public Expr getResult()
         An expression which can contain accu_var.

 Computes the result.
        .cel.expr.Expr result = 7;
        Specified by:
        getResult in interface Expr.ComprehensionOrBuilder
        Returns:
        The result.

      • setResult

        public Expr.Comprehension.Builder setResult​(Expr value)
         An expression which can contain accu_var.

 Computes the result.
        .cel.expr.Expr result = 7;

      • mergeResult

        public Expr.Comprehension.Builder mergeResult​(Expr value)
         An expression which can contain accu_var.

 Computes the result.
        .cel.expr.Expr result = 7;

      • clearResult

        public Expr.Comprehension.Builder clearResult()
         An expression which can contain accu_var.

 Computes the result.
        .cel.expr.Expr result = 7;

      • getResultBuilder

        public Expr.Builder getResultBuilder()
         An expression which can contain accu_var.

 Computes the result.
        .cel.expr.Expr result = 7;