Google Cloud Talent Solution V4 Client - Class PurgeJobsResponse (1.3.3)

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

The result of JobService.PurgeJobs. It's used to replace google.longrunning.Operation.response in case of success.

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

Namespace

Google \ Cloud \ Talent \ V4

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ purge_count int

The number of jobs that this request deleted (or, if force is false, the number of jobs that will be deleted). Note: This number isn't guaranteed to be accurate. Note: This number might change until operation status is FINISHED, FAILED or CANCELLED.
↳ purge_sample string[]

A sample of the resource names of jobs that will be deleted. Only populated if force is set to false. At most 100 job names are returned as a sample.
↳ job_results array<Google\Cloud\Talent\V4\JobResult>

List of job purge results from a purge jobs operation. Only populated if force is set to true. Note: This may change until operation status is FINISHED, FAILED or CANCELLED.

getPurgeCount

The number of jobs that this request deleted (or, if force is false, the number of jobs that will be deleted).

Note: This number isn't guaranteed to be accurate. Note: This number might change until operation status is FINISHED, FAILED or CANCELLED.

Returns
Type Description
int

setPurgeCount

The number of jobs that this request deleted (or, if force is false, the number of jobs that will be deleted).

Note: This number isn't guaranteed to be accurate. Note: This number might change until operation status is FINISHED, FAILED or CANCELLED.

Parameter
Name Description
var int
Returns
Type Description
$this

getPurgeSample

A sample of the resource names of jobs that will be deleted.

Only populated if force is set to false. At most 100 job names are returned as a sample.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setPurgeSample

A sample of the resource names of jobs that will be deleted.

Only populated if force is set to false. At most 100 job names are returned as a sample.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getJobResults

List of job purge results from a purge jobs operation.

Only populated if force is set to true. Note: This may change until operation status is FINISHED, FAILED or CANCELLED.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setJobResults

List of job purge results from a purge jobs operation.

Only populated if force is set to true. Note: This may change until operation status is FINISHED, FAILED or CANCELLED.

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