Network.Google.Resource.DFAReporting.UserRoles.List

Retrieves a list of user roles, possibly filtered. This method supports paging.

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

REST Resource

type UserRolesListResource = "dfareporting" :> ("v3.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("userRoles" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" UserRolesListSortOrder :> (QueryParam "accountUserRoleOnly" Bool :> (QueryParam "pageToken" Text :> (QueryParam "sortField" UserRolesListSortField :> (QueryParam "subaccountId" (Textual Int64) :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] UserRolesListResponse)))))))))))))

A resource alias for dfareporting.userRoles.list method which the UserRolesList request conforms to.

Creating a Request

userRolesList

Arguments

:: Int64

urlProFileId

-> UserRolesList

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

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

• urlSearchString
• urlIds
• urlProFileId
• urlSortOrder
• urlAccountUserRoleOnly
• urlPageToken
• urlSortField
• urlSubAccountId
• urlMaxResults

data UserRolesList

Retrieves a list of user roles, possibly filtered. This method supports paging.

See: userRolesList smart constructor.

Instances

Eq UserRolesList

Defined in Network.Google.Resource.DFAReporting.UserRoles.List

Methods

(==) :: UserRolesList -> UserRolesList -> Bool

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

Data UserRolesList

Defined in Network.Google.Resource.DFAReporting.UserRoles.List

Methods

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

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

toConstr :: UserRolesList -> Constr

dataTypeOf :: UserRolesList -> DataType

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

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

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

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

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

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

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

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

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

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

Show UserRolesList

Defined in Network.Google.Resource.DFAReporting.UserRoles.List

Methods

showsPrec :: Int -> UserRolesList -> ShowS

show :: UserRolesList -> String

showList :: [UserRolesList] -> ShowS

Generic UserRolesList

Defined in Network.Google.Resource.DFAReporting.UserRoles.List

Associated Types

type Rep UserRolesList :: Type -> Type

Methods

from :: UserRolesList -> Rep UserRolesList x

to :: Rep UserRolesList x -> UserRolesList

GoogleRequest UserRolesList

Defined in Network.Google.Resource.DFAReporting.UserRoles.List

Associated Types

type Rs UserRolesList :: Type

type Scopes UserRolesList :: [Symbol]

Methods

requestClient :: UserRolesList -> GClient (Rs UserRolesList)

type Rep UserRolesList

Defined in Network.Google.Resource.DFAReporting.UserRoles.List

type Rep UserRolesList = D1 (MetaData "UserRolesList" "Network.Google.Resource.DFAReporting.UserRoles.List" "gogol-dfareporting-0.4.0-9N9I1R95b3Y5YmOKldvlKw" False) (C1 (MetaCons "UserRolesList'" PrefixI True) (((S1 (MetaSel (Just "_urlSearchString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_urlIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))) :*: (S1 (MetaSel (Just "_urlProFileId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int64)) :*: S1 (MetaSel (Just "_urlSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 UserRolesListSortOrder))) :*: ((S1 (MetaSel (Just "_urlAccountUserRoleOnly") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_urlPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_urlSortField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 UserRolesListSortField) :*: (S1 (MetaSel (Just "_urlSubAccountId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64))) :*: S1 (MetaSel (Just "_urlMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int32)))))))

type Scopes UserRolesList

Defined in Network.Google.Resource.DFAReporting.UserRoles.List

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

type Rs UserRolesList

Defined in Network.Google.Resource.DFAReporting.UserRoles.List

type Rs UserRolesList = UserRolesListResponse

Request Lenses

urlSearchString :: Lens' UserRolesList (Maybe Text)

Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "userrole*2015" will return objects with names like "userrole June 2015", "userrole April 2015", or simply "userrole 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 "userrole" will match objects with name "my userrole", "userrole 2015", or simply "userrole".

urlIds :: Lens' UserRolesList [Int64]

Select only user roles with the specified IDs.

urlProFileId :: Lens' UserRolesList Int64

User profile ID associated with this request.

urlSortOrder :: Lens' UserRolesList UserRolesListSortOrder

Order of sorted results.

urlAccountUserRoleOnly :: Lens' UserRolesList (Maybe Bool)

Select only account level user roles not associated with any specific subaccount.

urlPageToken :: Lens' UserRolesList (Maybe Text)

Value of the nextPageToken from the previous result page.

urlSortField :: Lens' UserRolesList UserRolesListSortField

Field by which to sort the list.

urlSubAccountId :: Lens' UserRolesList (Maybe Int64)

Select only user roles that belong to this subaccount.

urlMaxResults :: Lens' UserRolesList Int32

Maximum number of results to return.