@maxim_mazurok/gapi.client.dlp-v2 0.0.20240616 → 0.0.20240624

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://dlp.googleapis.com/$discovery/rest?version=v2
-// Revision: 20240616
+// Revision: 20240624
 
 /// <reference types="gapi.client" />
 
@@ -516,6 +516,8 @@ declare namespace gapi.client {
     interface GooglePrivacyDlpV2DataProfileBigQueryRowSchema {
       /** Column data profile column */
       columnProfile?: GooglePrivacyDlpV2ColumnDataProfile;
+      /** File store data profile column. */
+      fileStoreProfile?: GooglePrivacyDlpV2FileStoreDataProfile;
       /** Table data profile column */
       tableProfile?: GooglePrivacyDlpV2TableDataProfile;
     }
@@ -554,6 +556,8 @@ declare namespace gapi.client {
     interface GooglePrivacyDlpV2DataProfilePubSubMessage {
       /** The event that caused the Pub/Sub message to be sent. */
       event?: string;
+      /** If `DetailLevel` is `FILE_STORE_PROFILE` this will be fully populated. Otherwise, if `DetailLevel` is `RESOURCE_NAME`, then only `name` and `file_store_path` will be populated. */
+      fileStoreProfile?: GooglePrivacyDlpV2FileStoreDataProfile;
       /** If `DetailLevel` is `TABLE_PROFILE` this will be fully populated. Otherwise, if `DetailLevel` is `RESOURCE_NAME`, then only `name` and `full_resource` will be populated. */
       profile?: GooglePrivacyDlpV2TableDataProfile;
     }
@@ -835,6 +839,8 @@ declare namespace gapi.client {
     interface GooglePrivacyDlpV2Error {
       /** Detailed error codes and messages. */
       details?: GoogleRpcStatus;
+      /** Additional information about the error. */
+      extraInfo?: string;
       /** The times the error occurred. List includes the oldest timestamp and the last 9 timestamps. */
       timestamps?: string[];
     }
@@ -884,12 +890,90 @@ declare namespace gapi.client {
       /** Apply the transformation to the entire field. */
       primitiveTransformation?: GooglePrivacyDlpV2PrimitiveTransformation;
     }
+    interface GooglePrivacyDlpV2FileClusterSummary {
+      /** The data risk level of this cluster. RISK_LOW if nothing has been scanned. */
+      dataRiskLevel?: GooglePrivacyDlpV2DataRiskLevel;
+      /** A list of Errors detected while scanning this cluster. The list is truncated to 10 per cluster. */
+      errors?: GooglePrivacyDlpV2Error[];
+      /** The file cluster type. */
+      fileClusterType?: GooglePrivacyDlpV2FileClusterType;
+      /** A sample of file types scanned in this cluster. Empty if no files were scanned. */
+      fileExtensionsScanned?: GooglePrivacyDlpV2FileExtensionInfo[];
+      /** A sample of file types seen in this cluster. Empty if no files were seen. */
+      fileExtensionsSeen?: GooglePrivacyDlpV2FileExtensionInfo[];
+      /** InfoTypes detected in this cluster. */
+      fileStoreInfoTypeSummaries?: GooglePrivacyDlpV2FileStoreInfoTypeSummary[];
+      /** True if no files exist in this cluster. If the bucket had more files than could be listed, this will be false even if no files for this cluster were seen and file_extensions_seen is empty. */
+      noFilesExist?: boolean;
+      /** The sensitivity score of this cluster. The score will be SENSITIVITY_LOW if nothing has been scanned. */
+      sensitivityScore?: GooglePrivacyDlpV2SensitivityScore;
+    }
+    interface GooglePrivacyDlpV2FileClusterType {
+      /** Cluster type. */
+      cluster?: string;
+    }
+    interface GooglePrivacyDlpV2FileExtensionInfo {
+      /** The file extension if set. (aka .pdf, .jpg, .txt) */
+      fileExtension?: string;
+    }
     interface GooglePrivacyDlpV2FileSet {
       /** The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set. */
       regexFileSet?: GooglePrivacyDlpV2CloudStorageRegexFileSet;
       /** The Cloud Storage url of the file(s) to scan, in the format `gs:///`. Trailing wildcard in the path is allowed. If the url ends in a trailing slash, the bucket or directory represented by the url will be scanned non-recursively (content in sub-directories will not be scanned). This means that `gs://mybucket/` is equivalent to `gs://mybucket/*`, and `gs://mybucket/directory/` is equivalent to `gs://mybucket/directory/*`. Exactly one of `url` or `regex_file_set` must be set. */
       url?: string;
     }
+    interface GooglePrivacyDlpV2FileStoreDataProfile {
+      /** The snapshot of the configurations used to generate the profile. */
+      configSnapshot?: GooglePrivacyDlpV2DataProfileConfigSnapshot;
+      /** The time the file store was first created. */
+      createTime?: string;
+      /** The data risk level of this resource. */
+      dataRiskLevel?: GooglePrivacyDlpV2DataRiskLevel;
+      /** The resource type that was profiled. */
+      dataSourceType?: GooglePrivacyDlpV2DataSourceType;
+      /** For resources that have multiple storage locations, these are those regions. For Google Cloud Storage this is the list of regions chosen for dual-region storage. `file_store_location` will normally be the corresponding multi-region for the list of individual locations. The first region is always picked as the processing and storage location for the data profile. */
+      dataStorageLocations?: string[];
+      /** FileClusterSummary per each cluster. */
+      fileClusterSummaries?: GooglePrivacyDlpV2FileClusterSummary[];
+      /** InfoTypes detected in this file store. */
+      fileStoreInfoTypeSummaries?: GooglePrivacyDlpV2FileStoreInfoTypeSummary[];
+      /** The file store does not have any files. */
+      fileStoreIsEmpty?: boolean;
+      /** The location of the file store. * Google Cloud Storage: https://cloud.google.com/storage/docs/locations#available-locations */
+      fileStoreLocation?: string;
+      /** The file store path. * Google Cloud Storage: `gs://{bucket}` */
+      fileStorePath?: string;
+      /** The resource name of the resource profiled. https://cloud.google.com/apis/design/resource_names#full_resource_name */
+      fullResource?: string;
+      /** The time the file store was last modified. */
+      lastModifiedTime?: string;
+      /** The location type of the bucket (region, dual-region, multi-region, etc). If dual-region, expect data_storage_locations to be populated. */
+      locationType?: string;
+      /** The name of the profile. */
+      name?: string;
+      /** The last time the profile was generated. */
+      profileLastGenerated?: string;
+      /** Success or error status from the most recent profile generation attempt. May be empty if the profile is still being generated. */
+      profileStatus?: GooglePrivacyDlpV2ProfileStatus;
+      /** The resource name to the project data profile for this file store. */
+      projectDataProfile?: string;
+      /** The Google Cloud project ID that owns the resource. */
+      projectId?: string;
+      /** Attributes of the resource being profiled. Currently used attributes: - customer_managed_encryption: boolean true: the resource is encrypted with a customer-managed key. false: the resource is encrypted with a provider-managed key. */
+      resourceAttributes?: {[P in string]: GooglePrivacyDlpV2Value};
+      /** The labels applied to the resource at the time the profile was generated. */
+      resourceLabels?: {[P in string]: string};
+      /** How broadly a resource has been shared. */
+      resourceVisibility?: string;
+      /** The sensitivity score of this resource. */
+      sensitivityScore?: GooglePrivacyDlpV2SensitivityScore;
+      /** State of a profile. */
+      state?: string;
+    }
+    interface GooglePrivacyDlpV2FileStoreInfoTypeSummary {
+      /** The InfoType seen. */
+      infoType?: GooglePrivacyDlpV2InfoType;
+    }
     interface GooglePrivacyDlpV2Finding {
       /** Timestamp when finding was detected. */
       createTime?: string;
@@ -1340,6 +1424,12 @@ declare namespace gapi.client {
       /** The standard List next-page token. */
       nextPageToken?: string;
     }
+    interface GooglePrivacyDlpV2ListFileStoreDataProfilesResponse {
+      /** List of data profiles. */
+      fileStoreDataProfiles?: GooglePrivacyDlpV2FileStoreDataProfile[];
+      /** The next page token. */
+      nextPageToken?: string;
+    }
     interface GooglePrivacyDlpV2ListInfoTypesResponse {
       /** Set of sensitive infoTypes. */
       infoTypes?: GooglePrivacyDlpV2InfoTypeDescription[];
@@ -1492,6 +1582,8 @@ declare namespace gapi.client {
     interface GooglePrivacyDlpV2ProjectDataProfile {
       /** The data risk level of this project. */
       dataRiskLevel?: GooglePrivacyDlpV2DataRiskLevel;
+      /** The number of file store data profiles generated for this project. */
+      fileStoreDataProfileCount?: string;
       /** The resource name of the profile. */
       name?: string;
       /** The last time the profile was generated. */
@@ -1502,6 +1594,8 @@ declare namespace gapi.client {
       projectId?: string;
       /** The sensitivity score of this project. */
       sensitivityScore?: GooglePrivacyDlpV2SensitivityScore;
+      /** The number of table data profiles generated for this project. */
+      tableDataProfileCount?: string;
     }
     interface GooglePrivacyDlpV2Proximity {
       /** Number of characters after the finding to consider. */
@@ -3317,6 +3411,97 @@ declare namespace gapi.client {
         uploadType?: string;
       }): Request<GooglePrivacyDlpV2ListDlpJobsResponse>;
     }
+    interface FileStoreDataProfilesResource {
+      /** Delete a FileStoreDataProfile. Will not prevent the profile from being regenerated if the resource is still included in a discovery configuration. */
+      delete(request?: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** Required. Resource name of the file store data profile. */
+        name: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+      }): Request<{}>;
+      /** Gets a file store data profile. */
+      get(request?: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** Required. Resource name, for example `organizations/12345/locations/us/fileStoreDataProfiles/53234423`. */
+        name: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+      }): Request<GooglePrivacyDlpV2FileStoreDataProfile>;
+      /** Lists file store data profiles for an organization. */
+      list(request?: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `file_store_path` - The path like "gs://bucket". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` . * 'file_store_path = "gs://mybucket"` The length of this field should be no more than 500 characters. */
+        filter?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Optional. Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `name` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `name`: The name of the profile. - `create_time`: The time the file store was first created. */
+        orderBy?: string;
+        /** Optional. Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100. */
+        pageSize?: number;
+        /** Optional. Page token to continue retrieval. */
+        pageToken?: string;
+        /** Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`. */
+        parent: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+      }): Request<GooglePrivacyDlpV2ListFileStoreDataProfilesResponse>;
+    }
     interface InspectTemplatesResource {
       /** Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more. */
       create(request: {
@@ -4103,6 +4288,7 @@ declare namespace gapi.client {
       deidentifyTemplates: DeidentifyTemplatesResource;
       discoveryConfigs: DiscoveryConfigsResource;
       dlpJobs: DlpJobsResource;
+      fileStoreDataProfiles: FileStoreDataProfilesResource;
       inspectTemplates: InspectTemplatesResource;
       jobTriggers: JobTriggersResource;
       projectDataProfiles: ProjectDataProfilesResource;
@@ -6669,6 +6855,97 @@ declare namespace gapi.client {
         uploadType?: string;
       }): Request<GooglePrivacyDlpV2ListDlpJobsResponse>;
     }
+    interface FileStoreDataProfilesResource {
+      /** Delete a FileStoreDataProfile. Will not prevent the profile from being regenerated if the resource is still included in a discovery configuration. */
+      delete(request?: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** Required. Resource name of the file store data profile. */
+        name: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+      }): Request<{}>;
+      /** Gets a file store data profile. */
+      get(request?: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** Required. Resource name, for example `organizations/12345/locations/us/fileStoreDataProfiles/53234423`. */
+        name: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+      }): Request<GooglePrivacyDlpV2FileStoreDataProfile>;
+      /** Lists file store data profiles for an organization. */
+      list(request?: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `file_store_path` - The path like "gs://bucket". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` . * 'file_store_path = "gs://mybucket"` The length of this field should be no more than 500 characters. */
+        filter?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Optional. Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `name` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `name`: The name of the profile. - `create_time`: The time the file store was first created. */
+        orderBy?: string;
+        /** Optional. Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100. */
+        pageSize?: number;
+        /** Optional. Page token to continue retrieval. */
+        pageToken?: string;
+        /** Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`. */
+        parent: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+      }): Request<GooglePrivacyDlpV2ListFileStoreDataProfilesResponse>;
+    }
     interface ImageResource {
       /** Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. */
       redact(request: {
@@ -7632,6 +7909,7 @@ declare namespace gapi.client {
       deidentifyTemplates: DeidentifyTemplatesResource;
       discoveryConfigs: DiscoveryConfigsResource;
       dlpJobs: DlpJobsResource;
+      fileStoreDataProfiles: FileStoreDataProfilesResource;
       image: ImageResource;
       inspectTemplates: InspectTemplatesResource;
       jobTriggers: JobTriggersResource;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.dlp-v2",
-  "version": "0.0.20240616",
+  "version": "0.0.20240624",
   "description": "TypeScript typings for Sensitive Data Protection (DLP) v2",
   "repository": {
     "type": "git",