| 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.getExecutable
- firebaserules.projects.releases.list
- firebaserules.projects.releases.patch
- firebaserules.projects.rulesets.create
- firebaserules.projects.rulesets.delete
- firebaserules.projects.rulesets.get
- firebaserules.projects.rulesets.list
- firebaserules.projects.test
- Types
- SourcePosition
- TestCase
- VisitedExpression
- Empty
- FunctionMock
- TestResultState
- FunctionCall
- ListReleasesResponse
- Result
- TestRulesetResponse
- Release
- Arg
- Ruleset
- GetReleaseExecutableResponse
- TestResult
- Xgafv
- IssueSeverity
- Source
- TestCaseExpectation
- TestSuite
- TestRulesetRequest
- File
- GetReleaseExecutableResponseExecutableVersion
- GetReleaseExecutableResponseLanguage
- ListRulesetsResponse
- Issue
- UpdateReleaseRequest
Description
Creates and manages rules that determine when a Firebase Rules-enabled service should permit a request.
Synopsis
- 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 :<|> (ProjectsReleasesPatchResource :<|> (ProjectsReleasesGetResource :<|> (ProjectsReleasesGetExecutableResource :<|> (ProjectsReleasesCreateResource :<|> (ProjectsReleasesDeleteResource :<|> 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.GetExecutable
- module Network.Google.Resource.FirebaseRules.Projects.Releases.List
- module Network.Google.Resource.FirebaseRules.Projects.Releases.Patch
- 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 TestCase
- testCase :: TestCase
- tcResource :: Lens' TestCase (Maybe JSONValue)
- tcExpectation :: Lens' TestCase (Maybe TestCaseExpectation)
- tcFunctionMocks :: Lens' TestCase [FunctionMock]
- tcRequest :: Lens' TestCase (Maybe JSONValue)
- data VisitedExpression
- visitedExpression :: VisitedExpression
- veSourcePosition :: Lens' VisitedExpression (Maybe SourcePosition)
- veValue :: Lens' VisitedExpression (Maybe JSONValue)
- data Empty
- empty :: Empty
- data FunctionMock
- functionMock :: FunctionMock
- fmArgs :: Lens' FunctionMock [Arg]
- fmFunction :: Lens' FunctionMock (Maybe Text)
- fmResult :: Lens' FunctionMock (Maybe Result)
- data TestResultState
- data FunctionCall
- functionCall :: FunctionCall
- fcArgs :: Lens' FunctionCall [JSONValue]
- fcFunction :: Lens' FunctionCall (Maybe Text)
- data ListReleasesResponse
- listReleasesResponse :: ListReleasesResponse
- lrrNextPageToken :: Lens' ListReleasesResponse (Maybe Text)
- lrrReleases :: Lens' ListReleasesResponse [Release]
- data Result
- result :: Result
- rValue :: Lens' Result (Maybe JSONValue)
- rUndefined :: Lens' Result (Maybe Empty)
- data TestRulesetResponse
- testRulesetResponse :: TestRulesetResponse
- trrTestResults :: Lens' TestRulesetResponse [TestResult]
- 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 Arg
- arg :: Arg
- aAnyValue :: Lens' Arg (Maybe Empty)
- aExactValue :: Lens' Arg (Maybe JSONValue)
- data Ruleset
- ruleset :: Ruleset
- rulName :: Lens' Ruleset (Maybe Text)
- rulSource :: Lens' Ruleset (Maybe Source)
- rulCreateTime :: Lens' Ruleset (Maybe UTCTime)
- data GetReleaseExecutableResponse
- getReleaseExecutableResponse :: GetReleaseExecutableResponse
- grerExecutable :: Lens' GetReleaseExecutableResponse (Maybe ByteString)
- grerRulesetName :: Lens' GetReleaseExecutableResponse (Maybe Text)
- grerUpdateTime :: Lens' GetReleaseExecutableResponse (Maybe UTCTime)
- grerSyncTime :: Lens' GetReleaseExecutableResponse (Maybe UTCTime)
- grerExecutableVersion :: Lens' GetReleaseExecutableResponse (Maybe GetReleaseExecutableResponseExecutableVersion)
- grerLanguage :: Lens' GetReleaseExecutableResponse (Maybe GetReleaseExecutableResponseLanguage)
- data TestResult
- testResult :: TestResult
- trState :: Lens' TestResult (Maybe TestResultState)
- trFunctionCalls :: Lens' TestResult [FunctionCall]
- trVisitedExpressions :: Lens' TestResult [VisitedExpression]
- trErrorPosition :: Lens' TestResult (Maybe SourcePosition)
- trDebugMessages :: Lens' TestResult [Text]
- data Xgafv
- data IssueSeverity
- data Source
- source :: Source
- sFiles :: Lens' Source [File]
- data TestCaseExpectation
- data TestSuite
- testSuite :: TestSuite
- tsTestCases :: Lens' TestSuite [TestCase]
- data TestRulesetRequest
- testRulesetRequest :: TestRulesetRequest
- trrSource :: Lens' TestRulesetRequest (Maybe Source)
- trrTestSuite :: Lens' TestRulesetRequest (Maybe TestSuite)
- data File
- file :: File
- fFingerprint :: Lens' File (Maybe ByteString)
- fContent :: Lens' File (Maybe Text)
- fName :: Lens' File (Maybe Text)
- data GetReleaseExecutableResponseExecutableVersion
- data GetReleaseExecutableResponseLanguage
- 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)
- data UpdateReleaseRequest
- updateReleaseRequest :: UpdateReleaseRequest
- urrUpdateMask :: Lens' UpdateReleaseRequest (Maybe GFieldMask)
- urrRelease :: Lens' UpdateReleaseRequest (Maybe Release)
Service Configuration
firebaseRulesService :: ServiceConfig Source #
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"] Source #
View and administer all your Firebase data and settings
cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"] Source #
View and manage your data across Google Cloud Platform services
firebaseReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/firebase.readonly"] Source #
View all your Firebase data and settings
API Declaration
type FirebaseRulesAPI = ProjectsRulesetsListResource :<|> (ProjectsRulesetsGetResource :<|> (ProjectsRulesetsCreateResource :<|> (ProjectsRulesetsDeleteResource :<|> (ProjectsReleasesListResource :<|> (ProjectsReleasesPatchResource :<|> (ProjectsReleasesGetResource :<|> (ProjectsReleasesGetExecutableResource :<|> (ProjectsReleasesCreateResource :<|> (ProjectsReleasesDeleteResource :<|> ProjectsTestResource))))))))) Source #
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.getExecutable
firebaserules.projects.releases.list
firebaserules.projects.releases.patch
firebaserules.projects.rulesets.create
firebaserules.projects.rulesets.delete
firebaserules.projects.rulesets.get
firebaserules.projects.rulesets.list
firebaserules.projects.test
Types
SourcePosition
data SourcePosition Source #
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 Source #
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) Source #
First column on the source line associated with the source fragment.
spFileName :: Lens' SourcePosition (Maybe Text) Source #
Name of the `File`.
TestCase
`TestCase` messages provide the request context and an expectation as to whether the given context will be allowed or denied. Test cases may specify the `request`, `resource`, and `function_mocks` to mock a function call to a service-provided function. The `request` object represents context present at request-time. The `resource` is the value of the target resource as it appears in persistent storage before the request is executed.
See: testCase smart constructor.
Instances
Creates a value of TestCase with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tcResource :: Lens' TestCase (Maybe JSONValue) Source #
Optional resource value as it appears in persistent storage before the request is fulfilled. The resource type depends on the `request.path` value.
tcExpectation :: Lens' TestCase (Maybe TestCaseExpectation) Source #
Test expectation.
tcFunctionMocks :: Lens' TestCase [FunctionMock] Source #
Optional function mocks for service-defined functions. If not set, any service defined function is expected to return an error, which may or may not influence the test outcome.
tcRequest :: Lens' TestCase (Maybe JSONValue) Source #
Request context. The exact format of the request context is service-dependent. See the appropriate service documentation for information about the supported fields and types on the request. Minimally, all services support the following fields and types: Request field | Type ---------------|----------------- auth.uid | `string` auth.token | `map` headers | `map` method | `string` params | `map` path | `string` time | `google.protobuf.Timestamp` If the request value is not well-formed for the service, the request will be rejected as an invalid argument.
VisitedExpression
data VisitedExpression Source #
Store the position and access outcome for an expression visited in rules.
See: visitedExpression smart constructor.
Instances
visitedExpression :: VisitedExpression Source #
Creates a value of VisitedExpression with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
veSourcePosition :: Lens' VisitedExpression (Maybe SourcePosition) Source #
Position in the `Source` or `Ruleset` where an expression was visited.
veValue :: Lens' VisitedExpression (Maybe JSONValue) Source #
The evaluated value for the visited expression, e.g. true/false
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.
Instances
| Eq Empty Source # | |
| Data Empty Source # | |
Defined in Network.Google.FirebaseRules.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Empty -> c Empty # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Empty # dataTypeOf :: Empty -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Empty) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Empty) # gmapT :: (forall b. Data b => b -> b) -> Empty -> Empty # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Empty -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Empty -> r # gmapQ :: (forall d. Data d => d -> u) -> Empty -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Empty -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Empty -> m Empty # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Empty -> m Empty # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Empty -> m Empty # | |
| Show Empty Source # | |
| Generic Empty Source # | |
| ToJSON Empty Source # | |
Defined in Network.Google.FirebaseRules.Types.Product | |
| FromJSON Empty Source # | |
| type Rep Empty Source # | |
FunctionMock
data FunctionMock Source #
Mock function definition. Mocks must refer to a function declared by the target service. The type of the function args and result will be inferred at test time. If either the arg or result values are not compatible with function type declaration, the request will be considered invalid. More than one `FunctionMock` may be provided for a given function name so long as the `Arg` matchers are distinct. There may be only one function for a given overload where all `Arg` values are `Arg.any_value`.
See: functionMock smart constructor.
Instances
functionMock :: FunctionMock Source #
Creates a value of FunctionMock with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fmArgs :: Lens' FunctionMock [Arg] Source #
The list of `Arg` values to match. The order in which the arguments are provided is the order in which they must appear in the function invocation.
fmFunction :: Lens' FunctionMock (Maybe Text) Source #
The name of the function. The function name must match one provided by a service declaration.
TestResultState
data TestResultState Source #
State of the test.
Constructors
| StateUnspecified |
|
| Success |
|
| Failure |
|
Instances
FunctionCall
data FunctionCall Source #
Represents a service-defined function call that was invoked during test execution.
See: functionCall smart constructor.
Instances
functionCall :: FunctionCall Source #
Creates a value of FunctionCall with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fcFunction :: Lens' FunctionCall (Maybe Text) Source #
Name of the function invoked.
ListReleasesResponse
data ListReleasesResponse Source #
The response for FirebaseRulesService.ListReleases.
See: listReleasesResponse smart constructor.
Instances
listReleasesResponse :: ListReleasesResponse Source #
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) Source #
The pagination token to retrieve the next page of results. If the value is empty, no further results remain.
lrrReleases :: Lens' ListReleasesResponse [Release] Source #
List of `Release` instances.
Result
Possible result values from the function mock invocation.
See: result smart constructor.
Instances
| Eq Result Source # | |
| Data Result Source # | |
Defined in Network.Google.FirebaseRules.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Result -> c Result # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Result # toConstr :: Result -> Constr # dataTypeOf :: Result -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Result) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Result) # gmapT :: (forall b. Data b => b -> b) -> Result -> Result # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Result -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Result -> r # gmapQ :: (forall d. Data d => d -> u) -> Result -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Result -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Result -> m Result # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Result -> m Result # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Result -> m Result # | |
| Show Result Source # | |
| Generic Result Source # | |
| ToJSON Result Source # | |
Defined in Network.Google.FirebaseRules.Types.Product | |
| FromJSON Result Source # | |
| type Rep Result Source # | |
Defined in Network.Google.FirebaseRules.Types.Product type Rep Result = D1 (MetaData "Result" "Network.Google.FirebaseRules.Types.Product" "gogol-firebase-rules-0.4.0-8f71BRcY6VI3IDZJSGi4Go" False) (C1 (MetaCons "Result'" PrefixI True) (S1 (MetaSel (Just "_rValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe JSONValue)) :*: S1 (MetaSel (Just "_rUndefined") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Empty)))) | |
Creates a value of Result with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rValue :: Lens' Result (Maybe JSONValue) Source #
The result is an actual value. The type of the value must match that of the type declared by the service.
rUndefined :: Lens' Result (Maybe Empty) Source #
The result is undefined, meaning the result could not be computed.
TestRulesetResponse
data TestRulesetResponse Source #
The response for FirebaseRulesService.TestRuleset.
See: testRulesetResponse smart constructor.
Instances
testRulesetResponse :: TestRulesetResponse Source #
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:
trrTestResults :: Lens' TestRulesetResponse [TestResult] Source #
The set of test results given the test cases in the `TestSuite`. The results will appear in the same order as the test cases appear in the `TestSuite`.
trrIssues :: Lens' TestRulesetResponse [Issue] Source #
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.
Instances
| Eq Release Source # | |
| Data Release Source # | |
Defined in Network.Google.FirebaseRules.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Release -> c Release # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Release # toConstr :: Release -> Constr # dataTypeOf :: Release -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Release) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Release) # gmapT :: (forall b. Data b => b -> b) -> Release -> Release # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Release -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Release -> r # gmapQ :: (forall d. Data d => d -> u) -> Release -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Release -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Release -> m Release # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Release -> m Release # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Release -> m Release # | |
| Show Release Source # | |
| Generic Release Source # | |
| ToJSON Release Source # | |
Defined in Network.Google.FirebaseRules.Types.Product | |
| FromJSON Release Source # | |
| type Rep Release Source # | |
Defined in Network.Google.FirebaseRules.Types.Product type Rep Release = D1 (MetaData "Release" "Network.Google.FirebaseRules.Types.Product" "gogol-firebase-rules-0.4.0-8f71BRcY6VI3IDZJSGi4Go" False) (C1 (MetaCons "Release'" PrefixI True) ((S1 (MetaSel (Just "_rRulesetName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_rUpdateTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DateTime'))) :*: (S1 (MetaSel (Just "_rName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_rCreateTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DateTime'))))) | |
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) Source #
Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist the `Release` to be created.
rName :: Lens' Release (Maybe Text) Source #
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}`
Arg
Arg matchers for the mock function.
See: arg smart constructor.
Instances
| Eq Arg Source # | |
| Data Arg Source # | |
Defined in Network.Google.FirebaseRules.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Arg -> c Arg # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Arg # dataTypeOf :: Arg -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Arg) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Arg) # gmapT :: (forall b. Data b => b -> b) -> Arg -> Arg # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Arg -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Arg -> r # gmapQ :: (forall d. Data d => d -> u) -> Arg -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Arg -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Arg -> m Arg # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Arg -> m Arg # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Arg -> m Arg # | |
| Show Arg Source # | |
| Generic Arg Source # | |
| ToJSON Arg Source # | |
Defined in Network.Google.FirebaseRules.Types.Product | |
| FromJSON Arg Source # | |
| type Rep Arg Source # | |
Defined in Network.Google.FirebaseRules.Types.Product type Rep Arg = D1 (MetaData "Arg" "Network.Google.FirebaseRules.Types.Product" "gogol-firebase-rules-0.4.0-8f71BRcY6VI3IDZJSGi4Go" False) (C1 (MetaCons "Arg'" PrefixI True) (S1 (MetaSel (Just "_aAnyValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Empty)) :*: S1 (MetaSel (Just "_aExactValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe JSONValue)))) | |
Creates a value of Arg with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Ruleset
`Ruleset` is an immutable copy of `Source` with a globally unique identifier and a creation time.
See: ruleset smart constructor.
Instances
| Eq Ruleset Source # | |
| Data Ruleset Source # | |
Defined in Network.Google.FirebaseRules.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Ruleset -> c Ruleset # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Ruleset # toConstr :: Ruleset -> Constr # dataTypeOf :: Ruleset -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Ruleset) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Ruleset) # gmapT :: (forall b. Data b => b -> b) -> Ruleset -> Ruleset # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Ruleset -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Ruleset -> r # gmapQ :: (forall d. Data d => d -> u) -> Ruleset -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Ruleset -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Ruleset -> m Ruleset # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Ruleset -> m Ruleset # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Ruleset -> m Ruleset # | |
| Show Ruleset Source # | |
| Generic Ruleset Source # | |
| ToJSON Ruleset Source # | |
Defined in Network.Google.FirebaseRules.Types.Product | |
| FromJSON Ruleset Source # | |
| type Rep Ruleset Source # | |
Defined in Network.Google.FirebaseRules.Types.Product type Rep Ruleset = D1 (MetaData "Ruleset" "Network.Google.FirebaseRules.Types.Product" "gogol-firebase-rules-0.4.0-8f71BRcY6VI3IDZJSGi4Go" False) (C1 (MetaCons "Ruleset'" PrefixI True) (S1 (MetaSel (Just "_rulName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_rulSource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Source)) :*: S1 (MetaSel (Just "_rulCreateTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DateTime'))))) | |
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) Source #
Name of the `Ruleset`. The ruleset_id is auto generated by the service. Format: `projects/{project_id}/rulesets/{ruleset_id}` Output only.
GetReleaseExecutableResponse
data GetReleaseExecutableResponse Source #
The response for FirebaseRulesService.GetReleaseExecutable
See: getReleaseExecutableResponse smart constructor.
Instances
getReleaseExecutableResponse :: GetReleaseExecutableResponse Source #
Creates a value of GetReleaseExecutableResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
grerExecutable :: Lens' GetReleaseExecutableResponse (Maybe ByteString) Source #
Executable view of the `Ruleset` referenced by the `Release`.
grerRulesetName :: Lens' GetReleaseExecutableResponse (Maybe Text) Source #
`Ruleset` name associated with the `Release` executable.
grerUpdateTime :: Lens' GetReleaseExecutableResponse (Maybe UTCTime) Source #
Timestamp for the most recent `Release.update_time`.
grerSyncTime :: Lens' GetReleaseExecutableResponse (Maybe UTCTime) Source #
Optional, indicates the freshness of the result. The response is guaranteed to be the latest within an interval up to the sync_time (inclusive).
grerExecutableVersion :: Lens' GetReleaseExecutableResponse (Maybe GetReleaseExecutableResponseExecutableVersion) Source #
The Rules runtime version of the executable.
grerLanguage :: Lens' GetReleaseExecutableResponse (Maybe GetReleaseExecutableResponseLanguage) Source #
`Language` used to generate the executable bytes.
TestResult
data TestResult Source #
Test result message containing the state of the test as well as a description and source position for test failures.
See: testResult smart constructor.
Instances
testResult :: TestResult Source #
Creates a value of TestResult with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
trState :: Lens' TestResult (Maybe TestResultState) Source #
State of the test.
trFunctionCalls :: Lens' TestResult [FunctionCall] Source #
The set of function calls made to service-defined methods. Function calls are included in the order in which they are encountered during evaluation, are provided for both mocked and unmocked functions, and included on the response regardless of the test `state`.
trVisitedExpressions :: Lens' TestResult [VisitedExpression] Source #
The set of visited expressions for a given test. This returns positions and evaluation results of all visited expressions.
trErrorPosition :: Lens' TestResult (Maybe SourcePosition) Source #
Position in the `Source` or `Ruleset` where the principle runtime error occurs. Evaluation of an expression may result in an error. Rules are deny by default, so a `DENY` expectation when an error is generated is valid. When there is a `DENY` with an error, the `SourcePosition` is returned. E.g. `error_position { line: 19 column: 37 }`
trDebugMessages :: Lens' TestResult [Text] Source #
Debug messages related to test execution issues encountered during evaluation. Debug messages may be related to too many or too few invocations of function mocks or to runtime errors that occur during evaluation. For example: ```Unable to read variable [name: "resource"]```
Xgafv
V1 error format.
Instances
IssueSeverity
data IssueSeverity Source #
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.
Instances
| Eq Source Source # | |
| Data Source Source # | |
Defined in Network.Google.FirebaseRules.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Source -> c Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Source # toConstr :: Source -> Constr # dataTypeOf :: Source -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Source) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Source) # gmapT :: (forall b. Data b => b -> b) -> Source -> Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Source -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Source -> r # gmapQ :: (forall d. Data d => d -> u) -> Source -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Source -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Source -> m Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Source -> m Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Source -> m Source # | |
| Show Source Source # | |
| Generic Source Source # | |
| ToJSON Source Source # | |
Defined in Network.Google.FirebaseRules.Types.Product | |
| FromJSON Source Source # | |
| type Rep Source Source # | |
Defined in Network.Google.FirebaseRules.Types.Product | |
TestCaseExpectation
data TestCaseExpectation Source #
Test expectation.
Constructors
| ExpectationUnspecified |
|
| Allow |
|
| Deny |
|
Instances
TestSuite
`TestSuite` is a collection of `TestCase` instances that validate the logical correctness of a `Ruleset`. The `TestSuite` may be referenced in-line within a `TestRuleset` invocation or as part of a `Release` object as a pre-release check.
See: testSuite smart constructor.
Instances
| Eq TestSuite Source # | |
| Data TestSuite Source # | |
Defined in Network.Google.FirebaseRules.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TestSuite -> c TestSuite # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TestSuite # toConstr :: TestSuite -> Constr # dataTypeOf :: TestSuite -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TestSuite) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TestSuite) # gmapT :: (forall b. Data b => b -> b) -> TestSuite -> TestSuite # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TestSuite -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TestSuite -> r # gmapQ :: (forall d. Data d => d -> u) -> TestSuite -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> TestSuite -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> TestSuite -> m TestSuite # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TestSuite -> m TestSuite # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TestSuite -> m TestSuite # | |
| Show TestSuite Source # | |
| Generic TestSuite Source # | |
| ToJSON TestSuite Source # | |
Defined in Network.Google.FirebaseRules.Types.Product | |
| FromJSON TestSuite Source # | |
| type Rep TestSuite Source # | |
Defined in Network.Google.FirebaseRules.Types.Product type Rep TestSuite = D1 (MetaData "TestSuite" "Network.Google.FirebaseRules.Types.Product" "gogol-firebase-rules-0.4.0-8f71BRcY6VI3IDZJSGi4Go" True) (C1 (MetaCons "TestSuite'" PrefixI True) (S1 (MetaSel (Just "_tsTestCases") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [TestCase])))) | |
testSuite :: TestSuite Source #
Creates a value of TestSuite with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tsTestCases :: Lens' TestSuite [TestCase] Source #
Collection of test cases associated with the `TestSuite`.
TestRulesetRequest
data TestRulesetRequest Source #
The request for FirebaseRulesService.TestRuleset.
See: testRulesetRequest smart constructor.
Instances
testRulesetRequest :: TestRulesetRequest Source #
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:
trrSource :: Lens' TestRulesetRequest (Maybe Source) Source #
Optional `Source` to be checked for correctness. This field must not be set when the resource name refers to a `Ruleset`.
trrTestSuite :: Lens' TestRulesetRequest (Maybe TestSuite) Source #
Inline `TestSuite` to run.
File
`File` containing source content.
See: file smart constructor.
Instances
| Eq File Source # | |
| Data File Source # | |
Defined in Network.Google.FirebaseRules.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> File -> c File # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c File # dataTypeOf :: File -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c File) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c File) # gmapT :: (forall b. Data b => b -> b) -> File -> File # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> File -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> File -> r # gmapQ :: (forall d. Data d => d -> u) -> File -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> File -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> File -> m File # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> File -> m File # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> File -> m File # | |
| Show File Source # | |
| Generic File Source # | |
| ToJSON File Source # | |
Defined in Network.Google.FirebaseRules.Types.Product | |
| FromJSON File Source # | |
| type Rep File Source # | |
Defined in Network.Google.FirebaseRules.Types.Product type Rep File = D1 (MetaData "File" "Network.Google.FirebaseRules.Types.Product" "gogol-firebase-rules-0.4.0-8f71BRcY6VI3IDZJSGi4Go" False) (C1 (MetaCons "File'" PrefixI True) (S1 (MetaSel (Just "_fFingerprint") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bytes)) :*: (S1 (MetaSel (Just "_fContent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_fName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) | |
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) Source #
Fingerprint (e.g. github sha) associated with the `File`.
GetReleaseExecutableResponseExecutableVersion
data GetReleaseExecutableResponseExecutableVersion Source #
The Rules runtime version of the executable.
Constructors
| ReleaseExecutableVersionUnspecified |
|
| FirebaseRulesExecutableV1 |
|
| FirebaseRulesExecutableV2 |
|
Instances
GetReleaseExecutableResponseLanguage
data GetReleaseExecutableResponseLanguage Source #
`Language` used to generate the executable bytes.
Constructors
| LanguageUnspecified |
|
| FirebaseRules |
|
| EventFlowTriggers |
|
Instances
ListRulesetsResponse
data ListRulesetsResponse Source #
The response for FirebaseRulesService.ListRulesets.
See: listRulesetsResponse smart constructor.
Instances
listRulesetsResponse :: ListRulesetsResponse Source #
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:
lNextPageToken :: Lens' ListRulesetsResponse (Maybe Text) Source #
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.
Instances
| Eq Issue Source # | |
| Data Issue Source # | |
Defined in Network.Google.FirebaseRules.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Issue -> c Issue # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Issue # dataTypeOf :: Issue -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Issue) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Issue) # gmapT :: (forall b. Data b => b -> b) -> Issue -> Issue # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Issue -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Issue -> r # gmapQ :: (forall d. Data d => d -> u) -> Issue -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Issue -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Issue -> m Issue # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Issue -> m Issue # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Issue -> m Issue # | |
| Show Issue Source # | |
| Generic Issue Source # | |
| ToJSON Issue Source # | |
Defined in Network.Google.FirebaseRules.Types.Product | |
| FromJSON Issue Source # | |
| type Rep Issue Source # | |
Defined in Network.Google.FirebaseRules.Types.Product type Rep Issue = D1 (MetaData "Issue" "Network.Google.FirebaseRules.Types.Product" "gogol-firebase-rules-0.4.0-8f71BRcY6VI3IDZJSGi4Go" False) (C1 (MetaCons "Issue'" PrefixI True) (S1 (MetaSel (Just "_iSourcePosition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe SourcePosition)) :*: (S1 (MetaSel (Just "_iSeverity") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe IssueSeverity)) :*: S1 (MetaSel (Just "_iDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) | |
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) Source #
Position of the issue in the `Source`.
UpdateReleaseRequest
data UpdateReleaseRequest Source #
The request for FirebaseRulesService.UpdateReleasePatch.
See: updateReleaseRequest smart constructor.
Instances
updateReleaseRequest :: UpdateReleaseRequest Source #
Creates a value of UpdateReleaseRequest with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
urrUpdateMask :: Lens' UpdateReleaseRequest (Maybe GFieldMask) Source #
Specifies which fields to update.
urrRelease :: Lens' UpdateReleaseRequest (Maybe Release) Source #
`Release` to update.