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
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 |
↳ 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 | |
|---|---|
| Type | Description |
string | |
setProjectId
Required. The ID of the Cloud Platform project that the job belongs to.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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 | |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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 | |
getLocation
The regional endpoint to which to direct the request.
| Returns | |
|---|---|
| Type | Description |
string | |
setLocation
The regional endpoint to which to direct the request.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTemplate
| Returns | |
|---|---|
| Type | Description |
string | |