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
Namespace
Google \ Cloud \ Talent \ V4Methods
__construct
Constructor.
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".
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".
var
string
$this
getFilter
Required. A filter matching the jobs to be purged.
The filter can be one of the following three parent resources.
- 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"
- 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".
- Project. Resource name of the project under which all the jobs should be deleted. The format is "projects/{project_id}". For example, "projects/foo/".
string
setFilter
Required. A filter matching the jobs to be purged.
The filter can be one of the following three parent resources.
- 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"
- 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".
- Project. Resource name of the project under which all the jobs should be deleted. The format is "projects/{project_id}". For example, "projects/foo/".
var
string
$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.
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.
var
bool
$this
