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.Reports.EntityUsageReports.Get

Contents

REST Resource
Creating a Request
Request Lenses

Description

Retrieves a report which is a collection of properties / statistics for a set of objects.

See: Admin Reports API Reference for reports.entityUsageReports.get.

Synopsis

type EntityUsageReportsGetResource = "admin" :> ("reports" :> ("v1" :> ("usage" :> (Capture "entityType" Text :> (Capture "entityKey" Text :> ("dates" :> (Capture "date" Text :> (QueryParam "filters" Text :> (QueryParam "customerId" Text :> (QueryParam "parameters" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] UsageReports)))))))))))))
entityUsageReportsGet :: Text -> Text -> Text -> EntityUsageReportsGet
data EntityUsageReportsGet
eurgEntityType :: Lens' EntityUsageReportsGet Text
eurgFilters :: Lens' EntityUsageReportsGet (Maybe Text)
eurgCustomerId :: Lens' EntityUsageReportsGet (Maybe Text)
eurgDate :: Lens' EntityUsageReportsGet Text
eurgEntityKey :: Lens' EntityUsageReportsGet Text
eurgParameters :: Lens' EntityUsageReportsGet (Maybe Text)
eurgPageToken :: Lens' EntityUsageReportsGet (Maybe Text)
eurgMaxResults :: Lens' EntityUsageReportsGet (Maybe Word32)

REST Resource

type EntityUsageReportsGetResource = "admin" :> ("reports" :> ("v1" :> ("usage" :> (Capture "entityType" Text :> (Capture "entityKey" Text :> ("dates" :> (Capture "date" Text :> (QueryParam "filters" Text :> (QueryParam "customerId" Text :> (QueryParam "parameters" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] UsageReports))))))))))))) Source #

A resource alias for reports.entityUsageReports.get method which the EntityUsageReportsGet request conforms to.

Creating a Request

entityUsageReportsGet Source #

Arguments

:: Text	`eurgEntityType`
-> Text	`eurgDate`
-> Text	`eurgEntityKey`
-> EntityUsageReportsGet

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

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

data EntityUsageReportsGet Source #

Retrieves a report which is a collection of properties / statistics for a set of objects.

See: entityUsageReportsGet smart constructor.

Instances

Eq EntityUsageReportsGet Source #
Instance details Defined in Network.Google.Resource.Reports.EntityUsageReports.Get Methods (==) :: EntityUsageReportsGet -> EntityUsageReportsGet -> Bool # (/=) :: EntityUsageReportsGet -> EntityUsageReportsGet -> Bool #
Data EntityUsageReportsGet Source #
Instance details Defined in Network.Google.Resource.Reports.EntityUsageReports.Get Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EntityUsageReportsGet -> c EntityUsageReportsGet # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EntityUsageReportsGet # toConstr :: EntityUsageReportsGet -> Constr # dataTypeOf :: EntityUsageReportsGet -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c EntityUsageReportsGet) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EntityUsageReportsGet) # gmapT :: (forall b. Data b => b -> b) -> EntityUsageReportsGet -> EntityUsageReportsGet # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EntityUsageReportsGet -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EntityUsageReportsGet -> r # gmapQ :: (forall d. Data d => d -> u) -> EntityUsageReportsGet -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> EntityUsageReportsGet -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> EntityUsageReportsGet -> m EntityUsageReportsGet # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EntityUsageReportsGet -> m EntityUsageReportsGet # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EntityUsageReportsGet -> m EntityUsageReportsGet #
Show EntityUsageReportsGet Source #
Instance details Defined in Network.Google.Resource.Reports.EntityUsageReports.Get Methods showsPrec :: Int -> EntityUsageReportsGet -> ShowS # show :: EntityUsageReportsGet -> String # showList :: [EntityUsageReportsGet] -> ShowS #
Generic EntityUsageReportsGet Source #
Instance details Defined in Network.Google.Resource.Reports.EntityUsageReports.Get Associated Types type Rep EntityUsageReportsGet :: Type -> Type # Methods from :: EntityUsageReportsGet -> Rep EntityUsageReportsGet x # to :: Rep EntityUsageReportsGet x -> EntityUsageReportsGet #
GoogleRequest EntityUsageReportsGet Source #
Instance details Defined in Network.Google.Resource.Reports.EntityUsageReports.Get Associated Types type Rs EntityUsageReportsGet :: Type # type Scopes EntityUsageReportsGet :: [Symbol] # Methods requestClient :: EntityUsageReportsGet -> GClient (Rs EntityUsageReportsGet) #
type Rep EntityUsageReportsGet Source #
Instance details Defined in Network.Google.Resource.Reports.EntityUsageReports.Get type Rep EntityUsageReportsGet = D1 (MetaData "EntityUsageReportsGet" "Network.Google.Resource.Reports.EntityUsageReports.Get" "gogol-admin-reports-0.4.0-rGKKrSmAty6UY4rZWvGwr" False) (C1 (MetaCons "EntityUsageReportsGet'" PrefixI True) (((S1 (MetaSel (Just "_eurgEntityType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_eurgFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_eurgCustomerId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_eurgDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :: ((S1 (MetaSel (Just "_eurgEntityKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_eurgParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_eurgPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_eurgMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32)))))))
type Scopes EntityUsageReportsGet Source #
Instance details Defined in Network.Google.Resource.Reports.EntityUsageReports.Get type Scopes EntityUsageReportsGet = "https://www.googleapis.com/auth/admin.reports.usage.readonly" ': ([] :: [Symbol])
type Rs EntityUsageReportsGet Source #
Instance details Defined in Network.Google.Resource.Reports.EntityUsageReports.Get type Rs EntityUsageReportsGet = UsageReports

Request Lenses

eurgEntityType :: Lens' EntityUsageReportsGet Text Source #

Type of object. Should be one of - gplus_communities.

eurgFilters :: Lens' EntityUsageReportsGet (Maybe Text) Source #

Represents the set of filters including parameter operator value.

eurgCustomerId :: Lens' EntityUsageReportsGet (Maybe Text) Source #

Represents the customer for which the data is to be fetched.

eurgDate :: Lens' EntityUsageReportsGet Text Source #

Represents the date in yyyy-mm-dd format for which the data is to be fetched.

eurgEntityKey :: Lens' EntityUsageReportsGet Text Source #

Represents the key of object for which the data should be filtered.

eurgParameters :: Lens' EntityUsageReportsGet (Maybe Text) Source #

Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.

eurgPageToken :: Lens' EntityUsageReportsGet (Maybe Text) Source #

Token to specify next page.

eurgMaxResults :: Lens' EntityUsageReportsGet (Maybe Word32) Source #

Maximum number of results to return. Maximum allowed is 1000