Google Cloud Talent Solution V4 Client - Class PurgeJobsRequest (1.0.5)

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

Request to purge a set of jobs.

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The resource name of the project under which the jobs should be deleted. The format is "projects/{project_id}". For example, "projects/foo".

↳ filter string

Required. A filter matching the jobs to be purged. The filter can be one of the following three parent resources. 1. Company. Resource name of the company under which all the jobs should be deleted. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}". For example, "projects/foo/tenants/bar/companies/baz" 2. Tenant. Resource name of the tenant under which all the jobs should be deleted. The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenants/bar". 3. Project. Resource name of the project under which all the jobs should be deleted. The format is "projects/{project_id}". For example, "projects/foo/".

↳ force bool

Actually perform the purge. If force is set to false, the method will return a sample of resource names that will be deleted.

getParent

Required. The resource name of the project under which the jobs should be deleted.

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

Returns
TypeDescription
string

setParent

Required. The resource name of the project under which the jobs should be deleted.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFilter

Required. A filter matching the jobs to be purged.

The filter can be one of the following three parent resources.

  1. Company. Resource name of the company under which all the jobs should be deleted. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}". For example, "projects/foo/tenants/bar/companies/baz"
  2. Tenant. Resource name of the tenant under which all the jobs should be deleted. The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenants/bar".
  3. Project. Resource name of the project under which all the jobs should be deleted. The format is "projects/{project_id}". For example, "projects/foo/".
Returns
TypeDescription
string

setFilter

Required. A filter matching the jobs to be purged.

The filter can be one of the following three parent resources.

  1. Company. Resource name of the company under which all the jobs should be deleted. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}". For example, "projects/foo/tenants/bar/companies/baz"
  2. Tenant. Resource name of the tenant under which all the jobs should be deleted. The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenants/bar".
  3. Project. Resource name of the project under which all the jobs should be deleted. The format is "projects/{project_id}". For example, "projects/foo/".
Parameter
NameDescription
var string
Returns
TypeDescription
$this

getForce

Actually perform the purge.

If force is set to false, the method will return a sample of resource names that will be deleted.

Returns
TypeDescription
bool

setForce

Actually perform the purge.

If force is set to false, the method will return a sample of resource names that will be deleted.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this