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.Resource.FirebaseRules.Projects.Rulesets.List

Contents

REST Resource
Creating a Request
Request Lenses

Description

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

See: Firebase Rules API Reference for firebaserules.projects.rulesets.list.

Synopsis

type ProjectsRulesetsListResource = "v1" :> (Capture "name" Text :> ("rulesets" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "filter" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListRulesetsResponse)))))))))))
projectsRulesetsList :: Text -> ProjectsRulesetsList
data ProjectsRulesetsList
prlXgafv :: Lens' ProjectsRulesetsList (Maybe Xgafv)
prlUploadProtocol :: Lens' ProjectsRulesetsList (Maybe Text)
prlAccessToken :: Lens' ProjectsRulesetsList (Maybe Text)
prlUploadType :: Lens' ProjectsRulesetsList (Maybe Text)
prlName :: Lens' ProjectsRulesetsList Text
prlFilter :: Lens' ProjectsRulesetsList (Maybe Text)
prlPageToken :: Lens' ProjectsRulesetsList (Maybe Text)
prlPageSize :: Lens' ProjectsRulesetsList (Maybe Int32)
prlCallback :: Lens' ProjectsRulesetsList (Maybe Text)

REST Resource

type ProjectsRulesetsListResource = "v1" :> (Capture "name" Text :> ("rulesets" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "filter" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListRulesetsResponse))))))))))) Source #

A resource alias for firebaserules.projects.rulesets.list method which the ProjectsRulesetsList request conforms to.

Creating a Request

projectsRulesetsList Source #

Arguments

:: Text	`prlName`
-> ProjectsRulesetsList

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

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

data ProjectsRulesetsList Source #

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

See: projectsRulesetsList smart constructor.

Instances

Eq ProjectsRulesetsList Source #
Instance details Defined in Network.Google.Resource.FirebaseRules.Projects.Rulesets.List Methods (==) :: ProjectsRulesetsList -> ProjectsRulesetsList -> Bool # (/=) :: ProjectsRulesetsList -> ProjectsRulesetsList -> Bool #
Data ProjectsRulesetsList Source #
Instance details Defined in Network.Google.Resource.FirebaseRules.Projects.Rulesets.List Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProjectsRulesetsList -> c ProjectsRulesetsList # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProjectsRulesetsList # toConstr :: ProjectsRulesetsList -> Constr # dataTypeOf :: ProjectsRulesetsList -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ProjectsRulesetsList) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProjectsRulesetsList) # gmapT :: (forall b. Data b => b -> b) -> ProjectsRulesetsList -> ProjectsRulesetsList # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsRulesetsList -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsRulesetsList -> r # gmapQ :: (forall d. Data d => d -> u) -> ProjectsRulesetsList -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ProjectsRulesetsList -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProjectsRulesetsList -> m ProjectsRulesetsList # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsRulesetsList -> m ProjectsRulesetsList # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsRulesetsList -> m ProjectsRulesetsList #
Show ProjectsRulesetsList Source #
Instance details Defined in Network.Google.Resource.FirebaseRules.Projects.Rulesets.List Methods showsPrec :: Int -> ProjectsRulesetsList -> ShowS # show :: ProjectsRulesetsList -> String # showList :: [ProjectsRulesetsList] -> ShowS #
Generic ProjectsRulesetsList Source #
Instance details Defined in Network.Google.Resource.FirebaseRules.Projects.Rulesets.List Associated Types type Rep ProjectsRulesetsList :: Type -> Type # Methods from :: ProjectsRulesetsList -> Rep ProjectsRulesetsList x # to :: Rep ProjectsRulesetsList x -> ProjectsRulesetsList #
GoogleRequest ProjectsRulesetsList Source #
Instance details Defined in Network.Google.Resource.FirebaseRules.Projects.Rulesets.List Associated Types type Rs ProjectsRulesetsList :: Type # type Scopes ProjectsRulesetsList :: [Symbol] # Methods requestClient :: ProjectsRulesetsList -> GClient (Rs ProjectsRulesetsList) #
type Rep ProjectsRulesetsList Source #
Instance details Defined in Network.Google.Resource.FirebaseRules.Projects.Rulesets.List type Rep ProjectsRulesetsList = D1 (MetaData "ProjectsRulesetsList" "Network.Google.Resource.FirebaseRules.Projects.Rulesets.List" "gogol-firebase-rules-0.4.0-8f71BRcY6VI3IDZJSGi4Go" False) (C1 (MetaCons "ProjectsRulesetsList'" PrefixI True) (((S1 (MetaSel (Just "_prlXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: S1 (MetaSel (Just "_prlUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_prlAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_prlUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_prlName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_prlFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_prlPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_prlPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :: S1 (MetaSel (Just "_prlCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))
type Scopes ProjectsRulesetsList Source #
Instance details Defined in Network.Google.Resource.FirebaseRules.Projects.Rulesets.List type Scopes ProjectsRulesetsList = "https://www.googleapis.com/auth/cloud-platform" ': ("https://www.googleapis.com/auth/firebase" ': ("https://www.googleapis.com/auth/firebase.readonly" ': ([] :: [Symbol])))
type Rs ProjectsRulesetsList Source #
Instance details Defined in Network.Google.Resource.FirebaseRules.Projects.Rulesets.List type Rs ProjectsRulesetsList = ListRulesetsResponse

Request Lenses

prlXgafv :: Lens' ProjectsRulesetsList (Maybe Xgafv) Source #

V1 error format.

prlUploadProtocol :: Lens' ProjectsRulesetsList (Maybe Text) Source #

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

prlAccessToken :: Lens' ProjectsRulesetsList (Maybe Text) Source #

OAuth access token.

prlUploadType :: Lens' ProjectsRulesetsList (Maybe Text) Source #

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

prlName :: Lens' ProjectsRulesetsList Text Source #

Resource name for the project. Format: `projects/{project_id}`

prlFilter :: Lens' ProjectsRulesetsList (Maybe Text) Source #

`Ruleset` filter. The list method supports filters with restrictions on `Ruleset.name`. Filters on `Ruleset.create_time` should use the `date` function which parses strings that conform to the RFC 3339 date/time specifications. Example: `create_time > date("2017-01-01") AND name=UUID-*`

prlPageToken :: Lens' ProjectsRulesetsList (Maybe Text) Source #

Next page token for loading the next batch of `Ruleset` instances.

prlPageSize :: Lens' ProjectsRulesetsList (Maybe Int32) Source #

Page size to load. Maximum of 100. Defaults to 10. Note: `page_size` is just a hint and the service may choose to load less than `page_size` due to the size of the output. To traverse all of the releases, caller should iterate until the `page_token` is empty.

prlCallback :: Lens' ProjectsRulesetsList (Maybe Text) Source #

JSONP