Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Network.Google.FirebaseRules
Contents
- Service Configuration
- OAuth Scopes
- API Declaration
- Resources
- firebaserules.projects.releases.create
- firebaserules.projects.releases.delete
- firebaserules.projects.releases.get
- firebaserules.projects.releases.list
- firebaserules.projects.releases.update
- firebaserules.projects.rulesets.create
- firebaserules.projects.rulesets.delete
- firebaserules.projects.rulesets.get
- firebaserules.projects.rulesets.list
- firebaserules.projects.test
- Types
Description
Creates and manages rules that determine when a Firebase Rules-enabled service should permit a request.
- firebaseRulesService :: ServiceConfig
- firebaseScope :: Proxy '["https://www.googleapis.com/auth/firebase"]
- cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"]
- firebaseReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/firebase.readonly"]
- type FirebaseRulesAPI = ProjectsRulesetsListResource :<|> (ProjectsRulesetsGetResource :<|> (ProjectsRulesetsCreateResource :<|> (ProjectsRulesetsDeleteResource :<|> (ProjectsReleasesListResource :<|> (ProjectsReleasesGetResource :<|> (ProjectsReleasesCreateResource :<|> (ProjectsReleasesDeleteResource :<|> (ProjectsReleasesUpdateResource :<|> ProjectsTestResource))))))))
- module Network.Google.Resource.FirebaseRules.Projects.Releases.Create
- module Network.Google.Resource.FirebaseRules.Projects.Releases.Delete
- module Network.Google.Resource.FirebaseRules.Projects.Releases.Get
- module Network.Google.Resource.FirebaseRules.Projects.Releases.List
- module Network.Google.Resource.FirebaseRules.Projects.Releases.Update
- module Network.Google.Resource.FirebaseRules.Projects.Rulesets.Create
- module Network.Google.Resource.FirebaseRules.Projects.Rulesets.Delete
- module Network.Google.Resource.FirebaseRules.Projects.Rulesets.Get
- module Network.Google.Resource.FirebaseRules.Projects.Rulesets.List
- module Network.Google.Resource.FirebaseRules.Projects.Test
- data SourcePosition
- sourcePosition :: SourcePosition
- spLine :: Lens' SourcePosition (Maybe Int32)
- spColumn :: Lens' SourcePosition (Maybe Int32)
- spFileName :: Lens' SourcePosition (Maybe Text)
- data Empty
- empty :: Empty
- data ListReleasesResponse
- listReleasesResponse :: ListReleasesResponse
- lrrNextPageToken :: Lens' ListReleasesResponse (Maybe Text)
- lrrReleases :: Lens' ListReleasesResponse [Release]
- data TestRulesetResponse
- testRulesetResponse :: TestRulesetResponse
- trrIssues :: Lens' TestRulesetResponse [Issue]
- data Release
- release :: Release
- rRulesetName :: Lens' Release (Maybe Text)
- rUpdateTime :: Lens' Release (Maybe UTCTime)
- rName :: Lens' Release (Maybe Text)
- rCreateTime :: Lens' Release (Maybe UTCTime)
- data Ruleset
- ruleset :: Ruleset
- rulName :: Lens' Ruleset (Maybe Text)
- rulSource :: Lens' Ruleset (Maybe Source)
- rulCreateTime :: Lens' Ruleset (Maybe UTCTime)
- data Xgafv
- data IssueSeverity
- data Source
- source :: Source
- sFiles :: Lens' Source [File]
- data TestRulesetRequest
- testRulesetRequest :: TestRulesetRequest
- trrSource :: Lens' TestRulesetRequest (Maybe Source)
- data File
- file :: File
- fFingerprint :: Lens' File (Maybe ByteString)
- fContent :: Lens' File (Maybe Text)
- fName :: Lens' File (Maybe Text)
- data ListRulesetsResponse
- listRulesetsResponse :: ListRulesetsResponse
- lRulesets :: Lens' ListRulesetsResponse [Ruleset]
- lNextPageToken :: Lens' ListRulesetsResponse (Maybe Text)
- data Issue
- issue :: Issue
- iSourcePosition :: Lens' Issue (Maybe SourcePosition)
- iSeverity :: Lens' Issue (Maybe IssueSeverity)
- iDescription :: Lens' Issue (Maybe Text)
Service Configuration
firebaseRulesService :: ServiceConfig #
Default request referring to version v1
of the Firebase Rules API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
firebaseScope :: Proxy '["https://www.googleapis.com/auth/firebase"] #
View and administer all your Firebase data and settings
cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"] #
View and manage your data across Google Cloud Platform services
firebaseReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/firebase.readonly"] #
View all your Firebase data and settings
API Declaration
type FirebaseRulesAPI = ProjectsRulesetsListResource :<|> (ProjectsRulesetsGetResource :<|> (ProjectsRulesetsCreateResource :<|> (ProjectsRulesetsDeleteResource :<|> (ProjectsReleasesListResource :<|> (ProjectsReleasesGetResource :<|> (ProjectsReleasesCreateResource :<|> (ProjectsReleasesDeleteResource :<|> (ProjectsReleasesUpdateResource :<|> ProjectsTestResource)))))))) #
Represents the entirety of the methods and resources available for the Firebase Rules API service.
Resources
firebaserules.projects.releases.create
firebaserules.projects.releases.delete
firebaserules.projects.releases.get
firebaserules.projects.releases.list
firebaserules.projects.releases.update
firebaserules.projects.rulesets.create
firebaserules.projects.rulesets.delete
firebaserules.projects.rulesets.get
firebaserules.projects.rulesets.list
firebaserules.projects.test
Types
SourcePosition
data SourcePosition #
Position in the `Source` content including its line, column number, and an index of the `File` in the `Source` message. Used for debug purposes.
See: sourcePosition
smart constructor.
Instances
sourcePosition :: SourcePosition #
Creates a value of SourcePosition
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
spColumn :: Lens' SourcePosition (Maybe Int32) #
First column on the source line associated with the source fragment.
spFileName :: Lens' SourcePosition (Maybe Text) #
Name of the `File`.
Empty
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 `{}`.
See: empty
smart constructor.
ListReleasesResponse
data ListReleasesResponse #
The response for FirebaseRulesService.ListReleases.
See: listReleasesResponse
smart constructor.
listReleasesResponse :: ListReleasesResponse #
Creates a value of ListReleasesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lrrNextPageToken :: Lens' ListReleasesResponse (Maybe Text) #
The pagination token to retrieve the next page of results. If the value is empty, no further results remain.
lrrReleases :: Lens' ListReleasesResponse [Release] #
List of `Release` instances.
TestRulesetResponse
data TestRulesetResponse #
The response for FirebaseRulesService.TestRuleset.
See: testRulesetResponse
smart constructor.
testRulesetResponse :: TestRulesetResponse #
Creates a value of TestRulesetResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
trrIssues :: Lens' TestRulesetResponse [Issue] #
Syntactic and semantic `Source` issues of varying severity. Issues of `ERROR` severity will prevent tests from executing.
Release
`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`.
See: release
smart constructor.
Creates a value of Release
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rRulesetName :: Lens' Release (Maybe Text) #
Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist the `Release` to be created.
rName :: Lens' Release (Maybe Text) #
Resource name for the `Release`. `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2` which affords developers a great deal of flexibility in mapping the name to the style that best fits their existing development practices. For example, a name could refer to an environment, an app, a version, or some combination of three. In the table below, for the project name `projects/foo`, the following relative release paths show how flat and structured names might be chosen to match a desired development / deployment strategy. Use Case | Flat Name | Structured Name -------------|---------------------|---------------- Environments | releases/qa | releases/qa Apps | releases/app1_qa | releases/app1/qa Versions | releases/app1_v2_qa | releases/app1/v2/qa The delimiter between the release name path elements can be almost anything and it should work equally well with the release name list filter, but in many ways the structured paths provide a clearer picture of the relationship between `Release` instances. Format: `projects/{project_id}/releases/{release_id}`
Ruleset
`Ruleset` is an immutable copy of `Source` with a globally unique identifier and a creation time.
See: ruleset
smart constructor.
Creates a value of Ruleset
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rulName :: Lens' Ruleset (Maybe Text) #
Name of the `Ruleset`. The ruleset_id is auto generated by the service. Format: `projects/{project_id}/rulesets/{ruleset_id}` 'OutputOnly
Xgafv
V1 error format.
IssueSeverity
data IssueSeverity #
The severity of the issue.
Constructors
SeverityUnspecified |
|
Deprecation |
|
Warning |
|
Error' |
|
Instances
Source
`Source` is one or more `File` messages comprising a logical set of rules.
See: source
smart constructor.
TestRulesetRequest
data TestRulesetRequest #
The request for FirebaseRulesService.TestRuleset.
See: testRulesetRequest
smart constructor.
testRulesetRequest :: TestRulesetRequest #
Creates a value of TestRulesetRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
File
`File` containing source content.
See: file
smart constructor.
Creates a value of File
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fFingerprint :: Lens' File (Maybe ByteString) #
Fingerprint (e.g. github sha) associated with the `File`.
ListRulesetsResponse
data ListRulesetsResponse #
The response for FirebaseRulesService.ListRulesets
See: listRulesetsResponse
smart constructor.
listRulesetsResponse :: ListRulesetsResponse #
Creates a value of ListRulesetsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lRulesets :: Lens' ListRulesetsResponse [Ruleset] #
List of `Ruleset` instances.
lNextPageToken :: Lens' ListRulesetsResponse (Maybe Text) #
The pagination token to retrieve the next page of results. If the value is empty, no further results remain.
Issue
Issues include warnings, errors, and deprecation notices.
See: issue
smart constructor.
Creates a value of Issue
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iSourcePosition :: Lens' Issue (Maybe SourcePosition) #
Position of the issue in the `Source`.