Class CustomInfoType (3.49.0)

public final class CustomInfoType extends GeneratedMessageV3 implements CustomInfoTypeOrBuilder

Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question.

Protobuf type google.privacy.dlp.v2.CustomInfoType

Static Fields

DETECTION_RULES_FIELD_NUMBER

public static final int DETECTION_RULES_FIELD_NUMBER
Field Value
Type Description
int

DICTIONARY_FIELD_NUMBER

public static final int DICTIONARY_FIELD_NUMBER
Field Value
Type Description
int

EXCLUSION_TYPE_FIELD_NUMBER

public static final int EXCLUSION_TYPE_FIELD_NUMBER
Field Value
Type Description
int

INFO_TYPE_FIELD_NUMBER

public static final int INFO_TYPE_FIELD_NUMBER
Field Value
Type Description
int

LIKELIHOOD_FIELD_NUMBER

public static final int LIKELIHOOD_FIELD_NUMBER
Field Value
Type Description
int

REGEX_FIELD_NUMBER

public static final int REGEX_FIELD_NUMBER
Field Value
Type Description
int

SENSITIVITY_SCORE_FIELD_NUMBER

public static final int SENSITIVITY_SCORE_FIELD_NUMBER
Field Value
Type Description
int

STORED_TYPE_FIELD_NUMBER

public static final int STORED_TYPE_FIELD_NUMBER
Field Value
Type Description
int

SURROGATE_TYPE_FIELD_NUMBER

public static final int SURROGATE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CustomInfoType getDefaultInstance()
Returns
Type Description
CustomInfoType

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CustomInfoType.Builder newBuilder()
Returns
Type Description
CustomInfoType.Builder

newBuilder(CustomInfoType prototype)

public static CustomInfoType.Builder newBuilder(CustomInfoType prototype)
Parameter
Name Description
prototype CustomInfoType
Returns
Type Description
CustomInfoType.Builder

parseDelimitedFrom(InputStream input)

public static CustomInfoType parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CustomInfoType
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomInfoType parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomInfoType
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CustomInfoType parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CustomInfoType
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CustomInfoType parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomInfoType
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CustomInfoType parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CustomInfoType
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CustomInfoType parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomInfoType
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CustomInfoType parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CustomInfoType
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomInfoType parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomInfoType
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CustomInfoType parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CustomInfoType
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomInfoType parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomInfoType
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CustomInfoType parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CustomInfoType
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CustomInfoType parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomInfoType
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CustomInfoType> parser()
Returns
Type Description
Parser<CustomInfoType>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public CustomInfoType getDefaultInstanceForType()
Returns
Type Description
CustomInfoType

getDetectionRules(int index)

public CustomInfoType.DetectionRule getDetectionRules(int index)

Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the surrogate_type CustomInfoType.

repeated .google.privacy.dlp.v2.CustomInfoType.DetectionRule detection_rules = 7;

Parameter
Name Description
index int
Returns
Type Description
CustomInfoType.DetectionRule

getDetectionRulesCount()

public int getDetectionRulesCount()

Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the surrogate_type CustomInfoType.

repeated .google.privacy.dlp.v2.CustomInfoType.DetectionRule detection_rules = 7;

Returns
Type Description
int

getDetectionRulesList()

public List<CustomInfoType.DetectionRule> getDetectionRulesList()

Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the surrogate_type CustomInfoType.

repeated .google.privacy.dlp.v2.CustomInfoType.DetectionRule detection_rules = 7;

Returns
Type Description
List<DetectionRule>

getDetectionRulesOrBuilder(int index)

public CustomInfoType.DetectionRuleOrBuilder getDetectionRulesOrBuilder(int index)

Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the surrogate_type CustomInfoType.

repeated .google.privacy.dlp.v2.CustomInfoType.DetectionRule detection_rules = 7;

Parameter
Name Description
index int
Returns
Type Description
CustomInfoType.DetectionRuleOrBuilder

getDetectionRulesOrBuilderList()

public List<? extends CustomInfoType.DetectionRuleOrBuilder> getDetectionRulesOrBuilderList()

Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the surrogate_type CustomInfoType.

repeated .google.privacy.dlp.v2.CustomInfoType.DetectionRule detection_rules = 7;

Returns
Type Description
List<? extends com.google.privacy.dlp.v2.CustomInfoType.DetectionRuleOrBuilder>

getDictionary()

public CustomInfoType.Dictionary getDictionary()

A list of phrases to detect as a CustomInfoType.

.google.privacy.dlp.v2.CustomInfoType.Dictionary dictionary = 2;

Returns
Type Description
CustomInfoType.Dictionary

The dictionary.

getDictionaryOrBuilder()

public CustomInfoType.DictionaryOrBuilder getDictionaryOrBuilder()

A list of phrases to detect as a CustomInfoType.

.google.privacy.dlp.v2.CustomInfoType.Dictionary dictionary = 2;

Returns
Type Description
CustomInfoType.DictionaryOrBuilder

getExclusionType()

public CustomInfoType.ExclusionType getExclusionType()

If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching.

.google.privacy.dlp.v2.CustomInfoType.ExclusionType exclusion_type = 8;

Returns
Type Description
CustomInfoType.ExclusionType

The exclusionType.

getExclusionTypeValue()

public int getExclusionTypeValue()

If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching.

.google.privacy.dlp.v2.CustomInfoType.ExclusionType exclusion_type = 8;

Returns
Type Description
int

The enum numeric value on the wire for exclusionType.

getInfoType()

public InfoType getInfoType()

CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in InspectContent.info_types field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in InspectContent.info_types list then the name is treated as a custom info type.

.google.privacy.dlp.v2.InfoType info_type = 1;

Returns
Type Description
InfoType

The infoType.

getInfoTypeOrBuilder()

