google_api_firebase_rules v0.2.0 API Reference

Modules

API calls for all endpoints tagged Projects

Handle Tesla connections for GoogleApi.FirebaseRules.V1

Helper functions for deserializing responses into models

Arg matchers for the mock function

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`

Represents a service-defined function call that was invoked during test execution

Mock function definition. Mocks must refer to a function declared by the target service. The type of the function args and result will be inferred at test time. If either the arg or result values are not compatible with function type declaration, the request will be considered invalid. More than one `FunctionMock` may be provided for a given function name so long as the `Arg` matchers are distinct. There may be only one function for a given overload where all `Arg` values are `Arg.any_value`

The response for FirebaseRulesService.GetReleaseExecutable

Issues include warnings, errors, and deprecation notices

The response for FirebaseRulesService.ListReleases

The response for FirebaseRulesService.ListRulesets

`Release` is a named reference to a `Ruleset`. Once a `Release` refers to a `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`

Possible result values from the function mock invocation

`Ruleset` is an immutable copy of `Source` with a globally unique identifier and a creation time

`Source` is one or more `File` messages comprising a logical set of rules

Position in the `Source` content including its line, column number, and an index of the `File` in the `Source` message. Used for debug purposes

`TestCase` messages provide the request context and an expectation as to whether the given context will be allowed or denied. Test cases may specify the `request`, `resource`, and `function_mocks` to mock a function call to a service-provided function. The `request` object represents context present at request-time. The `resource` is the value of the target resource as it appears in persistent storage before the request is executed

Test result message containing the state of the test as well as a description and source position for test failures

The request for FirebaseRulesService.TestRuleset

The response for FirebaseRulesService.TestRuleset

`TestSuite` is a collection of `TestCase` instances that validate the logical correctness of a `Ruleset`. The `TestSuite` may be referenced in-line within a `TestRuleset` invocation or as part of a `Release` object as a pre-release check

The request for FirebaseRulesService.UpdateReleasePatch

Store the position and access outcome for an expression visited in rules

Helper functions for building Tesla requests