1. class
  2. Google
  3. \
  4. Service
  5. \
  6. FirebaseRules
  7. \
  8. Resource
  9. \
  10. Projects

Projects

class Projects extends Resource (View source)

The "projects" collection of methods.

Typical usage is:

 $firebaserulesService = new Google\Service\FirebaseRules(...);
 $projects = $firebaserulesService->projects;

Methods

TestRulesetResponse
test(string $name, TestRulesetRequest $postBody, array $optParams = [])

Test Source for syntactic and semantic correctness. Issues present, if any, will be returned to the caller with a description, severity, and source location. The test method may be executed with Source or a Ruleset name.

Details

at line 57
TestRulesetResponse test(string $name, TestRulesetRequest $postBody, array $optParams = [])

Test Source for syntactic and semantic correctness. Issues present, if any, will be returned to the caller with a description, severity, and source location. The test method may be executed with Source or a Ruleset name.

Passing Source is useful for unit testing new rules. Passing a Ruleset name is useful for regression testing an existing rule. The following is an example of Source that permits users to upload images to a bucket bearing their user id and matching the correct metadata: Example // Users are allowed to subscribe and unsubscribe to the blog. service firebase.storage { match /users/{userId}/images/{imageName} { allow write: if userId == request.auth.uid && (imageName.matches('.png$') || imageName.matches('.jpg$')) && resource.mimeType.matches('^image/') } } (projects.test)

Parameters

string $name

Required. Tests may either provide source or a Ruleset resource name. For tests against source, the resource name must refer to the project: Format: projects/{project_id} For tests against a Ruleset, this must be the Ruleset resource name: Format: projects/{project_id}/rulesets/{ruleset_id}
TestRulesetRequest $postBody
array $optParams

Optional parameters.

Return Value

TestRulesetResponse

Exceptions

Exception