Index
Decimal
A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal .
value
string
The decimal value, as a string.
The string representation consists of an optional sign, +
( U+002B
) or -
( U+002D
), followed by a sequence of zero or more decimal digits ("the integer"), optionally followed by a fraction, optionally followed by an exponent. An empty string shouldbe interpreted as 0
.
The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. The number formed by the sign, the integer and the fraction is referred to as the significand.
The exponent consists of the character e
( U+0065
) or E
( U+0045
) followed by one or more decimal digits.
Services shouldnormalize decimal values before storing them by:
- Removing an explicitly-provided
+sign (+2.5->2.5). - Replacing a zero-length integer value with
0(.5->0.5). - Coercing the exponent character to upper-case, with explicit sign (
2.5e8->2.5E+8). - Removing an explicitly-provided zero exponent (
2.5E0->2.5).
Services mayperform additional normalization based on its own needs and the internal decimal implementation selected, such as shifting the decimal point and exponent value together (example: 2.5E-1
<-> 0.25
). Additionally, services maypreserve trailing zeroes in the fraction to indicate increased precision, but are not required to do so.
Note that only the .
character is supported to divide the integer and the fraction; ,
should notbe supported regardless of locale. Additionally, thousand separators should notbe supported. If a service does support them, values mustbe normalized.
The ENBF grammar is:
DecimalString =
'' | [Sign] Significand [Exponent];
Sign = '+' | '-';
Significand =
Digits ['.'] [Digits] | [Digits] '.' Digits;
Exponent = ('e' | 'E') [Sign] Digits;
Digits = { '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' };
Services shouldclearly document the range of supported values, the maximum supported precision (total number of digits), and, if applicable, the scale (number of digits after the decimal point), as well as how it behaves when receiving out-of-bounds values.
Services maychoose to accept values passed as input even when the value has a higher precision or scale than the service supports, and shouldround the value to fit the supported scale. Alternatively, the service mayerror with 400 Bad Request
( INVALID_ARGUMENT
in gRPC) if precision would be lost.
Services shoulderror with 400 Bad Request
( INVALID_ARGUMENT
in gRPC) if the service receives a value outside of the supported range.
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.
| Fields | |
|---|---|
expression
|
Textual representation of an expression in Common Expression Language syntax. |
title
|
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
|
Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. |
location
|
Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. |
Money
Represents an amount of money with its currency type.
| Fields | |
|---|---|
currency_code
|
The three-letter currency code defined in ISO 4217. |
units
|
The whole units of the amount. For example if |
nanos
|
Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If |
