target.apidocs.com.google.api.services.dlp.v2.DLP.Projects.DlpJobs.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-dlp Show documentation

There is a newer version: v2-rev20250105-2.0.0

Show newest version







DLP.Projects.DlpJobs (Sensitive Data Protection (DLP) v2-rev20240609-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.dlp.v2
Class DLP.Projects.DlpJobs



java.lang.Object


com.google.api.services.dlp.v2.DLP.Projects.DlpJobs







Enclosing class:
DLP.Projects




public class DLP.Projects.DlpJobs
extends Object
The "dlpJobs" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
DLP.Projects.DlpJobs.Cancel 


class 
DLP.Projects.DlpJobs.Create 


class 
DLP.Projects.DlpJobs.Delete 


class 
DLP.Projects.DlpJobs.Get 


class 
DLP.Projects.DlpJobs.List 









Constructor Summary

Constructors 

Constructor and Description


DlpJobs() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


DLP.Projects.DlpJobs.Cancel
cancel(String name,
      GooglePrivacyDlpV2CancelDlpJobRequest content)
Starts asynchronous cancellation on a long-running DlpJob.



DLP.Projects.DlpJobs.Create
create(String parent,
      GooglePrivacyDlpV2CreateDlpJobRequest content)
Creates a new job to inspect storage or calculate risk metrics.



DLP.Projects.DlpJobs.Delete
delete(String name)
Deletes a long-running DlpJob.



DLP.Projects.DlpJobs.Get
get(String name)
Gets the latest state of a long-running DlpJob.



DLP.Projects.DlpJobs.List
list(String parent)
Lists DlpJobs that match the specified filter in the request.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





DlpJobs
public DlpJobs()









Method Detail





cancel
public DLP.Projects.DlpJobs.Cancel cancel(String name,
                                          GooglePrivacyDlpV2CancelDlpJobRequest content)
                                   throws IOException
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.

 Create a request for the method "dlpJobs.cancel".

 This request holds the parameters needed by the dlp server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The name of the DlpJob resource to be cancelled.
content - the GooglePrivacyDlpV2CancelDlpJobRequest
Returns:
the request
Throws:
IOException








create
public DLP.Projects.DlpJobs.Create create(String parent,
                                          GooglePrivacyDlpV2CreateDlpJobRequest content)
                                   throws IOException
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.

 Create a request for the method "dlpJobs.create".

 This request holds the parameters needed by the dlp server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
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
content - the GooglePrivacyDlpV2CreateDlpJobRequest
Returns:
the request
Throws:
IOException








delete
public DLP.Projects.DlpJobs.Delete delete(String name)
                                   throws IOException
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.

 Create a request for the method "dlpJobs.delete".

 This request holds the parameters needed by the dlp server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The name of the DlpJob resource to be deleted.
Returns:
the request
Throws:
IOException








get
public DLP.Projects.DlpJobs.Get get(String name)
                             throws IOException
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.

 Create a request for the method "dlpJobs.get".

 This request holds the parameters needed by the dlp server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The name of the DlpJob resource.
Returns:
the request
Throws:
IOException








list
public DLP.Projects.DlpJobs.List list(String parent)
                               throws IOException
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.

 Create a request for the method "dlpJobs.list".

 This request holds the parameters needed by the dlp server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
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
Returns:
the request
Throws:
IOException














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Class and Description
`class`	`DLP.Projects.DlpJobs.Cancel`
`class`	`DLP.Projects.DlpJobs.Create`
`class`	`DLP.Projects.DlpJobs.Delete`
`class`	`DLP.Projects.DlpJobs.Get`
`class`	`DLP.Projects.DlpJobs.List`

Modifier and Type	Method and Description
`DLP.Projects.DlpJobs.Cancel`	`cancel(String name, GooglePrivacyDlpV2CancelDlpJobRequest content)` Starts asynchronous cancellation on a long-running DlpJob.
`DLP.Projects.DlpJobs.Create`	`create(String parent, GooglePrivacyDlpV2CreateDlpJobRequest content)` Creates a new job to inspect storage or calculate risk metrics.
`DLP.Projects.DlpJobs.Delete`	`delete(String name)` Deletes a long-running DlpJob.
`DLP.Projects.DlpJobs.Get`	`get(String name)` Gets the latest state of a long-running DlpJob.
`DLP.Projects.DlpJobs.List`	`list(String parent)` Lists DlpJobs that match the specified filter in the request.