Reference documentation and code samples for the Google Cloud Dataproc V1 Client class UpdateJobRequest.
A request to update a job.
Generated from protobuf message google.cloud.dataproc.v1.UpdateJobRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ project_id |
string
Required. The ID of the Google Cloud Platform project that the job belongs to. |
↳ region |
string
Required. The Dataproc region in which to handle the request. |
↳ job_id |
string
Required. The job ID. |
↳ job |
Google\Cloud\Dataproc\V1\Job
Required. The changes to the job. |
↳ update_mask |
Google\Protobuf\FieldMask
Required. Specifies the path, relative to |
getProjectId
Required. The ID of the Google Cloud Platform project that the job belongs to.
Generated from protobuf field string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setProjectId
Required. The ID of the Google Cloud Platform project that the job belongs to.
Generated from protobuf field string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRegion
Required. The Dataproc region in which to handle the request.
Generated from protobuf field string region = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setRegion
Required. The Dataproc region in which to handle the request.
Generated from protobuf field string region = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getJobId
Required. The job ID.
Generated from protobuf field string job_id = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setJobId
Required. The job ID.
Generated from protobuf field string job_id = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getJob
Required. The changes to the job.
Generated from protobuf field .google.cloud.dataproc.v1.Job job = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataproc\V1\Job|null | |
hasJob
clearJob
setJob
Required. The changes to the job.
Generated from protobuf field .google.cloud.dataproc.v1.Job job = 4 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataproc\V1\Job
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateMask
Required. Specifies the path, relative to Job, of
the field to update. For example, to update the labels of a Job the
update_mask parameter would be specified as
labels, and the PATCH request body would specify the new
value. Note: Currently, labels is the only
field that can be updated.
Generated from protobuf field .google.protobuf.FieldMask update_mask = 5 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\FieldMask|null | |
hasUpdateMask
clearUpdateMask
setUpdateMask
Required. Specifies the path, relative to Job, of
the field to update. For example, to update the labels of a Job the
update_mask parameter would be specified as
labels, and the PATCH request body would specify the new
value. Note: Currently, labels is the only
field that can be updated.
Generated from protobuf field .google.protobuf.FieldMask update_mask = 5 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\FieldMask
|
| Returns | |
|---|---|
| Type | Description |
$this | |