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.WebSecurityScanner.Projects.ScanConfigs.Start

Contents

REST Resource
Creating a Request
Request Lenses

Description

Start a ScanRun according to the given ScanConfig.

See: Web Security Scanner API Reference for websecurityscanner.projects.scanConfigs.start.

Synopsis

type ProjectsScanConfigsStartResource = "v1alpha" :> (CaptureMode "name" "start" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] StartScanRunRequest :> Post '[JSON] ScanRun))))))))
projectsScanConfigsStart :: StartScanRunRequest -> Text -> ProjectsScanConfigsStart
data ProjectsScanConfigsStart
pscsXgafv :: Lens' ProjectsScanConfigsStart (Maybe Xgafv)
pscsUploadProtocol :: Lens' ProjectsScanConfigsStart (Maybe Text)
pscsAccessToken :: Lens' ProjectsScanConfigsStart (Maybe Text)
pscsUploadType :: Lens' ProjectsScanConfigsStart (Maybe Text)
pscsPayload :: Lens' ProjectsScanConfigsStart StartScanRunRequest
pscsName :: Lens' ProjectsScanConfigsStart Text
pscsCallback :: Lens' ProjectsScanConfigsStart (Maybe Text)

REST Resource

type ProjectsScanConfigsStartResource = "v1alpha" :> (CaptureMode "name" "start" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] StartScanRunRequest :> Post '[JSON] ScanRun)))))))) Source #

A resource alias for websecurityscanner.projects.scanConfigs.start method which the ProjectsScanConfigsStart request conforms to.

Creating a Request

projectsScanConfigsStart Source #

Arguments

:: StartScanRunRequest	`pscsPayload`
-> Text	`pscsName`
-> ProjectsScanConfigsStart

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

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

data ProjectsScanConfigsStart Source #

Start a ScanRun according to the given ScanConfig.

See: projectsScanConfigsStart smart constructor.

Instances

Eq ProjectsScanConfigsStart Source #
Instance details Defined in Network.Google.Resource.WebSecurityScanner.Projects.ScanConfigs.Start Methods (==) :: ProjectsScanConfigsStart -> ProjectsScanConfigsStart -> Bool # (/=) :: ProjectsScanConfigsStart -> ProjectsScanConfigsStart -> Bool #
Data ProjectsScanConfigsStart Source #
Instance details Defined in Network.Google.Resource.WebSecurityScanner.Projects.ScanConfigs.Start Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProjectsScanConfigsStart -> c ProjectsScanConfigsStart # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProjectsScanConfigsStart # toConstr :: ProjectsScanConfigsStart -> Constr # dataTypeOf :: ProjectsScanConfigsStart -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ProjectsScanConfigsStart) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProjectsScanConfigsStart) # gmapT :: (forall b. Data b => b -> b) -> ProjectsScanConfigsStart -> ProjectsScanConfigsStart # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsScanConfigsStart -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsScanConfigsStart -> r # gmapQ :: (forall d. Data d => d -> u) -> ProjectsScanConfigsStart -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ProjectsScanConfigsStart -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProjectsScanConfigsStart -> m ProjectsScanConfigsStart # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsScanConfigsStart -> m ProjectsScanConfigsStart # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsScanConfigsStart -> m ProjectsScanConfigsStart #
Show ProjectsScanConfigsStart Source #
Instance details Defined in Network.Google.Resource.WebSecurityScanner.Projects.ScanConfigs.Start Methods showsPrec :: Int -> ProjectsScanConfigsStart -> ShowS # show :: ProjectsScanConfigsStart -> String # showList :: [ProjectsScanConfigsStart] -> ShowS #
Generic ProjectsScanConfigsStart Source #
Instance details Defined in Network.Google.Resource.WebSecurityScanner.Projects.ScanConfigs.Start Associated Types type Rep ProjectsScanConfigsStart :: Type -> Type # Methods from :: ProjectsScanConfigsStart -> Rep ProjectsScanConfigsStart x # to :: Rep ProjectsScanConfigsStart x -> ProjectsScanConfigsStart #
GoogleRequest ProjectsScanConfigsStart Source #
Instance details Defined in Network.Google.Resource.WebSecurityScanner.Projects.ScanConfigs.Start Associated Types type Rs ProjectsScanConfigsStart :: Type # type Scopes ProjectsScanConfigsStart :: [Symbol] # Methods requestClient :: ProjectsScanConfigsStart -> GClient (Rs ProjectsScanConfigsStart) #
type Rep ProjectsScanConfigsStart Source #
Instance details Defined in Network.Google.Resource.WebSecurityScanner.Projects.ScanConfigs.Start type Rep ProjectsScanConfigsStart = D1 (MetaData "ProjectsScanConfigsStart" "Network.Google.Resource.WebSecurityScanner.Projects.ScanConfigs.Start" "gogol-websecurityscanner-0.4.0-JQyQ1sCwOLo6vYn7QejFAT" False) (C1 (MetaCons "ProjectsScanConfigsStart'" PrefixI True) ((S1 (MetaSel (Just "_pscsXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_pscsUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_pscsAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_pscsUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_pscsPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 StartScanRunRequest)) :: (S1 (MetaSel (Just "_pscsName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_pscsCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes ProjectsScanConfigsStart Source #
Instance details Defined in Network.Google.Resource.WebSecurityScanner.Projects.ScanConfigs.Start type Scopes ProjectsScanConfigsStart = "https://www.googleapis.com/auth/cloud-platform" ': ([] :: [Symbol])
type Rs ProjectsScanConfigsStart Source #
Instance details Defined in Network.Google.Resource.WebSecurityScanner.Projects.ScanConfigs.Start type Rs ProjectsScanConfigsStart = ScanRun

Request Lenses

pscsXgafv :: Lens' ProjectsScanConfigsStart (Maybe Xgafv) Source #

V1 error format.

pscsUploadProtocol :: Lens' ProjectsScanConfigsStart (Maybe Text) Source #

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

pscsAccessToken :: Lens' ProjectsScanConfigsStart (Maybe Text) Source #

OAuth access token.

pscsUploadType :: Lens' ProjectsScanConfigsStart (Maybe Text) Source #

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

pscsPayload :: Lens' ProjectsScanConfigsStart StartScanRunRequest Source #

Multipart request metadata.

pscsName :: Lens' ProjectsScanConfigsStart Text Source #

Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.

pscsCallback :: Lens' ProjectsScanConfigsStart (Maybe Text) Source #

JSONP