target.apidocs.com.google.api.services.firebaserules.v1.FirebaseRules.Projects.html Maven / Gradle / Ivy
FirebaseRules.Projects (Firebase Rules API v1-rev20241125-2.0.0)
com.google.api.services.firebaserules.v1
Class FirebaseRules.Projects
- java.lang.Object
-
- com.google.api.services.firebaserules.v1.FirebaseRules.Projects
-
- Enclosing class:
- FirebaseRules
public class FirebaseRules.Projects
extends Object
The "projects" collection of methods.
-
-
Nested Class Summary
Nested Classes
Modifier and Type
Class and Description
class FirebaseRules.Projects.Releases
The "releases" collection of methods.
class FirebaseRules.Projects.Rulesets
The "rulesets" collection of methods.
class FirebaseRules.Projects.Test
-
Constructor Summary
Constructors
Constructor and Description
Projects()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
FirebaseRules.Projects.Releasesreleases()
An accessor for creating requests from the Releases collection.
FirebaseRules.Projects.Rulesetsrulesets()
An accessor for creating requests from the Rulesets collection.
FirebaseRules.Projects.Testtest(String name,
TestRulesetRequest content)
Test `Source` for syntactic and semantic correctness.
-
-
Method Detail
-
test
public FirebaseRules.Projects.Test test(String name,
TestRulesetRequest content)
throws IOException
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/') } }
Create a request for the method "projects.test".
This request holds the parameters needed by the firebaserules server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
- Parameters:
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}`content - the TestRulesetRequest- Returns:
- the request
- Throws:
IOException
-
releases
public FirebaseRules.Projects.Releases releases()
An accessor for creating requests from the Releases collection.
The typical use is:
FirebaseRules firebaserules = new FirebaseRules(...);
FirebaseRules.Releases.List request = firebaserules.releases().list(parameters ...)
- Returns:
- the resource collection
-
rulesets
public FirebaseRules.Projects.Rulesets rulesets()
An accessor for creating requests from the Rulesets collection.
The typical use is:
FirebaseRules firebaserules = new FirebaseRules(...);
FirebaseRules.Rulesets.List request = firebaserules.rulesets().list(parameters ...)
- Returns:
- the resource collection
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy