Method: projects.releases.getExecutable

Get theRelease executable to use when enforcing rules.

HTTP request

GET https://firebaserules.googleapis.com/v1/{name=projects/*/releases/**}:getExecutable

The URL usesgRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Resource name of theRelease.

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:

The response forFirebaseRulesService.GetReleaseExecutable

JSON representation
{"executable":string,"language":enum (Language),"rulesetName":string,"updateTime":string,"executableVersion":enum (ReleaseExecutableVersion),"syncTime":string}
Fields
executable

string (bytes format)

Executable view of theRuleset referenced by theRelease.

A base64-encoded string.

language

enum (Language)

Language used to generate the executable bytes.

rulesetName

string

Ruleset name associated with theRelease executable.

updateTime

string (Timestamp format)

Timestamp for the most recentRelease.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-platform
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/firebase.readonly

For more information, see theAuthentication Overview.

ReleaseExecutableVersion

The executable versions supported for each language and syntax revision.

Enums
RELEASE_EXECUTABLE_VERSION_UNSPECIFIEDExecutable format unspecified. Defaults to FIREBASE_RULES_EXECUTABLE_V1
FIREBASE_RULES_EXECUTABLE_V1Firebase Rules syntax 'rules2' executable versions: Custom AST for use with Java clients.
FIREBASE_RULES_EXECUTABLE_V2CEL-based executable for use with C++ clients.

Language

Language set supported withinSource.

Enums
LANGUAGE_UNSPECIFIEDLanguage unspecified. Defaults to FIREBASE_RULES.
FIREBASE_RULESFirebase Rules language.
EVENT_FLOW_TRIGGERSEvent Flow triggers.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2021-06-30 UTC.