google-cloud-dlp-v2 0.18.0 → 0.19.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -32,36 +32,43 @@ module Google
32
32
  # @!attribute [rw] version
33
33
  # @return [::String]
34
34
  # Optional version name for this InfoType.
35
+ # @!attribute [rw] sensitivity_score
36
+ # @return [::Google::Cloud::Dlp::V2::SensitivityScore]
37
+ # Optional custom sensitivity for this InfoType.
38
+ # This only applies to data profiling.
35
39
  class InfoType
36
40
  include ::Google::Protobuf::MessageExts
37
41
  extend ::Google::Protobuf::MessageExts::ClassMethods
38
42
  end
39
43
 
40
- # Score is a summary of all elements in the data profile.
41
- # A higher number means more sensitive.
44
+ # Score is calculated from of all elements in the data profile.
45
+ # A higher level means the data is more sensitive.
42
46
  # @!attribute [rw] score
43
47
  # @return [::Google::Cloud::Dlp::V2::SensitivityScore::SensitivityScoreLevel]
44
- # The score applied to the resource.
48
+ # The sensitivity score applied to the resource.
45
49
  class SensitivityScore
46
50
  include ::Google::Protobuf::MessageExts
47
51
  extend ::Google::Protobuf::MessageExts::ClassMethods
48
52
 
49
- # Various score levels for resources.
53
+ # Various sensitivity score levels for resources.
50
54
  module SensitivityScoreLevel
51
55
  # Unused.
52
56
  SENSITIVITY_SCORE_UNSPECIFIED = 0
53
57
 
54
- # No sensitive information detected. Limited access.
58
+ # No sensitive information detected. The resource isn't publicly
59
+ # accessible.
55
60
  SENSITIVITY_LOW = 10
56
61
 
57
- # Medium risk - PII, potentially sensitive data, or fields with free-text
58
- # data that are at higher risk of having intermittent sensitive data.
59
- # Consider limiting access.
62
+ # Medium risk. Contains personally identifiable information (PII),
63
+ # potentially sensitive data, or fields with free-text data that are at a
64
+ # higher risk of having intermittent sensitive data. Consider limiting
65
+ # access.
60
66
  SENSITIVITY_MODERATE = 20
61
67
 
62
- # High risk – SPII may be present. Exfiltration of data may lead to user
63
- # data loss. Re-identification of users may be possible. Consider limiting
64
- # usage and or removing SPII.
68
+ # High risk. Sensitive personally identifiable information (SPII) can be
69
+ # present. Exfiltration of data can lead to user data loss.
70
+ # Re-identification of users might be possible. Consider limiting usage and
71
+ # or removing SPII.
65
72
  SENSITIVITY_HIGH = 30
66
73
  end
67
74
  end
@@ -119,6 +126,13 @@ module Google
119
126
  # @return [::Google::Cloud::Dlp::V2::CustomInfoType::ExclusionType]
120
127
  # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding
121
128
  # to be returned. It still can be used for rules matching.
129
+ # @!attribute [rw] sensitivity_score
130
+ # @return [::Google::Cloud::Dlp::V2::SensitivityScore]
131
+ # Sensitivity for this CustomInfoType. If this CustomInfoType extends an
132
+ # existing InfoType, the sensitivity here will take precedence over that of
133
+ # the original InfoType. If unset for a CustomInfoType, it will default to
134
+ # HIGH.
135
+ # This only applies to data profiling.
122
136
  class CustomInfoType
123
137
  include ::Google::Protobuf::MessageExts
124
138
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -400,16 +414,22 @@ module Google
400
414
  # @!attribute [rw] bytes_limit_per_file
401
415
  # @return [::Integer]
402
416
  # Max number of bytes to scan from a file. If a scanned file's size is bigger
403
- # than this value then the rest of the bytes are omitted. Only one
404
- # of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.
405
- # Cannot be set if de-identification is requested.
417
+ # than this value then the rest of the bytes are omitted. Only one of
418
+ # `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified.
419
+ # This field can't be set if de-identification is requested. For certain file
420
+ # types, setting this field has no effect. For more information, see [Limits
421
+ # on bytes scanned per
422
+ # file](https://cloud.google.com/dlp/docs/supported-file-types#max-byte-size-per-file).
406
423
  # @!attribute [rw] bytes_limit_per_file_percent
407
424
  # @return [::Integer]
408
425
  # Max percentage of bytes to scan from a file. The rest are omitted. The
409
426
  # number of bytes scanned is rounded down. Must be between 0 and 100,
410
- # inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one
411
- # of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.
412
- # Cannot be set if de-identification is requested.
427
+ # inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of
428
+ # bytes_limit_per_file and bytes_limit_per_file_percent can be specified.
429
+ # This field can't be set if de-identification is requested. For certain file
430
+ # types, setting this field has no effect. For more information, see [Limits
431
+ # on bytes scanned per
432
+ # file](https://cloud.google.com/dlp/docs/supported-file-types#max-byte-size-per-file).
413
433
  # @!attribute [rw] file_types
414
434
  # @return [::Array<::Google::Cloud::Dlp::V2::FileType>]
415
435
  # List of file type groups to include in the scan.
@@ -517,9 +537,15 @@ module Google
517
537
  # @return [::Array<::Google::Cloud::Dlp::V2::FieldId>]
518
538
  # References to fields excluded from scanning. This allows you to skip
519
539
  # inspection of entire columns which you know have no findings.
540
+ # When inspecting a table, we recommend that you inspect all columns.
541
+ # Otherwise, findings might be affected because hints from excluded columns
542
+ # will not be used.
520
543
  # @!attribute [rw] included_fields
