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.DialogFlow.Projects.Agent.Search

Contents

REST Resource
Creating a Request
Request Lenses

Description

Returns the list of agents. Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id "-". Refer to List Sub-Collections.

See: Dialogflow API Reference for dialogflow.projects.agent.search.

Synopsis

type ProjectsAgentSearchResource = "v2" :> (Capture "parent" Text :> ("agent:search" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] GoogleCloudDialogflowV2SearchAgentsResponse))))))))))
projectsAgentSearch :: Text -> ProjectsAgentSearch
data ProjectsAgentSearch
pasParent :: Lens' ProjectsAgentSearch Text
pasXgafv :: Lens' ProjectsAgentSearch (Maybe Xgafv)
pasUploadProtocol :: Lens' ProjectsAgentSearch (Maybe Text)
pasAccessToken :: Lens' ProjectsAgentSearch (Maybe Text)
pasUploadType :: Lens' ProjectsAgentSearch (Maybe Text)
pasPageToken :: Lens' ProjectsAgentSearch (Maybe Text)
pasPageSize :: Lens' ProjectsAgentSearch (Maybe Int32)
pasCallback :: Lens' ProjectsAgentSearch (Maybe Text)

REST Resource

type ProjectsAgentSearchResource = "v2" :> (Capture "parent" Text :> ("agent:search" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] GoogleCloudDialogflowV2SearchAgentsResponse)))))))))) Source #

A resource alias for dialogflow.projects.agent.search method which the ProjectsAgentSearch request conforms to.

Creating a Request

projectsAgentSearch Source #

Arguments

:: Text	`pasParent`
-> ProjectsAgentSearch

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

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

data ProjectsAgentSearch Source #

Returns the list of agents. Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id "-". Refer to List Sub-Collections.

See: projectsAgentSearch smart constructor.

Instances

Eq ProjectsAgentSearch Source #
Instance details Defined in Network.Google.Resource.DialogFlow.Projects.Agent.Search Methods (==) :: ProjectsAgentSearch -> ProjectsAgentSearch -> Bool # (/=) :: ProjectsAgentSearch -> ProjectsAgentSearch -> Bool #
Data ProjectsAgentSearch Source #
Instance details Defined in Network.Google.Resource.DialogFlow.Projects.Agent.Search Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProjectsAgentSearch -> c ProjectsAgentSearch # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProjectsAgentSearch # toConstr :: ProjectsAgentSearch -> Constr # dataTypeOf :: ProjectsAgentSearch -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ProjectsAgentSearch) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProjectsAgentSearch) # gmapT :: (forall b. Data b => b -> b) -> ProjectsAgentSearch -> ProjectsAgentSearch # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsAgentSearch -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsAgentSearch -> r # gmapQ :: (forall d. Data d => d -> u) -> ProjectsAgentSearch -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ProjectsAgentSearch -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProjectsAgentSearch -> m ProjectsAgentSearch # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsAgentSearch -> m ProjectsAgentSearch # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsAgentSearch -> m ProjectsAgentSearch #
Show ProjectsAgentSearch Source #
Instance details Defined in Network.Google.Resource.DialogFlow.Projects.Agent.Search Methods showsPrec :: Int -> ProjectsAgentSearch -> ShowS # show :: ProjectsAgentSearch -> String # showList :: [ProjectsAgentSearch] -> ShowS #
Generic ProjectsAgentSearch Source #
Instance details Defined in Network.Google.Resource.DialogFlow.Projects.Agent.Search Associated Types type Rep ProjectsAgentSearch :: Type -> Type # Methods from :: ProjectsAgentSearch -> Rep ProjectsAgentSearch x # to :: Rep ProjectsAgentSearch x -> ProjectsAgentSearch #
GoogleRequest ProjectsAgentSearch Source #
Instance details Defined in Network.Google.Resource.DialogFlow.Projects.Agent.Search Associated Types type Rs ProjectsAgentSearch :: Type # type Scopes ProjectsAgentSearch :: [Symbol] # Methods requestClient :: ProjectsAgentSearch -> GClient (Rs ProjectsAgentSearch) #
type Rep ProjectsAgentSearch Source #
Instance details Defined in Network.Google.Resource.DialogFlow.Projects.Agent.Search type Rep ProjectsAgentSearch = D1 (MetaData "ProjectsAgentSearch" "Network.Google.Resource.DialogFlow.Projects.Agent.Search" "gogol-dialogflow-0.4.0-LhfWFPNiwlPEL3P0xqpEYp" False) (C1 (MetaCons "ProjectsAgentSearch'" PrefixI True) (((S1 (MetaSel (Just "_pasParent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_pasXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv))) :: (S1 (MetaSel (Just "_pasUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_pasAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_pasUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_pasPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_pasPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_pasCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes ProjectsAgentSearch Source #
Instance details Defined in Network.Google.Resource.DialogFlow.Projects.Agent.Search type Scopes ProjectsAgentSearch = "https://www.googleapis.com/auth/cloud-platform" ': ("https://www.googleapis.com/auth/dialogflow" ': ([] :: [Symbol]))
type Rs ProjectsAgentSearch Source #
Instance details Defined in Network.Google.Resource.DialogFlow.Projects.Agent.Search type Rs ProjectsAgentSearch = GoogleCloudDialogflowV2SearchAgentsResponse

Request Lenses

pasParent :: Lens' ProjectsAgentSearch Text Source #

Required. The project to list agents from. Format: `projects/`.

pasXgafv :: Lens' ProjectsAgentSearch (Maybe Xgafv) Source #

V1 error format.

pasUploadProtocol :: Lens' ProjectsAgentSearch (Maybe Text) Source #

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

pasAccessToken :: Lens' ProjectsAgentSearch (Maybe Text) Source #

OAuth access token.

pasUploadType :: Lens' ProjectsAgentSearch (Maybe Text) Source #

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

pasPageToken :: Lens' ProjectsAgentSearch (Maybe Text) Source #

Optional. The next_page_token value returned from a previous list request.

pasPageSize :: Lens' ProjectsAgentSearch (Maybe Int32) Source #

Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.

pasCallback :: Lens' ProjectsAgentSearch (Maybe Text) Source #

JSONP