Google Cloud Dataflow V1beta3 Client - Class CreateJobFromTemplateRequest (0.4.1)

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

A request to create a Cloud Dataflow job from a template.

Generated from protobuf message google.dataflow.v1beta3.CreateJobFromTemplateRequest

Namespace

Google \ Cloud \ Dataflow \ V1beta3

Methods

__construct

Constructor.

Parameters
NameDescription
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.

↳ job_name string

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

↳ gcs_path string

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

↳ 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.

↳ 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
TypeDescription
string

setProjectId

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

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

getGcsPath

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

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

Returns
TypeDescription
string

hasGcsPath

setGcsPath

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

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

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

getLocation

The regional endpoint to which to direct the request.

Returns
TypeDescription
string

setLocation

The regional endpoint to which to direct the request.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTemplate

Returns
TypeDescription
string