521
544
  # @return [::Array<::Google::Cloud::Dlp::V2::FieldId>]
522
545
  # Limit scanning only to these fields.
546
+ # When inspecting a table, we recommend that you inspect all columns.
547
+ # Otherwise, findings might be affected because hints from excluded columns
548
+ # will not be used.
523
549
  class BigQueryOptions
524
550
  include ::Google::Protobuf::MessageExts
525
551
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -814,23 +840,38 @@ module Google
814
840
  extend ::Google::Protobuf::MessageExts::ClassMethods
815
841
  end
816
842
 
817
- # Categorization of results based on how likely they are to represent a match,
818
- # based on the number of elements they contain which imply a match.
843
+ # Coarse-grained confidence level of how well a particular finding
844
+ # satisfies the criteria to match a particular infoType.
845
+ #
846
+ # Likelihood is calculated based on the number of signals a
847
+ # finding has that implies that the finding matches the infoType. For
848
+ # example, a string that has an '@' and a '.com' is more likely to be a
849
+ # match for an email address than a string that only has an '@'.
850
+ #
851
+ # In general, the highest likelihood level has the strongest signals that
852
+ # indicate a match. That is, a finding with a high likelihood has a low chance
853
+ # of being a false positive.
854
+ #
855
+ # For more information about each likelihood level
856
+ # and how likelihood works, see [Match
857
+ # likelihood](https://cloud.google.com/dlp/docs/likelihood).
819
858
  module Likelihood
820
859
  # Default value; same as POSSIBLE.
821
860
  LIKELIHOOD_UNSPECIFIED = 0
822
861
 
823
- # Few matching elements.
862
+ # Highest chance of a false positive.
824
863
  VERY_UNLIKELY = 1
825
864
 
865
+ # High chance of a false positive.
826
866
  UNLIKELY = 2
827
867
 
828
- # Some matching elements.
868
+ # Some matching signals. The default value.
829
869
  POSSIBLE = 3
830
870
 
871
+ # Low chance of a false positive.
831
872
  LIKELY = 4
832
873
 
833
- # Many matching elements.
874
+ # Confidence level is high. Lowest chance of a false positive.
834
875
  VERY_LIKELY = 5
835
876
  end
836
877
 
@@ -844,7 +885,7 @@ module Google
844
885
  # scanning attempts to convert the content of the file to utf_8 to scan
845
886
  # the file.
846
887
  # If you wish to avoid this fall back, specify one or more of the other
847
- # FileType's in your storage scan.
888
+ # file types in your storage scan.
848
889
  BINARY_FILE = 1
849
890
 
850
891
  # Included file extensions:
@@ -857,19 +898,24 @@ module Google
857
898
  TEXT_FILE = 2
858
899
 
859
900
  # Included file extensions:
860
- # bmp, gif, jpg, jpeg, jpe, png.
861
- # bytes_limit_per_file has no effect on image files.
862
- # Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.
901
+ # bmp, gif, jpg, jpeg, jpe, png. Setting
902
+ # {::Google::Cloud::Dlp::V2::CloudStorageOptions#bytes_limit_per_file bytes_limit_per_file}
903
+ # or
904
+ # {::Google::Cloud::Dlp::V2::CloudStorageOptions#bytes_limit_per_file bytes_limit_per_file_percent}
905
+ # has no effect on image files. Image inspection is restricted to the
906
+ # `global`, `us`, `asia`, and `europe` regions.
863
907
  IMAGE = 3
864
908
 
865
- # Word files >30 MB will be scanned as binary files.
909
+ # Microsoft Word files larger than 30 MB will be scanned as binary files.
866
910
  # Included file extensions:
867
- # docx, dotx, docm, dotm
911
+ # docx, dotx, docm, dotm. Setting `bytes_limit_per_file` or
912
+ # `bytes_limit_per_file_percent` has no effect on Word files.
868
913
  WORD = 5
869
914
 
870
- # PDF files >30 MB will be scanned as binary files.
915
+ # PDF files larger than 30 MB will be scanned as binary files.
871
916
  # Included file extensions:
872
- # pdf
917
+ # pdf. Setting `bytes_limit_per_file` or `bytes_limit_per_file_percent`
918
+ # has no effect on PDF files.
873
919
  PDF = 6
874
920
 
875
921
  # Included file extensions:
@@ -884,14 +930,16 @@ module Google
884
930
  # tsv
885
931
  TSV = 9
886
932
 
887
- # Powerpoint files >30 MB will be scanned as binary files.
888
- # Included file extensions:
889
- # pptx, pptm, potx, potm, pot
933
+ # Microsoft PowerPoint files larger than 30 MB will be scanned as binary
934
+ # files. Included file extensions:
935
+ # pptx, pptm, potx, potm, pot. Setting `bytes_limit_per_file` or
936
+ # `bytes_limit_per_file_percent` has no effect on PowerPoint files.
890
937
  POWERPOINT = 11
891
938
 
892
- # Excel files >30 MB will be scanned as binary files.
939
+ # Microsoft Excel files larger than 30 MB will be scanned as binary files.
893
940
  # Included file extensions:
894
- # xlsx, xlsm, xltx, xltm
941
+ # xlsx, xlsm, xltx, xltm. Setting `bytes_limit_per_file` or
942
+ # `bytes_limit_per_file_percent` has no effect on Excel files.
895
943
  EXCEL = 12
896
944
  end
897
945
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-dlp-v2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.18.0
4
+ version: 0.19.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-09-12 00:00:00.000000000 Z
11
+ date: 2023-10-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common