List triggers

List all job triggers 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 
 
 ; 
 using 
  
 System 
 ; 
 public 
  
 class 
  
 TriggersList 
 { 
  
 public 
  
 static 
  
 PagedEnumerable<ListJobTriggersResponse 
 , 
  
 JobTrigger 
>  
 List 
 ( 
 string 
  
 projectId 
 ) 
  
 { 
  
 var 
  
 dlp 
  
 = 
  
  DlpServiceClient 
 
 . 
  Create 
 
 (); 
  
 var 
  
 response 
  
 = 
  
 dlp 
 . 
 ListJobTriggers 
 ( 
  
 new 
  
  ListJobTriggersRequest 
 
  
 { 
  
 Parent 
  
 = 
  
 new 
  
  LocationName 
 
 ( 
 projectId 
 , 
  
 "global" 
 ). 
 ToString 
 (), 
  
 }); 
  
 foreach 
  
 ( 
 var 
  
 trigger 
  
 in 
  
 response 
 ) 
  
 { 
  
 Console 
 . 
 WriteLine 
 ( 
 $"Name: {trigger.Name}" 
 ); 
  
 Console 
 . 
 WriteLine 
 ( 
 $"  Created: {trigger.CreateTime}" 
 ); 
  
 Console 
 . 
 WriteLine 
 ( 
 $"  Updated: {trigger.UpdateTime}" 
 ); 
  
 Console 
 . 
 WriteLine 
 ( 
 $"  Display Name: {trigger.DisplayName}" 
 ); 
  
 Console 
 . 
 WriteLine 
 ( 
 $"  Description: {trigger.Description}" 
 ); 
  
 Console 
 . 
 WriteLine 
 ( 
 $"  Status: {trigger.Status}" 
 ); 
  
 Console 
 . 
 WriteLine 
 ( 
 $"  Error count: {trigger.Errors.Count}" 
 ); 
  
 } 
  
 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" 
  
 "time" 
  
 dlp 
  
 "cloud.google.com/go/dlp/apiv2" 
  
 "cloud.google.com/go/dlp/apiv2/dlppb" 
  
 "github.com/golang/protobuf/ptypes" 
  
 "google.golang.org/api/iterator" 
 ) 
 // listTriggers lists the triggers for the given project. 
 func 
  
 listTriggers 
 ( 
 w 
  
 io 
 . 
 Writer 
 , 
  
 projectID 
  
 string 
 ) 
  
 error 
  
 { 
  
 // projectID := "my-project-id" 
  
 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 
 . 
 ListJobTriggersRequest 
 { 
  
 Parent 
 : 
  
 fmt 
 . 
 Sprintf 
 ( 
 "projects/%s/locations/global" 
 , 
  
 projectID 
 ), 
  
 } 
  
 // Send the request and iterate over the results. 
  
 it 
  
 := 
  
 client 
 . 
 ListJobTriggers 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 for 
  
 { 
  
 t 
 , 
  
 err 
  
 := 
  
 it 
 . 
 Next 
 () 
  
 if 
  
 err 
  
 == 
  
 iterator 
 . 
 Done 
  
 { 
  
 break 
  
 } 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "Next: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Trigger %v\n" 
 , 
  
 t 
 . 
 GetName 
 ()) 
  
 c 
 , 
  
 err 
  
 := 
  
 ptypes 
 . 
 Timestamp 
 ( 
 t 
 . 
 GetCreateTime 
 ()) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "CreateTime Timestamp: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "  Created: %v\n" 
 , 
  
 c 
 . 
 Format 
 ( 
 time 
 . 
 RFC1123 
 )) 
  
 u 
 , 
  
 err 
  
 := 
  
 ptypes 
 . 
 Timestamp 
 ( 
 t 
 . 
 GetUpdateTime 
 ()) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "UpdateTime Timestamp: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "  Updated: %v\n" 
 , 
  
 u 
 . 
 Format 
 ( 
 time 
 . 
 RFC1123 
 )) 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "  Display Name: %q\n" 
 , 
  
 t 
 . 
 GetDisplayName 
 ()) 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "  Description: %q\n" 
 , 
  
 t 
 . 
 GetDescription 
 ()) 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "  Status: %v\n" 
 , 
  
 t 
 . 
 GetStatus 
 ()) 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "  Error Count: %v\n" 
 , 
  
 len 
 ( 
 t 
 . 
 GetErrors 
 ())) 
  
 } 
  
 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. JobTrigger 
 
 ; 
 import 
  
 com.google.privacy.dlp.v2. ListJobTriggersRequest 
 
 ; 
 import 
  
 com.google.privacy.dlp.v2. LocationName 
 
 ; 
 import 
  
 java.io.IOException 
 ; 
 class 
 TriggersList 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 throws 
  
 Exception 
  
 { 
  
 // TODO(developer): Replace these variables before running the sample. 
  
 String 
  
 projectId 
  
 = 
  
 "your-project-id" 
 ; 
  
 listTriggers 
 ( 
 projectId 
 ); 
  
 } 
  
 public 
  
 static 
  
 void 
  
 listTriggers 
 ( 
 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 
 ()) 
  
 { 
  
 // Build the request to be sent by the client 
  
  ListJobTriggersRequest 
 
  
 listJobTriggersRequest 
  
 = 
  
  ListJobTriggersRequest 
 
 . 
 newBuilder 
 () 
  
 . 
 setParent 
 ( 
  LocationName 
 
 . 
 of 
 ( 
 projectId 
 , 
  
 "global" 
 ). 
 toString 
 ()) 
  
 . 
 build 
 (); 
  
 // Use the client to send the API request. 
  
  DlpServiceClient 
 
 . 
  ListJobTriggersPagedResponse 
 
  
 response 
  
 = 
  
 dlpServiceClient 
 . 
 listJobTriggers 
 ( 
 listJobTriggersRequest 
 ); 
  
 // Parse the response and process the results 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "DLP triggers found:" 
 ); 
  
 for 
  
 ( 
  JobTrigger 
 
  
 trigger 
  
 : 
  
 response 
 . 
 getPage 
 (). 
 getValues 
 ()) 
  
 { 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Trigger: " 
  
 + 
  
 trigger 
 . 
 getName 
 ()); 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "\tCreated: " 
  
 + 
  
 trigger 
 . 
 getCreateTime 
 ()); 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "\tUpdated: " 
  
 + 
  
 trigger 
 . 
 getUpdateTime 
 ()); 
  
 if 
  
 ( 
 trigger 
 . 
 getDisplayName 
 () 
  
 != 
  
 null 
 ) 
  
 { 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "\tDisplay name: " 
  
 + 
  
 trigger 
 . 
 getDisplayName 
 ()); 
  
 } 
  
 if 
  
 ( 
 trigger 
 . 
 getDescription 
 () 
  
 != 
  
 null 
 ) 
  
 { 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "\tDescription: " 
  
 + 
  
 trigger 
 . 
 getDescription 
 ()); 
  
 } 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "\tStatus: " 
  
 + 
  
 trigger 
 . 
 getStatus 
 ()); 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "\tError count: " 
  
 + 
  
 trigger 
 . 
 getErrorsCount 
 ()); 
  
 } 
  
 ; 
  
 } 
  
 } 
 } 
 

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' 
 async 
  
 function 
  
 listTriggers 
 () 
  
 { 
  
 // Construct trigger listing request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 parent 
 : 
  
 `projects/ 
 ${ 
 projectId 
 } 
 /locations/global` 
 , 
  
 }; 
  
 // Helper function to pretty-print dates 
  
 const 
  
 formatDate 
  
 = 
  
 date 
  
 = 
