com.google.api.services.firebaserules.v1

Class FirebaseRules.Projects.Rulesets

java.lang.Object

com.google.api.services.firebaserules.v1.FirebaseRules.Projects.Rulesets

Enclosing class:

FirebaseRules.Projects

public class FirebaseRules.Projects.Rulesets
extends java.lang.Object

The "rulesets" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	FirebaseRules.Projects.Rulesets.Create
class	FirebaseRules.Projects.Rulesets.Delete
class	FirebaseRules.Projects.Rulesets.Get
class	FirebaseRules.Projects.Rulesets.List

Constructor Summary

Constructors

Constructor and Description
Rulesets()

Method Summary

Modifier and Type	Method and Description
FirebaseRules.Projects.Rulesets.Create	create(java.lang.String name, Ruleset content) Create a `Ruleset` from `Source`.
FirebaseRules.Projects.Rulesets.Delete	delete(java.lang.String name) Delete a `Ruleset` by resource name.
FirebaseRules.Projects.Rulesets.Get	get(java.lang.String name) Get a `Ruleset` by name including the full `Source` contents.
FirebaseRules.Projects.Rulesets.List	list(java.lang.String name) List `Ruleset` metadata only and optionally filter the results by `Ruleset` name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Rulesets

public Rulesets()

Method Detail

create

public FirebaseRules.Projects.Rulesets.Create create(java.lang.String name,
                                                     Ruleset content)
                                              throws java.io.IOException

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. Create a request for the method "rulesets.create". 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 - Resource name for Project which owns this `Ruleset`. Format: `projects/{project_id}`

content - the Ruleset

Returns:

the request

Throws:

java.io.IOException

delete

public FirebaseRules.Projects.Rulesets.Delete delete(java.lang.String name)
                                              throws java.io.IOException

Delete a `Ruleset` by resource name. If the `Ruleset` is referenced by a `Release` the operation will fail. Create a request for the method "rulesets.delete". 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 - Resource name for the ruleset to delete. Format: `projects/{project_id}/rulesets/{ruleset_id}`

Returns:

the request

Throws:

java.io.IOException

get

public FirebaseRules.Projects.Rulesets.Get get(java.lang.String name)
                                        throws java.io.IOException

Get a `Ruleset` by name including the full `Source` contents. Create a request for the method "rulesets.get". 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 - Resource name for the ruleset to get. Format: `projects/{project_id}/rulesets/{ruleset_id}`

Returns:

the request

Throws:

java.io.IOException

list

public FirebaseRules.Projects.Rulesets.List list(java.lang.String name)
                                          throws java.io.IOException

List `Ruleset` metadata only and optionally filter the results by `Ruleset` name. The full `Source` contents of a `Ruleset` may be retrieved with GetRuleset. Create a request for the method "rulesets.list". 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 - Resource name for the project. Format: `projects/{project_id}`

Returns:

the request

Throws:

java.io.IOException