@google-cloud/dlp 3.5.0 → 4.1.0

package/CHANGELOG.md

@@ -4,6 +4,43 @@
 
 [1]: https://www.npmjs.com/package/PACKAGE NAME?activeTab=versions
 
+## [4.1.0](https://github.com/googleapis/nodejs-dlp/compare/v4.0.2...v4.1.0) (2022-07-12)
+
+
+### Features
+
+* InfoType categories were added to built-in infoTypes ([#730](https://github.com/googleapis/nodejs-dlp/issues/730)) ([1147763](https://github.com/googleapis/nodejs-dlp/commit/114776322342445ae1e792c51ee6a2eedc48bebf))
+
+
+### Bug Fixes
+
+* **deps:** do not depend on protobufjs ([#728](https://github.com/googleapis/nodejs-dlp/issues/728)) ([3ce38f6](https://github.com/googleapis/nodejs-dlp/commit/3ce38f6d714e32d7df3b01eb4e78023eff023de5))
+
+## [4.0.2](https://github.com/googleapis/nodejs-dlp/compare/v4.0.1...v4.0.2) (2022-06-30)
+
+
+### Bug Fixes
+
+* **docs:** document fallback rest option ([#724](https://github.com/googleapis/nodejs-dlp/issues/724)) ([3d4518f](https://github.com/googleapis/nodejs-dlp/commit/3d4518f5d13e0a13fd993f541dbf6d5a6bb0febb))
+
+## [4.0.1](https://github.com/googleapis/nodejs-dlp/compare/v4.0.0...v4.0.1) (2022-06-07)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @google-cloud/pubsub to v3 ([#715](https://github.com/googleapis/nodejs-dlp/issues/715)) ([c8636f8](https://github.com/googleapis/nodejs-dlp/commit/c8636f84d844b594ffd11dd7bfbf5f73b56ee729))
+
+## [4.0.0](https://github.com/googleapis/nodejs-dlp/compare/v3.5.0...v4.0.0) (2022-05-20)
+
+
+### ⚠ BREAKING CHANGES
+
+* update library to use Node 12 (#713)
+
+### Build System
+
+* update library to use Node 12 ([#713](https://github.com/googleapis/nodejs-dlp/issues/713)) ([2999561](https://github.com/googleapis/nodejs-dlp/commit/2999561d3c1b1f4de78fb11a8c916e2bb06a92a5))
+
 ## [3.5.0](https://github.com/googleapis/nodejs-dlp/compare/v3.4.0...v3.5.0) (2022-04-01)
 
 

package/build/protos/google/privacy/dlp/v2/dlp.proto

@@ -773,7 +773,7 @@ message InspectConfig {
   FindingLimits limits = 3;
 
   // When true, a contextual quote from the data that triggered a finding is
-  // included in the response; see Finding.quote.
+  // included in the response; see [Finding.quote][google.privacy.dlp.v2.Finding.quote].
   // This is not used for data profiling.
   bool include_quote = 4;
 
@@ -1554,6 +1554,201 @@ message InfoTypeDescription {
   // Description of the infotype. Translated when language is provided in the
   // request.
   string description = 4;
+
+  // The category of the infoType.
+  repeated InfoTypeCategory categories = 10;
+}
+
+// Classification of infoTypes to organize them according to geographic
+// location, industry, and data type.
+message InfoTypeCategory {
+  // Enum of the current locations.
+  // We might add more locations in the future.
+  enum LocationCategory {
+    // Unused location
+    LOCATION_UNSPECIFIED = 0;
+
+    // The infoType is not issued by or tied to a specific region, but is used
+    // almost everywhere.
+    GLOBAL = 1;
+
+    // The infoType is typically used in Argentina.
+    ARGENTINA = 2;
+
+    // The infoType is typically used in Australia.
+    AUSTRALIA = 3;
+
+    // The infoType is typically used in Belgium.
+    BELGIUM = 4;
+
+    // The infoType is typically used in Brazil.
+    BRAZIL = 5;
+
+    // The infoType is typically used in Canada.
+    CANADA = 6;
+
+    // The infoType is typically used in Chile.
+    CHILE = 7;
+
+    // The infoType is typically used in China.
+    CHINA = 8;
+
+    // The infoType is typically used in Colombia.
+    COLOMBIA = 9;
+
+    // The infoType is typically used in Denmark.
+    DENMARK = 10;
+
+    // The infoType is typically used in France.
+    FRANCE = 11;
+
+    // The infoType is typically used in Finland.
+    FINLAND = 12;
+
+    // The infoType is typically used in Germany.
+    GERMANY = 13;
+
+    // The infoType is typically used in Hong Kong.
+    HONG_KONG = 14;
+
+    // The infoType is typically used in India.
+    INDIA = 15;
+
+    // The infoType is typically used in Indonesia.
+    INDONESIA = 16;
+
+    // The infoType is typically used in Ireland.
+    IRELAND = 17;
+
+    // The infoType is typically used in Israel.
+    ISRAEL = 18;
+
+    // The infoType is typically used in Italy.
+    ITALY = 19;
+
+    // The infoType is typically used in Japan.
+    JAPAN = 20;
+
+    // The infoType is typically used in Korea.
+    KOREA = 21;
+
+    // The infoType is typically used in Mexico.
+    MEXICO = 22;
+
+    // The infoType is typically used in the Netherlands.
+    THE_NETHERLANDS = 23;
+
+    // The infoType is typically used in Norway.
+    NORWAY = 24;
+
+    // The infoType is typically used in Paraguay.
+    PARAGUAY = 25;
+
+    // The infoType is typically used in Peru.
+    PERU = 26;
+
+    // The infoType is typically used in Poland.
+    POLAND = 27;
+
+    // The infoType is typically used in Portugal.
+    PORTUGAL = 28;
+
+    // The infoType is typically used in Singapore.
+    SINGAPORE = 29;
+
+    // The infoType is typically used in South Africa.
+    SOUTH_AFRICA = 30;
+
+    // The infoType is typically used in Spain.
+    SPAIN = 31;
+
+    // The infoType is typically used in Sweden.
+    SWEDEN = 32;
+
+    // The infoType is typically used in Taiwan.
+    TAIWAN = 33;
+
+    // The infoType is typically used in Thailand.
+    THAILAND = 34;
+
+    // The infoType is typically used in Turkey.
+    TURKEY = 35;
+
+    // The infoType is typically used in the United Kingdom.
+    UNITED_KINGDOM = 36;
+
+    // The infoType is typically used in the United States.
+    UNITED_STATES = 37;
+
+    // The infoType is typically used in Uruguay.
+    URUGUAY = 38;
+
+    // The infoType is typically used in Venezuela.
+    VENEZUELA = 39;
+
+    // The infoType is typically used in Google internally.
+    INTERNAL = 40;
+  }
+
+  // Enum of the current industries in the category.
+  // We might add more industries in the future.
+  enum IndustryCategory {
+    // Unused industry
+    INDUSTRY_UNSPECIFIED = 0;
+
+    // The infoType is typically used in the finance industry.
+    FINANCE = 1;
+
+    // The infoType is typically used in the health industry.
+    HEALTH = 2;
+
+    // The infoType is typically used in the telecommunications industry.
+    TELECOMMUNICATIONS = 3;
+  }
+
+  // Enum of the current types in the category.
+  // We might add more types in the future.
+  enum TypeCategory {
+    // Unused type
+    TYPE_UNSPECIFIED = 0;
+
+    // Personally identifiable information, for example, a
+    // name or phone number
+    PII = 1;
+
+    // Personally identifiable information that is especially sensitive, for
+    // example, a passport number.
+    SPII = 2;
+
+    // Attributes that can partially identify someone, especially in
+    // combination with other attributes, like age, height, and gender.
+    DEMOGRAPHIC = 3;
+
+    // Confidential or secret information, for example, a password.
+    CREDENTIAL = 4;
+
+    // An identification document issued by a government.
+    GOVERNMENT_ID = 5;
+
+    // A document, for example, a resume or source code.
+    DOCUMENT = 6;
+
+    // Information that is not sensitive on its own, but provides details about
+    // the circumstances surrounding an entity or an event.
+    CONTEXTUAL_INFORMATION = 7;
+  }
+
+  oneof category {
+    // The region or country that issued the ID or document represented by the
+    // infoType.
+    LocationCategory location_category = 1;
+
+    // The group of relevant businesses where this infoType is commonly used
+    IndustryCategory industry_category = 2;
+
+    // The class of identifiers where this infoType belongs
+    TypeCategory type_category = 3;
+  }
 }
 
 // Request for the list of infoTypes.

package/build/protos/google/privacy/dlp/v2/storage.proto

@@ -149,7 +149,11 @@ message CustomInfoType {
     // Message for specifying a window around a finding to apply a detection
     // rule.
     message Proximity {
-      // Number of characters before the finding to consider.
+      // Number of characters before the finding to consider. For tabular data,
+      // if you want to modify the likelihood of an entire column of findngs,
+      // set this to 1. For more information, see
+      // [Hotword example: Set the match likelihood of a table column]
+      // (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values).
       int32 window_before = 1;
 
       // Number of characters after the finding to consider.
@@ -181,14 +185,19 @@ message CustomInfoType {
       // Regular expression pattern defining what qualifies as a hotword.
       Regex hotword_regex = 1;
 
-      // Proximity of the finding within which the entire hotword must reside.
-      // The total length of the window cannot exceed 1000 characters. Note that
-      // the finding itself will be included in the window, so that hotwords may
-      // be used to match substrings of the finding itself. For example, the
-      // certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be
-      // adjusted upwards if the area code is known to be the local area code of
-      // a company office using the hotword regex "\(xxx\)", where "xxx"
-      // is the area code in question.
+      // Range of characters within which the entire hotword must reside.
+      // The total length of the window cannot exceed 1000 characters.
+      // The finding itself will be included in the window, so that hotwords can
+      // be used to match substrings of the finding itself. Suppose you
+      // want Cloud DLP to promote the likelihood of the phone number
+      // regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the
+      // area code of a company's office. In this case, use the hotword regex
+      // "\(xxx\)", where "xxx" is the area code in question.
+      //
+      // For tabular data, if you want to modify the likelihood of an entire
+      // column of findngs, see
+      // [Hotword example: Set the match likelihood of a table column]
+      // (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values).
       Proximity proximity = 2;
 
       // Likelihood adjustment to apply to all matching findings.

package/build/protos/protos.d.ts

@@ -5000,6 +5000,9 @@ export namespace google {
 
                     /** InfoTypeDescription description */
                     description?: (string|null);
+
+                    /** InfoTypeDescription categories */
+                    categories?: (google.privacy.dlp.v2.IInfoTypeCategory[]|null);
                 }
 
                 /** Represents an InfoTypeDescription. */
@@ -5023,6 +5026,9 @@ export namespace google {
                     /** InfoTypeDescription description. */
                     public description: string;
 
+                    /** InfoTypeDescription categories. */
+                    public categories: google.privacy.dlp.v2.IInfoTypeCategory[];
+
                     /**
                      * Creates a new InfoTypeDescription instance using the specified properties.
                      * @param [properties] Properties to set
@@ -5094,6 +5100,179 @@ export namespace google {
                     public toJSON(): { [k: string]: any };
                 }
 
+                /** Properties of an InfoTypeCategory. */
+                interface IInfoTypeCategory {
+
+                    /** InfoTypeCategory locationCategory */
+                    locationCategory?: (google.privacy.dlp.v2.InfoTypeCategory.LocationCategory|keyof typeof google.privacy.dlp.v2.InfoTypeCategory.LocationCategory|null);
+
+                    /** InfoTypeCategory industryCategory */
+                    industryCategory?: (google.privacy.dlp.v2.InfoTypeCategory.IndustryCategory|keyof typeof google.privacy.dlp.v2.InfoTypeCategory.IndustryCategory|null);
+
+                    /** InfoTypeCategory typeCategory */
+                    typeCategory?: (google.privacy.dlp.v2.InfoTypeCategory.TypeCategory|keyof typeof google.privacy.dlp.v2.InfoTypeCategory.TypeCategory|null);
+                }
+
+                /** Represents an InfoTypeCategory. */
+                class InfoTypeCategory implements IInfoTypeCategory {
+
+                    /**
+                     * Constructs a new InfoTypeCategory.
+                     * @param [properties] Properties to set
+                     */
+                    constructor(properties?: google.privacy.dlp.v2.IInfoTypeCategory);
+
+                    /** InfoTypeCategory locationCategory. */
+                    public locationCategory?: (google.privacy.dlp.v2.InfoTypeCategory.LocationCategory|keyof typeof google.privacy.dlp.v2.InfoTypeCategory.LocationCategory|null);
+
+                    /** InfoTypeCategory industryCategory. */
+                    public industryCategory?: (google.privacy.dlp.v2.InfoTypeCategory.IndustryCategory|keyof typeof google.privacy.dlp.v2.InfoTypeCategory.IndustryCategory|null);
+
+                    /** InfoTypeCategory typeCategory. */
+                    public typeCategory?: (google.privacy.dlp.v2.InfoTypeCategory.TypeCategory|keyof typeof google.privacy.dlp.v2.InfoTypeCategory.TypeCategory|null);
+
+                    /** InfoTypeCategory category. */
+                    public category?: ("locationCategory"|"industryCategory"|"typeCategory");
+
+                    /**
+                     * Creates a new InfoTypeCategory instance using the specified properties.
+                     * @param [properties] Properties to set
+                     * @returns InfoTypeCategory instance
+                     */
+                    public static create(properties?: google.privacy.dlp.v2.IInfoTypeCategory): google.privacy.dlp.v2.InfoTypeCategory;
+
+                    /**
+                     * Encodes the specified InfoTypeCategory message. Does not implicitly {@link google.privacy.dlp.v2.InfoTypeCategory.verify|verify} messages.
+                     * @param message InfoTypeCategory message or plain object to encode
+                     * @param [writer] Writer to encode to
+                     * @returns Writer
+                     */
+                    public static encode(message: google.privacy.dlp.v2.IInfoTypeCategory, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                    /**
+                     * Encodes the specified InfoTypeCategory message, length delimited. Does not implicitly {@link google.privacy.dlp.v2.InfoTypeCategory.verify|verify} messages.
+                     * @param message InfoTypeCategory message or plain object to encode
+                     * @param [writer] Writer to encode to
+                     * @returns Writer
+                     */
+                    public static encodeDelimited(message: google.privacy.dlp.v2.IInfoTypeCategory, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                    /**
+                     * Decodes an InfoTypeCategory message from the specified reader or buffer.
+                     * @param reader Reader or buffer to decode from
+                     * @param [length] Message length if known beforehand
+                     * @returns InfoTypeCategory
+                     * @throws {Error} If the payload is not a reader or valid buffer
+                     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                     */
+                    public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.privacy.dlp.v2.InfoTypeCategory;
+
+                    /**
+                     * Decodes an InfoTypeCategory message from the specified reader or buffer, length delimited.
+                     * @param reader Reader or buffer to decode from
+                     * @returns InfoTypeCategory
+                     * @throws {Error} If the payload is not a reader or valid buffer
+                     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                     */
+                    public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.privacy.dlp.v2.InfoTypeCategory;
+
+                    /**
+                     * Verifies an InfoTypeCategory message.
+                     * @param message Plain object to verify
+                     * @returns `null` if valid, otherwise the reason why it is not
+                     */
+                    public static verify(message: { [k: string]: any }): (string|null);
+
+                    /**
+                     * Creates an InfoTypeCategory message from a plain object. Also converts values to their respective internal types.
+                     * @param object Plain object
+                     * @returns InfoTypeCategory
+                     */
+                    public static fromObject(object: { [k: string]: any }): google.privacy.dlp.v2.InfoTypeCategory;
+
+                    /**
+                     * Creates a plain object from an InfoTypeCategory message. Also converts values to other types if specified.
+                     * @param message InfoTypeCategory
+                     * @param [options] Conversion options
+                     * @returns Plain object
+                     */
+                    public static toObject(message: google.privacy.dlp.v2.InfoTypeCategory, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+                    /**
+                     * Converts this InfoTypeCategory to JSON.
+                     * @returns JSON object
+                     */
+                    public toJSON(): { [k: string]: any };
+                }
+
+                namespace InfoTypeCategory {
+
+                    /** LocationCategory enum. */
+                    enum LocationCategory {
+                        LOCATION_UNSPECIFIED = 0,
+                        GLOBAL = 1,
+                        ARGENTINA = 2,
+                        AUSTRALIA = 3,
+                        BELGIUM = 4,
+                        BRAZIL = 5,
+                        CANADA = 6,
+                        CHILE = 7,
+                        CHINA = 8,
+                        COLOMBIA = 9,
+                        DENMARK = 10,
+                        FRANCE = 11,
+                        FINLAND = 12,
+                        GERMANY = 13,
+                        HONG_KONG = 14,
+                        INDIA = 15,
+                        INDONESIA = 16,
+                        IRELAND = 17,
+                        ISRAEL = 18,
+                        ITALY = 19,
+                        JAPAN = 20,
+                        KOREA = 21,
+                        MEXICO = 22,
+                        THE_NETHERLANDS = 23,
+                        NORWAY = 24,
+                        PARAGUAY = 25,
+                        PERU = 26,
+                        POLAND = 27,
+                        PORTUGAL = 28,
+                        SINGAPORE = 29,
+                        SOUTH_AFRICA = 30,
+                        SPAIN = 31,
+                        SWEDEN = 32,
+                        TAIWAN = 33,
+                        THAILAND = 34,
+                        TURKEY = 35,
+                        UNITED_KINGDOM = 36,
+                        UNITED_STATES = 37,
+                        URUGUAY = 38,
+                        VENEZUELA = 39,
+                        INTERNAL = 40
+                    }
+
+                    /** IndustryCategory enum. */
+                    enum IndustryCategory {
+                        INDUSTRY_UNSPECIFIED = 0,
+                        FINANCE = 1,
+                        HEALTH = 2,
+                        TELECOMMUNICATIONS = 3
+                    }
+
+                    /** TypeCategory enum. */
+                    enum TypeCategory {
+                        TYPE_UNSPECIFIED = 0,
+                        PII = 1,
+                        SPII = 2,
+                        DEMOGRAPHIC = 3,
+                        CREDENTIAL = 4,
+                        GOVERNMENT_ID = 5,
+                        DOCUMENT = 6,
+                        CONTEXTUAL_INFORMATION = 7
+                    }
+                }
+
                 /** Properties of a ListInfoTypesRequest. */
                 interface IListInfoTypesRequest {
 
@@ -26158,6 +26337,9 @@ export namespace google {
             /** FieldOptions lazy */
             lazy?: (boolean|null);
 
+            /** FieldOptions unverifiedLazy */
+            unverifiedLazy?: (boolean|null);
+
             /** FieldOptions deprecated */
             deprecated?: (boolean|null);
 
@@ -26195,6 +26377,9 @@ export namespace google {
             /** FieldOptions lazy. */
             public lazy: boolean;
 
+            /** FieldOptions unverifiedLazy. */
+            public unverifiedLazy: boolean;
+
             /** FieldOptions deprecated. */
             public deprecated: boolean;