Package com.google.privacy.dlp.v2

Interface InspectConfigOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    InspectConfig, InspectConfig.Builder
    public interface InspectConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getInfoTypesList

        List<InfoType> getInfoTypesList()
         Restricts what info_types to look for. The values must correspond to
 InfoType values returned by ListInfoTypes or listed at
 https://cloud.google.com/dlp/docs/infotypes-reference.

 When no InfoTypes or CustomInfoTypes are specified in a request, the
 system may automatically choose what detectors to run. By default this may
 be all types, but may change over time as detectors are updated.

 If you need precise control and predictability as to what detectors are
 run you should specify specific InfoTypes listed in the reference,
 otherwise a default list will be used, which may change over time.
        repeated .google.privacy.dlp.v2.InfoType info_types = 1;

      • getInfoTypes

        InfoType getInfoTypes​(int index)
         Restricts what info_types to look for. The values must correspond to
 InfoType values returned by ListInfoTypes or listed at
 https://cloud.google.com/dlp/docs/infotypes-reference.

 When no InfoTypes or CustomInfoTypes are specified in a request, the
 system may automatically choose what detectors to run. By default this may
 be all types, but may change over time as detectors are updated.

 If you need precise control and predictability as to what detectors are
 run you should specify specific InfoTypes listed in the reference,
 otherwise a default list will be used, which may change over time.
        repeated .google.privacy.dlp.v2.InfoType info_types = 1;

      • getInfoTypesCount

        int getInfoTypesCount()
         Restricts what info_types to look for. The values must correspond to
 InfoType values returned by ListInfoTypes or listed at
 https://cloud.google.com/dlp/docs/infotypes-reference.

 When no InfoTypes or CustomInfoTypes are specified in a request, the
 system may automatically choose what detectors to run. By default this may
 be all types, but may change over time as detectors are updated.

 If you need precise control and predictability as to what detectors are
 run you should specify specific InfoTypes listed in the reference,
 otherwise a default list will be used, which may change over time.
        repeated .google.privacy.dlp.v2.InfoType info_types = 1;

      • getInfoTypesOrBuilderList

        List<? extends InfoTypeOrBuilder> getInfoTypesOrBuilderList()
         Restricts what info_types to look for. The values must correspond to
 InfoType values returned by ListInfoTypes or listed at
 https://cloud.google.com/dlp/docs/infotypes-reference.

 When no InfoTypes or CustomInfoTypes are specified in a request, the
 system may automatically choose what detectors to run. By default this may
 be all types, but may change over time as detectors are updated.

 If you need precise control and predictability as to what detectors are
 run you should specify specific InfoTypes listed in the reference,
 otherwise a default list will be used, which may change over time.
        repeated .google.privacy.dlp.v2.InfoType info_types = 1;

      • getInfoTypesOrBuilder

        InfoTypeOrBuilder getInfoTypesOrBuilder​(int index)
         Restricts what info_types to look for. The values must correspond to
 InfoType values returned by ListInfoTypes or listed at
 https://cloud.google.com/dlp/docs/infotypes-reference.

 When no InfoTypes or CustomInfoTypes are specified in a request, the
 system may automatically choose what detectors to run. By default this may
 be all types, but may change over time as detectors are updated.

 If you need precise control and predictability as to what detectors are
 run you should specify specific InfoTypes listed in the reference,
 otherwise a default list will be used, which may change over time.
        repeated .google.privacy.dlp.v2.InfoType info_types = 1;

      • getMinLikelihoodValue

        int getMinLikelihoodValue()
         Only returns findings equal or above this threshold. The default is
 POSSIBLE.
 See https://cloud.google.com/dlp/docs/likelihood to learn more.
        .google.privacy.dlp.v2.Likelihood min_likelihood = 2;
        Returns:
        The enum numeric value on the wire for minLikelihood.

      • getMinLikelihood

        Likelihood getMinLikelihood()
         Only returns findings equal or above this threshold. The default is
 POSSIBLE.
 See https://cloud.google.com/dlp/docs/likelihood to learn more.
        .google.privacy.dlp.v2.Likelihood min_likelihood = 2;
        Returns:
        The minLikelihood.

      • hasLimits

        boolean hasLimits()
         Configuration to control the number of findings returned.
 This is not used for data profiling.

 When redacting sensitive data from images, finding limits don't apply. They
 can cause unexpected or inconsistent results, where only some data is
 redacted. Don't include finding limits in
 [RedactImage][google.privacy.dlp.v2.DlpService.RedactImage]
 requests. Otherwise, Cloud DLP returns an error.
        .google.privacy.dlp.v2.InspectConfig.FindingLimits limits = 3;
        Returns:
        Whether the limits field is set.

      • getLimits

        InspectConfig.FindingLimits getLimits()
         Configuration to control the number of findings returned.
 This is not used for data profiling.

 When redacting sensitive data from images, finding limits don't apply. They
 can cause unexpected or inconsistent results, where only some data is
 redacted. Don't include finding limits in
 [RedactImage][google.privacy.dlp.v2.DlpService.RedactImage]
 requests. Otherwise, Cloud DLP returns an error.
        .google.privacy.dlp.v2.InspectConfig.FindingLimits limits = 3;
        Returns:
        The limits.

      • getLimitsOrBuilder

        InspectConfig.FindingLimitsOrBuilder getLimitsOrBuilder()
         Configuration to control the number of findings returned.
 This is not used for data profiling.

 When redacting sensitive data from images, finding limits don't apply. They
 can cause unexpected or inconsistent results, where only some data is
 redacted. Don't include finding limits in
 [RedactImage][google.privacy.dlp.v2.DlpService.RedactImage]
 requests. Otherwise, Cloud DLP returns an error.
        .google.privacy.dlp.v2.InspectConfig.FindingLimits limits = 3;

      • getIncludeQuote

        boolean getIncludeQuote()
         When true, a contextual quote from the data that triggered a finding is
 included in the response; see [Finding.quote][google.privacy.dlp.v2.Finding.quote].
 This is not used for data profiling.
        bool include_quote = 4;
        Returns:
        The includeQuote.

      • getExcludeInfoTypes

        boolean getExcludeInfoTypes()
         When true, excludes type information of the findings.
 This is not used for data profiling.
        bool exclude_info_types = 5;
        Returns:
        The excludeInfoTypes.

      • getCustomInfoTypesList

        List<CustomInfoType> getCustomInfoTypesList()
         CustomInfoTypes provided by the user. See
 https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.
        repeated .google.privacy.dlp.v2.CustomInfoType custom_info_types = 6;

      • getCustomInfoTypes

        CustomInfoType getCustomInfoTypes​(int index)
         CustomInfoTypes provided by the user. See
 https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.
        repeated .google.privacy.dlp.v2.CustomInfoType custom_info_types = 6;

      • getCustomInfoTypesCount

        int getCustomInfoTypesCount()
         CustomInfoTypes provided by the user. See
 https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.
        repeated .google.privacy.dlp.v2.CustomInfoType custom_info_types = 6;

      • getCustomInfoTypesOrBuilderList

        List<? extends CustomInfoTypeOrBuilder> getCustomInfoTypesOrBuilderList()
         CustomInfoTypes provided by the user. See
 https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.
        repeated .google.privacy.dlp.v2.CustomInfoType custom_info_types = 6;

      • getCustomInfoTypesOrBuilder

        CustomInfoTypeOrBuilder getCustomInfoTypesOrBuilder​(int index)
         CustomInfoTypes provided by the user. See
 https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.
        repeated .google.privacy.dlp.v2.CustomInfoType custom_info_types = 6;

      • getContentOptionsList

        List<ContentOption> getContentOptionsList()
         Deprecated and unused.
        repeated .google.privacy.dlp.v2.ContentOption content_options = 8;
        Returns:
        A list containing the contentOptions.

      • getContentOptionsCount

        int getContentOptionsCount()
         Deprecated and unused.
        repeated .google.privacy.dlp.v2.ContentOption content_options = 8;
        Returns:
        The count of contentOptions.

      • getContentOptions

        ContentOption getContentOptions​(int index)
         Deprecated and unused.
        repeated .google.privacy.dlp.v2.ContentOption content_options = 8;
        Parameters:
        index - The index of the element to return.
        Returns:
        The contentOptions at the given index.

      • getContentOptionsValueList

        List<Integer> getContentOptionsValueList()
         Deprecated and unused.
        repeated .google.privacy.dlp.v2.ContentOption content_options = 8;
        Returns:
        A list containing the enum numeric values on the wire for contentOptions.

      • getContentOptionsValue

        int getContentOptionsValue​(int index)
         Deprecated and unused.
        repeated .google.privacy.dlp.v2.ContentOption content_options = 8;
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of contentOptions at the given index.

      • getRuleSetList

        List<InspectionRuleSet> getRuleSetList()
         Set of rules to apply to the findings for this InspectConfig.
 Exclusion rules, contained in the set are executed in the end, other
 rules are executed in the order they are specified for each info type.
        repeated .google.privacy.dlp.v2.InspectionRuleSet rule_set = 10;

      • getRuleSet

        InspectionRuleSet getRuleSet​(int index)
         Set of rules to apply to the findings for this InspectConfig.
 Exclusion rules, contained in the set are executed in the end, other
 rules are executed in the order they are specified for each info type.
        repeated .google.privacy.dlp.v2.InspectionRuleSet rule_set = 10;

      • getRuleSetCount

        int getRuleSetCount()
         Set of rules to apply to the findings for this InspectConfig.
 Exclusion rules, contained in the set are executed in the end, other
 rules are executed in the order they are specified for each info type.
        repeated .google.privacy.dlp.v2.InspectionRuleSet rule_set = 10;

      • getRuleSetOrBuilderList

        List<? extends InspectionRuleSetOrBuilder> getRuleSetOrBuilderList()
         Set of rules to apply to the findings for this InspectConfig.
 Exclusion rules, contained in the set are executed in the end, other
 rules are executed in the order they are specified for each info type.
        repeated .google.privacy.dlp.v2.InspectionRuleSet rule_set = 10;

      • getRuleSetOrBuilder

        InspectionRuleSetOrBuilder getRuleSetOrBuilder​(int index)
         Set of rules to apply to the findings for this InspectConfig.
 Exclusion rules, contained in the set are executed in the end, other
 rules are executed in the order they are specified for each info type.
        repeated .google.privacy.dlp.v2.InspectionRuleSet rule_set = 10;