Package com.google.privacy.dlp.v2

Class CustomInfoType

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.privacy.dlp.v2.CustomInfoType
All Implemented Interfaces:
CustomInfoTypeOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class CustomInfoType extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Field Details

    • INFO_TYPE_FIELD_NUMBER

      public static final int INFO_TYPE_FIELD_NUMBER
      See Also:

    • LIKELIHOOD_FIELD_NUMBER

      public static final int LIKELIHOOD_FIELD_NUMBER
      See Also:

    • DICTIONARY_FIELD_NUMBER

      public static final int DICTIONARY_FIELD_NUMBER
      See Also:

    • REGEX_FIELD_NUMBER

      public static final int REGEX_FIELD_NUMBER
      See Also:

    • SURROGATE_TYPE_FIELD_NUMBER

      public static final int SURROGATE_TYPE_FIELD_NUMBER
      See Also:

    • STORED_TYPE_FIELD_NUMBER

      public static final int STORED_TYPE_FIELD_NUMBER
      See Also:

    • METADATA_KEY_VALUE_EXPRESSION_FIELD_NUMBER

      public static final int METADATA_KEY_VALUE_EXPRESSION_FIELD_NUMBER
      See Also:

    • DETECTION_RULES_FIELD_NUMBER

      public static final int DETECTION_RULES_FIELD_NUMBER
      See Also:

    • EXCLUSION_TYPE_FIELD_NUMBER

      public static final int EXCLUSION_TYPE_FIELD_NUMBER
      See Also:

    • SENSITIVITY_SCORE_FIELD_NUMBER

      public static final int SENSITIVITY_SCORE_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getTypeCase

      public CustomInfoType.TypeCase getTypeCase()
      Specified by:
      getTypeCase in interface CustomInfoTypeOrBuilder

    • 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;
      Specified by:
      hasInfoType in interface CustomInfoTypeOrBuilder
      Returns:
      Whether the infoType field is set.

    • 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;
      Specified by:
      getInfoType in interface CustomInfoTypeOrBuilder
      Returns:
      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;
      Specified by:
      getInfoTypeOrBuilder in interface CustomInfoTypeOrBuilder

    • 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;
      Specified by:
      getLikelihoodValue in interface CustomInfoTypeOrBuilder
      Returns:
      The enum numeric value on the wire for likelihood.

    • 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;
      Specified by:
      getLikelihood in interface CustomInfoTypeOrBuilder
      Returns:
      The likelihood.

    • hasDictionary

      public boolean hasDictionary()
       A list of phrases to detect as a CustomInfoType.
      .google.privacy.dlp.v2.CustomInfoType.Dictionary dictionary = 2;
      Specified by:
      hasDictionary in interface CustomInfoTypeOrBuilder
      Returns:
      Whether the dictionary field is set.

    • getDictionary

      public CustomInfoType.Dictionary getDictionary()
       A list of phrases to detect as a CustomInfoType.
      .google.privacy.dlp.v2.CustomInfoType.Dictionary dictionary = 2;
      Specified by:
      getDictionary in interface CustomInfoTypeOrBuilder
      Returns:
      The dictionary.

    • getDictionaryOrBuilder

      public CustomInfoType.DictionaryOrBuilder getDictionaryOrBuilder()
       A list of phrases to detect as a CustomInfoType.
      .google.privacy.dlp.v2.CustomInfoType.Dictionary dictionary = 2;
      Specified by:
      getDictionaryOrBuilder in interface CustomInfoTypeOrBuilder

    • hasRegex

      public boolean hasRegex()
       Regular expression based CustomInfoType.
      .google.privacy.dlp.v2.CustomInfoType.Regex regex = 3;
      Specified by:
      hasRegex in interface CustomInfoTypeOrBuilder
      Returns:
      Whether the regex field is set.

    • getRegex

      public CustomInfoType.Regex getRegex()
       Regular expression based CustomInfoType.
      .google.privacy.dlp.v2.CustomInfoType.Regex regex = 3;
      Specified by:
      getRegex in interface CustomInfoTypeOrBuilder
      Returns:
      The regex.

    • getRegexOrBuilder

      public CustomInfoType.RegexOrBuilder getRegexOrBuilder()
       Regular expression based CustomInfoType.
      .google.privacy.dlp.v2.CustomInfoType.Regex regex = 3;
      Specified by:
      getRegexOrBuilder in interface CustomInfoTypeOrBuilder

    • hasSurrogateType

      public boolean hasSurrogateType()
       Message for detecting output from deidentification transformations that
 support reversing.
      .google.privacy.dlp.v2.CustomInfoType.SurrogateType surrogate_type = 4;
      Specified by:
      hasSurrogateType in interface CustomInfoTypeOrBuilder
      Returns:
      Whether the surrogateType field is set.

    • getSurrogateType

      public CustomInfoType.SurrogateType getSurrogateType()
       Message for detecting output from deidentification transformations that
 support reversing.
      .google.privacy.dlp.v2.CustomInfoType.SurrogateType surrogate_type = 4;
      Specified by:
      getSurrogateType in interface CustomInfoTypeOrBuilder
      Returns:
      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;
      Specified by:
      getSurrogateTypeOrBuilder in interface CustomInfoTypeOrBuilder

    • hasStoredType

      public boolean hasStoredType()
       Loads an existing `StoredInfoType` resource.
      .google.privacy.dlp.v2.StoredType stored_type = 5;
      Specified by:
      hasStoredType in interface CustomInfoTypeOrBuilder
      Returns:
      Whether the storedType field is set.

    • getStoredType

      public StoredType getStoredType()
       Loads an existing `StoredInfoType` resource.
      .google.privacy.dlp.v2.StoredType stored_type = 5;
      Specified by:
      getStoredType in interface CustomInfoTypeOrBuilder
      Returns:
      The storedType.

    • getStoredTypeOrBuilder

      public StoredTypeOrBuilder getStoredTypeOrBuilder()
       Loads an existing `StoredInfoType` resource.
      .google.privacy.dlp.v2.StoredType stored_type = 5;
      Specified by:
      getStoredTypeOrBuilder in interface CustomInfoTypeOrBuilder

    • hasMetadataKeyValueExpression

      public boolean hasMetadataKeyValueExpression()
       Key-value pair to detect in the metadata.
      .google.privacy.dlp.v2.CustomInfoType.MetadataKeyValueExpression metadata_key_value_expression = 10;
      Specified by:
      hasMetadataKeyValueExpression in interface CustomInfoTypeOrBuilder
      Returns:
      Whether the metadataKeyValueExpression field is set.

    • getMetadataKeyValueExpression

      public CustomInfoType.MetadataKeyValueExpression getMetadataKeyValueExpression()
       Key-value pair to detect in the metadata.
      .google.privacy.dlp.v2.CustomInfoType.MetadataKeyValueExpression metadata_key_value_expression = 10;
      Specified by:
      getMetadataKeyValueExpression in interface CustomInfoTypeOrBuilder
      Returns:
      The metadataKeyValueExpression.

    • getMetadataKeyValueExpressionOrBuilder

      public CustomInfoType.MetadataKeyValueExpressionOrBuilder getMetadataKeyValueExpressionOrBuilder()
       Key-value pair to detect in the metadata.
      .google.privacy.dlp.v2.CustomInfoType.MetadataKeyValueExpression metadata_key_value_expression = 10;
      Specified by:
      getMetadataKeyValueExpressionOrBuilder in interface CustomInfoTypeOrBuilder

    • getDetectionRulesList

      public List<CustomInfoType.DetectionRule> getDetectionRulesList()
       Set of detection rules to apply to all findings of this CustomInfoType.
 Rules are applied in the order that they are specified. Only supported
 for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes.
      repeated .google.privacy.dlp.v2.CustomInfoType.DetectionRule detection_rules = 7;
      Specified by:
      getDetectionRulesList in interface CustomInfoTypeOrBuilder

    • getDetectionRulesOrBuilderList

      public List<? extends CustomInfoType.DetectionRuleOrBuilder> getDetectionRulesOrBuilderList()
       Set of detection rules to apply to all findings of this CustomInfoType.
 Rules are applied in the order that they are specified. Only supported
 for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes.
      repeated .google.privacy.dlp.v2.CustomInfoType.DetectionRule detection_rules = 7;
      Specified by:
      getDetectionRulesOrBuilderList in interface CustomInfoTypeOrBuilder

    • getDetectionRulesCount

      public int getDetectionRulesCount()
       Set of detection rules to apply to all findings of this CustomInfoType.
 Rules are applied in the order that they are specified. Only supported
 for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes.
      repeated .google.privacy.dlp.v2.CustomInfoType.DetectionRule detection_rules = 7;
      Specified by:
      getDetectionRulesCount in interface CustomInfoTypeOrBuilder

    • getDetectionRules

      public CustomInfoType.DetectionRule getDetectionRules(int index)
       Set of detection rules to apply to all findings of this CustomInfoType.
 Rules are applied in the order that they are specified. Only supported
 for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes.
      repeated .google.privacy.dlp.v2.CustomInfoType.DetectionRule detection_rules = 7;
      Specified by:
      getDetectionRules in interface CustomInfoTypeOrBuilder

    • getDetectionRulesOrBuilder

      public CustomInfoType.DetectionRuleOrBuilder getDetectionRulesOrBuilder(int index)
       Set of detection rules to apply to all findings of this CustomInfoType.
 Rules are applied in the order that they are specified. Only supported
 for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes.
      repeated .google.privacy.dlp.v2.CustomInfoType.DetectionRule detection_rules = 7;
      Specified by:
      getDetectionRulesOrBuilder in interface CustomInfoTypeOrBuilder

    • 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. Only supported
 for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes.
      .google.privacy.dlp.v2.CustomInfoType.ExclusionType exclusion_type = 8;
      Specified by:
      getExclusionTypeValue in interface CustomInfoTypeOrBuilder
      Returns:
      The enum numeric value on the wire for exclusionType.

    • 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. Only supported
 for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes.
      .google.privacy.dlp.v2.CustomInfoType.ExclusionType exclusion_type = 8;
      Specified by:
      getExclusionType in interface CustomInfoTypeOrBuilder
      Returns:
      The exclusionType.

    • 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;
      Specified by:
      hasSensitivityScore in interface CustomInfoTypeOrBuilder
      Returns:
      Whether the sensitivityScore field is set.

    • 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;
      Specified by:
      getSensitivityScore in interface CustomInfoTypeOrBuilder
      Returns:
      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;
      Specified by:
      getSensitivityScoreOrBuilder in interface CustomInfoTypeOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static CustomInfoType parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CustomInfoType parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CustomInfoType parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CustomInfoType parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CustomInfoType parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CustomInfoType parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CustomInfoType parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CustomInfoType parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CustomInfoType parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CustomInfoType parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CustomInfoType parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CustomInfoType parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public CustomInfoType.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static CustomInfoType.Builder newBuilder()

    • newBuilder

      public static CustomInfoType.Builder newBuilder(CustomInfoType prototype)

    • toBuilder

      public CustomInfoType.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected CustomInfoType.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static CustomInfoType getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<CustomInfoType> parser()

    • getParserForType

      public com.google.protobuf.Parser<CustomInfoType> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public CustomInfoType getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder