public final class CloudStorageRegexFileSet extends com.google.protobuf.GeneratedMessageV3 implements CloudStorageRegexFileSetOrBuilder
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 `/`
Protobuf type google.privacy.dlp.v2.CloudStorageRegexFileSet| Modifier and Type | Class and Description |
|---|---|
static class |
CloudStorageRegexFileSet.Builder
Message representing a set of files in a Cloud Storage bucket.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
BUCKET_NAME_FIELD_NUMBER |
static int |
EXCLUDE_REGEX_FIELD_NUMBER |
static int |
INCLUDE_REGEX_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
String |
getBucketName()
The name of a Cloud Storage bucket.
|
com.google.protobuf.ByteString |
getBucketNameBytes()
The name of a Cloud Storage bucket.
|
static CloudStorageRegexFileSet |
getDefaultInstance() |
CloudStorageRegexFileSet |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getExcludeRegex(int index)
A list of regular expressions matching file paths to exclude.
|
com.google.protobuf.ByteString |
getExcludeRegexBytes(int index)
A list of regular expressions matching file paths to exclude.
|
int |
getExcludeRegexCount()
A list of regular expressions matching file paths to exclude.
|
com.google.protobuf.ProtocolStringList |
getExcludeRegexList()
A list of regular expressions matching file paths to exclude.
|
String |
getIncludeRegex(int index)
A list of regular expressions matching file paths to include.
|
com.google.protobuf.ByteString |
getIncludeRegexBytes(int index)
A list of regular expressions matching file paths to include.
|
int |
getIncludeRegexCount()
A list of regular expressions matching file paths to include.
|
com.google.protobuf.ProtocolStringList |
getIncludeRegexList()
A list of regular expressions matching file paths to include.
|
com.google.protobuf.Parser<CloudStorageRegexFileSet> |
getParserForType() |
int |
getSerializedSize() |
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
int |
hashCode() |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static CloudStorageRegexFileSet.Builder |
newBuilder() |
static CloudStorageRegexFileSet.Builder |
newBuilder(CloudStorageRegexFileSet prototype) |
CloudStorageRegexFileSet.Builder |
newBuilderForType() |
protected CloudStorageRegexFileSet.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static CloudStorageRegexFileSet |
parseDelimitedFrom(InputStream input) |
static CloudStorageRegexFileSet |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static CloudStorageRegexFileSet |
parseFrom(byte[] data) |
static CloudStorageRegexFileSet |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static CloudStorageRegexFileSet |
parseFrom(ByteBuffer data) |
static CloudStorageRegexFileSet |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static CloudStorageRegexFileSet |
parseFrom(com.google.protobuf.ByteString data) |
static CloudStorageRegexFileSet |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static CloudStorageRegexFileSet |
parseFrom(com.google.protobuf.CodedInputStream input) |
static CloudStorageRegexFileSet |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static CloudStorageRegexFileSet |
parseFrom(InputStream input) |
static CloudStorageRegexFileSet |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<CloudStorageRegexFileSet> |
parser() |
CloudStorageRegexFileSet.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int BUCKET_NAME_FIELD_NUMBER
public static final int INCLUDE_REGEX_FIELD_NUMBER
public static final int EXCLUDE_REGEX_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getBucketName()
The name of a Cloud Storage bucket. Required.
string bucket_name = 1;getBucketName in interface CloudStorageRegexFileSetOrBuilderpublic com.google.protobuf.ByteString getBucketNameBytes()
The name of a Cloud Storage bucket. Required.
string bucket_name = 1;getBucketNameBytes in interface CloudStorageRegexFileSetOrBuilderpublic com.google.protobuf.ProtocolStringList getIncludeRegexList()
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.
repeated string include_regex = 2;getIncludeRegexList in interface CloudStorageRegexFileSetOrBuilderpublic int getIncludeRegexCount()
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.
repeated string include_regex = 2;getIncludeRegexCount in interface CloudStorageRegexFileSetOrBuilderpublic String getIncludeRegex(int index)
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.
repeated string include_regex = 2;getIncludeRegex in interface CloudStorageRegexFileSetOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getIncludeRegexBytes(int index)
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.
repeated string include_regex = 2;getIncludeRegexBytes in interface CloudStorageRegexFileSetOrBuilderindex - The index of the value to return.public com.google.protobuf.ProtocolStringList getExcludeRegexList()
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.
repeated string exclude_regex = 3;getExcludeRegexList in interface CloudStorageRegexFileSetOrBuilderpublic int getExcludeRegexCount()
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.
repeated string exclude_regex = 3;getExcludeRegexCount in interface CloudStorageRegexFileSetOrBuilderpublic String getExcludeRegex(int index)
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.
repeated string exclude_regex = 3;getExcludeRegex in interface CloudStorageRegexFileSetOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getExcludeRegexBytes(int index)
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.
repeated string exclude_regex = 3;getExcludeRegexBytes in interface CloudStorageRegexFileSetOrBuilderindex - The index of the value to return.public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static CloudStorageRegexFileSet parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CloudStorageRegexFileSet parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CloudStorageRegexFileSet parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CloudStorageRegexFileSet parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CloudStorageRegexFileSet parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CloudStorageRegexFileSet parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CloudStorageRegexFileSet parseFrom(InputStream input) throws IOException
IOExceptionpublic static CloudStorageRegexFileSet parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static CloudStorageRegexFileSet parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static CloudStorageRegexFileSet parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static CloudStorageRegexFileSet parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static CloudStorageRegexFileSet parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic CloudStorageRegexFileSet.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static CloudStorageRegexFileSet.Builder newBuilder()
public static CloudStorageRegexFileSet.Builder newBuilder(CloudStorageRegexFileSet prototype)
public CloudStorageRegexFileSet.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected CloudStorageRegexFileSet.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static CloudStorageRegexFileSet getDefaultInstance()
public static com.google.protobuf.Parser<CloudStorageRegexFileSet> parser()
public com.google.protobuf.Parser<CloudStorageRegexFileSet> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public CloudStorageRegexFileSet getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2022 Google LLC. All rights reserved.