Package com.google.privacy.dlp.v2

Class InspectConfig

  • All Implemented Interfaces:
    InspectConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class InspectConfig
extends com.google.protobuf.GeneratedMessageV3
implements InspectConfigOrBuilder
     Configuration description of the scanning process.
 When used with redactContent only info_types and min_likelihood are currently
 used.
    Protobuf type google.privacy.dlp.v2.InspectConfig
    See Also:
    Serialized Form

    • Field Detail

      • INFO_TYPES_FIELD_NUMBER

        public static final int INFO_TYPES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MIN_LIKELIHOOD_FIELD_NUMBER

        public static final int MIN_LIKELIHOOD_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INCLUDE_QUOTE_FIELD_NUMBER

        public static final int INCLUDE_QUOTE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXCLUDE_INFO_TYPES_FIELD_NUMBER

        public static final int EXCLUDE_INFO_TYPES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CUSTOM_INFO_TYPES_FIELD_NUMBER

        public static final int CUSTOM_INFO_TYPES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CONTENT_OPTIONS_FIELD_NUMBER

        public static final int CONTENT_OPTIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • getInfoTypesList

        public 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;
        Specified by:
        getInfoTypesList in interface InspectConfigOrBuilder

      • getInfoTypesOrBuilderList

        public 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;
        Specified by:
        getInfoTypesOrBuilderList in interface InspectConfigOrBuilder

      • getInfoTypesCount

        public 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;
        Specified by:
        getInfoTypesCount in interface InspectConfigOrBuilder

      • getInfoTypes

        public 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;
        Specified by:
        getInfoTypes in interface InspectConfigOrBuilder

      • getInfoTypesOrBuilder

        public 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;
        Specified by:
        getInfoTypesOrBuilder in interface InspectConfigOrBuilder

      • getMinLikelihoodValue

        public 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;
        Specified by:
        getMinLikelihoodValue in interface InspectConfigOrBuilder
        Returns:
        The enum numeric value on the wire for minLikelihood.

      • getMinLikelihood

        public 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;
        Specified by:
        getMinLikelihood in interface InspectConfigOrBuilder
        Returns:
        The minLikelihood.

      • hasLimits

        public 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;
        Specified by:
        hasLimits in interface InspectConfigOrBuilder
        Returns:
        Whether the limits field is set.

      • getLimits

        public 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;
        Specified by:
        getLimits in interface InspectConfigOrBuilder
        Returns:
        The limits.

      • getLimitsOrBuilder

        public 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;
        Specified by:
        getLimitsOrBuilder in interface InspectConfigOrBuilder

      • getIncludeQuote

        public 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;
        Specified by:
        getIncludeQuote in interface InspectConfigOrBuilder
        Returns:
        The includeQuote.

      • getExcludeInfoTypes

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

      • getCustomInfoTypesList

        public 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;
        Specified by:
        getCustomInfoTypesList in interface InspectConfigOrBuilder

      • getCustomInfoTypesCount

        public 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;
        Specified by:
        getCustomInfoTypesCount in interface InspectConfigOrBuilder

      • getCustomInfoTypes

        public 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;
        Specified by:
        getCustomInfoTypes in interface InspectConfigOrBuilder

      • getCustomInfoTypesOrBuilder

        public 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;
        Specified by:
        getCustomInfoTypesOrBuilder in interface InspectConfigOrBuilder

      • getContentOptionsCount

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

      • getContentOptions

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

      • getContentOptionsValueList

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

      • getContentOptionsValue

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

      • getRuleSetList

        public 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;
        Specified by:
        getRuleSetList in interface InspectConfigOrBuilder

      • getRuleSetOrBuilderList

        public 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;
        Specified by:
        getRuleSetOrBuilderList in interface InspectConfigOrBuilder

      • getRuleSetCount

        public 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;
        Specified by:
        getRuleSetCount in interface InspectConfigOrBuilder

      • getRuleSet

        public 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;
        Specified by:
        getRuleSet in interface InspectConfigOrBuilder

      • getRuleSetOrBuilder

        public 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;
        Specified by:
        getRuleSetOrBuilder in interface InspectConfigOrBuilder

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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 InspectConfig parseFrom​(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected InspectConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static InspectConfig getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<InspectConfig> 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.GeneratedMessageV3

      • getDefaultInstanceForType

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