Google Cloud Dataflow V1beta3 Client - Class LaunchTemplateParameters (0.8.1)

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

Parameters to provide to the template being launched. Note that the metadata in the pipeline code determines which runtime parameters are valid.

Generated from protobuf message google.dataflow.v1beta3.LaunchTemplateParameters

Namespace

Google \ Cloud \ Dataflow \ V1beta3

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ job_name`	`string` Required. The job name to use for the created job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
`↳ parameters`	`array\|Google\Protobuf\Internal\MapField` The runtime parameters to pass to the job.
`↳ environment`	`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.

The name must match the regular expression [a-z]([-a-z0-9]{0,1022}[a-z0-9])?

Returns
Type	Description
`string`

setJobName

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

The name must match the regular expression [a-z]([-a-z0-9]{0,1022}[a-z0-9])?

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getParameters

The runtime parameters to pass to the job.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setParameters

The runtime parameters to pass to the job.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getEnvironment

The runtime environment for the job.

Returns
Type	Description
`RuntimeEnvironment\|null`

hasEnvironment

clearEnvironment

setEnvironment