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.Genomics.Pipelines.Run

Contents

REST Resource
Creating a Request
Request Lenses

Description

Runs a pipeline. **Note:** Before you can use this method, the Genomics Service Agent must have access to your project. This is done automatically when the Cloud Genomics API is first enabled, but if you delete this permission, or if you enabled the Cloud Genomics API before the v2alpha1 API launch, you must disable and re-enable the API to grant the Genomics Service Agent the required permissions. Authorization requires the following Google IAM permission: * `genomics.operations.create` [1]: /genomics/gsa

See: Genomics API Reference for genomics.pipelines.run.

Synopsis

type PipelinesRunResource = "v2alpha1" :> ("pipelines:run" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] RunPipelineRequest :> Post '[JSON] Operation))))))))
pipelinesRun :: RunPipelineRequest -> PipelinesRun
data PipelinesRun
prXgafv :: Lens' PipelinesRun (Maybe Xgafv)
prUploadProtocol :: Lens' PipelinesRun (Maybe Text)
prAccessToken :: Lens' PipelinesRun (Maybe Text)
prUploadType :: Lens' PipelinesRun (Maybe Text)
prPayload :: Lens' PipelinesRun RunPipelineRequest
prCallback :: Lens' PipelinesRun (Maybe Text)

REST Resource

type PipelinesRunResource = "v2alpha1" :> ("pipelines:run" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] RunPipelineRequest :> Post '[JSON] Operation)))))))) Source #

A resource alias for genomics.pipelines.run method which the PipelinesRun request conforms to.

Creating a Request

pipelinesRun Source #

Arguments

:: RunPipelineRequest	`prPayload`
-> PipelinesRun

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

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

data PipelinesRun Source #

Runs a pipeline. **Note:** Before you can use this method, the Genomics Service Agent must have access to your project. This is done automatically when the Cloud Genomics API is first enabled, but if you delete this permission, or if you enabled the Cloud Genomics API before the v2alpha1 API launch, you must disable and re-enable the API to grant the Genomics Service Agent the required permissions. Authorization requires the following Google IAM permission: * `genomics.operations.create` [1]: /genomics/gsa

See: pipelinesRun smart constructor.

Instances

Eq PipelinesRun Source #
Instance details Defined in Network.Google.Resource.Genomics.Pipelines.Run Methods (==) :: PipelinesRun -> PipelinesRun -> Bool # (/=) :: PipelinesRun -> PipelinesRun -> Bool #
Data PipelinesRun Source #
Instance details Defined in Network.Google.Resource.Genomics.Pipelines.Run Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PipelinesRun -> c PipelinesRun # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PipelinesRun # toConstr :: PipelinesRun -> Constr # dataTypeOf :: PipelinesRun -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PipelinesRun) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PipelinesRun) # gmapT :: (forall b. Data b => b -> b) -> PipelinesRun -> PipelinesRun # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PipelinesRun -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PipelinesRun -> r # gmapQ :: (forall d. Data d => d -> u) -> PipelinesRun -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> PipelinesRun -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PipelinesRun -> m PipelinesRun # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PipelinesRun -> m PipelinesRun # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PipelinesRun -> m PipelinesRun #
Show PipelinesRun Source #
Instance details Defined in Network.Google.Resource.Genomics.Pipelines.Run Methods showsPrec :: Int -> PipelinesRun -> ShowS # show :: PipelinesRun -> String # showList :: [PipelinesRun] -> ShowS #
Generic PipelinesRun Source #
Instance details Defined in Network.Google.Resource.Genomics.Pipelines.Run Associated Types type Rep PipelinesRun :: Type -> Type # Methods from :: PipelinesRun -> Rep PipelinesRun x # to :: Rep PipelinesRun x -> PipelinesRun #
GoogleRequest PipelinesRun Source #
Instance details Defined in Network.Google.Resource.Genomics.Pipelines.Run Associated Types type Rs PipelinesRun :: Type # type Scopes PipelinesRun :: [Symbol] # Methods requestClient :: PipelinesRun -> GClient (Rs PipelinesRun) #
type Rep PipelinesRun Source #
Instance details Defined in Network.Google.Resource.Genomics.Pipelines.Run type Rep PipelinesRun = D1 (MetaData "PipelinesRun" "Network.Google.Resource.Genomics.Pipelines.Run" "gogol-genomics-0.4.0-63oTcGDCcdz79Wan6imH0i" False) (C1 (MetaCons "PipelinesRun'" PrefixI True) ((S1 (MetaSel (Just "_prXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_prUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_prAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 (MetaSel (Just "_prUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_prPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 RunPipelineRequest) :*: S1 (MetaSel (Just "_prCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes PipelinesRun Source #
Instance details Defined in Network.Google.Resource.Genomics.Pipelines.Run type Scopes PipelinesRun = "https://www.googleapis.com/auth/cloud-platform" ': ("https://www.googleapis.com/auth/genomics" ': ([] :: [Symbol]))
type Rs PipelinesRun Source #
Instance details Defined in Network.Google.Resource.Genomics.Pipelines.Run type Rs PipelinesRun = Operation

Request Lenses

prXgafv :: Lens' PipelinesRun (Maybe Xgafv) Source #

V1 error format.

prUploadProtocol :: Lens' PipelinesRun (Maybe Text) Source #

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

prAccessToken :: Lens' PipelinesRun (Maybe Text) Source #

OAuth access token.

prUploadType :: Lens' PipelinesRun (Maybe Text) Source #

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

prPayload :: Lens' PipelinesRun RunPipelineRequest Source #

Multipart request metadata.

prCallback :: Lens' PipelinesRun (Maybe Text) Source #

JSONP