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.Locations.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.locations.workflowTemplates.instantiate.

Synopsis

REST Resource

type ProjectsLocationsWorkflowTemplatesInstantiateResource = "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.locations.workflowTemplates.instantiate method which the ProjectsLocationsWorkflowTemplatesInstantiate request conforms to.

Creating a Request

projectsLocationsWorkflowTemplatesInstantiate Source #

Arguments

:: InstantiateWorkflowTemplateRequest

plwtiPayload

-> Text

plwtiName

-> ProjectsLocationsWorkflowTemplatesInstantiate 

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

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

data ProjectsLocationsWorkflowTemplatesInstantiate 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: projectsLocationsWorkflowTemplatesInstantiate smart constructor.

Instances
Eq ProjectsLocationsWorkflowTemplatesInstantiate Source # 
Instance details

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

Methods

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

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

Data ProjectsLocationsWorkflowTemplatesInstantiate Source # 
Instance details

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

Methods

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

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

toConstr :: ProjectsLocationsWorkflowTemplatesInstantiate -> Constr #

dataTypeOf :: ProjectsLocationsWorkflowTemplatesInstantiate -> DataType #

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

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

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

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

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

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

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

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

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

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

Show ProjectsLocationsWorkflowTemplatesInstantiate Source # 
Instance details

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

Methods

showsPrec :: Int -> ProjectsLocationsWorkflowTemplatesInstantiate -> ShowS #

show :: ProjectsLocationsWorkflowTemplatesInstantiate -> String #

showList :: [ProjectsLocationsWorkflowTemplatesInstantiate] -> ShowS #

Generic ProjectsLocationsWorkflowTemplatesInstantiate Source # 
Instance details

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

Associated Types

type Rep ProjectsLocationsWorkflowTemplatesInstantiate :: Type -> Type #

Methods

from :: ProjectsLocationsWorkflowTemplatesInstantiate -> Rep ProjectsLocationsWorkflowTemplatesInstantiate x #

to :: Rep ProjectsLocationsWorkflowTemplatesInstantiate x -> ProjectsLocationsWorkflowTemplatesInstantiate #

GoogleRequest ProjectsLocationsWorkflowTemplatesInstantiate Source # 
Instance details

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

Associated Types

type Rs ProjectsLocationsWorkflowTemplatesInstantiate :: Type #

type Scopes ProjectsLocationsWorkflowTemplatesInstantiate :: [Symbol] #

Methods

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

type Rep ProjectsLocationsWorkflowTemplatesInstantiate Source # 
Instance details

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

type Rep ProjectsLocationsWorkflowTemplatesInstantiate = D1 (MetaData "ProjectsLocationsWorkflowTemplatesInstantiate" "Network.Google.Resource.Dataproc.Projects.Locations.WorkflowTemplates.Instantiate" "gogol-dataproc-0.4.0-1udjiqosCX7iHPt6mLpl8" False) (C1 (MetaCons "ProjectsLocationsWorkflowTemplatesInstantiate'" PrefixI True) ((S1 (MetaSel (Just "_plwtiXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_plwtiUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_plwtiAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_plwtiUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_plwtiPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 InstantiateWorkflowTemplateRequest)) :*: (S1 (MetaSel (Just "_plwtiName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_plwtiCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes ProjectsLocationsWorkflowTemplatesInstantiate Source # 
Instance details

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

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

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

type Rs ProjectsLocationsWorkflowTemplatesInstantiate = Operation

Request Lenses

plwtiXgafv :: Lens' ProjectsLocationsWorkflowTemplatesInstantiate (Maybe Xgafv) Source #

V1 error format.

plwtiUploadProtocol :: Lens' ProjectsLocationsWorkflowTemplatesInstantiate (Maybe Text) Source #

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

plwtiAccessToken :: Lens' ProjectsLocationsWorkflowTemplatesInstantiate (Maybe Text) Source #

OAuth access token.

plwtiUploadType :: Lens' ProjectsLocationsWorkflowTemplatesInstantiate (Maybe Text) Source #

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

plwtiPayload :: Lens' ProjectsLocationsWorkflowTemplatesInstantiate InstantiateWorkflowTemplateRequest Source #

Multipart request metadata.

plwtiName :: Lens' ProjectsLocationsWorkflowTemplatesInstantiate 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}

plwtiCallback :: Lens' ProjectsLocationsWorkflowTemplatesInstantiate (Maybe Text) Source #

JSONP