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.ScanRuns.Stop

Contents

REST Resource
Creating a Request
Request Lenses

Description

Stops a ScanRun. The stopped ScanRun is returned.

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

Synopsis

type ProjectsScanConfigsScanRunsStopResource = "v1alpha" :> (CaptureMode "name" "stop" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] StopScanRunRequest :> Post '[JSON] ScanRun))))))))
projectsScanConfigsScanRunsStop :: StopScanRunRequest -> Text -> ProjectsScanConfigsScanRunsStop
data ProjectsScanConfigsScanRunsStop
pscsrsXgafv :: Lens' ProjectsScanConfigsScanRunsStop (Maybe Xgafv)
pscsrsUploadProtocol :: Lens' ProjectsScanConfigsScanRunsStop (Maybe Text)
pscsrsAccessToken :: Lens' ProjectsScanConfigsScanRunsStop (Maybe Text)
pscsrsUploadType :: Lens' ProjectsScanConfigsScanRunsStop (Maybe Text)
pscsrsPayload :: Lens' ProjectsScanConfigsScanRunsStop StopScanRunRequest
pscsrsName :: Lens' ProjectsScanConfigsScanRunsStop Text
pscsrsCallback :: Lens' ProjectsScanConfigsScanRunsStop (Maybe Text)

REST Resource

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

A resource alias for websecurityscanner.projects.scanConfigs.scanRuns.stop method which the ProjectsScanConfigsScanRunsStop request conforms to.

Creating a Request

projectsScanConfigsScanRunsStop Source #

Arguments

:: StopScanRunRequest	`pscsrsPayload`
-> Text	`pscsrsName`
-> ProjectsScanConfigsScanRunsStop

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

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

data ProjectsScanConfigsScanRunsStop Source #

Stops a ScanRun. The stopped ScanRun is returned.

See: projectsScanConfigsScanRunsStop smart constructor.

Instances

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

Request Lenses

pscsrsXgafv :: Lens' ProjectsScanConfigsScanRunsStop (Maybe Xgafv) Source #

V1 error format.

pscsrsUploadProtocol :: Lens' ProjectsScanConfigsScanRunsStop (Maybe Text) Source #

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

pscsrsAccessToken :: Lens' ProjectsScanConfigsScanRunsStop (Maybe Text) Source #

OAuth access token.

pscsrsUploadType :: Lens' ProjectsScanConfigsScanRunsStop (Maybe Text) Source #

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

pscsrsPayload :: Lens' ProjectsScanConfigsScanRunsStop StopScanRunRequest Source #

Multipart request metadata.

pscsrsName :: Lens' ProjectsScanConfigsScanRunsStop Text Source #

Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.

pscsrsCallback :: Lens' ProjectsScanConfigsScanRunsStop (Maybe Text) Source #

JSONP