List jobs

List all Cloud DLP jobs for the current project.

Explore further

For detailed documentation that includes this code sample, see the following:

Code sample

C#

To learn how to install and use the client library for Sensitive Data Protection, see Sensitive Data Protection client libraries .

To authenticate to Sensitive Data Protection, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  using 
  
  Google.Api.Gax 
 
 ; 
 using 
  
  Google.Api.Gax.ResourceNames 
 
 ; 
 using 
  
  Google.Cloud.Dlp.V2 
 
 ; 
 public 
  
 class 
  
 JobsList 
 { 
  
 public 
  
 static 
  
 PagedEnumerable<ListDlpJobsResponse 
 , 
  
 DlpJob 
>  
 ListDlpJobs 
 ( 
 string 
  
 projectId 
 , 
  
 string 
  
 filter 
 , 
  
  DlpJobType 
 
  
 jobType 
 ) 
  
 { 
  
 var 
  
 dlp 
  
 = 
  
  DlpServiceClient 
 
 . 
  Create 
 
 (); 
  
 var 
  
 response 
  
 = 
  
 dlp 
 . 
 ListDlpJobs 
 ( 
 new 
  
  ListDlpJobsRequest 
 
  
 { 
  
 Parent 
  
 = 
  
 new 
  
  LocationName 
 
 ( 
 projectId 
 , 
  
 "global" 
 ). 
 ToString 
 (), 
  
 Filter 
  
 = 
  
 filter 
 , 
  
 Type 
  
 = 
  
 jobType 
  
 }); 
  
 // Uncomment to print jobs 
  
 // foreach (var job in response) 
  
 // { 
  
 //     Console.WriteLine($"Job: {job.Name} status: {job.State}"); 
  
 // } 
  
 return 
  
 response 
 ; 
  
 } 
 } 
 

Go

To learn how to install and use the client library for Sensitive Data Protection, see Sensitive Data Protection client libraries .

To authenticate to Sensitive Data Protection, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  import 
  
 ( 
  
 "context" 
  
 "fmt" 
  
 "io" 
  
 dlp 
  
 "cloud.google.com/go/dlp/apiv2" 
  
 "cloud.google.com/go/dlp/apiv2/dlppb" 
  
 "google.golang.org/api/iterator" 
 ) 
 // listJobs lists jobs matching the given optional filter and optional jobType. 
 func 
  
 listJobs 
 ( 
 w 
  
 io 
 . 
 Writer 
 , 
  
 projectID 
 , 
  
 filter 
 , 
  
 jobType 
  
 string 
 ) 
  
 error 
  
 { 
  
 // projectID := "my-project-id" 
  
 // filter := "`state` = FINISHED" 
  
 // jobType := "RISK_ANALYSIS_JOB" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 client 
 , 
  
 err 
  
 := 
  
 dlp 
 . 
  NewClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "dlp.NewClient: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 client 
 . 
  Close 
 
 () 
  
 // Create a configured request. 
  
 req 
  
 := 
  
& dlppb 
 . 
 ListDlpJobsRequest 
 { 
  
 Parent 
 : 
  
 fmt 
 . 
 Sprintf 
 ( 
 "projects/%s/locations/global" 
 , 
  
 projectID 
 ), 
  
 Filter 
 : 
  
 filter 
 , 
  
 Type 
 : 
  
 dlppb 
 . 
  DlpJobType 
 
 ( 
 dlppb 
 . 
  DlpJobType_value 
 
 [ 
 jobType 
 ]), 
  
 } 
  
 // Send the request and iterate over the results. 
  
 it 
  
 := 
  
 client 
 . 
 ListDlpJobs 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 for 
  
 { 
  
 j 
 , 
  
 err 
  
 := 
  
 it 
 . 
 Next 
 () 
  
 if 
  
 err 
  
 == 
  
 iterator 
 . 
 Done 
  
 { 
  
 break 
  
 } 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "Next: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Job %v status: %v\n" 
 , 
  
 j 
 . 
 GetName 
 (), 
  
 j 
 . 
 GetState 
 ()) 
  
 } 
  
 return 
  
 nil 
 } 
 

Java

To learn how to install and use the client library for Sensitive Data Protection, see Sensitive Data Protection client libraries .

