Interface CustomInfoTypeOrBuilder (3.57.0)

public interface CustomInfoTypeOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDetectionRules(int index)

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getRegex()

public abstract CustomInfoType.Regex getRegex()

Regular expression based CustomInfoType.

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

Returns
Type Description
CustomInfoType.Regex

The regex.

getRegexOrBuilder()

public abstract CustomInfoType.RegexOrBuilder getRegexOrBuilder()

Regular expression based CustomInfoType.

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

Returns
Type Description
CustomInfoType.RegexOrBuilder

getSensitivityScore()

public abstract 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 abstract 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

getStoredType()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract CustomInfoType.TypeCase getTypeCase()
Returns
Type Description
CustomInfoType.TypeCase

hasDictionary()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.