Google Cloud Dataflow V1beta3 Client - Class LaunchTemplateRequest (0.6.4)

Reference documentation and code samples for the Google Cloud Dataflow V1beta3 Client class LaunchTemplateRequest.

A request to launch a template.

Generated from protobuf message google.dataflow.v1beta3.LaunchTemplateRequest

Namespace

Google \ Cloud \ Dataflow \ V1beta3

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ project_id string

Required. The ID of the Cloud Platform project that the job belongs to.

↳ validate_only bool

If true, the request is validated but not actually executed. Defaults to false.

↳ gcs_path string

A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.

↳ dynamic_template Google\Cloud\Dataflow\V1beta3\DynamicTemplateLaunchParams

Params for launching a dynamic template.

↳ launch_parameters Google\Cloud\Dataflow\V1beta3\LaunchTemplateParameters

The parameters of the template to launch. This should be part of the body of the POST request.

↳ location string

The regional endpoint to which to direct the request.

getProjectId

Required. The ID of the Cloud Platform project that the job belongs to.

Returns
Type Description
string

setProjectId

Required. The ID of the Cloud Platform project that the job belongs to.

Parameter
Name Description
var string
Returns
Type Description
$this

getValidateOnly

If true, the request is validated but not actually executed.

Defaults to false.

Returns
Type Description
bool

setValidateOnly

If true, the request is validated but not actually executed.

Defaults to false.

Parameter
Name Description
var bool
Returns
Type Description
$this

getGcsPath

A Cloud Storage path to the template from which to create the job.

Must be valid Cloud Storage URL, beginning with 'gs://'.

Returns
Type Description
string

hasGcsPath

setGcsPath

A Cloud Storage path to the template from which to create the job.

Must be valid Cloud Storage URL, beginning with 'gs://'.

Parameter
Name Description
var string
Returns
Type Description
$this

getDynamicTemplate

Params for launching a dynamic template.

Returns
Type Description
Google\Cloud\Dataflow\V1beta3\DynamicTemplateLaunchParams|null

hasDynamicTemplate

setDynamicTemplate

Params for launching a dynamic template.

Parameter
Name Description
var Google\Cloud\Dataflow\V1beta3\DynamicTemplateLaunchParams
Returns
Type Description
$this

getLaunchParameters

The parameters of the template to launch. This should be part of the body of the POST request.

Returns
Type Description
Google\Cloud\Dataflow\V1beta3\LaunchTemplateParameters|null

hasLaunchParameters

clearLaunchParameters

setLaunchParameters

The parameters of the template to launch. This should be part of the body of the POST request.

Parameter
Name Description
var Google\Cloud\Dataflow\V1beta3\LaunchTemplateParameters
Returns
Type Description
$this

getLocation

The regional endpoint to which to direct the request.

Returns
Type Description
string

setLocation

The regional endpoint to which to direct the request.

Parameter
Name Description
var string
Returns
Type Description
$this

getTemplate

Returns
Type Description
string