Google Cloud Talent Solution V4 Client - Class BatchUpdateJobsRequest (2.0.0-RC1)

Reference documentation and code samples for the Google Cloud Talent Solution V4 Client class BatchUpdateJobsRequest.

Request to update a batch of jobs.

Generated from protobuf message google.cloud.talent.v4.BatchUpdateJobsRequest

Namespace

Google \ Cloud \ Talent \ V4

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The resource name of the tenant under which the job is created. The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenants/bar".
↳ jobs array<Google\Cloud\Talent\V4\Job>

Required. The jobs to be updated. A maximum of 200 jobs can be updated in a batch.
↳ update_mask Google\Protobuf\FieldMask

Strongly recommended for the best service experience. Be aware that it will also increase latency when checking the status of a batch operation. If update_mask is provided, only the specified fields in Job are updated. Otherwise all the fields are updated. A field mask to restrict the fields that are updated. Only top level fields of Job are supported. If update_mask is provided, The Job inside JobResult will only contains fields that is updated, plus the Id of the Job. Otherwise, Job will include all fields, which can yield a very large response.

getParent

Required. The resource name of the tenant under which the job is created.

The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenants/bar".

Returns
Type Description
string

setParent

Required. The resource name of the tenant under which the job is created.

The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenants/bar".

Parameter
Name Description
var string
Returns
Type Description
$this

getJobs

Required. The jobs to be updated.

A maximum of 200 jobs can be updated in a batch.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setJobs

Required. The jobs to be updated.

A maximum of 200 jobs can be updated in a batch.

Parameter
Name Description
var array<Google\Cloud\Talent\V4\Job>
Returns
Type Description
$this

getUpdateMask

Strongly recommended for the best service experience. Be aware that it will also increase latency when checking the status of a batch operation.

If update_mask is provided, only the specified fields in Job are updated. Otherwise all the fields are updated. A field mask to restrict the fields that are updated. Only top level fields of Job are supported. If update_mask is provided, The Job inside JobResult will only contains fields that is updated, plus the Id of the Job. Otherwise, Job will include all fields, which can yield a very large response.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Strongly recommended for the best service experience. Be aware that it will also increase latency when checking the status of a batch operation.

If update_mask is provided, only the specified fields in Job are updated. Otherwise all the fields are updated. A field mask to restrict the fields that are updated. Only top level fields of Job are supported. If update_mask is provided, The Job inside JobResult will only contains fields that is updated, plus the Id of the Job. Otherwise, Job will include all fields, which can yield a very large response.

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. The resource name of the tenant under which the job is created.

The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenants/bar". Please see Google\Cloud\Talent\V4\JobServiceClient::tenantName() for help formatting this field.
jobs array<Google\Cloud\Talent\V4\Job>

Required. The jobs to be updated. A maximum of 200 jobs can be updated in a batch.
Returns
Type Description
Google\Cloud\Talent\V4\BatchUpdateJobsRequest