Reference documentation and code samples for the Google Cloud Dataflow V1beta3 Client class UpdateJobRequest.
Request to update a Cloud Dataflow job.
Generated from protobuf message google.dataflow.v1beta3.UpdateJobRequest
Namespace
Google \ Cloud \ Dataflow \ V1beta3Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ project_id |
string
The ID of the Cloud Platform project that the job belongs to. |
↳ job_id |
string
The job ID. |
↳ job |
Job
The updated job. Only the job state is updatable; other fields will be ignored. |
↳ location |
string
The regional endpoint that contains this job. |
↳ update_mask |
Google\Protobuf\FieldMask
The list of fields to update relative to Job. If empty, only RequestedJobState will be considered for update. If the FieldMask is not empty and RequestedJobState is none/empty, The fields specified in the update mask will be the only ones considered for update. If both RequestedJobState and update_mask are specified, an error will be returned as we cannot update both state and mask. |
getProjectId
The ID of the Cloud Platform project that the job belongs to.
| Returns | |
|---|---|
| Type | Description |
string |
|
setProjectId
The ID of the Cloud Platform project that the job belongs to.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getJobId
The job ID.
| Returns | |
|---|---|
| Type | Description |
string |
|
setJobId
The job ID.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getJob
The updated job.
Only the job state is updatable; other fields will be ignored.
| Returns | |
|---|---|
| Type | Description |
Job|null |
|
hasJob
clearJob
setJob
The updated job.
Only the job state is updatable; other fields will be ignored.
| Parameter | |
|---|---|
| Name | Description |
var |
Job
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLocation
The regional endpoint that contains this job.
| Returns | |
|---|---|
| Type | Description |
string |
|
setLocation
The regional endpoint that contains this job.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateMask
The list of fields to update relative to Job. If empty, only RequestedJobState will be considered for update. If the FieldMask is not empty and RequestedJobState is none/empty, The fields specified in the update mask will be the only ones considered for update. If both RequestedJobState and update_mask are specified, an error will be returned as we cannot update both state and mask.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\FieldMask|null |
|
hasUpdateMask
clearUpdateMask
setUpdateMask
The list of fields to update relative to Job. If empty, only RequestedJobState will be considered for update. If the FieldMask is not empty and RequestedJobState is none/empty, The fields specified in the update mask will be the only ones considered for update. If both RequestedJobState and update_mask are specified, an error will be returned as we cannot update both state and mask.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\FieldMask
|
| Returns | |
|---|---|
| Type | Description |
$this |
|