>  
 { 
  
 const 
  
 msSinceEpoch 
  
 = 
  
 parseInt 
 ( 
 date 
 . 
 seconds 
 , 
  
 10 
 ) 
  
 * 
  
 1000 
 ; 
  
 return 
  
 new 
  
  Date 
 
 ( 
 msSinceEpoch 
 ). 
 toLocaleString 
 ( 
 'en-US' 
 ); 
  
 }; 
  
 // Run trigger listing request 
  
 const 
  
 [ 
 triggers 
 ] 
  
 = 
  
 await 
  
 dlp 
 . 
 listJobTriggers 
 ( 
 request 
 ); 
  
 triggers 
 . 
 forEach 
 ( 
 trigger 
  
 = 
>  
 { 
  
 // Log trigger details 
  
 console 
 . 
 log 
 ( 
 `Trigger 
 ${ 
  trigger 
 
 . 
 name 
 } 
 :` 
 ); 
  
 console 
 . 
 log 
 ( 
 `  Created: 
 ${ 
 formatDate 
 ( 
  trigger 
 
 . 
 createTime 
 ) 
 } 
 ` 
 ); 
  
 console 
 . 
 log 
 ( 
 `  Updated: 
 ${ 
 formatDate 
 ( 
  trigger 
 
 . 
 updateTime 
 ) 
 } 
 ` 
 ); 
  
 if 
  
 ( 
  trigger 
 
 . 
 displayName 
 ) 
  
 { 
  
 console 
 . 
 log 
 ( 
 `  Display Name: 
 ${ 
  trigger 
 
 . 
 displayName 
 } 
 ` 
 ); 
  
 } 
  
 if 
  
 ( 
  trigger 
 
 . 
 description 
 ) 
  
 { 
  
 console 
 . 
 log 
 ( 
 `  Description: 
 ${ 
  trigger 
 
 . 
 description 
 } 
 ` 
 ); 
  
 } 
  
 console 
 . 
 log 
 ( 
 `  Status: 
 ${ 
  trigger 
 
 . 
 status 
 } 
 ` 
 ); 
  
 console 
 . 
 log 
 ( 
 `  Error count: 
 ${ 
  trigger 
 
 . 
 errors 
 . 
 length 
 } 
 ` 
 ); 
  
 }); 
 } 
 listTriggers 
 (); 
 

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\ListJobTriggersRequest; 
 /** 
 * List Data Loss Prevention API job triggers. 
 * 
 * @param string $callingProjectId  The project ID to run the API call under 
 */ 
 function list_triggers(string $callingProjectId): void 
 { 
 // Instantiate a client. 
 $dlp = new DlpServiceClient(); 
 $parent = "projects/$callingProjectId/locations/global"; 
 // Run request 
 $listJobTriggersRequest = (new ListJobTriggersRequest()) 
 ->setParent($parent); 
 $response = $dlp->listJobTriggers($listJobTriggersRequest); 
 // Print results 
 $triggers = $response->iterateAllElements(); 
 foreach ($triggers as $trigger) { 
 printf('Trigger %s' . PHP_EOL, $trigger->getName()); 
 printf('  Created: %s' . PHP_EOL, $trigger->getCreateTime()->getSeconds()); 
 printf('  Updated: %s' . PHP_EOL, $trigger->getUpdateTime()->getSeconds()); 
 printf('  Display Name: %s' . PHP_EOL, $trigger->getDisplayName()); 
 printf('  Description: %s' . PHP_EOL, $trigger->getDescription()); 
 printf('  Status: %s' . PHP_EOL, $trigger->getStatus()); 
 printf('  Error count: %s' . PHP_EOL, count($trigger->getErrors())); 
 $timespanConfig = $trigger->getInspectJob()->getStorageConfig()->getTimespanConfig(); 
 printf('  Auto-populates timespan config: %s' . PHP_EOL, 
 ($timespanConfig && $timespanConfig->getEnableAutoPopulationOfTimespanConfig() ? 'yes' : 'no')); 
 } 
 } 
 

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 .

  import 
  
 google.cloud.dlp 
 def 
  
 list_triggers 
 ( 
 project 
 : 
 str 
 ) 
 - 