public InfoTypeOrBuilder getInfoTypeOrBuilder()

CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in InspectContent.info_types field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in InspectContent.info_types list then the name is treated as a custom info type.

.google.privacy.dlp.v2.InfoType info_type = 1;

Returns
Type Description
InfoTypeOrBuilder

getLikelihood()

public Likelihood getLikelihood()

Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to VERY_LIKELY if not specified.

.google.privacy.dlp.v2.Likelihood likelihood = 6;

Returns
Type Description
Likelihood

The likelihood.

getLikelihoodValue()

public int getLikelihoodValue()

Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to VERY_LIKELY if not specified.

.google.privacy.dlp.v2.Likelihood likelihood = 6;

Returns
Type Description
int

The enum numeric value on the wire for likelihood.

getParserForType()

public Parser<CustomInfoType> getParserForType()
Returns
Type Description
Parser<CustomInfoType>
Overrides

getRegex()

public CustomInfoType.Regex getRegex()

Regular expression based CustomInfoType.

.google.privacy.dlp.v2.CustomInfoType.Regex regex = 3;

Returns
Type Description
CustomInfoType.Regex

The regex.

getRegexOrBuilder()

public CustomInfoType.RegexOrBuilder getRegexOrBuilder()

Regular expression based CustomInfoType.

.google.privacy.dlp.v2.CustomInfoType.Regex regex = 3;

Returns
Type Description
CustomInfoType.RegexOrBuilder

getSensitivityScore()

public SensitivityScore getSensitivityScore()

Sensitivity for this CustomInfoType. If this CustomInfoType extends an existing InfoType, the sensitivity here will take precedence over that of the original InfoType. If unset for a CustomInfoType, it will default to HIGH. This only applies to data profiling.

.google.privacy.dlp.v2.SensitivityScore sensitivity_score = 9;

Returns
Type Description
SensitivityScore

The sensitivityScore.

getSensitivityScoreOrBuilder()

public SensitivityScoreOrBuilder getSensitivityScoreOrBuilder()

Sensitivity for this CustomInfoType. If this CustomInfoType extends an existing InfoType, the sensitivity here will take precedence over that of the original InfoType. If unset for a CustomInfoType, it will default to HIGH. This only applies to data profiling.

.google.privacy.dlp.v2.SensitivityScore sensitivity_score = 9;

Returns
Type Description
SensitivityScoreOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStoredType()

public StoredType getStoredType()

Load an existing StoredInfoType resource for use in InspectDataSource. Not currently supported in InspectContent.

.google.privacy.dlp.v2.StoredType stored_type = 5;

Returns
Type Description
StoredType

The storedType.

getStoredTypeOrBuilder()

public StoredTypeOrBuilder getStoredTypeOrBuilder()

Load an existing StoredInfoType resource for use in InspectDataSource. Not currently supported in InspectContent.

.google.privacy.dlp.v2.StoredType stored_type = 5;

Returns
Type Description
StoredTypeOrBuilder

getSurrogateType()

public CustomInfoType.SurrogateType getSurrogateType()

Message for detecting output from deidentification transformations that support reversing.

.google.privacy.dlp.v2.CustomInfoType.SurrogateType surrogate_type = 4;

Returns
Type Description
CustomInfoType.SurrogateType

The surrogateType.

getSurrogateTypeOrBuilder()

public CustomInfoType.SurrogateTypeOrBuilder getSurrogateTypeOrBuilder()

Message for detecting output from deidentification transformations that support reversing.

.google.privacy.dlp.v2.CustomInfoType.SurrogateType surrogate_type = 4;

Returns
Type Description
CustomInfoType.SurrogateTypeOrBuilder

getTypeCase()

public CustomInfoType.TypeCase getTypeCase()
Returns
Type Description
CustomInfoType.TypeCase

hasDictionary()

public boolean hasDictionary()

A list of phrases to detect as a CustomInfoType.

.google.privacy.dlp.v2.CustomInfoType.Dictionary dictionary = 2;

Returns
Type Description
boolean

Whether the dictionary field is set.

hasInfoType()

public boolean hasInfoType()

CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in InspectContent.info_types field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in InspectContent.info_types list then the name is treated as a custom info type.

.google.privacy.dlp.v2.InfoType info_type = 1;

Returns
Type Description
boolean

Whether the infoType field is set.

hasRegex()

public boolean hasRegex()

Regular expression based CustomInfoType.

.google.privacy.dlp.v2.CustomInfoType.Regex regex = 3;

Returns
Type Description
boolean

Whether the regex field is set.

hasSensitivityScore()

public boolean hasSensitivityScore()

Sensitivity for this CustomInfoType. If this CustomInfoType extends an existing InfoType, the sensitivity here will take precedence over that of the original InfoType. If unset for a CustomInfoType, it will default to HIGH. This only applies to data profiling.

.google.privacy.dlp.v2.SensitivityScore sensitivity_score = 9;

Returns
Type Description
boolean

Whether the sensitivityScore field is set.

hasStoredType()

public boolean hasStoredType()

Load an existing StoredInfoType resource for use in InspectDataSource. Not currently supported in InspectContent.

.google.privacy.dlp.v2.StoredType stored_type = 5;

Returns
Type Description
boolean

Whether the storedType field is set.

hasSurrogateType()

public boolean hasSurrogateType()

Message for detecting output from deidentification transformations that support reversing.

.google.privacy.dlp.v2.CustomInfoType.SurrogateType surrogate_type = 4;

Returns
Type Description
boolean

Whether the surrogateType field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CustomInfoType.Builder newBuilderForType()
Returns
Type Description
CustomInfoType.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CustomInfoType.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CustomInfoType.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CustomInfoType.Builder toBuilder()
Returns
Type Description
CustomInfoType.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException