Copyright	(c) 2015-2025 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <[email protected]> Toni Cebrián <[email protected]>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	GHC2021

Gogol.Dataflow.Projects.Templates.Launch

Contents

Resource
- Constructing a Request

Description

Launches a template. To launch a template, we recommend using projects.locations.templates.launch with a regional endpoint. Using projects.templates.launch is not recommended, because jobs launched from the template will always start in us-central1.

See: Dataflow API Reference for dataflow.projects.templates.launch.

Synopsis

type DataflowProjectsTemplatesLaunchResource = "v1b3" :> ("projects" :> (Capture "projectId" Text :> ("templates:launch" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParam "dynamicTemplate.gcsPath" Text :> (QueryParam "dynamicTemplate.stagingLocation" Text :> (QueryParam "gcsPath" Text :> (QueryParam "location" Text :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "validateOnly" Bool :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] LaunchTemplateParameters :> Post '[JSON] LaunchTemplateResponse)))))))))))))))
data DataflowProjectsTemplatesLaunch = DataflowProjectsTemplatesLaunch {
- xgafv :: Maybe Xgafv
- accessToken :: Maybe Text
- callback :: Maybe Text
- dynamicTemplateGcsPath :: Maybe Text
- dynamicTemplateStagingLocation :: Maybe Text
- gcsPath :: Maybe Text
- location :: Maybe Text
- payload :: LaunchTemplateParameters
- projectId :: Text
- uploadType :: Maybe Text
- uploadProtocol :: Maybe Text
- validateOnly :: Maybe Bool
}
newDataflowProjectsTemplatesLaunch :: LaunchTemplateParameters -> Text -> DataflowProjectsTemplatesLaunch

Resource

A resource alias for dataflow.projects.templates.launch method which the DataflowProjectsTemplatesLaunch request conforms to.

Constructing a Request

data DataflowProjectsTemplatesLaunch Source #

Launches a template. To launch a template, we recommend using projects.locations.templates.launch with a regional endpoint. Using projects.templates.launch is not recommended, because jobs launched from the template will always start in us-central1.

See: newDataflowProjectsTemplatesLaunch smart constructor.

Constructors

DataflowProjectsTemplatesLaunch

Fields

xgafv :: Maybe Xgafv
V1 error format.
accessToken :: Maybe Text
OAuth access token.
callback :: Maybe Text
JSONP
dynamicTemplateGcsPath :: Maybe Text
Path to the dynamic template specification file on Cloud Storage. The file must be a JSON serialized DynamicTemplateFileSpec object.
dynamicTemplateStagingLocation :: Maybe Text
Cloud Storage path for staging dependencies. Must be a valid Cloud Storage URL, beginning with gs://.
gcsPath :: Maybe Text
A Cloud Storage path to the template to use to create the job. Must be valid Cloud Storage URL, beginning with gs://.
location :: Maybe Text
The regional endpoint to which to direct the request.
payload :: LaunchTemplateParameters
Multipart request metadata.
projectId :: Text
Required. The ID of the Cloud Platform project that the job belongs to.
uploadType :: Maybe Text
Legacy upload protocol for media (e.g. "media", "multipart").
uploadProtocol :: Maybe Text
Upload protocol for media (e.g. "raw", "multipart").
validateOnly :: Maybe Bool
If true, the request is validated but not actually executed. Defaults to false.

Instances

Instances details

Generic DataflowProjectsTemplatesLaunch Source #

Instance details

Defined in Gogol.Dataflow.Projects.Templates.Launch

Associated Types

type Rep DataflowProjectsTemplatesLaunch

Instance details

Defined in Gogol.Dataflow.Projects.Templates.Launch

Methods

from :: DataflowProjectsTemplatesLaunch -> Rep DataflowProjectsTemplatesLaunch x #

to :: Rep DataflowProjectsTemplatesLaunch x -> DataflowProjectsTemplatesLaunch #

Show DataflowProjectsTemplatesLaunch Source #

Instance details

Defined in Gogol.Dataflow.Projects.Templates.Launch

Methods

showsPrec :: Int -> DataflowProjectsTemplatesLaunch -> ShowS #

show :: DataflowProjectsTemplatesLaunch -> String #

showList :: [DataflowProjectsTemplatesLaunch] -> ShowS #

Eq DataflowProjectsTemplatesLaunch Source #

Instance details

Defined in Gogol.Dataflow.Projects.Templates.Launch

Methods

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

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

GoogleRequest DataflowProjectsTemplatesLaunch Source #

Instance details

Defined in Gogol.Dataflow.Projects.Templates.Launch

Associated Types

type Rs DataflowProjectsTemplatesLaunch
Instance details Defined in Gogol.Dataflow.Projects.Templates.Launch type Rs DataflowProjectsTemplatesLaunch = LaunchTemplateResponse
type Scopes DataflowProjectsTemplatesLaunch
Instance details Defined in Gogol.Dataflow.Projects.Templates.Launch type Scopes DataflowProjectsTemplatesLaunch = '[CloudPlatform'FullControl, Compute'FullControl]

Methods

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

type Rep DataflowProjectsTemplatesLaunch Source #

Instance details

Defined in Gogol.Dataflow.Projects.Templates.Launch

type Rs DataflowProjectsTemplatesLaunch Source #

Instance details

Defined in Gogol.Dataflow.Projects.Templates.Launch

type Rs DataflowProjectsTemplatesLaunch = LaunchTemplateResponse

type Scopes DataflowProjectsTemplatesLaunch Source #

Instance details

Defined in Gogol.Dataflow.Projects.Templates.Launch

type Scopes DataflowProjectsTemplatesLaunch = '[CloudPlatform'FullControl, Compute'FullControl]

newDataflowProjectsTemplatesLaunch Source #

Arguments

:: LaunchTemplateParameters	Multipart request metadata. See `payload`.
-> Text	Required. The ID of the Cloud Platform project that the job belongs to. See `projectId`.
-> DataflowProjectsTemplatesLaunch

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