Network.Google.Resource.FirebaseRules.Projects.Test

Test `Source` for syntactic and semantic correctness. Issues present in the rules, if any, will be returned to the caller with a description, severity, and source location. The test method will typically be executed with a developer provided `Source`, but if regression testing is desired, this method may be executed against a `Ruleset` resource name and the `Source` will be retrieved from the persisted `Ruleset`. 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.userId && (imageName.endsWith('.png') || imageName.endsWith('.jpg')) && resource.mimeType.startsWith('image/') } }

See: Firebase Rules API Reference for firebaserules.projects.test.

REST Resource

type ProjectsTestResource = "v1" :> (CaptureMode "name" "test" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] TestRulesetRequest :> Post '[JSON] TestRulesetResponse))))))))))

A resource alias for firebaserules.projects.test method which the ProjectsTest request conforms to.

Creating a Request

projectsTest

Arguments

:: TestRulesetRequest

ptPayload

-> Text

ptName

-> ProjectsTest

Creates a value of ProjectsTest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ptXgafv
• ptUploadProtocol
• ptPp
• ptAccessToken
• ptUploadType
• ptPayload
• ptBearerToken
• ptName
• ptCallback

data ProjectsTest

Test `Source` for syntactic and semantic correctness. Issues present in the rules, if any, will be returned to the caller with a description, severity, and source location. The test method will typically be executed with a developer provided `Source`, but if regression testing is desired, this method may be executed against a `Ruleset` resource name and the `Source` will be retrieved from the persisted `Ruleset`. 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.userId && (imageName.endsWith('.png') || imageName.endsWith('.jpg')) && resource.mimeType.startsWith('image/') } }

See: projectsTest smart constructor.

Instances

Eq ProjectsTest

Methods

(==) :: ProjectsTest -> ProjectsTest -> Bool

(/=) :: ProjectsTest -> ProjectsTest -> Bool

Data ProjectsTest

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProjectsTest -> c ProjectsTest

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProjectsTest

toConstr :: ProjectsTest -> Constr

dataTypeOf :: ProjectsTest -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ProjectsTest)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProjectsTest)

gmapT :: (forall b. Data b => b -> b) -> ProjectsTest -> ProjectsTest

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsTest -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsTest -> r

gmapQ :: (forall d. Data d => d -> u) -> ProjectsTest -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ProjectsTest -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProjectsTest -> m ProjectsTest

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsTest -> m ProjectsTest

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsTest -> m ProjectsTest

Show ProjectsTest

Methods

showsPrec :: Int -> ProjectsTest -> ShowS

show :: ProjectsTest -> String

showList :: [ProjectsTest] -> ShowS

Generic ProjectsTest

Associated Types

type Rep ProjectsTest :: * -> *

Methods

from :: ProjectsTest -> Rep ProjectsTest x

to :: Rep ProjectsTest x -> ProjectsTest

GoogleRequest ProjectsTest

Associated Types

type Rs ProjectsTest :: *

type Scopes ProjectsTest :: [Symbol]

Methods

requestClient :: ProjectsTest -> Client (Rs ProjectsTest)

type Rep ProjectsTest

type Rep ProjectsTest = D1 (MetaData "ProjectsTest" "Network.Google.Resource.FirebaseRules.Projects.Test" "gogol-firebase-rules-0.1.0-FcBsaMhKNgXEgKygszMRCE" False) (C1 (MetaCons "ProjectsTest'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ptXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv))) (S1 (MetaSel (Just Symbol "_ptUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_ptPp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) (S1 (MetaSel (Just Symbol "_ptAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ptUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ptPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 TestRulesetRequest))) ((:*:) (S1 (MetaSel (Just Symbol "_ptBearerToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ptName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_ptCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))

type Scopes ProjectsTest

type Scopes ProjectsTest = (:) Symbol "https://www.googleapis.com/auth/cloud-platform" ([] Symbol)

type Rs ProjectsTest

type Rs ProjectsTest = TestRulesetResponse

Request Lenses

ptXgafv :: Lens' ProjectsTest (Maybe Xgafv)

V1 error format.

ptUploadProtocol :: Lens' ProjectsTest (Maybe Text)

Upload protocol for media (e.g. "raw", "multipart").

ptPp :: Lens' ProjectsTest Bool

Pretty-print response.

ptAccessToken :: Lens' ProjectsTest (Maybe Text)

OAuth access token.

ptUploadType :: Lens' ProjectsTest (Maybe Text)

Legacy upload protocol for media (e.g. "media", "multipart").

ptPayload :: Lens' ProjectsTest TestRulesetRequest

Multipart request metadata.

ptBearerToken :: Lens' ProjectsTest (Maybe Text)

OAuth bearer token.

ptName :: Lens' ProjectsTest Text

Name of the project. Format: `projects/{project_id}`

ptCallback :: Lens' ProjectsTest (Maybe Text)

JSONP