Network.Google.Resource.Directory.Users.Watch

Watch for changes in users list

See: Admin Directory API Reference for directory.users.watch.

REST Resource

type UsersWatchResource = "admin" :> ("directory" :> ("v1" :> ("users" :> ("watch" :> (QueryParam "event" UsersWatchEvent :> (QueryParam "orderBy" UsersWatchOrderBy :> (QueryParam "viewType" UsersWatchViewType :> (QueryParam "customFieldMask" Text :> (QueryParam "domain" Text :> (QueryParam "showDeleted" Text :> (QueryParam "sortOrder" UsersWatchSortOrder :> (QueryParam "customer" Text :> (QueryParam "query" Text :> (QueryParam "projection" UsersWatchProjection :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Channel :> Post '[JSON] Channel))))))))))))))))))

A resource alias for directory.users.watch method which the UsersWatch request conforms to.

Creating a Request

usersWatch

Arguments

:: Channel

uwPayload

-> UsersWatch

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

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

• uwEvent
• uwOrderBy
• uwViewType
• uwCustomFieldMask
• uwDomain
• uwShowDeleted
• uwPayload
• uwSortOrder
• uwCustomer
• uwQuery
• uwProjection
• uwPageToken
• uwMaxResults

data UsersWatch

Watch for changes in users list

See: usersWatch smart constructor.

Instances

Eq UsersWatch

Methods

(==) :: UsersWatch -> UsersWatch -> Bool

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

Data UsersWatch

Methods

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

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

toConstr :: UsersWatch -> Constr

dataTypeOf :: UsersWatch -> DataType

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

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

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

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

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

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

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

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

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

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

Show UsersWatch

Methods

showsPrec :: Int -> UsersWatch -> ShowS

show :: UsersWatch -> String

showList :: [UsersWatch] -> ShowS

Generic UsersWatch

Associated Types

type Rep UsersWatch :: * -> *

Methods

from :: UsersWatch -> Rep UsersWatch x

to :: Rep UsersWatch x -> UsersWatch

GoogleRequest UsersWatch

Associated Types

type Rs UsersWatch :: *

type Scopes UsersWatch :: [Symbol]

Methods

requestClient :: UsersWatch -> Client (Rs UsersWatch)

type Rep UsersWatch

type Rep UsersWatch = D1 (MetaData "UsersWatch" "Network.Google.Resource.Directory.Users.Watch" "gogol-admin-directory-0.2.0-LtLu3aZ0zIMLZgbWZuob8D" False) (C1 (MetaCons "UsersWatch'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_uwEvent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe UsersWatchEvent))) ((:*:) (S1 (MetaSel (Just Symbol "_uwOrderBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe UsersWatchOrderBy))) (S1 (MetaSel (Just Symbol "_uwViewType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 UsersWatchViewType)))) ((:*:) (S1 (MetaSel (Just Symbol "_uwCustomFieldMask") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_uwDomain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_uwShowDeleted") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_uwPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Channel)) ((:*:) (S1 (MetaSel (Just Symbol "_uwSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe UsersWatchSortOrder))) (S1 (MetaSel (Just Symbol "_uwCustomer") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_uwQuery") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_uwProjection") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 UsersWatchProjection))) ((:*:) (S1 (MetaSel (Just Symbol "_uwPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_uwMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))))))))

type Scopes UsersWatch

type Scopes UsersWatch = (:) Symbol "https://www.googleapis.com/auth/admin.directory.user" ((:) Symbol "https://www.googleapis.com/auth/admin.directory.user.readonly" ([] Symbol))

type Rs UsersWatch

type Rs UsersWatch = Channel

Request Lenses

uwEvent :: Lens' UsersWatch (Maybe UsersWatchEvent)

Event on which subscription is intended (if subscribing)

uwOrderBy :: Lens' UsersWatch (Maybe UsersWatchOrderBy)

Column to use for sorting results

uwViewType :: Lens' UsersWatch UsersWatchViewType

Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.

uwCustomFieldMask :: Lens' UsersWatch (Maybe Text)

Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.

uwDomain :: Lens' UsersWatch (Maybe Text)

Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead.

uwShowDeleted :: Lens' UsersWatch (Maybe Text)

If set to true retrieves the list of deleted users. Default is false

uwPayload :: Lens' UsersWatch Channel

Multipart request metadata.

uwSortOrder :: Lens' UsersWatch (Maybe UsersWatchSortOrder)

Whether to return results in ascending or descending order.

uwCustomer :: Lens' UsersWatch (Maybe Text)

Immutable id of the Google Apps account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.

uwQuery :: Lens' UsersWatch (Maybe Text)

Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users

uwProjection :: Lens' UsersWatch UsersWatchProjection

What subset of fields to fetch for this user.

uwPageToken :: Lens' UsersWatch (Maybe Text)

Token to specify next page in the list

uwMaxResults :: Lens' UsersWatch (Maybe Int32)

Maximum number of results to return. Default is 100. Max allowed is 500