Google Cloud Dataflow V1beta3 Client - Class LaunchTemplateParameters (0.3.10)

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

Parameters to provide to the template being launched.

Generated from protobuf message google.dataflow.v1beta3.LaunchTemplateParameters

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ job_name string

Required. The job name to use for the created job.

↳ parameters array|Google\Protobuf\Internal\MapField

The runtime parameters to pass to the job.

↳ environment Google\Cloud\Dataflow\V1beta3\RuntimeEnvironment

The runtime environment for the job.

↳ update bool

If set, replace the existing pipeline with the name specified by jobName with this pipeline, preserving state.

↳ transform_name_mapping array|Google\Protobuf\Internal\MapField

Only applicable when updating a pipeline. Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

getJobName

Required. The job name to use for the created job.

Returns
TypeDescription
string

setJobName

Required. The job name to use for the created job.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getParameters

The runtime parameters to pass to the job.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setParameters

The runtime parameters to pass to the job.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getEnvironment

The runtime environment for the job.

Returns
TypeDescription
Google\Cloud\Dataflow\V1beta3\RuntimeEnvironment|null

hasEnvironment

clearEnvironment

setEnvironment

The runtime environment for the job.

Parameter
NameDescription
var Google\Cloud\Dataflow\V1beta3\RuntimeEnvironment
Returns
TypeDescription
$this

getUpdate

If set, replace the existing pipeline with the name specified by jobName with this pipeline, preserving state.

Returns
TypeDescription
bool

setUpdate

If set, replace the existing pipeline with the name specified by jobName with this pipeline, preserving state.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getTransformNameMapping

Only applicable when updating a pipeline. Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setTransformNameMapping

Only applicable when updating a pipeline. Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this