gogol-dataproc-0.4.0: Google Cloud Dataproc SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.Dataproc.Projects.Regions.WorkflowTemplates.Instantiate

Contents

Description

Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty.

See: Cloud Dataproc API Reference for dataproc.projects.regions.workflowTemplates.instantiate.

Synopsis

REST Resource

type ProjectsRegionsWorkflowTemplatesInstantiateResource = "v1" :> (CaptureMode "name" "instantiate" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] InstantiateWorkflowTemplateRequest :> Post '[JSON] Operation)))))))) Source #

A resource alias for dataproc.projects.regions.workflowTemplates.instantiate method which the ProjectsRegionsWorkflowTemplatesInstantiate request conforms to.

Creating a Request

projectsRegionsWorkflowTemplatesInstantiate Source #

Arguments

:: InstantiateWorkflowTemplateRequest

prwtiPayload

-> Text

prwtiName

-> ProjectsRegionsWorkflowTemplatesInstantiate 

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

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

data ProjectsRegionsWorkflowTemplatesInstantiate Source #

Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty.

See: projectsRegionsWorkflowTemplatesInstantiate smart constructor.

Instances
Eq ProjectsRegionsWorkflowTemplatesInstantiate Source # 
Instance details

Defined in Network.Google.Resource.Dataproc.Projects.Regions.WorkflowTemplates.Instantiate

Methods

(==) :: ProjectsRegionsWorkflowTemplatesInstantiate -> ProjectsRegionsWorkflowTemplatesInstantiate -> Bool #

(/=) :: ProjectsRegionsWorkflowTemplatesInstantiate -> ProjectsRegionsWorkflowTemplatesInstantiate -> Bool #

Data ProjectsRegionsWorkflowTemplatesInstantiate Source # 
Instance details

Defined in Network.Google.Resource.Dataproc.Projects.Regions.WorkflowTemplates.Instantiate

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProjectsRegionsWorkflowTemplatesInstantiate -> c ProjectsRegionsWorkflowTemplatesInstantiate #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProjectsRegionsWorkflowTemplatesInstantiate #

toConstr :: ProjectsRegionsWorkflowTemplatesInstantiate -> Constr #

dataTypeOf :: ProjectsRegionsWorkflowTemplatesInstantiate -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ProjectsRegionsWorkflowTemplatesInstantiate) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProjectsRegionsWorkflowTemplatesInstantiate) #

gmapT :: (forall b. Data b => b -> b) -> ProjectsRegionsWorkflowTemplatesInstantiate -> ProjectsRegionsWorkflowTemplatesInstantiate #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsRegionsWorkflowTemplatesInstantiate -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsRegionsWorkflowTemplatesInstantiate -> r #

gmapQ :: (forall d. Data d => d -> u) -> ProjectsRegionsWorkflowTemplatesInstantiate -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ProjectsRegionsWorkflowTemplatesInstantiate -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProjectsRegionsWorkflowTemplatesInstantiate -> m ProjectsRegionsWorkflowTemplatesInstantiate #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsRegionsWorkflowTemplatesInstantiate -> m ProjectsRegionsWorkflowTemplatesInstantiate #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsRegionsWorkflowTemplatesInstantiate -> m ProjectsRegionsWorkflowTemplatesInstantiate #

Show ProjectsRegionsWorkflowTemplatesInstantiate Source # 
Instance details

Defined in Network.Google.Resource.Dataproc.Projects.Regions.WorkflowTemplates.Instantiate

Methods

showsPrec :: Int -> ProjectsRegionsWorkflowTemplatesInstantiate -> ShowS #

show :: ProjectsRegionsWorkflowTemplatesInstantiate -> String #

showList :: [ProjectsRegionsWorkflowTemplatesInstantiate] -> ShowS #

Generic ProjectsRegionsWorkflowTemplatesInstantiate Source # 
Instance details

Defined in Network.Google.Resource.Dataproc.Projects.Regions.WorkflowTemplates.Instantiate

Associated Types

type Rep ProjectsRegionsWorkflowTemplatesInstantiate :: Type -> Type #

Methods

from :: ProjectsRegionsWorkflowTemplatesInstantiate -> Rep ProjectsRegionsWorkflowTemplatesInstantiate x #

to :: Rep ProjectsRegionsWorkflowTemplatesInstantiate x -> ProjectsRegionsWorkflowTemplatesInstantiate #

GoogleRequest ProjectsRegionsWorkflowTemplatesInstantiate Source # 
Instance details

Defined in Network.Google.Resource.Dataproc.Projects.Regions.WorkflowTemplates.Instantiate

Associated Types

type Rs ProjectsRegionsWorkflowTemplatesInstantiate :: Type #

type Scopes ProjectsRegionsWorkflowTemplatesInstantiate :: [Symbol] #

Methods

requestClient :: ProjectsRegionsWorkflowTemplatesInstantiate -> GClient (Rs ProjectsRegionsWorkflowTemplatesInstantiate) #

type Rep ProjectsRegionsWorkflowTemplatesInstantiate Source # 
Instance details

Defined in Network.Google.Resource.Dataproc.Projects.Regions.WorkflowTemplates.Instantiate

type Rep ProjectsRegionsWorkflowTemplatesInstantiate = D1 (MetaData "ProjectsRegionsWorkflowTemplatesInstantiate" "Network.Google.Resource.Dataproc.Projects.Regions.WorkflowTemplates.Instantiate" "gogol-dataproc-0.4.0-1udjiqosCX7iHPt6mLpl8" False) (C1 (MetaCons "ProjectsRegionsWorkflowTemplatesInstantiate'" PrefixI True) ((S1 (MetaSel (Just "_prwtiXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_prwtiUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_prwtiAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_prwtiUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_prwtiPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 InstantiateWorkflowTemplateRequest)) :*: (S1 (MetaSel (Just "_prwtiName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_prwtiCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes ProjectsRegionsWorkflowTemplatesInstantiate Source # 
Instance details

Defined in Network.Google.Resource.Dataproc.Projects.Regions.WorkflowTemplates.Instantiate

type Scopes ProjectsRegionsWorkflowTemplatesInstantiate = "https://www.googleapis.com/auth/cloud-platform" ': ([] :: [Symbol])
type Rs ProjectsRegionsWorkflowTemplatesInstantiate Source # 
Instance details

Defined in Network.Google.Resource.Dataproc.Projects.Regions.WorkflowTemplates.Instantiate

type Rs ProjectsRegionsWorkflowTemplatesInstantiate = Operation

Request Lenses

prwtiXgafv :: Lens' ProjectsRegionsWorkflowTemplatesInstantiate (Maybe Xgafv) Source #

V1 error format.

prwtiUploadProtocol :: Lens' ProjectsRegionsWorkflowTemplatesInstantiate (Maybe Text) Source #

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

prwtiAccessToken :: Lens' ProjectsRegionsWorkflowTemplatesInstantiate (Maybe Text) Source #

OAuth access token.

prwtiUploadType :: Lens' ProjectsRegionsWorkflowTemplatesInstantiate (Maybe Text) Source #

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

prwtiPayload :: Lens' ProjectsRegionsWorkflowTemplatesInstantiate InstantiateWorkflowTemplateRequest Source #

Multipart request metadata.

prwtiName :: Lens' ProjectsRegionsWorkflowTemplatesInstantiate Text Source #

Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}

prwtiCallback :: Lens' ProjectsRegionsWorkflowTemplatesInstantiate (Maybe Text) Source #

JSONP