Google Cloud Dataflow V1beta3 Client - Class LaunchFlexTemplateParameter (0.6.3)

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

Launch FlexTemplate Parameter.

Generated from protobuf message google.dataflow.v1beta3.LaunchFlexTemplateParameter

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. For update job request, job name should be same as the existing running job.

↳ container_spec Google\Cloud\Dataflow\V1beta3\ContainerSpec

Spec about the container image to launch.

↳ container_spec_gcs_path string

Cloud Storage path to a file with json serialized ContainerSpec as content.

↳ parameters array|Google\Protobuf\Internal\MapField

The parameters for FlexTemplate. Ex. {"num_workers":"5"}

↳ launch_options array|Google\Protobuf\Internal\MapField

Launch options for this flex template job. This is a common set of options across languages and templates. This should not be used to pass job parameters.

↳ environment Google\Cloud\Dataflow\V1beta3\FlexTemplateRuntimeEnvironment

The runtime environment for the FlexTemplate job

↳ update bool

Set this to true if you are sending a request to update a running streaming job. When set, the job name should be the same as the running job.

↳ transform_name_mappings array|Google\Protobuf\Internal\MapField

Use this to pass transform_name_mappings for streaming update jobs. Ex:{"oldTransformName":"newTransformName",...}'

getJobName

Required. The job name to use for the created job. For update job request, job name should be same as the existing running job.

Returns
Type Description
string

setJobName

Required. The job name to use for the created job. For update job request, job name should be same as the existing running job.

Parameter
Name Description
var string
Returns
Type Description
$this

getContainerSpec

Spec about the container image to launch.

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

hasContainerSpec

setContainerSpec

Spec about the container image to launch.

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

getContainerSpecGcsPath

Cloud Storage path to a file with json serialized ContainerSpec as content.

Returns
Type Description
string

hasContainerSpecGcsPath

setContainerSpecGcsPath

Cloud Storage path to a file with json serialized ContainerSpec as content.

Parameter
Name Description
var string
Returns
Type Description
$this

getParameters

The parameters for FlexTemplate.

Ex. {"num_workers":"5"}

Returns
Type Description
Google\Protobuf\Internal\MapField

setParameters

The parameters for FlexTemplate.

Ex. {"num_workers":"5"}

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getLaunchOptions

Launch options for this flex template job. This is a common set of options across languages and templates. This should not be used to pass job parameters.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLaunchOptions

Launch options for this flex template job. This is a common set of options across languages and templates. This should not be used to pass job parameters.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getEnvironment

The runtime environment for the FlexTemplate job

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

hasEnvironment

clearEnvironment

setEnvironment

The runtime environment for the FlexTemplate job

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

getUpdate

Set this to true if you are sending a request to update a running streaming job. When set, the job name should be the same as the running job.

Returns
Type Description
bool

setUpdate

Set this to true if you are sending a request to update a running streaming job. When set, the job name should be the same as the running job.

Parameter
Name Description
var bool
Returns
Type Description
$this

getTransformNameMappings

Use this to pass transform_name_mappings for streaming update jobs.

Ex:{"oldTransformName":"newTransformName",...}'

Returns
Type Description
Google\Protobuf\Internal\MapField

setTransformNameMappings

Use this to pass transform_name_mappings for streaming update jobs.

Ex:{"oldTransformName":"newTransformName",...}'

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getTemplate

Returns
Type Description
string