To authenticate to Sensitive Data Protection, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  import 
  
 com.google.cloud.dlp.v2. DlpServiceClient 
 
 ; 
 import 
  
 com.google.privacy.dlp.v2. DlpJob 
 
 ; 
 import 
  
 com.google.privacy.dlp.v2. DlpJobType 
 
 ; 
 import 
  
 com.google.privacy.dlp.v2. ListDlpJobsRequest 
 
 ; 
 import 
  
 com.google.privacy.dlp.v2. LocationName 
 
 ; 
 import 
  
 java.io.IOException 
 ; 
 public 
  
 class 
 JobsList 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 throws 
  
 Exception 
  
 { 
  
 // TODO(developer): Replace these variables before running the sample. 
  
 String 
  
 projectId 
  
 = 
  
 "your-project-id" 
 ; 
  
 listJobs 
 ( 
 projectId 
 ); 
  
 } 
  
 // Lists DLP jobs 
  
 public 
  
 static 
  
 void 
  
 listJobs 
 ( 
 String 
  
 projectId 
 ) 
  
 throws 
  
 IOException 
  
 { 
  
 // Initialize client that will be used to send requests. This client only needs to be created 
  
 // once, and can be reused for multiple requests. After completing all of your requests, call 
  
 // the "close" method on the client to safely clean up any remaining background resources. 
  
 try 
  
 ( 
  DlpServiceClient 
 
  
 dlpServiceClient 
  
 = 
  
  DlpServiceClient 
 
 . 
 create 
 ()) 
  
 { 
  
 // Construct the request to be sent by the client. 
  
 // For more info on filters and job types, 
  
 // see https://cloud.google.com/dlp/docs/reference/rest/v2/projects.dlpJobs/list 
  
  ListDlpJobsRequest 
 
  
 listDlpJobsRequest 
  
 = 
  
  ListDlpJobsRequest 
 
 . 
 newBuilder 
 () 
  
 . 
 setParent 
 ( 
  LocationName 
 
 . 
 of 
 ( 
 projectId 
 , 
  
 "global" 
 ). 
 toString 
 ()) 
  
 . 
 setFilter 
 ( 
 "state=DONE" 
 ) 
  
 . 
 setType 
 ( 
  DlpJobType 
 
 . 
 valueOf 
 ( 
 "INSPECT_JOB" 
 )) 
  
 . 
 build 
 (); 
  
 // Send the request to list jobs and process the response 
  
  DlpServiceClient 
 
 . 
  ListDlpJobsPagedResponse 
 
  
 response 
  
 = 
  
 dlpServiceClient 
 . 
 listDlpJobs 
 ( 
 listDlpJobsRequest 
 ); 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "DLP jobs found:" 
 ); 
  
 for 
  
 ( 
  DlpJob 
 
  
 dlpJob 
  
 : 
  
 response 
 . 
 getPage 
 (). 
 getValues 
 ()) 
  
 { 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 dlpJob 
 . 
 getName 
 () 
  
 + 
  
 " -- " 
  
 + 
  
 dlpJob 
 . 
 getState 
 ()); 
  
 } 
  
 } 
  
 } 
 } 
 

Node.js

To learn how to install and use the client library for Sensitive Data Protection, see Sensitive Data Protection client libraries .

To authenticate to Sensitive Data Protection, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  // Imports the Google Cloud Data Loss Prevention library 
 const 
  
 DLP 
  
 = 
  
 require 
 ( 
 ' @google-cloud/dlp 
' 
 ); 
 // Instantiates a client 
 const 
  
 dlp 
  
 = 
  
 new 
  
 DLP 
 . 
  DlpServiceClient 
 
 (); 
 // The project ID to run the API call under 
 // const projectId = 'my-project'; 
 // The filter expression to use 
 // For more information and filter syntax, see https://cloud.google.com/dlp/docs/reference/rest/v2/projects.dlpJobs/list 
 // const filter = `state=DONE`; 
 // The type of job to list (either 'INSPECT_JOB' or 'RISK_ANALYSIS_JOB') 
 // const jobType = 'INSPECT_JOB'; 
 async 
  
 function 
  
 listJobs 
 () 
  
 { 
  
 // Construct request for listing DLP scan jobs 
  
 const 
  
 request 
  
 = 
  
 { 
  
 parent 
 : 
  
 `projects/ 
 ${ 
 projectId 
 } 
 /locations/global` 
 , 
  
 filter 
 : 
  
 filter 
 , 
  
 type 
 : 
  
 jobType 
 , 
  
 }; 
  
 // Run job-listing request 
  
 const 
  
 [ 
 jobs 
 ] 
  
 = 
  
 await 
  
 dlp 
 . 
 listDlpJobs 
 ( 
 request 
 ); 
  
 jobs 
 . 
 forEach 
 ( 
 job 
  
 = 
>  
 { 
  
 console 
 . 
 log 
 ( 
 `Job 
 ${ 
 job 
 . 
 name 
 } 
 status: 
 ${ 
 job 
 . 
 state 
 } 
 ` 
 ); 
  
 }); 
 } 
 listJobs 
 (); 
 

PHP

To learn how to install and use the client library for Sensitive Data Protection, see Sensitive Data Protection client libraries .

