Method: projects.releases.getExecutable
Stay organized with collections
Save and categorize content based on your preferences.
Get the Release executable to use when enforcing rules.
HTTP request
GET https://firebaserules.googleapis.com/v1/{name=projects/*/releases/**}:getExecutable
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. Resource name of the Release. Format: projects/{project_id}/releases/{release_id}
|
Query parameters
| Parameters |
executableVersion |
enum (ReleaseExecutableVersion)
The requested runtime executable version. Defaults to FIREBASE_RULES_EXECUTABLE_V1.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
| JSON representation |
{
"executable": string,
"language": enum (Language),
"rulesetName": string,
"updateTime": string,
"executableVersion": enum (ReleaseExecutableVersion),
"syncTime": string
} |
| Fields |
executable |
string (bytes format)
Executable view of the Ruleset referenced by the Release. A base64-encoded string.
|
language |
enum (Language)
Language used to generate the executable bytes.
|
rulesetName |
string
Ruleset name associated with the Release executable.
|
updateTime |
string (Timestamp format)
Timestamp for the most recent Release.update_time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
|
executableVersion |
enum (ReleaseExecutableVersion)
The Rules runtime version of the executable.
|
syncTime |
string (Timestamp format)
Optional, indicates the freshness of the result. The response is guaranteed to be the latest within an interval up to the syncTime (inclusive). A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
|
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/firebasehttps://www.googleapis.com/auth/firebase.readonly
For more information, see the Authentication Overview.
ReleaseExecutableVersion
The executable versions supported for each language and syntax revision.
| Enums |
RELEASE_EXECUTABLE_VERSION_UNSPECIFIED |
Executable format unspecified. Defaults to FIREBASE_RULES_EXECUTABLE_V1 |
FIREBASE_RULES_EXECUTABLE_V1 |
Firebase Rules syntax 'rules2' executable versions: Custom AST for use with Java clients. |
FIREBASE_RULES_EXECUTABLE_V2 |
CEL-based executable for use with C++ clients. |
Language
Language set supported within Source.
| Enums |
LANGUAGE_UNSPECIFIED |
Language unspecified. Defaults to FIREBASE_RULES. |
FIREBASE_RULES |
Firebase Rules language. |
EVENT_FLOW_TRIGGERS |
Event Flow triggers. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2021-06-30 UTC.
[null,null,["Last updated 2021-06-30 UTC."],[],[],null,["# Method: projects.releases.getExecutable\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.GetReleaseExecutableResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n- [ReleaseExecutableVersion](#ReleaseExecutableVersion)\n- [Language](#Language)\n- [Try it!](#try-it)\n\nGet the `Release` executable to use when enforcing rules.\n\n### HTTP request\n\n`GET https://firebaserules.googleapis.com/v1/{name=projects/*/releases/**}:getExecutable`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|----------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. Resource name of the `Release`. Format: `projects/{project_id}/releases/{release_id}` |\n\n### Query parameters\n\n| Parameters ||\n|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `executableVersion` | `enum (`[ReleaseExecutableVersion](/docs/reference/rules/rest/v1/projects.releases/getExecutable#ReleaseExecutableVersion)`)` The requested runtime executable version. Defaults to FIREBASE_RULES_EXECUTABLE_V1. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\nThe response for [FirebaseRulesService.GetReleaseExecutable](/docs/reference/rules/rest/v1/projects.releases/getExecutable#google.firebase.rules.v1.FirebaseRulesService.GetReleaseExecutable)\n\n| JSON representation ||\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"executable\": string, \"language\": enum (/docs/reference/rules/rest/v1/projects.releases/getExecutable#Language), \"rulesetName\": string, \"updateTime\": string, \"executableVersion\": enum (/docs/reference/rules/rest/v1/projects.releases/getExecutable#ReleaseExecutableVersion), \"syncTime\": string } ``` |\n\n| Fields ||\n|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `executable` | `string (`[bytes](https://developers.google.com/discovery/v1/type-format)` format)` Executable view of the `Ruleset` referenced by the `Release`. A base64-encoded string. |\n| `language` | `enum (`[Language](/docs/reference/rules/rest/v1/projects.releases/getExecutable#Language)`)` `Language` used to generate the executable bytes. |\n| `rulesetName` | `string` `Ruleset` name associated with the `Release` executable. |\n| `updateTime` | `string (`[Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp)` format)` Timestamp for the most recent `Release.update_time`. A timestamp in RFC3339 UTC \"Zulu\" format, with nanosecond resolution and up to nine fractional digits. Examples: `\"2014-10-02T15:01:23Z\"` and `\"2014-10-02T15:01:23.045123456Z\"`. |\n| `executableVersion` | `enum (`[ReleaseExecutableVersion](/docs/reference/rules/rest/v1/projects.releases/getExecutable#ReleaseExecutableVersion)`)` The Rules runtime version of the executable. |\n| `syncTime` | `string (`[Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp)` format)` Optional, indicates the freshness of the result. The response is guaranteed to be the latest within an interval up to the syncTime (inclusive). A timestamp in RFC3339 UTC \"Zulu\" format, with nanosecond resolution and up to nine fractional digits. Examples: `\"2014-10-02T15:01:23Z\"` and `\"2014-10-02T15:01:23.045123456Z\"`. |\n\n### Authorization Scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n- `https://www.googleapis.com/auth/firebase`\n- `https://www.googleapis.com/auth/firebase.readonly`\n\nFor more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/).\n\nReleaseExecutableVersion\n------------------------\n\nThe executable versions supported for each language and syntax revision.\n\n| Enums ||\n|------------------------------------------|-------------------------------------------------------------------------------------------|\n| `RELEASE_EXECUTABLE_VERSION_UNSPECIFIED` | Executable format unspecified. Defaults to FIREBASE_RULES_EXECUTABLE_V1 |\n| `FIREBASE_RULES_EXECUTABLE_V1` | Firebase Rules syntax 'rules2' executable versions: Custom AST for use with Java clients. |\n| `FIREBASE_RULES_EXECUTABLE_V2` | CEL-based executable for use with C++ clients. |\n\nLanguage\n--------\n\n`Language` set supported within `Source`.\n\n| Enums ||\n|------------------------|---------------------------------------------------|\n| `LANGUAGE_UNSPECIFIED` | Language unspecified. Defaults to FIREBASE_RULES. |\n| `FIREBASE_RULES` | Firebase Rules language. |\n| `EVENT_FLOW_TRIGGERS` | Event Flow triggers. |"]]
