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

ProjectsRulesets

class ProjectsRulesets extends Resource (View source)

The "rulesets" collection of methods.

Typical usage is:

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

Methods

Ruleset
create(string $name, Ruleset $postBody, array $optParams = [])

Create a Ruleset from Source. The Ruleset is given a unique generated name which is returned to the caller. Source containing syntactic or semantics errors will result in an error response indicating the first error encountered. For a detailed view of Source issues, use TestRuleset.

FirebaserulesEmpty
delete(string $name, array $optParams = [])

Delete a Ruleset by resource name. If the Ruleset is referenced by a Release the operation will fail. (rulesets.delete)

Ruleset
get(string $name, array $optParams = [])

Get a Ruleset by name including the full Source contents. (rulesets.get)

ListRulesetsResponse
listProjectsRulesets(string $name, array $optParams = [])

List Ruleset metadata only and optionally filter the results by Ruleset name. The full Source contents of a Ruleset may be retrieved with GetRuleset. (rulesets.listProjectsRulesets)

Details

at line 48
Ruleset create(string $name, Ruleset $postBody, array $optParams = [])

Create a Ruleset from Source. The Ruleset is given a unique generated name which is returned to the caller. Source containing syntactic or semantics errors will result in an error response indicating the first error encountered. For a detailed view of Source issues, use TestRuleset.

(rulesets.create)

Parameters

string $name

Required. Resource name for Project which owns this Ruleset. Format: projects/{project_id}
Ruleset $postBody
array $optParams

Optional parameters.

Return Value

Ruleset

Exceptions

Exception

at line 64
FirebaserulesEmpty delete(string $name, array $optParams = [])

Delete a Ruleset by resource name. If the Ruleset is referenced by a Release the operation will fail. (rulesets.delete)

Parameters

string $name

Required. Resource name for the ruleset to delete. Format: projects/{project_id}/rulesets/{ruleset_id}
array $optParams

Optional parameters.

Return Value

FirebaserulesEmpty

Exceptions

Exception

at line 79
Ruleset get(string $name, array $optParams = [])

Get a Ruleset by name including the full Source contents. (rulesets.get)

Parameters

string $name

Required. Resource name for the ruleset to get. Format: projects/{project_id}/rulesets/{ruleset_id}
array $optParams

Optional parameters.

Return Value

Ruleset

Exceptions

Exception

at line 108
ListRulesetsResponse listProjectsRulesets(string $name, array $optParams = [])

List Ruleset metadata only and optionally filter the results by Ruleset name. The full Source contents of a Ruleset may be retrieved with GetRuleset. (rulesets.listProjectsRulesets)

Parameters

string $name

Required. Resource name for the project. Format: projects/{project_id}
array $optParams

Optional parameters.

Return Value

ListRulesetsResponse

Exceptions

Exception