Google Cloud Dataproc V1 Client - Class UpdateJobRequest (3.12.0)

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

Namespace

Google \ Cloud \ Dataproc \ V1

Methods

__construct

Constructor.

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

getProjectId

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

Returns
TypeDescription
string

setProjectId

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRegion

Required. The Dataproc region in which to handle the request.

Returns
TypeDescription
string

setRegion

Required. The Dataproc region in which to handle the request.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getJobId

Required. The job ID.

Returns
TypeDescription
string

setJobId

Required. The job ID.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getJob

Required. The changes to the job.

Returns
TypeDescription
Google\Cloud\Dataproc\V1\Job|null

hasJob

clearJob

setJob

Required. The changes to the job.

Parameter
NameDescription
var Google\Cloud\Dataproc\V1\Job
Returns
TypeDescription
$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.

Returns
TypeDescription
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.

Parameter
NameDescription
var Google\Protobuf\FieldMask
Returns
TypeDescription
$this