> None 
 : 
  
 """Lists all Data Loss Prevention API triggers. 
 Args: 
 project: The Google Cloud project id to use as a parent resource. 
 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 
 } 
 " 
 # Call the API. 
 response 
 = 
 dlp 
 . 
  list_job_triggers 
 
 ( 
 request 
 = 
 { 
 "parent" 
 : 
 parent 
 }) 
 for 
 trigger 
 in 
 response 
 : 
 print 
 ( 
 f 
 "Trigger 
 { 
 trigger 
 . 
 name 
 } 
 :" 
 ) 
 print 
 ( 
 f 
 "  Created: 
 { 
 trigger 
 . 
 create_time 
 } 
 " 
 ) 
 print 
 ( 
 f 
 "  Updated: 
 { 
 trigger 
 . 
 update_time 
 } 
 " 
 ) 
 if 
 trigger 
 . 
 display_name 
 : 
 print 
 ( 
 f 
 "  Display Name: 
 { 
 trigger 
 . 
 display_name 
 } 
 " 
 ) 
 if 
 trigger 
 . 
 description 
 : 
 print 
 ( 
 f 
 "  Description: 
 { 
 trigger 
 . 
 description 
 } 
 " 
 ) 
 print 
 ( 
 f 
 "  Status: 
 { 
 trigger 
 . 
 status 
 } 
 " 
 ) 
 print 
 ( 
 f 
 "  Error count: 
 { 
 len 
 ( 
 trigger 
 . 
 errors 
 ) 
 } 
 " 
 ) 
 

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: