class ProjectsDlpJobs extends Resource (View source)

The "dlpJobs" collection of methods.

Typical usage is:

 $dlpService = new Google\Service\DLP(...);
 $dlpJobs = $dlpService->projects_dlpJobs;

Methods

cancel(string $name, GooglePrivacyDlpV2CancelDlpJobRequest $postBody, array $optParams = [])

Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk- analysis to learn more. (dlpJobs.cancel)

create(string $parent, GooglePrivacyDlpV2CreateDlpJobRequest $postBody, array $optParams = [])

Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk- analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. (dlpJobs.create)

delete(string $name, array $optParams = [])

Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be canceled if possible.

get(string $name, array $optParams = [])

Gets the latest state of a long-running DlpJob. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk- analysis to learn more. (dlpJobs.get)

listProjectsDlpJobs(string $parent, array $optParams = [])

Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk- analysis to learn more. (dlpJobs.listProjectsDlpJobs)

Details

GoogleProtobufEmpty cancel(string $name, GooglePrivacyDlpV2CancelDlpJobRequest $postBody, array $optParams = [])

Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk- analysis to learn more. (dlpJobs.cancel)

Parameters

string $name

Required. The name of the DlpJob resource to be cancelled.

GooglePrivacyDlpV2CancelDlpJobRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

GooglePrivacyDlpV2DlpJob create(string $parent, GooglePrivacyDlpV2CreateDlpJobRequest $postBody, array $optParams = [])

Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk- analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. (dlpJobs.create)

Parameters

string $parent

Required. Parent resource name. The format of this value varies depending on whether you have specified a processing location: + Projects scope, location specified: projects/PROJECT_ID/locations/ LOCATION_ID + Projects scope, no location specified (defaults to global): projects/PROJECT_ID The following example parent string specifies a parent project with the identifier example- project, and specifies the europe-west3 location for processing data: parent=projects/example-project/locations/europe-west3

GooglePrivacyDlpV2CreateDlpJobRequest $postBody
array $optParams

Optional parameters.

Return Value

GooglePrivacyDlpV2DlpJob

Exceptions

Exception

GoogleProtobufEmpty delete(string $name, array $optParams = [])

Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be canceled if possible.

See https://cloud.google.com/sensitive-data-protection/docs/inspecting- storage and https://cloud.google.com/sensitive-data-protection/docs/compute- risk-analysis to learn more. (dlpJobs.delete)

Parameters

string $name

Required. The name of the DlpJob resource to be deleted.

array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

GooglePrivacyDlpV2DlpJob get(string $name, array $optParams = [])

Gets the latest state of a long-running DlpJob. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk- analysis to learn more. (dlpJobs.get)

Parameters

string $name

Required. The name of the DlpJob resource.

array $optParams

Optional parameters.

Return Value

GooglePrivacyDlpV2DlpJob

Exceptions

Exception

GooglePrivacyDlpV2ListDlpJobsResponse listProjectsDlpJobs(string $parent, array $optParams = [])

Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk- analysis to learn more. (dlpJobs.listProjectsDlpJobs)

Parameters

string $parent

Required. Parent resource name. The format of this value varies depending on whether you have specified a processing location: + Projects scope, location specified: projects/PROJECT_ID/locations/ LOCATION_ID + Projects scope, no location specified (defaults to global): projects/PROJECT_ID The following example parent string specifies a parent project with the identifier example- project, and specifies the europe-west3 location for processing data: parent=projects/example-project/locations/europe-west3

array $optParams

Optional parameters.

Return Value

GooglePrivacyDlpV2ListDlpJobsResponse

Exceptions

Exception