To authenticate to Sensitive Data Protection, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  use Google\Cloud\Dlp\V2\Client\DlpServiceClient; 
 use Google\Cloud\Dlp\V2\DlpJob\JobState; 
 use Google\Cloud\Dlp\V2\DlpJobType; 
 use Google\Cloud\Dlp\V2\ListDlpJobsRequest; 
 /** 
 * List Data Loss Prevention API jobs corresponding to a given filter. 
 * 
 * @param string $callingProjectId  The project ID to run the API call under 
 * @param string $filter            The filter expression to use 
 */ 
 function list_jobs(string $callingProjectId, string $filter): void 
 { 
 // Instantiate a client. 
 $dlp = new DlpServiceClient(); 
 // The type of job to list (either 'INSPECT_JOB' or 'REDACT_JOB') 
 $jobType = DlpJobType::INSPECT_JOB; 
 // Run job-listing request 
 // For more information and filter syntax, 
 // @see https://cloud.google.com/dlp/docs/reference/rest/v2/projects.dlpJobs/list 
 $parent = "projects/$callingProjectId/locations/global"; 
 $listDlpJobsRequest = (new ListDlpJobsRequest()) 
 ->setParent($parent) 
 ->setFilter($filter) 
 ->setType($jobType); 
 $response = $dlp->listDlpJobs($listDlpJobsRequest); 
 // Print job list 
 $jobs = $response->iterateAllElements(); 
 foreach ($jobs as $job) { 
 printf('Job %s status: %s' . PHP_EOL, $job->getName(), $job->getState()); 
 $infoTypeStats = $job->getInspectDetails()->getResult()->getInfoTypeStats(); 
 if ($job->getState() == JobState::DONE) { 
 if (count($infoTypeStats) > 0) { 
 foreach ($infoTypeStats as $infoTypeStat) { 
 printf( 
 '  Found %s instance(s) of type %s' . PHP_EOL, 
 $infoTypeStat->getCount(), 
 $infoTypeStat->getInfoType()->getName() 
 ); 
 } 
 } else { 
 print('  No findings.' . PHP_EOL); 
 } 
 } 
 } 
 } 
 

Python

To learn how to install and use the client library for Sensitive Data Protection, see Sensitive Data Protection client libraries .

To authenticate to Sensitive Data Protection, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  from 
  
 typing 
  
 import 
 Optional 
 import 
  
 google.cloud.dlp 
 def 
  
 list_dlp_jobs 
 ( 
 project 
 : 
 str 
 , 
 filter_string 
 : 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 job_type 
 : 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 ) 
 - 
> None 
 : 
  
 """Uses the Data Loss Prevention API to lists DLP jobs that match the 
 specified filter in the request. 
 Args: 
 project: The project id to use as a parent resource. 
 filter: (Optional) 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 resource name of the trigger that 
 created job. 
 * Supported fields for risk analysis jobs: 
 - `state` - RUNNING|CANCELED|FINISHED|FAILED 
 * 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) 
 type: (Optional) The type of job. Defaults to 'INSPECT'. 
 Choices: 
 DLP_JOB_TYPE_UNSPECIFIED 
 INSPECT_JOB: The job inspected content for sensitive data. 
 RISK_ANALYSIS_JOB: The job executed a Risk Analysis computation. 
 Returns: 
 None; the response from the API is printed to the terminal. 
 """ 
 # Instantiate a client. 
 dlp 
 = 
 google 
 . 
 cloud 
 . 
  dlp_v2 
 
 . 
  DlpServiceClient 
 
 () 
 # Convert the project id into a full resource id. 
 parent 
 = 
 f 
 "projects/ 
 { 
 project 
 } 
 " 
 # Job type dictionary 
 job_type_to_int 
 = 
 { 
 "DLP_JOB_TYPE_UNSPECIFIED" 
 : 
 google 
 . 
 cloud 
 . 
 dlp 
 . 
  DlpJobType 
 
 . 
 DLP_JOB_TYPE_UNSPECIFIED 
 , 
 "INSPECT_JOB" 
 : 
 google 
 . 
 cloud 
 . 
 dlp 
 . 
  DlpJobType 
 
 . 
 INSPECT_JOB 
 , 
 "RISK_ANALYSIS_JOB" 
 : 
 google 
 . 
 cloud 
 . 
 dlp 
 . 
  DlpJobType 
 
 . 
 RISK_ANALYSIS_JOB 
 , 
 } 
 # If job type is specified, convert job type to number through enums. 
 if 
 job_type 
 : 
 job_type 
 = 
 job_type_to_int 
 [ 
 job_type 
 ] 
 # Call the API to get a list of jobs. 
 response 
 = 
 dlp 
 . 
 list_dlp_jobs 
 ( 
 request 
 = 
 { 
 "parent" 
 : 
 parent 
 , 
 "filter" 
 : 
 filter_string 
 , 
 "type_" 
 : 
 job_type 
 } 
 ) 
 # Iterate over results. 
 for 
 job 
 in 
 response 
 : 
 print 
 ( 
 f 
 "Job: 
 { 
 job 
 . 
 name 
 } 
 ; status: 
 { 
 job 
 . 
 state 
 . 
 name 
 } 
 " 
 ) 
 

What's next

To search and filter code samples for other Google Cloud products, see the Google Cloud sample browser .

Create a Mobile Website
View Site in Mobile | Classic
Share by: