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
Namespace
Google \ Cloud \ Dataflow \ V1beta3Methods
__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. |
↳ 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 | |
|---|---|
| Type | Description |
string |
|
setJobName
Required. The job name to use for the created job.
| 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 |
Google\Cloud\Dataflow\V1beta3\RuntimeEnvironment|null |
|
hasEnvironment
clearEnvironment
setEnvironment
The runtime environment for the job.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataflow\V1beta3\RuntimeEnvironment
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdate
If set, replace the existing pipeline with the name specified by jobName with this pipeline, preserving state.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setUpdate
If set, replace the existing pipeline with the name specified by jobName with this pipeline, preserving state.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|