Network.Google.Resource.DFAReporting.DirectorySiteContacts.List

Retrieves a list of directory site contacts, possibly filtered. This method supports paging.

See: DCM/DFA Reporting And Trafficking API Reference for dfareporting.directorySiteContacts.list.

REST Resource

type DirectorySiteContactsListResource = "dfareporting" :> ("v2.7" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("directorySiteContacts" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParams "directorySiteIds" (Textual Int64) :> (QueryParam "sortOrder" DirectorySiteContactsListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" DirectorySiteContactsListSortField :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] DirectorySiteContactsListResponse))))))))))))

A resource alias for dfareporting.directorySiteContacts.list method which the DirectorySiteContactsList request conforms to.

Creating a Request

directorySiteContactsList

Arguments

:: Int64

dsclProFileId

-> DirectorySiteContactsList

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

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

• dsclSearchString
• dsclIds
• dsclProFileId
• dsclDirectorySiteIds
• dsclSortOrder
• dsclPageToken
• dsclSortField
• dsclMaxResults

data DirectorySiteContactsList

Retrieves a list of directory site contacts, possibly filtered. This method supports paging.

See: directorySiteContactsList smart constructor.

Instances

Eq DirectorySiteContactsList

Methods

(==) :: DirectorySiteContactsList -> DirectorySiteContactsList -> Bool

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

Data DirectorySiteContactsList

Methods

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

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

toConstr :: DirectorySiteContactsList -> Constr

dataTypeOf :: DirectorySiteContactsList -> DataType

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

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

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

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

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

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

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

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

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

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

Show DirectorySiteContactsList

Methods

showsPrec :: Int -> DirectorySiteContactsList -> ShowS

show :: DirectorySiteContactsList -> String

showList :: [DirectorySiteContactsList] -> ShowS

Generic DirectorySiteContactsList

Associated Types

type Rep DirectorySiteContactsList :: * -> *

Methods

from :: DirectorySiteContactsList -> Rep DirectorySiteContactsList x

to :: Rep DirectorySiteContactsList x -> DirectorySiteContactsList

GoogleRequest DirectorySiteContactsList

Associated Types

type Rs DirectorySiteContactsList :: *

type Scopes DirectorySiteContactsList :: [Symbol]

Methods

requestClient :: DirectorySiteContactsList -> Client (Rs DirectorySiteContactsList)

type Rep DirectorySiteContactsList

type Rep DirectorySiteContactsList = D1 (MetaData "DirectorySiteContactsList" "Network.Google.Resource.DFAReporting.DirectorySiteContacts.List" "gogol-dfareporting-0.3.0-1Sz7MzcQaqT30NKUHnKpNh" False) (C1 (MetaCons "DirectorySiteContactsList'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dsclSearchString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dsclIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])))) ((:*:) (S1 (MetaSel (Just Symbol "_dsclProFileId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int64))) (S1 (MetaSel (Just Symbol "_dsclDirectorySiteIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dsclSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DirectorySiteContactsListSortOrder))) (S1 (MetaSel (Just Symbol "_dsclPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_dsclSortField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DirectorySiteContactsListSortField))) (S1 (MetaSel (Just Symbol "_dsclMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))))))))

type Scopes DirectorySiteContactsList

type Scopes DirectorySiteContactsList = (:) Symbol "https://www.googleapis.com/auth/dfatrafficking" ([] Symbol)

type Rs DirectorySiteContactsList

type Rs DirectorySiteContactsList = DirectorySiteContactsListResponse

Request Lenses

dsclSearchString :: Lens' DirectorySiteContactsList (Maybe Text)

Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "directory site contact*2015" will return objects with names like "directory site contact June 2015", "directory site contact April 2015", or simply "directory site contact 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site contact" will match objects with name "my directory site contact", "directory site contact 2015", or simply "directory site contact".

dsclIds :: Lens' DirectorySiteContactsList [Int64]

Select only directory site contacts with these IDs.

dsclProFileId :: Lens' DirectorySiteContactsList Int64

User profile ID associated with this request.

dsclDirectorySiteIds :: Lens' DirectorySiteContactsList [Int64]

Select only directory site contacts with these directory site IDs. This is a required field.

dsclSortOrder :: Lens' DirectorySiteContactsList (Maybe DirectorySiteContactsListSortOrder)

Order of sorted results, default is ASCENDING.

dsclPageToken :: Lens' DirectorySiteContactsList (Maybe Text)

Value of the nextPageToken from the previous result page.

dsclSortField :: Lens' DirectorySiteContactsList (Maybe DirectorySiteContactsListSortField)

Field by which to sort the list.

dsclMaxResults :: Lens' DirectorySiteContactsList (Maybe Int32)

Maximum number of results to return.