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.BigQuery.Jobs.Cancel

Contents

REST Resource
Creating a Request
Request Lenses

Description

Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs.

See: BigQuery API Reference for bigquery.jobs.cancel.

Synopsis

type JobsCancelResource = "bigquery" :> ("v2" :> ("projects" :> (Capture "projectId" Text :> ("jobs" :> (Capture "jobId" Text :> ("cancel" :> (QueryParam "location" Text :> (QueryParam "alt" AltJSON :> Post '[JSON] JobCancelResponse))))))))
jobsCancel :: Text -> Text -> JobsCancel
data JobsCancel
jcJobId :: Lens' JobsCancel Text
jcLocation :: Lens' JobsCancel (Maybe Text)
jcProjectId :: Lens' JobsCancel Text

REST Resource

type JobsCancelResource = "bigquery" :> ("v2" :> ("projects" :> (Capture "projectId" Text :> ("jobs" :> (Capture "jobId" Text :> ("cancel" :> (QueryParam "location" Text :> (QueryParam "alt" AltJSON :> Post '[JSON] JobCancelResponse)))))))) Source #

A resource alias for bigquery.jobs.cancel method which the JobsCancel request conforms to.

Creating a Request

jobsCancel Source #

Arguments

:: Text	`jcJobId`
-> Text	`jcProjectId`
-> JobsCancel

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

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

data JobsCancel Source #

Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs.

See: jobsCancel smart constructor.

Instances

Eq JobsCancel Source #
Instance details Defined in Network.Google.Resource.BigQuery.Jobs.Cancel Methods (==) :: JobsCancel -> JobsCancel -> Bool # (/=) :: JobsCancel -> JobsCancel -> Bool #
Data JobsCancel Source #
Instance details Defined in Network.Google.Resource.BigQuery.Jobs.Cancel Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> JobsCancel -> c JobsCancel # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c JobsCancel # toConstr :: JobsCancel -> Constr # dataTypeOf :: JobsCancel -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c JobsCancel) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c JobsCancel) # gmapT :: (forall b. Data b => b -> b) -> JobsCancel -> JobsCancel # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> JobsCancel -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> JobsCancel -> r # gmapQ :: (forall d. Data d => d -> u) -> JobsCancel -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> JobsCancel -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> JobsCancel -> m JobsCancel # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> JobsCancel -> m JobsCancel # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> JobsCancel -> m JobsCancel #
Show JobsCancel Source #
Instance details Defined in Network.Google.Resource.BigQuery.Jobs.Cancel Methods showsPrec :: Int -> JobsCancel -> ShowS # show :: JobsCancel -> String # showList :: [JobsCancel] -> ShowS #
Generic JobsCancel Source #
Instance details Defined in Network.Google.Resource.BigQuery.Jobs.Cancel Associated Types type Rep JobsCancel :: Type -> Type # Methods from :: JobsCancel -> Rep JobsCancel x # to :: Rep JobsCancel x -> JobsCancel #
GoogleRequest JobsCancel Source #
Instance details Defined in Network.Google.Resource.BigQuery.Jobs.Cancel Associated Types type Rs JobsCancel :: Type # type Scopes JobsCancel :: [Symbol] # Methods requestClient :: JobsCancel -> GClient (Rs JobsCancel) #
type Rep JobsCancel Source #
Instance details Defined in Network.Google.Resource.BigQuery.Jobs.Cancel type Rep JobsCancel = D1 (MetaData "JobsCancel" "Network.Google.Resource.BigQuery.Jobs.Cancel" "gogol-bigquery-0.4.0-3wbQXUDNgiIGV0tYGk98l5" False) (C1 (MetaCons "JobsCancel'" PrefixI True) (S1 (MetaSel (Just "_jcJobId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: (S1 (MetaSel (Just "_jcLocation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_jcProjectId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Scopes JobsCancel Source #
Instance details Defined in Network.Google.Resource.BigQuery.Jobs.Cancel type Scopes JobsCancel = "https://www.googleapis.com/auth/bigquery" ': ("https://www.googleapis.com/auth/cloud-platform" ': ([] :: [Symbol]))
type Rs JobsCancel Source #
Instance details Defined in Network.Google.Resource.BigQuery.Jobs.Cancel type Rs JobsCancel = JobCancelResponse

Request Lenses

jcJobId :: Lens' JobsCancel Text Source #

Required: Job ID of the job to cancel

jcLocation :: Lens' JobsCancel (Maybe Text) Source #

The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.

jcProjectId :: Lens' JobsCancel Text Source #

Required: Project ID of the job to cancel