com.google.api.services.dlp.v2.model

Class GooglePrivacyDlpV2CloudStorageRegexFileSet

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.dlp.v2.model.GooglePrivacyDlpV2CloudStorageRegexFileSet

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GooglePrivacyDlpV2CloudStorageRegexFileSet
extends GenericJson

Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/`

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Data Loss Prevention (DLP) API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

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>

Constructor Summary

Constructors

Constructor and Description
GooglePrivacyDlpV2CloudStorageRegexFileSet()

Method Summary

Modifier and Type	Method and Description
GooglePrivacyDlpV2CloudStorageRegexFileSet	clone()
String	getBucketName() The name of a Cloud Storage bucket.
List<String>	getExcludeRegex() A list of regular expressions matching file paths to exclude.
List<String>	getIncludeRegex() A list of regular expressions matching file paths to include.
GooglePrivacyDlpV2CloudStorageRegexFileSet	set(String fieldName, Object value)
GooglePrivacyDlpV2CloudStorageRegexFileSet	setBucketName(String bucketName) The name of a Cloud Storage bucket.
GooglePrivacyDlpV2CloudStorageRegexFileSet	setExcludeRegex(List<String> excludeRegex) A list of regular expressions matching file paths to exclude.
GooglePrivacyDlpV2CloudStorageRegexFileSet	setIncludeRegex(List<String> includeRegex) A list of regular expressions matching file paths to include.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

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

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

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

GooglePrivacyDlpV2CloudStorageRegexFileSet

public GooglePrivacyDlpV2CloudStorageRegexFileSet()

Method Detail

getBucketName

public String getBucketName()

The name of a Cloud Storage bucket. Required.

Returns:

value or null for none

setBucketName

public GooglePrivacyDlpV2CloudStorageRegexFileSet setBucketName(String bucketName)

The name of a Cloud Storage bucket. Required.

Parameters:

bucketName - bucketName or null for none

getExcludeRegex

public List<String> getExcludeRegex()

A list of regular expressions matching file paths to exclude. All files in the bucket that match at least one of these regular expressions will be excluded from the scan. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub.

Returns:

value or null for none

setExcludeRegex

public GooglePrivacyDlpV2CloudStorageRegexFileSet setExcludeRegex(List<String> excludeRegex)

A list of regular expressions matching file paths to exclude. All files in the bucket that match at least one of these regular expressions will be excluded from the scan. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub.

Parameters:

excludeRegex - excludeRegex or null for none

getIncludeRegex

public List<String> getIncludeRegex()

A list of regular expressions matching file paths to include. All files in the bucket that match at least one of these regular expressions will be included in the set of files, except for those that also match an item in `exclude_regex`. Leaving this field empty will match all files by default (this is equivalent to including `.*` in the list). Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub.

Returns:

value or null for none

setIncludeRegex

public GooglePrivacyDlpV2CloudStorageRegexFileSet setIncludeRegex(List<String> includeRegex)

A list of regular expressions matching file paths to include. All files in the bucket that match at least one of these regular expressions will be included in the set of files, except for those that also match an item in `exclude_regex`. Leaving this field empty will match all files by default (this is equivalent to including `.*` in the list). Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub.

Parameters:

includeRegex - includeRegex or null for none

set

public GooglePrivacyDlpV2CloudStorageRegexFileSet set(String fieldName,
                                                      Object value)

Overrides:

set in class GenericJson

clone

public GooglePrivacyDlpV2CloudStorageRegexFileSet clone()

Overrides:

clone in class GenericJson