DLP.Organizations.Locations.DlpJobs.List (Cloud Data Loss Prevention (DLP) API v2-rev20201207-1.31.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
    - - com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
      - com.google.api.services.dlp.v2.DLPRequest<GooglePrivacyDlpV2ListDlpJobsResponse>
        
        com.google.api.services.dlp.v2.DLP.Organizations.Locations.DlpJobs.List

All Implemented Interfaces:: Cloneable, Map<String,Object>

Enclosing class:: DLP.Organizations.Locations.DlpJobs

public class DLP.Organizations.Locations.DlpJobs.List
extends DLPRequest<GooglePrivacyDlpV2ListDlpJobsResponse>

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected List(String parent)
Lists DlpJobs that match the specified filter in the request.

Constructors
Modifier	Constructor and Description
`protected`	`List(String parent)` Lists DlpJobs that match the specified filter in the request.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpRequest`	`buildHttpRequestUsingHead()`
`HttpResponse`	`executeUsingHead()`
`String`	`getFilter()` Allows filtering.
`String`	`getLocationId()` Deprecated.
`String`	`getOrderBy()` Comma separated list of fields to order by, followed by `asc` or `desc` postfix.
`Integer`	`getPageSize()` The standard list page size.
`String`	`getPageToken()` The standard list page token.
`String`	`getParent()` Required.
`String`	`getType()` The type of job.
`DLP.Organizations.Locations.DlpJobs.List`	`set(String parameterName, Object value)`
`DLP.Organizations.Locations.DlpJobs.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`DLP.Organizations.Locations.DlpJobs.List`	`setAccessToken(String accessToken)` OAuth access token.
`DLP.Organizations.Locations.DlpJobs.List`	`setAlt(String alt)` Data format for response.
`DLP.Organizations.Locations.DlpJobs.List`	`setCallback(String callback)` JSONP
`DLP.Organizations.Locations.DlpJobs.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`DLP.Organizations.Locations.DlpJobs.List`	`setFilter(String filter)` Allows filtering.
`DLP.Organizations.Locations.DlpJobs.List`	`setKey(String key)` API key.
`DLP.Organizations.Locations.DlpJobs.List`	`setLocationId(String locationId)` Deprecated.
`DLP.Organizations.Locations.DlpJobs.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`DLP.Organizations.Locations.DlpJobs.List`	`setOrderBy(String orderBy)` Comma separated list of fields to order by, followed by `asc` or `desc` postfix.
`DLP.Organizations.Locations.DlpJobs.List`	`setPageSize(Integer pageSize)` The standard list page size.
`DLP.Organizations.Locations.DlpJobs.List`	`setPageToken(String pageToken)` The standard list page token.
`DLP.Organizations.Locations.DlpJobs.List`	`setParent(String parent)` Required.
`DLP.Organizations.Locations.DlpJobs.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`DLP.Organizations.Locations.DlpJobs.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`DLP.Organizations.Locations.DlpJobs.List`	`setType(String type)` The type of job.
`DLP.Organizations.Locations.DlpJobs.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`DLP.Organizations.Locations.DlpJobs.List`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.dlp.v2.DLPRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - List
```
protected List(String parent)
```
    Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs /compute-risk-analysis to learn more. Create a request for the method "dlpJobs.list". This request holds the parameters needed by the the dlp server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    DLP.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    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/dlp/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
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public HttpResponse executeUsingHead()
                              throws IOException
```
    Overrides:
    
    executeUsingHead in class AbstractGoogleClientRequest<GooglePrivacyDlpV2ListDlpJobsResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class AbstractGoogleClientRequest<GooglePrivacyDlpV2ListDlpJobsResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public DLP.Organizations.Locations.DlpJobs.List set$Xgafv(String $Xgafv)
```
    Description copied from class: DLPRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class DLPRequest<GooglePrivacyDlpV2ListDlpJobsResponse>
  - setAccessToken
```
public DLP.Organizations.Locations.DlpJobs.List setAccessToken(String accessToken)
```
    Description copied from class: DLPRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class DLPRequest<GooglePrivacyDlpV2ListDlpJobsResponse>
  - setAlt
```
public DLP.Organizations.Locations.DlpJobs.List setAlt(String alt)
```
    Description copied from class: DLPRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class DLPRequest<GooglePrivacyDlpV2ListDlpJobsResponse>
  - setCallback
```
public DLP.Organizations.Locations.DlpJobs.List setCallback(String callback)
```
    Description copied from class: DLPRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class DLPRequest<GooglePrivacyDlpV2ListDlpJobsResponse>
  - setFields
```
public DLP.Organizations.Locations.DlpJobs.List setFields(String fields)
```
    Description copied from class: DLPRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class DLPRequest<GooglePrivacyDlpV2ListDlpJobsResponse>
  - setKey
```
public DLP.Organizations.Locations.DlpJobs.List setKey(String key)
```
    Description copied from class: DLPRequest
    
    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    
    Overrides:
    
    setKey in class DLPRequest<GooglePrivacyDlpV2ListDlpJobsResponse>
  - setOauthToken
```
public DLP.Organizations.Locations.DlpJobs.List setOauthToken(String oauthToken)
```
    Description copied from class: DLPRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class DLPRequest<GooglePrivacyDlpV2ListDlpJobsResponse>
  - setPrettyPrint
```
public DLP.Organizations.Locations.DlpJobs.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: DLPRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class DLPRequest<GooglePrivacyDlpV2ListDlpJobsResponse>
  - setQuotaUser
```
public DLP.Organizations.Locations.DlpJobs.List setQuotaUser(String quotaUser)
```
    Description copied from class: DLPRequest
    
    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class DLPRequest<GooglePrivacyDlpV2ListDlpJobsResponse>
  - setUploadType
```
public DLP.Organizations.Locations.DlpJobs.List setUploadType(String uploadType)
```
    Description copied from class: DLPRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class DLPRequest<GooglePrivacyDlpV2ListDlpJobsResponse>
  - setUploadProtocol
```
public DLP.Organizations.Locations.DlpJobs.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: DLPRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class DLPRequest<GooglePrivacyDlpV2ListDlpJobsResponse>
  - getParent
```
public String getParent()
```
    Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/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
  - setParent
```
public DLP.Organizations.Locations.DlpJobs.List setParent(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/dlp/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
  - getFilter
```
public String getFilter()
```
    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. - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to 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.
  - setFilter
```
public DLP.Organizations.Locations.DlpJobs.List setFilter(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 resource name of the trigger that created job. - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to 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.
  - getLocationId
```
public String getLocationId()
```
    Deprecated. This field has no effect.
  - setLocationId
```
public DLP.Organizations.Locations.DlpJobs.List setLocationId(String locationId)
```
    Deprecated. This field has no effect.
  - getOrderBy
```
public String getOrderBy()
```
    Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case- insensitive, 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 time the job was created. - `end_time`: corresponds to time the job ended. - `name`: corresponds to job's name. - `state`: corresponds to `state`
  - setOrderBy
```
public DLP.Organizations.Locations.DlpJobs.List setOrderBy(String orderBy)
```
    Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, 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 time the job was created. - `end_time`: corresponds to time the job ended. - `name`: corresponds to job's name. - `state`: corresponds to `state`
  - getPageSize
```
public Integer getPageSize()
```
    The standard list page size.
  - setPageSize
```
public DLP.Organizations.Locations.DlpJobs.List setPageSize(Integer pageSize)
```
    The standard list page size.
  - getPageToken
```
public String getPageToken()
```
    The standard list page token.
  - setPageToken
```
public DLP.Organizations.Locations.DlpJobs.List setPageToken(String pageToken)
```
    The standard list page token.
  - getType
```
public String getType()
```
    The type of job. Defaults to `DlpJobType.INSPECT`
  - setType
```
public DLP.Organizations.Locations.DlpJobs.List setType(String type)
```
    The type of job. Defaults to `DlpJobType.INSPECT`
  - set
```
public DLP.Organizations.Locations.DlpJobs.List set(String parameterName,
                                                    Object value)
```
    Overrides:
    
    set in class DLPRequest<GooglePrivacyDlpV2ListDlpJobsResponse>

Class DLP.Organizations.Locations.DlpJobs.List

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.dlp.v2.DLPRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getParent

setParent

getFilter

setFilter

getLocationId

setLocationId

getOrderBy

setOrderBy

getPageSize

setPageSize

getPageToken

setPageToken

getType

setType

set