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.AlertCenter.Alerts.List

Contents

REST Resource
Creating a Request
Request Lenses

Description

Lists the alerts.

See: G Suite Alert Center API Reference for alertcenter.alerts.list.

Synopsis

type AlertsListResource = "v1beta1" :> ("alerts" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "orderBy" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "customerId" Text :> (QueryParam "filter" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListAlertsResponse))))))))))))
alertsList :: AlertsList
data AlertsList
alXgafv :: Lens' AlertsList (Maybe Xgafv)
alUploadProtocol :: Lens' AlertsList (Maybe Text)
alOrderBy :: Lens' AlertsList (Maybe Text)
alAccessToken :: Lens' AlertsList (Maybe Text)
alUploadType :: Lens' AlertsList (Maybe Text)
alCustomerId :: Lens' AlertsList (Maybe Text)
alFilter :: Lens' AlertsList (Maybe Text)
alPageToken :: Lens' AlertsList (Maybe Text)
alPageSize :: Lens' AlertsList (Maybe Int32)
alCallback :: Lens' AlertsList (Maybe Text)

REST Resource

type AlertsListResource = "v1beta1" :> ("alerts" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "orderBy" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "customerId" Text :> (QueryParam "filter" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListAlertsResponse)))))))))))) Source #

A resource alias for alertcenter.alerts.list method which the AlertsList request conforms to.

Creating a Request

alertsList :: AlertsList Source #

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

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

data AlertsList Source #

Lists the alerts.

See: alertsList smart constructor.

Instances

Eq AlertsList Source #
Instance details Defined in Network.Google.Resource.AlertCenter.Alerts.List Methods (==) :: AlertsList -> AlertsList -> Bool # (/=) :: AlertsList -> AlertsList -> Bool #
Data AlertsList Source #
Instance details Defined in Network.Google.Resource.AlertCenter.Alerts.List Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AlertsList -> c AlertsList # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AlertsList # toConstr :: AlertsList -> Constr # dataTypeOf :: AlertsList -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c AlertsList) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AlertsList) # gmapT :: (forall b. Data b => b -> b) -> AlertsList -> AlertsList # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AlertsList -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AlertsList -> r # gmapQ :: (forall d. Data d => d -> u) -> AlertsList -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> AlertsList -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> AlertsList -> m AlertsList # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AlertsList -> m AlertsList # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AlertsList -> m AlertsList #
Show AlertsList Source #
Instance details Defined in Network.Google.Resource.AlertCenter.Alerts.List Methods showsPrec :: Int -> AlertsList -> ShowS # show :: AlertsList -> String # showList :: [AlertsList] -> ShowS #
Generic AlertsList Source #
Instance details Defined in Network.Google.Resource.AlertCenter.Alerts.List Associated Types type Rep AlertsList :: Type -> Type # Methods from :: AlertsList -> Rep AlertsList x # to :: Rep AlertsList x -> AlertsList #
GoogleRequest AlertsList Source #
Instance details Defined in Network.Google.Resource.AlertCenter.Alerts.List Associated Types type Rs AlertsList :: Type # type Scopes AlertsList :: [Symbol] # Methods requestClient :: AlertsList -> GClient (Rs AlertsList) #
type Rep AlertsList Source #
Instance details Defined in Network.Google.Resource.AlertCenter.Alerts.List type Rep AlertsList = D1 (MetaData "AlertsList" "Network.Google.Resource.AlertCenter.Alerts.List" "gogol-alertcenter-0.4.0-9dY40O2r8HE66nfrCXN2KD" False) (C1 (MetaCons "AlertsList'" PrefixI True) (((S1 (MetaSel (Just "_alXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: S1 (MetaSel (Just "_alUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_alOrderBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_alAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_alUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 (MetaSel (Just "_alCustomerId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_alFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_alPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_alPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_alCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))
type Scopes AlertsList Source #
Instance details Defined in Network.Google.Resource.AlertCenter.Alerts.List type Scopes AlertsList = "https://www.googleapis.com/auth/apps.alerts" ': ([] :: [Symbol])
type Rs AlertsList Source #
Instance details Defined in Network.Google.Resource.AlertCenter.Alerts.List type Rs AlertsList = ListAlertsResponse

Request Lenses

alXgafv :: Lens' AlertsList (Maybe Xgafv) Source #

V1 error format.

alUploadProtocol :: Lens' AlertsList (Maybe Text) Source #

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

alOrderBy :: Lens' AlertsList (Maybe Text) Source #

Optional. The sort order of the list results. If not specified results may be returned in arbitrary order. You can sort the results in descending order based on the creation timestamp using `order_by="create_time desc"`. Currently, only sorting by `create_time desc` is supported.

alAccessToken :: Lens' AlertsList (Maybe Text) Source #

OAuth access token.

alUploadType :: Lens' AlertsList (Maybe Text) Source #

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

alCustomerId :: Lens' AlertsList (Maybe Text) Source #

Optional. The unique identifier of the G Suite organization account of the customer the alerts are associated with. Inferred from the caller identity if not provided.

alFilter :: Lens' AlertsList (Maybe Text) Source #

Optional. A query string for filtering alert results. For more details, see Query filters and Supported query filter fields.

alPageToken :: Lens' AlertsList (Maybe Text) Source #

Optional. A token identifying a page of results the server should return. If empty, a new iteration is started. To continue an iteration, pass in the value from the previous ListAlertsResponse's next_page_token field.

alPageSize :: Lens' AlertsList (Maybe Int32) Source #

Optional. The requested page size. Server may return fewer items than requested. If unspecified, server picks an appropriate default.

alCallback :: Lens' AlertsList (Maybe Text) Source #

JSONP