* $dlpService = new Google\Service\DLP(...); * $dlpJobs = $dlpService->projects_locations_dlpJobs; * */ class ProjectsLocationsDlpJobs extends \Google\Service\Resource { /** * 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) * * @param string $name Required. The name of the DlpJob resource to be * cancelled. * @param GooglePrivacyDlpV2CancelDlpJobRequest $postBody * @param array $optParams Optional parameters. * @return GoogleProtobufEmpty * @throws \Google\Service\Exception */ public function cancel($name, GooglePrivacyDlpV2CancelDlpJobRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('cancel', [$params], GoogleProtobufEmpty::class); } /** * 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) * * @param string $parent Required. Parent resource name. The format of this * value varies depending on whether you have [specified a processing * location](https://cloud.google.com/sensitive-data-protection/docs/specifying- * 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 * @param GooglePrivacyDlpV2CreateDlpJobRequest $postBody * @param array $optParams Optional parameters. * @return GooglePrivacyDlpV2DlpJob * @throws \Google\Service\Exception */ public function create($parent, GooglePrivacyDlpV2CreateDlpJobRequest $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('create', [$params], GooglePrivacyDlpV2DlpJob::class); } /** * 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) * * @param string $name Required. The name of the DlpJob resource to be deleted. * @param array $optParams Optional parameters. * @return GoogleProtobufEmpty * @throws \Google\Service\Exception */ public function delete($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('delete', [$params], GoogleProtobufEmpty::class); } /** * Finish a running hybrid DlpJob. Triggers the finalization steps and running * of any enabled actions that have not yet run. (dlpJobs.finish) * * @param string $name Required. The name of the DlpJob resource to be finished. * @param GooglePrivacyDlpV2FinishDlpJobRequest $postBody * @param array $optParams Optional parameters. * @return GoogleProtobufEmpty * @throws \Google\Service\Exception */ public function finish($name, GooglePrivacyDlpV2FinishDlpJobRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('finish', [$params], GoogleProtobufEmpty::class); } /** * 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) * * @param string $name Required. The name of the DlpJob resource. * @param array $optParams Optional parameters. * @return GooglePrivacyDlpV2DlpJob * @throws \Google\Service\Exception */ public function get($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('get', [$params], GooglePrivacyDlpV2DlpJob::class); } /** * Inspect hybrid content and store findings to a job. To review the findings, * inspect the job. Inspection will occur asynchronously. * (dlpJobs.hybridInspect) * * @param string $name Required. Resource name of the job to execute a hybrid * inspect on, for example `projects/dlp-test-project/dlpJob/53234423`. * @param GooglePrivacyDlpV2HybridInspectDlpJobRequest $postBody * @param array $optParams Optional parameters. * @return GooglePrivacyDlpV2HybridInspectResponse * @throws \Google\Service\Exception */ public function hybridInspect($name, GooglePrivacyDlpV2HybridInspectDlpJobRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('hybridInspect', [$params], GooglePrivacyDlpV2HybridInspectResponse::class); } /** * 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.listProjectsLocationsDlpJobs) * * @param string $parent Required. Parent resource name. The format of this * value varies depending on whether you have [specified a processing * location](https://cloud.google.com/sensitive-data-protection/docs/specifying- * 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 * @param array $optParams Optional parameters. * * @opt_param string filter Allows filtering. Supported syntax: * Filter * expressions are made up of one or more restrictions. * Restrictions can be * combined by `AND` or `OR` logical operators. A sequence of restrictions * implicitly uses `AND`. * A restriction has the form of `{field} {operator} * {value}`. * Supported fields/values for inspect jobs: - `state` - * PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - * DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The name of the trigger * that created the job. - 'end_time` - Corresponds to the time the job * finished. - 'start_time` - Corresponds to the time the job finished. * * Supported fields for risk analysis jobs: - `state` - * RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to the time the * job finished. - 'start_time` - Corresponds to the time the job finished. * * The operator must be `=` or `!=`. Examples: * inspected_storage = * cloud_storage AND state = done * inspected_storage = cloud_storage OR * inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = * done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The * length of this field should be no more than 500 characters. * @opt_param string locationId Deprecated. This field has no effect. * @opt_param string orderBy Comma-separated list of fields to order by, * followed by `asc` or `desc` postfix. This list is case insensitive. The * default sorting order is ascending. Redundant space characters are * insignificant. Example: `name asc, end_time asc, create_time desc` Supported * fields are: - `create_time`: corresponds to the time the job was created. - * `end_time`: corresponds to the time the job ended. - `name`: corresponds to * the job's name. - `state`: corresponds to `state` * @opt_param int pageSize The standard list page size. * @opt_param string pageToken The standard list page token. * @opt_param string type The type of job. Defaults to `DlpJobType.INSPECT` * @return GooglePrivacyDlpV2ListDlpJobsResponse * @throws \Google\Service\Exception */ public function listProjectsLocationsDlpJobs($parent, $optParams = []) { $params = ['parent' => $parent]; $params = array_merge($params, $optParams); return $this->call('list', [$params], GooglePrivacyDlpV2ListDlpJobsResponse::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(ProjectsLocationsDlpJobs::class, 'Google_Service_DLP_Resource_ProjectsLocationsDlpJobs');