Class ExcludeByHotword (3.21.0)

public final class ExcludeByHotword extends GeneratedMessageV3 implements ExcludeByHotwordOrBuilder

The rule to exclude findings based on a hotword. For record inspection of tables, column names are considered hotwords. An example of this is to exclude a finding if a BigQuery column matches a specific pattern.

Protobuf type google.privacy.dlp.v2.ExcludeByHotword

Static Fields

HOTWORD_REGEX_FIELD_NUMBER

public static final int HOTWORD_REGEX_FIELD_NUMBER
Field Value
TypeDescription
int

PROXIMITY_FIELD_NUMBER

public static final int PROXIMITY_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ExcludeByHotword getDefaultInstance()
Returns
TypeDescription
ExcludeByHotword

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ExcludeByHotword.Builder newBuilder()
Returns
TypeDescription
ExcludeByHotword.Builder

newBuilder(ExcludeByHotword prototype)

public static ExcludeByHotword.Builder newBuilder(ExcludeByHotword prototype)
Parameter
NameDescription
prototypeExcludeByHotword
Returns
TypeDescription
ExcludeByHotword.Builder

parseDelimitedFrom(InputStream input)

public static ExcludeByHotword parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExcludeByHotword
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExcludeByHotword parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExcludeByHotword
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ExcludeByHotword parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ExcludeByHotword
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExcludeByHotword parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExcludeByHotword
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExcludeByHotword parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ExcludeByHotword
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExcludeByHotword parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExcludeByHotword
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExcludeByHotword parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ExcludeByHotword
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExcludeByHotword parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExcludeByHotword
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ExcludeByHotword parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExcludeByHotword
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExcludeByHotword parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExcludeByHotword
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ExcludeByHotword parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ExcludeByHotword
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExcludeByHotword parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExcludeByHotword
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ExcludeByHotword> parser()
Returns
TypeDescription
Parser<ExcludeByHotword>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public ExcludeByHotword getDefaultInstanceForType()
Returns
TypeDescription
ExcludeByHotword

getHotwordRegex()

public CustomInfoType.Regex getHotwordRegex()

Regular expression pattern defining what qualifies as a hotword.

.google.privacy.dlp.v2.CustomInfoType.Regex hotword_regex = 1;

Returns
TypeDescription
CustomInfoType.Regex

The hotwordRegex.

getHotwordRegexOrBuilder()

public CustomInfoType.RegexOrBuilder getHotwordRegexOrBuilder()

Regular expression pattern defining what qualifies as a hotword.

.google.privacy.dlp.v2.CustomInfoType.Regex hotword_regex = 1;

Returns
TypeDescription
CustomInfoType.RegexOrBuilder

getParserForType()

public Parser<ExcludeByHotword> getParserForType()
Returns
TypeDescription
Parser<ExcludeByHotword>
Overrides

getProximity()

public CustomInfoType.DetectionRule.Proximity getProximity()

Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The windowBefore property in proximity should be set to 1 if the hotword needs to be included in a column header.

.google.privacy.dlp.v2.CustomInfoType.DetectionRule.Proximity proximity = 2;

Returns
TypeDescription
CustomInfoType.DetectionRule.Proximity

The proximity.

getProximityOrBuilder()

public CustomInfoType.DetectionRule.ProximityOrBuilder getProximityOrBuilder()

Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The windowBefore property in proximity should be set to 1 if the hotword needs to be included in a column header.

.google.privacy.dlp.v2.CustomInfoType.DetectionRule.Proximity proximity = 2;

Returns
TypeDescription
CustomInfoType.DetectionRule.ProximityOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasHotwordRegex()

public boolean hasHotwordRegex()

Regular expression pattern defining what qualifies as a hotword.

.google.privacy.dlp.v2.CustomInfoType.Regex hotword_regex = 1;

Returns
TypeDescription
boolean

Whether the hotwordRegex field is set.

hasProximity()

public boolean hasProximity()

Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The windowBefore property in proximity should be set to 1 if the hotword needs to be included in a column header.

.google.privacy.dlp.v2.CustomInfoType.DetectionRule.Proximity proximity = 2;

Returns
TypeDescription
boolean

Whether the proximity field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ExcludeByHotword.Builder newBuilderForType()
Returns
TypeDescription
ExcludeByHotword.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExcludeByHotword.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ExcludeByHotword.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ExcludeByHotword.Builder toBuilder()
Returns
TypeDescription
ExcludeByHotword.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException