{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
},
"basePath": "",
"baseUrl": "https://dlp.googleapis.com/",
"batchPath": "batch",
"canonicalName": "DLP",
"description": "Discover and protect your sensitive data. A fully managed service designed to help you discover, classify, and protect your valuable data assets with ease.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/sensitive-data-protection/docs/",
"endpoints": [
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.africa-south1.rep.googleapis.com/",
"location": "africa-south1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.asia-east1.rep.googleapis.com/",
"location": "asia-east1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.asia-east2.rep.googleapis.com/",
"location": "asia-east2"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.asia-northeast1.rep.googleapis.com/",
"location": "asia-northeast1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.asia-northeast2.rep.googleapis.com/",
"location": "asia-northeast2"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.asia-northeast3.rep.googleapis.com/",
"location": "asia-northeast3"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.asia-south1.rep.googleapis.com/",
"location": "asia-south1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.asia-south2.rep.googleapis.com/",
"location": "asia-south2"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.asia-southeast1.rep.googleapis.com/",
"location": "asia-southeast1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.asia-southeast2.rep.googleapis.com/",
"location": "asia-southeast2"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.asia-southeast3.rep.googleapis.com/",
"location": "asia-southeast3"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.australia-southeast1.rep.googleapis.com/",
"location": "australia-southeast1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.australia-southeast2.rep.googleapis.com/",
"location": "australia-southeast2"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.europe-central2.rep.googleapis.com/",
"location": "europe-central2"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.europe-north1.rep.googleapis.com/",
"location": "europe-north1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.europe-north2.rep.googleapis.com/",
"location": "europe-north2"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.europe-southwest1.rep.googleapis.com/",
"location": "europe-southwest1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.europe-west1.rep.googleapis.com/",
"location": "europe-west1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.europe-west10.rep.googleapis.com/",
"location": "europe-west10"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.europe-west12.rep.googleapis.com/",
"location": "europe-west12"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.europe-west2.rep.googleapis.com/",
"location": "europe-west2"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.europe-west3.rep.googleapis.com/",
"location": "europe-west3"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.europe-west4.rep.googleapis.com/",
"location": "europe-west4"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.europe-west6.rep.googleapis.com/",
"location": "europe-west6"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.europe-west8.rep.googleapis.com/",
"location": "europe-west8"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.europe-west9.rep.googleapis.com/",
"location": "europe-west9"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.me-central1.rep.googleapis.com/",
"location": "me-central1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.me-central2.rep.googleapis.com/",
"location": "me-central2"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.me-west1.rep.googleapis.com/",
"location": "me-west1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.northamerica-northeast1.rep.googleapis.com/",
"location": "northamerica-northeast1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.northamerica-northeast2.rep.googleapis.com/",
"location": "northamerica-northeast2"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.northamerica-south1.rep.googleapis.com/",
"location": "northamerica-south1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.southamerica-east1.rep.googleapis.com/",
"location": "southamerica-east1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.southamerica-west1.rep.googleapis.com/",
"location": "southamerica-west1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.us-central1.rep.googleapis.com/",
"location": "us-central1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.us-central2.rep.googleapis.com/",
"location": "us-central2"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.us-east1.rep.googleapis.com/",
"location": "us-east1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.us-east4.rep.googleapis.com/",
"location": "us-east4"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.us-east5.rep.googleapis.com/",
"location": "us-east5"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.us-south1.rep.googleapis.com/",
"location": "us-south1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.us-west1.rep.googleapis.com/",
"location": "us-west1"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.us-west2.rep.googleapis.com/",
"location": "us-west2"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.us-west3.rep.googleapis.com/",
"location": "us-west3"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.us-west4.rep.googleapis.com/",
"location": "us-west4"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.us-west8.rep.googleapis.com/",
"location": "us-west8"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.us.rep.googleapis.com/",
"location": "us"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.eu.rep.googleapis.com/",
"location": "eu"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://dlp.in.rep.googleapis.com/",
"location": "in"
}
],
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "dlp:v2",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://dlp.mtls.googleapis.com/",
"name": "dlp",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "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.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "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.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"infoTypes": {
"methods": {
"list": {
"description": "Returns a list of the sensitive information types that the DLP API supports. See https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.",
"flatPath": "v2/infoTypes",
"httpMethod": "GET",
"id": "dlp.infoTypes.list",
"parameterOrder": [],
"parameters": {
"filter": {
"description": "filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT.",
"location": "query",
"type": "string"
},
"languageCode": {
"description": "BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned.",
"location": "query",
"type": "string"
},
"locationId": {
"description": "Deprecated. This field has no effect.",
"location": "query",
"type": "string"
},
"parent": {
"description": "The parent resource name. The format of this value is as follows: `locations/{location_id}`",
"location": "query",
"type": "string"
}
},
"path": "v2/infoTypes",
"response": {
"$ref": "GooglePrivacyDlpV2ListInfoTypesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"locations": {
"resources": {
"infoTypes": {
"methods": {
"list": {
"description": "Returns a list of the sensitive information types that the DLP API supports. See https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.",
"flatPath": "v2/locations/{locationsId}/infoTypes",
"httpMethod": "GET",
"id": "dlp.locations.infoTypes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT.",
"location": "query",
"type": "string"
},
"languageCode": {
"description": "BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned.",
"location": "query",
"type": "string"
},
"locationId": {
"description": "Deprecated. This field has no effect.",
"location": "query",
"type": "string"
},
"parent": {
"description": "The parent resource name. The format of this value is as follows: `locations/{location_id}`",
"location": "path",
"pattern": "^locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/infoTypes",
"response": {
"$ref": "GooglePrivacyDlpV2ListInfoTypesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"organizations": {
"resources": {
"deidentifyTemplates": {
"methods": {
"create": {
"description": "Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.",
"flatPath": "v2/organizations/{organizationsId}/deidentifyTemplates",
"httpMethod": "POST",
"id": "dlp.organizations.deidentifyTemplates.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/deidentifyTemplates",
"request": {
"$ref": "GooglePrivacyDlpV2CreateDeidentifyTemplateRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2DeidentifyTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.",
"flatPath": "v2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}",
"httpMethod": "DELETE",
"id": "dlp.organizations.deidentifyTemplates.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the organization and deidentify template to be deleted, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.",
"location": "path",
"pattern": "^organizations/[^/]+/deidentifyTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.",
"flatPath": "v2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}",
"httpMethod": "GET",
"id": "dlp.organizations.deidentifyTemplates.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the organization and deidentify template to be read, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.",
"location": "path",
"pattern": "^organizations/[^/]+/deidentifyTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GooglePrivacyDlpV2DeidentifyTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.",
"flatPath": "v2/organizations/{organizationsId}/deidentifyTemplates",
"httpMethod": "GET",
"id": "dlp.organizations.deidentifyTemplates.list",
"parameterOrder": [
"parent"
],
"parameters": {
"locationId": {
"description": "Deprecated. This field has no effect.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "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. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Page token to continue retrieval. Comes from the previous call to `ListDeidentifyTemplates`.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/deidentifyTemplates",
"response": {
"$ref": "GooglePrivacyDlpV2ListDeidentifyTemplatesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates the DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.",
"flatPath": "v2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}",
"httpMethod": "PATCH",
"id": "dlp.organizations.deidentifyTemplates.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of organization and deidentify template to be updated, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.",
"location": "path",
"pattern": "^organizations/[^/]+/deidentifyTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2DeidentifyTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"inspectTemplates": {
"methods": {
"create": {
"description": "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.",
"flatPath": "v2/organizations/{organizationsId}/inspectTemplates",
"httpMethod": "POST",
"id": "dlp.organizations.inspectTemplates.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/inspectTemplates",
"request": {
"$ref": "GooglePrivacyDlpV2CreateInspectTemplateRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2InspectTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.",
"flatPath": "v2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}",
"httpMethod": "DELETE",
"id": "dlp.organizations.inspectTemplates.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the organization and inspectTemplate to be deleted, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.",
"location": "path",
"pattern": "^organizations/[^/]+/inspectTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.",
"flatPath": "v2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}",
"httpMethod": "GET",
"id": "dlp.organizations.inspectTemplates.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the organization and inspectTemplate to be read, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.",
"location": "path",
"pattern": "^organizations/[^/]+/inspectTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GooglePrivacyDlpV2InspectTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.",
"flatPath": "v2/organizations/{organizationsId}/inspectTemplates",
"httpMethod": "GET",
"id": "dlp.organizations.inspectTemplates.list",
"parameterOrder": [
"parent"
],
"parameters": {
"locationId": {
"description": "Deprecated. This field has no effect.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "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. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Page token to continue retrieval. Comes from the previous call to `ListInspectTemplates`.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/inspectTemplates",
"response": {
"$ref": "GooglePrivacyDlpV2ListInspectTemplatesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.",
"flatPath": "v2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}",
"httpMethod": "PATCH",
"id": "dlp.organizations.inspectTemplates.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of organization and inspectTemplate to be updated, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.",
"location": "path",
"pattern": "^organizations/[^/]+/inspectTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "GooglePrivacyDlpV2UpdateInspectTemplateRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2InspectTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"locations": {
"resources": {
"columnDataProfiles": {
"methods": {
"get": {
"description": "Gets a column data profile.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/columnDataProfiles/{columnDataProfilesId}",
"httpMethod": "GET",
"id": "dlp.organizations.locations.columnDataProfiles.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name, for example `organizations/12345/locations/us/columnDataProfiles/53234423`.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/columnDataProfiles/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GooglePrivacyDlpV2ColumnDataProfile"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists column data profiles for an organization.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/columnDataProfiles",
"httpMethod": "GET",
"id": "dlp.organizations.locations.columnDataProfiles.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "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: - `table_data_profile_name`: The name of the related table data profile - `project_id`: The Google Cloud project ID (REQUIRED) - `dataset_id`: The BigQuery dataset ID (REQUIRED) - `table_id`: The BigQuery table ID (REQUIRED) - `field_id`: The ID of the BigQuery field - `info_type`: The infotype detected in the resource - `sensitivity_level`: HIGH|MEDIUM|LOW - `data_risk_level`: How much risk is associated with this data - `status_code`: An RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` for project_id, dataset_id, and table_id. Other filters also support `!=`. The `profile_last_generated` filter also supports `<` and `>`. The syntax is based on https://google.aip.dev/160. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH * project_id = 12345 AND info_type = STREET_ADDRESS * profile_last_generated < \"2025-01-01T00:00:00.000Z\" The length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "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` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a column 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.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Page token to continue retrieval.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/columnDataProfiles",
"response": {
"$ref": "GooglePrivacyDlpV2ListColumnDataProfilesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"connections": {
"methods": {
"create": {
"description": "Create a Connection to an external data source.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/connections",
"httpMethod": "POST",
"id": "dlp.organizations.locations.connections.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/{project_id}/locations/{location_id}` + Organizations scope: `organizations/{org_id}/locations/{location_id}`",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/connections",
"request": {
"$ref": "GooglePrivacyDlpV2CreateConnectionRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2Connection"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Delete a Connection.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/connections/{connectionsId}",
"httpMethod": "DELETE",
"id": "dlp.organizations.locations.connections.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the Connection to be deleted, in the format: `projects/{project}/locations/{location}/connections/{connection}`.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/connections/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Get a Connection by name.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/connections/{connectionsId}",
"httpMethod": "GET",
"id": "dlp.organizations.locations.connections.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name in the format: `projects/{project}/locations/{location}/connections/{connection}`.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/connections/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GooglePrivacyDlpV2Connection"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists Connections in a parent. Use SearchConnections to see all connections within an organization.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/connections",
"httpMethod": "GET",
"id": "dlp.organizations.locations.connections.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Supported field/value: `state` - MISSING|AVAILABLE|ERROR The syntax is based on https://google.aip.dev/160.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. Number of results per page, max 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. Page token from a previous page to return the next set of results. If set, all other request fields must match the original request.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Resource name of the organization or project, for example, `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/connections",
"response": {
"$ref": "GooglePrivacyDlpV2ListConnectionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Update a Connection.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/connections/{connectionsId}",
"httpMethod": "PATCH",
"id": "dlp.organizations.locations.connections.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name in the format: `projects/{project}/locations/{location}/connections/{connection}`.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/connections/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "GooglePrivacyDlpV2UpdateConnectionRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2Connection"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"search": {
"description": "Searches for Connections in a parent.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/connections:search",
"httpMethod": "GET",
"id": "dlp.organizations.locations.connections.search",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Supported field/value: - `state` - MISSING|AVAILABLE|ERROR The syntax is based on https://google.aip.dev/160.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. Number of results per page, max 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. Page token from a previous page to return the next set of results. If set, all other request fields must match the original request.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Resource name of the organization or project with a wildcard location, for example, `organizations/433245324/locations/-` or `projects/project-id/locations/-`.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/connections:search",
"response": {
"$ref": "GooglePrivacyDlpV2SearchConnectionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"deidentifyTemplates": {
"methods": {
"create": {
"description": "Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates",
"httpMethod": "POST",
"id": "dlp.organizations.locations.deidentifyTemplates.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/deidentifyTemplates",
"request": {
"$ref": "GooglePrivacyDlpV2CreateDeidentifyTemplateRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2DeidentifyTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}",
"httpMethod": "DELETE",
"id": "dlp.organizations.locations.deidentifyTemplates.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the organization and deidentify template to be deleted, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/deidentifyTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}",
"httpMethod": "GET",
"id": "dlp.organizations.locations.deidentifyTemplates.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the organization and deidentify template to be read, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/deidentifyTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GooglePrivacyDlpV2DeidentifyTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates",
"httpMethod": "GET",
"id": "dlp.organizations.locations.deidentifyTemplates.list",
"parameterOrder": [
"parent"
],
"parameters": {
"locationId": {
"description": "Deprecated. This field has no effect.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "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. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Page token to continue retrieval. Comes from the previous call to `ListDeidentifyTemplates`.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/deidentifyTemplates",
"response": {
"$ref": "GooglePrivacyDlpV2ListDeidentifyTemplatesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates the DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}",
"httpMethod": "PATCH",
"id": "dlp.organizations.locations.deidentifyTemplates.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of organization and deidentify template to be updated, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/deidentifyTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2DeidentifyTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"discoveryConfigs": {
"methods": {
"create": {
"description": "Creates a config for discovery to scan and profile storage.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/discoveryConfigs",
"httpMethod": "POST",
"id": "dlp.organizations.locations.discoveryConfigs.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/{project_id}/locations/{location_id}` + Organizations scope: `organizations/{org_id}/locations/{location_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/discoveryConfigs",
"request": {
"$ref": "GooglePrivacyDlpV2CreateDiscoveryConfigRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2DiscoveryConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a discovery configuration.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/discoveryConfigs/{discoveryConfigsId}",
"httpMethod": "DELETE",
"id": "dlp.organizations.locations.discoveryConfigs.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the project and the config, for example `projects/dlp-test-project/discoveryConfigs/53234423`.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/discoveryConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a discovery configuration.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/discoveryConfigs/{discoveryConfigsId}",
"httpMethod": "GET",
"id": "dlp.organizations.locations.discoveryConfigs.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the project and the configuration, for example `projects/dlp-test-project/discoveryConfigs/53234423`.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/discoveryConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GooglePrivacyDlpV2DiscoveryConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists discovery configurations.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/discoveryConfigs",
"httpMethod": "GET",
"id": "dlp.organizations.locations.discoveryConfigs.list",
"parameterOrder": [
"parent"
],
"parameters": {
"orderBy": {
"description": "Comma-separated list of config 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. Example: `name asc,update_time, create_time desc` Supported fields are: - `last_run_time`: corresponds to the last time the DiscoveryConfig ran. - `name`: corresponds to the DiscoveryConfig's name. - `status`: corresponds to DiscoveryConfig's status.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Size of the page. This value can be limited by a server.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Page token to continue retrieval. Comes from the previous call to ListDiscoveryConfigs. `order_by` field must not change for subsequent calls.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Parent resource name. The format of this value is as follows: `projects/{project_id}/locations/{location_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/discoveryConfigs",
"response": {
"$ref": "GooglePrivacyDlpV2ListDiscoveryConfigsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a discovery configuration.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/discoveryConfigs/{discoveryConfigsId}",
"httpMethod": "PATCH",
"id": "dlp.organizations.locations.discoveryConfigs.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the project and the configuration, for example `projects/dlp-test-project/discoveryConfigs/53234423`.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/discoveryConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "GooglePrivacyDlpV2UpdateDiscoveryConfigRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2DiscoveryConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"dlpJobs": {
"methods": {
"list": {
"description": "Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/dlpJobs",
"httpMethod": "GET",
"id": "dlp.organizations.locations.dlpJobs.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "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 for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The name of the trigger that created the job. - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * The operator must be `=` or `!=`. The syntax is based on https://google.aip.dev/160. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \\\"2017-12-12T00:00:00+00:00\\\" The length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"locationId": {
"description": "Deprecated. This field has no effect.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "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. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state`",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"type": {
"description": "The type of job. Defaults to `DlpJobType.INSPECT`",
"enum": [
"DLP_JOB_TYPE_UNSPECIFIED",
"INSPECT_JOB",
"RISK_ANALYSIS_JOB"
],
"enumDescriptions": [
"Defaults to INSPECT_JOB.",
"The job inspected Google Cloud for sensitive data.",
"The job executed a Risk Analysis computation."
],
"location": "query",
"type": "string"
}
},
"path": "v2/{+parent}/dlpJobs",
"response": {
"$ref": "GooglePrivacyDlpV2ListDlpJobsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"fileStoreDataProfiles": {
"methods": {
"delete": {
"description": "Delete a FileStoreDataProfile. Will not prevent the profile from being regenerated if the resource is still included in a discovery configuration.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/fileStoreDataProfiles/{fileStoreDataProfilesId}",
"httpMethod": "DELETE",
"id": "dlp.organizations.locations.fileStoreDataProfiles.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the file store data profile.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/fileStoreDataProfiles/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a file store data profile.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/fileStoreDataProfiles/{fileStoreDataProfilesId}",
"httpMethod": "GET",
"id": "dlp.organizations.locations.fileStoreDataProfiles.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name, for example `organizations/12345/locations/us/fileStoreDataProfiles/53234423`.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/fileStoreDataProfiles/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GooglePrivacyDlpV2FileStoreDataProfile"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists file store data profiles for an organization.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/fileStoreDataProfiles",
"httpMethod": "GET",
"id": "dlp.organizations.locations.fileStoreDataProfiles.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "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: - `project_id`: The Google Cloud project ID - `account_id`: The AWS account ID - `file_store_path`: The path like \"gs://bucket\" - `data_source_type`: The profile's data source type, like \"google/storage/bucket\" - `data_storage_location`: The location where the file store's data is stored, like \"us-central1\" - `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 - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` or `!=`. The `profile_last_generated` filter also supports `<` and `>`. The syntax is based on https://google.aip.dev/160. 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\"` * `profile_last_generated < \"2025-01-01T00:00:00.000Z\"` The length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "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.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. Page token to continue retrieval.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/fileStoreDataProfiles",
"response": {
"$ref": "GooglePrivacyDlpV2ListFileStoreDataProfilesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"infoTypes": {
"methods": {
"list": {
"description": "Returns a list of the sensitive information types that the DLP API supports. See https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/infoTypes",
"httpMethod": "GET",
"id": "dlp.organizations.locations.infoTypes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT.",
"location": "query",
"type": "string"
},
"languageCode": {
"description": "BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned.",
"location": "query",
"type": "string"
},
"locationId": {
"description": "Deprecated. This field has no effect.",
"location": "query",
"type": "string"
},
"parent": {
"description": "The parent resource name. The format of this value is as follows: `locations/{location_id}`",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/infoTypes",
"response": {
"$ref": "GooglePrivacyDlpV2ListInfoTypesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"inspectTemplates": {
"methods": {
"create": {
"description": "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.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates",
"httpMethod": "POST",
"id": "dlp.organizations.locations.inspectTemplates.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/inspectTemplates",
"request": {
"$ref": "GooglePrivacyDlpV2CreateInspectTemplateRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2InspectTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}",
"httpMethod": "DELETE",
"id": "dlp.organizations.locations.inspectTemplates.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the organization and inspectTemplate to be deleted, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/inspectTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}",
"httpMethod": "GET",
"id": "dlp.organizations.locations.inspectTemplates.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the organization and inspectTemplate to be read, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/inspectTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GooglePrivacyDlpV2InspectTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates",
"httpMethod": "GET",
"id": "dlp.organizations.locations.inspectTemplates.list",
"parameterOrder": [
"parent"
],
"parameters": {
"locationId": {
"description": "Deprecated. This field has no effect.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "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. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Page token to continue retrieval. Comes from the previous call to `ListInspectTemplates`.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/inspectTemplates",
"response": {
"$ref": "GooglePrivacyDlpV2ListInspectTemplatesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}",
"httpMethod": "PATCH",
"id": "dlp.organizations.locations.inspectTemplates.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of organization and inspectTemplate to be updated, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/inspectTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "GooglePrivacyDlpV2UpdateInspectTemplateRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2InspectTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"jobTriggers": {
"methods": {
"create": {
"description": "Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers",
"httpMethod": "POST",
"id": "dlp.organizations.locations.jobTriggers.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/jobTriggers",
"request": {
"$ref": "GooglePrivacyDlpV2CreateJobTriggerRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2JobTrigger"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}",
"httpMethod": "DELETE",
"id": "dlp.organizations.locations.jobTriggers.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/jobTriggers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}",
"httpMethod": "GET",
"id": "dlp.organizations.locations.jobTriggers.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/jobTriggers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GooglePrivacyDlpV2JobTrigger"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists job triggers. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers",
"httpMethod": "GET",
"id": "dlp.organizations.locations.jobTriggers.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "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 for inspect triggers: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. The syntax is based on https://google.aip.dev/160. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \\\"2017-12-12T00:00:00+00:00\\\" The length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"locationId": {
"description": "Deprecated. This field has no effect.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Comma-separated list of triggeredJob 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. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Size of the page. This value can be limited by a server.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Page token to continue retrieval. Comes from the previous call to ListJobTriggers. `order_by` field must not change for subsequent calls.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"type": {
"description": "The type of jobs. Will use `DlpJobType.INSPECT` if not set.",
"enum": [
"DLP_JOB_TYPE_UNSPECIFIED",
"INSPECT_JOB",
"RISK_ANALYSIS_JOB"
],
"enumDescriptions": [
"Defaults to INSPECT_JOB.",
"The job inspected Google Cloud for sensitive data.",
"The job executed a Risk Analysis computation."
],
"location": "query",
"type": "string"
}
},
"path": "v2/{+parent}/jobTriggers",
"response": {
"$ref": "GooglePrivacyDlpV2ListJobTriggersResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}",
"httpMethod": "PATCH",
"id": "dlp.organizations.locations.jobTriggers.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/jobTriggers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "GooglePrivacyDlpV2UpdateJobTriggerRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2JobTrigger"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"projectDataProfiles": {
"methods": {
"get": {
"description": "Gets a project data profile.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/projectDataProfiles/{projectDataProfilesId}",
"httpMethod": "GET",
"id": "dlp.organizations.locations.projectDataProfiles.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name, for example `organizations/12345/locations/us/projectDataProfiles/53234423`.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/projectDataProfiles/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GooglePrivacyDlpV2ProjectDataProfile"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists project data profiles for an organization.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/projectDataProfiles",
"httpMethod": "GET",
"id": "dlp.organizations.locations.projectDataProfiles.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "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: - `project_id`: the Google Cloud project ID - `sensitivity_level`: HIGH|MODERATE|LOW - `data_risk_level`: HIGH|MODERATE|LOW - `status_code`: an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` or `!=`. The `profile_last_generated` filter also supports `<` and `>`. The syntax is based on https://google.aip.dev/160. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `profile_last_generated < \"2025-01-01T00:00:00.000Z\"` The length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "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` * `sensitivity_level desc` Supported fields: - `project_id`: Google Cloud project ID - `sensitivity_level`: How sensitive the data in a project is, at most - `data_risk_level`: How much risk is associated with this data - `profile_last_generated`: Date and time (in epoch seconds) the profile was last generated",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Page token to continue retrieval.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. organizations/{org_id}/locations/{loc_id}",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/projectDataProfiles",
"response": {
"$ref": "GooglePrivacyDlpV2ListProjectDataProfilesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"storedInfoTypes": {
"methods": {
"create": {
"description": "Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes",
"httpMethod": "POST",
"id": "dlp.organizations.locations.storedInfoTypes.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/storedInfoTypes",
"request": {
"$ref": "GooglePrivacyDlpV2CreateStoredInfoTypeRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2StoredInfoType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}",
"httpMethod": "DELETE",
"id": "dlp.organizations.locations.storedInfoTypes.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the organization and storedInfoType to be deleted, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/storedInfoTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}",
"httpMethod": "GET",
"id": "dlp.organizations.locations.storedInfoTypes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the organization and storedInfoType to be read, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/storedInfoTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GooglePrivacyDlpV2StoredInfoType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists stored infoTypes. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes",
"httpMethod": "GET",
"id": "dlp.organizations.locations.storedInfoTypes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"locationId": {
"description": "Deprecated. This field has no effect.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "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. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Page token to continue retrieval. Comes from the previous call to `ListStoredInfoTypes`.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/storedInfoTypes",
"response": {
"$ref": "GooglePrivacyDlpV2ListStoredInfoTypesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}",
"httpMethod": "PATCH",
"id": "dlp.organizations.locations.storedInfoTypes.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of organization and storedInfoType to be updated, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/storedInfoTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "GooglePrivacyDlpV2UpdateStoredInfoTypeRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2StoredInfoType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"tableDataProfiles": {
"methods": {
"delete": {
"description": "Delete a TableDataProfile. Will not prevent the profile from being regenerated if the table is still included in a discovery configuration.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/tableDataProfiles/{tableDataProfilesId}",
"httpMethod": "DELETE",
"id": "dlp.organizations.locations.tableDataProfiles.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the table data profile.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/tableDataProfiles/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a table data profile.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/tableDataProfiles/{tableDataProfilesId}",
"httpMethod": "GET",
"id": "dlp.organizations.locations.tableDataProfiles.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name, for example `organizations/12345/locations/us/tableDataProfiles/53234423`.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/tableDataProfiles/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GooglePrivacyDlpV2TableDataProfile"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists table data profiles for an organization.",
"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/tableDataProfiles",
"httpMethod": "GET",
"id": "dlp.organizations.locations.tableDataProfiles.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "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: - `project_id`: The Google Cloud project ID - `dataset_id`: The BigQuery dataset ID - `table_id`: The ID of the BigQuery table - `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 - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` or `!=`. The `profile_last_generated` filter also supports `<` and `>`. The syntax is based on https://google.aip.dev/160. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `profile_last_generated < \"2025-01-01T00:00:00.000Z\"` The length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "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` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `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. - `row_count`: Number of rows in this resource.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Page token to continue retrieval.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`.",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/tableDataProfiles",
"response": {
"$ref": "GooglePrivacyDlpV2ListTableDataProfilesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"storedInfoTypes": {
"methods": {
"create": {
"description": "Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.",
"flatPath": "v2/organizations/{organizationsId}/storedInfoTypes",
"httpMethod": "POST",
"id": "dlp.organizations.storedInfoTypes.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/storedInfoTypes",
"request": {
"$ref": "GooglePrivacyDlpV2CreateStoredInfoTypeRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2StoredInfoType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.",
"flatPath": "v2/organizations/{organizationsId}/storedInfoTypes/{storedInfoTypesId}",
"httpMethod": "DELETE",
"id": "dlp.organizations.storedInfoTypes.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the organization and storedInfoType to be deleted, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342.",
"location": "path",
"pattern": "^organizations/[^/]+/storedInfoTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.",
"flatPath": "v2/organizations/{organizationsId}/storedInfoTypes/{storedInfoTypesId}",
"httpMethod": "GET",
"id": "dlp.organizations.storedInfoTypes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the organization and storedInfoType to be read, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342.",
"location": "path",
"pattern": "^organizations/[^/]+/storedInfoTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GooglePrivacyDlpV2StoredInfoType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists stored infoTypes. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.",
"flatPath": "v2/organizations/{organizationsId}/storedInfoTypes",
"httpMethod": "GET",
"id": "dlp.organizations.storedInfoTypes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"locationId": {
"description": "Deprecated. This field has no effect.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "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. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Page token to continue retrieval. Comes from the previous call to `ListStoredInfoTypes`.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/storedInfoTypes",
"response": {
"$ref": "GooglePrivacyDlpV2ListStoredInfoTypesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.",
"flatPath": "v2/organizations/{organizationsId}/storedInfoTypes/{storedInfoTypesId}",
"httpMethod": "PATCH",
"id": "dlp.organizations.storedInfoTypes.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of organization and storedInfoType to be updated, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342.",
"location": "path",
"pattern": "^organizations/[^/]+/storedInfoTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "GooglePrivacyDlpV2UpdateStoredInfoTypeRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2StoredInfoType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"projects": {
"resources": {
"content": {
"methods": {
"deidentify": {
"description": "De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data 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.",
"flatPath": "v2/projects/{projectsId}/content:deidentify",
"httpMethod": "POST",
"id": "dlp.projects.content.deidentify",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/content:deidentify",
"request": {
"$ref": "GooglePrivacyDlpV2DeidentifyContentRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2DeidentifyContentResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"inspect": {
"description": "Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. 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. For how to guides, see https://cloud.google.com/sensitive-data-protection/docs/inspecting-images and https://cloud.google.com/sensitive-data-protection/docs/inspecting-text,",
"flatPath": "v2/projects/{projectsId}/content:inspect",
"httpMethod": "POST",
"id": "dlp.projects.content.inspect",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/content:inspect",
"request": {
"$ref": "GooglePrivacyDlpV2InspectContentRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2InspectContentResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"reidentify": {
"description": "Re-identifies content that has been de-identified. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example to learn more.",
"flatPath": "v2/projects/{projectsId}/content:reidentify",
"httpMethod": "POST",
"id": "dlp.projects.content.reidentify",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/content:reidentify",
"request": {
"$ref": "GooglePrivacyDlpV2ReidentifyContentRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2ReidentifyContentResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"deidentifyTemplates": {
"methods": {
"create": {
"description": "Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.",
"flatPath": "v2/projects/{projectsId}/deidentifyTemplates",
"httpMethod": "POST",
"id": "dlp.projects.deidentifyTemplates.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/deidentifyTemplates",
"request": {
"$ref": "GooglePrivacyDlpV2CreateDeidentifyTemplateRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2DeidentifyTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.",
"flatPath": "v2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}",
"httpMethod": "DELETE",
"id": "dlp.projects.deidentifyTemplates.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the organization and deidentify template to be deleted, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.",
"location": "path",
"pattern": "^projects/[^/]+/deidentifyTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.",
"flatPath": "v2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}",
"httpMethod": "GET",
"id": "dlp.projects.deidentifyTemplates.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the organization and deidentify template to be read, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.",
"location": "path",
"pattern": "^projects/[^/]+/deidentifyTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GooglePrivacyDlpV2DeidentifyTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.",
"flatPath": "v2/projects/{projectsId}/deidentifyTemplates",
"httpMethod": "GET",
"id": "dlp.projects.deidentifyTemplates.list",
"parameterOrder": [
"parent"
],
"parameters": {
"locationId": {
"description": "Deprecated. This field has no effect.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "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. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Page token to continue retrieval. Comes from the previous call to `ListDeidentifyTemplates`.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/deidentifyTemplates",
"response": {
"$ref": "GooglePrivacyDlpV2ListDeidentifyTemplatesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates the DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.",
"flatPath": "v2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}",
"httpMethod": "PATCH",
"id": "dlp.projects.deidentifyTemplates.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of organization and deidentify template to be updated, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.",
"location": "path",
"pattern": "^projects/[^/]+/deidentifyTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2DeidentifyTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"dlpJobs": {
"methods": {
"cancel": {
"description": "Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.",
"flatPath": "v2/projects/{projectsId}/dlpJobs/{dlpJobsId}:cancel",
"httpMethod": "POST",
"id": "dlp.projects.dlpJobs.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the DlpJob resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/dlpJobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}:cancel",
"request": {
"$ref": "GooglePrivacyDlpV2CancelDlpJobRequest"
},
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, 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.",
"flatPath": "v2/projects/{projectsId}/dlpJobs",
"httpMethod": "POST",
"id": "dlp.projects.dlpJobs.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/dlpJobs",
"request": {
"$ref": "GooglePrivacyDlpV2CreateDlpJobRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2DlpJob"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be canceled if possible. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.",
"flatPath": "v2/projects/{projectsId}/dlpJobs/{dlpJobsId}",
"httpMethod": "DELETE",
"id": "dlp.projects.dlpJobs.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the DlpJob resource to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/dlpJobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets the latest state of a long-running DlpJob. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.",
"flatPath": "v2/projects/{projectsId}/dlpJobs/{dlpJobsId}",
"httpMethod": "GET",
"id": "dlp.projects.dlpJobs.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the DlpJob resource.",
"location": "path",
"pattern": "^projects/[^/]+/dlpJobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GooglePrivacyDlpV2DlpJob"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.",
"flatPath": "v2/projects/{projectsId}/dlpJobs",
"httpMethod": "GET",
"id": "dlp.projects.dlpJobs.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "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 for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The name of the trigger that created the job. - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * The operator must be `=` or `!=`. The syntax is based on https://google.aip.dev/160. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \\\"2017-12-12T00:00:00+00:00\\\" The length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"locationId": {
"description": "Deprecated. This field has no effect.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "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. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state`",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"type": {
"description": "The type of job. Defaults to `DlpJobType.INSPECT`",
"enum": [
"DLP_JOB_TYPE_UNSPECIFIED",
"INSPECT_JOB",
"RISK_ANALYSIS_JOB"
],
"enumDescriptions": [
"Defaults to INSPECT_JOB.",
"The job inspected Google Cloud for sensitive data.",
"The job executed a Risk Analysis computation."
],
"location": "query",
"type": "string"
}
},
"path": "v2/{+parent}/dlpJobs",
"response": {
"$ref": "GooglePrivacyDlpV2ListDlpJobsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"image": {
"methods": {
"redact": {
"description": "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. Only the first frame of each multiframe image is redacted. Metadata and other frames are omitted in the response.",
"flatPath": "v2/projects/{projectsId}/image:redact",
"httpMethod": "POST",
"id": "dlp.projects.image.redact",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/image:redact",
"request": {
"$ref": "GooglePrivacyDlpV2RedactImageRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2RedactImageResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"inspectTemplates": {
"methods": {
"create": {
"description": "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.",
"flatPath": "v2/projects/{projectsId}/inspectTemplates",
"httpMethod": "POST",
"id": "dlp.projects.inspectTemplates.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/inspectTemplates",
"request": {
"$ref": "GooglePrivacyDlpV2CreateInspectTemplateRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2InspectTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.",
"flatPath": "v2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}",
"httpMethod": "DELETE",
"id": "dlp.projects.inspectTemplates.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the organization and inspectTemplate to be deleted, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.",
"location": "path",
"pattern": "^projects/[^/]+/inspectTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.",
"flatPath": "v2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}",
"httpMethod": "GET",
"id": "dlp.projects.inspectTemplates.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the organization and inspectTemplate to be read, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.",
"location": "path",
"pattern": "^projects/[^/]+/inspectTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GooglePrivacyDlpV2InspectTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.",
"flatPath": "v2/projects/{projectsId}/inspectTemplates",
"httpMethod": "GET",
"id": "dlp.projects.inspectTemplates.list",
"parameterOrder": [
"parent"
],
"parameters": {
"locationId": {
"description": "Deprecated. This field has no effect.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "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. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Page token to continue retrieval. Comes from the previous call to `ListInspectTemplates`.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/inspectTemplates",
"response": {
"$ref": "GooglePrivacyDlpV2ListInspectTemplatesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.",
"flatPath": "v2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}",
"httpMethod": "PATCH",
"id": "dlp.projects.inspectTemplates.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of organization and inspectTemplate to be updated, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.",
"location": "path",
"pattern": "^projects/[^/]+/inspectTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "GooglePrivacyDlpV2UpdateInspectTemplateRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2InspectTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"jobTriggers": {
"methods": {
"activate": {
"description": "Activate a job trigger. Causes the immediate execute of a trigger instead of waiting on the trigger event to occur.",
"flatPath": "v2/projects/{projectsId}/jobTriggers/{jobTriggersId}:activate",
"httpMethod": "POST",
"id": "dlp.projects.jobTriggers.activate",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the trigger to activate, for example `projects/dlp-test-project/jobTriggers/53234423`.",
"location": "path",
"pattern": "^projects/[^/]+/jobTriggers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}:activate",
"request": {
"$ref": "GooglePrivacyDlpV2ActivateJobTriggerRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2DlpJob"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.",
"flatPath": "v2/projects/{projectsId}/jobTriggers",
"httpMethod": "POST",
"id": "dlp.projects.jobTriggers.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/jobTriggers",
"request": {
"$ref": "GooglePrivacyDlpV2CreateJobTriggerRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2JobTrigger"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.",
"flatPath": "v2/projects/{projectsId}/jobTriggers/{jobTriggersId}",
"httpMethod": "DELETE",
"id": "dlp.projects.jobTriggers.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`.",
"location": "path",
"pattern": "^projects/[^/]+/jobTriggers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.",
"flatPath": "v2/projects/{projectsId}/jobTriggers/{jobTriggersId}",
"httpMethod": "GET",
"id": "dlp.projects.jobTriggers.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`.",
"location": "path",
"pattern": "^projects/[^/]+/jobTriggers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GooglePrivacyDlpV2JobTrigger"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists job triggers. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.",
"flatPath": "v2/projects/{projectsId}/jobTriggers",
"httpMethod": "GET",
"id": "dlp.projects.jobTriggers.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "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 for inspect triggers: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. The syntax is based on https://google.aip.dev/160. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \\\"2017-12-12T00:00:00+00:00\\\" The length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"locationId": {
"description": "Deprecated. This field has no effect.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Comma-separated list of triggeredJob 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. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Size of the page. This value can be limited by a server.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Page token to continue retrieval. Comes from the previous call to ListJobTriggers. `order_by` field must not change for subsequent calls.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"type": {
"description": "The type of jobs. Will use `DlpJobType.INSPECT` if not set.",
"enum": [
"DLP_JOB_TYPE_UNSPECIFIED",
"INSPECT_JOB",
"RISK_ANALYSIS_JOB"
],
"enumDescriptions": [
"Defaults to INSPECT_JOB.",
"The job inspected Google Cloud for sensitive data.",
"The job executed a Risk Analysis computation."
],
"location": "query",
"type": "string"
}
},
"path": "v2/{+parent}/jobTriggers",
"response": {
"$ref": "GooglePrivacyDlpV2ListJobTriggersResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.",
"flatPath": "v2/projects/{projectsId}/jobTriggers/{jobTriggersId}",
"httpMethod": "PATCH",
"id": "dlp.projects.jobTriggers.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`.",
"location": "path",
"pattern": "^projects/[^/]+/jobTriggers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "GooglePrivacyDlpV2UpdateJobTriggerRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2JobTrigger"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"locations": {
"resources": {
"columnDataProfiles": {
"methods": {
"get": {
"description": "Gets a column data profile.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/columnDataProfiles/{columnDataProfilesId}",
"httpMethod": "GET",
"id": "dlp.projects.locations.columnDataProfiles.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name, for example `organizations/12345/locations/us/columnDataProfiles/53234423`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/columnDataProfiles/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GooglePrivacyDlpV2ColumnDataProfile"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists column data profiles for an organization.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/columnDataProfiles",
"httpMethod": "GET",
"id": "dlp.projects.locations.columnDataProfiles.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "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: - `table_data_profile_name`: The name of the related table data profile - `project_id`: The Google Cloud project ID (REQUIRED) - `dataset_id`: The BigQuery dataset ID (REQUIRED) - `table_id`: The BigQuery table ID (REQUIRED) - `field_id`: The ID of the BigQuery field - `info_type`: The infotype detected in the resource - `sensitivity_level`: HIGH|MEDIUM|LOW - `data_risk_level`: How much risk is associated with this data - `status_code`: An RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` for project_id, dataset_id, and table_id. Other filters also support `!=`. The `profile_last_generated` filter also supports `<` and `>`. The syntax is based on https://google.aip.dev/160. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH * project_id = 12345 AND info_type = STREET_ADDRESS * profile_last_generated < \"2025-01-01T00:00:00.000Z\" The length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "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` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a column 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.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Page token to continue retrieval.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/columnDataProfiles",
"response": {
"$ref": "GooglePrivacyDlpV2ListColumnDataProfilesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"connections": {
"methods": {
"create": {
"description": "Create a Connection to an external data source.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections",
"httpMethod": "POST",
"id": "dlp.projects.locations.connections.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/{project_id}/locations/{location_id}` + Organizations scope: `organizations/{org_id}/locations/{location_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/connections",
"request": {
"$ref": "GooglePrivacyDlpV2CreateConnectionRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2Connection"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Delete a Connection.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}",
"httpMethod": "DELETE",
"id": "dlp.projects.locations.connections.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the Connection to be deleted, in the format: `projects/{project}/locations/{location}/connections/{connection}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Get a Connection by name.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}",
"httpMethod": "GET",
"id": "dlp.projects.locations.connections.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name in the format: `projects/{project}/locations/{location}/connections/{connection}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GooglePrivacyDlpV2Connection"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists Connections in a parent. Use SearchConnections to see all connections within an organization.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections",
"httpMethod": "GET",
"id": "dlp.projects.locations.connections.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Supported field/value: `state` - MISSING|AVAILABLE|ERROR The syntax is based on https://google.aip.dev/160.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. Number of results per page, max 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. Page token from a previous page to return the next set of results. If set, all other request fields must match the original request.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Resource name of the organization or project, for example, `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/connections",
"response": {
"$ref": "GooglePrivacyDlpV2ListConnectionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Update a Connection.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}",
"httpMethod": "PATCH",
"id": "dlp.projects.locations.connections.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name in the format: `projects/{project}/locations/{location}/connections/{connection}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "GooglePrivacyDlpV2UpdateConnectionRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2Connection"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"search": {
"description": "Searches for Connections in a parent.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections:search",
"httpMethod": "GET",
"id": "dlp.projects.locations.connections.search",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Supported field/value: - `state` - MISSING|AVAILABLE|ERROR The syntax is based on https://google.aip.dev/160.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. Number of results per page, max 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. Page token from a previous page to return the next set of results. If set, all other request fields must match the original request.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Resource name of the organization or project with a wildcard location, for example, `organizations/433245324/locations/-` or `projects/project-id/locations/-`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/connections:search",
"response": {
"$ref": "GooglePrivacyDlpV2SearchConnectionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"content": {
"methods": {
"deidentify": {
"description": "De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data 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.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/content:deidentify",
"httpMethod": "POST",
"id": "dlp.projects.locations.content.deidentify",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/content:deidentify",
"request": {
"$ref": "GooglePrivacyDlpV2DeidentifyContentRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2DeidentifyContentResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"inspect": {
"description": "Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. 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. For how to guides, see https://cloud.google.com/sensitive-data-protection/docs/inspecting-images and https://cloud.google.com/sensitive-data-protection/docs/inspecting-text,",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/content:inspect",
"httpMethod": "POST",
"id": "dlp.projects.locations.content.inspect",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/content:inspect",
"request": {
"$ref": "GooglePrivacyDlpV2InspectContentRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2InspectContentResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"reidentify": {
"description": "Re-identifies content that has been de-identified. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example to learn more.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/content:reidentify",
"httpMethod": "POST",
"id": "dlp.projects.locations.content.reidentify",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/content:reidentify",
"request": {
"$ref": "GooglePrivacyDlpV2ReidentifyContentRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2ReidentifyContentResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"deidentifyTemplates": {
"methods": {
"create": {
"description": "Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates",
"httpMethod": "POST",
"id": "dlp.projects.locations.deidentifyTemplates.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/deidentifyTemplates",
"request": {
"$ref": "GooglePrivacyDlpV2CreateDeidentifyTemplateRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2DeidentifyTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}",
"httpMethod": "DELETE",
"id": "dlp.projects.locations.deidentifyTemplates.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the organization and deidentify template to be deleted, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/deidentifyTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}",
"httpMethod": "GET",
"id": "dlp.projects.locations.deidentifyTemplates.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the organization and deidentify template to be read, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/deidentifyTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GooglePrivacyDlpV2DeidentifyTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates",
"httpMethod": "GET",
"id": "dlp.projects.locations.deidentifyTemplates.list",
"parameterOrder": [
"parent"
],
"parameters": {
"locationId": {
"description": "Deprecated. This field has no effect.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "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. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Page token to continue retrieval. Comes from the previous call to `ListDeidentifyTemplates`.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/deidentifyTemplates",
"response": {
"$ref": "GooglePrivacyDlpV2ListDeidentifyTemplatesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates the DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/deidentifyTemplates/{deidentifyTemplatesId}",
"httpMethod": "PATCH",
"id": "dlp.projects.locations.deidentifyTemplates.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of organization and deidentify template to be updated, for example `organizations/433245324/deidentifyTemplates/432452342` or projects/project-id/deidentifyTemplates/432452342.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/deidentifyTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2DeidentifyTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"discoveryConfigs": {
"methods": {
"create": {
"description": "Creates a config for discovery to scan and profile storage.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/discoveryConfigs",
"httpMethod": "POST",
"id": "dlp.projects.locations.discoveryConfigs.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/{project_id}/locations/{location_id}` + Organizations scope: `organizations/{org_id}/locations/{location_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/discoveryConfigs",
"request": {
"$ref": "GooglePrivacyDlpV2CreateDiscoveryConfigRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2DiscoveryConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a discovery configuration.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/discoveryConfigs/{discoveryConfigsId}",
"httpMethod": "DELETE",
"id": "dlp.projects.locations.discoveryConfigs.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the project and the config, for example `projects/dlp-test-project/discoveryConfigs/53234423`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/discoveryConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a discovery configuration.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/discoveryConfigs/{discoveryConfigsId}",
"httpMethod": "GET",
"id": "dlp.projects.locations.discoveryConfigs.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the project and the configuration, for example `projects/dlp-test-project/discoveryConfigs/53234423`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/discoveryConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GooglePrivacyDlpV2DiscoveryConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists discovery configurations.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/discoveryConfigs",
"httpMethod": "GET",
"id": "dlp.projects.locations.discoveryConfigs.list",
"parameterOrder": [
"parent"
],
"parameters": {
"orderBy": {
"description": "Comma-separated list of config 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. Example: `name asc,update_time, create_time desc` Supported fields are: - `last_run_time`: corresponds to the last time the DiscoveryConfig ran. - `name`: corresponds to the DiscoveryConfig's name. - `status`: corresponds to DiscoveryConfig's status.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Size of the page. This value can be limited by a server.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Page token to continue retrieval. Comes from the previous call to ListDiscoveryConfigs. `order_by` field must not change for subsequent calls.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Parent resource name. The format of this value is as follows: `projects/{project_id}/locations/{location_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/discoveryConfigs",
"response": {
"$ref": "GooglePrivacyDlpV2ListDiscoveryConfigsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a discovery configuration.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/discoveryConfigs/{discoveryConfigsId}",
"httpMethod": "PATCH",
"id": "dlp.projects.locations.discoveryConfigs.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the project and the configuration, for example `projects/dlp-test-project/discoveryConfigs/53234423`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/discoveryConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "GooglePrivacyDlpV2UpdateDiscoveryConfigRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2DiscoveryConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"dlpJobs": {
"methods": {
"cancel": {
"description": "Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:cancel",
"httpMethod": "POST",
"id": "dlp.projects.locations.dlpJobs.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the DlpJob resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dlpJobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}:cancel",
"request": {
"$ref": "GooglePrivacyDlpV2CancelDlpJobRequest"
},
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, 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.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dlpJobs",
"httpMethod": "POST",
"id": "dlp.projects.locations.dlpJobs.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/dlpJobs",
"request": {
"$ref": "GooglePrivacyDlpV2CreateDlpJobRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2DlpJob"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be canceled if possible. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}",
"httpMethod": "DELETE",
"id": "dlp.projects.locations.dlpJobs.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the DlpJob resource to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dlpJobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"finish": {
"description": "Finish a running hybrid DlpJob. Triggers the finalization steps and running of any enabled actions that have not yet run.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:finish",
"httpMethod": "POST",
"id": "dlp.projects.locations.dlpJobs.finish",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the DlpJob resource to be finished.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dlpJobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}:finish",
"request": {
"$ref": "GooglePrivacyDlpV2FinishDlpJobRequest"
},
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets the latest state of a long-running DlpJob. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}",
"httpMethod": "GET",
"id": "dlp.projects.locations.dlpJobs.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the DlpJob resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dlpJobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GooglePrivacyDlpV2DlpJob"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"hybridInspect": {
"description": "Inspect hybrid content and store findings to a job. To review the findings, inspect the job. Inspection will occur asynchronously.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dlpJobs/{dlpJobsId}:hybridInspect",
"httpMethod": "POST",
"id": "dlp.projects.locations.dlpJobs.hybridInspect",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the job to execute a hybrid inspect on, for example `projects/dlp-test-project/dlpJob/53234423`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dlpJobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}:hybridInspect",
"request": {
"$ref": "GooglePrivacyDlpV2HybridInspectDlpJobRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2HybridInspectResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/dlpJobs",
"httpMethod": "GET",
"id": "dlp.projects.locations.dlpJobs.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "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 for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The name of the trigger that created the job. - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * The operator must be `=` or `!=`. The syntax is based on https://google.aip.dev/160. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \\\"2017-12-12T00:00:00+00:00\\\" The length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"locationId": {
"description": "Deprecated. This field has no effect.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "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. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state`",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"type": {
"description": "The type of job. Defaults to `DlpJobType.INSPECT`",
"enum": [
"DLP_JOB_TYPE_UNSPECIFIED",
"INSPECT_JOB",
"RISK_ANALYSIS_JOB"
],
"enumDescriptions": [
"Defaults to INSPECT_JOB.",
"The job inspected Google Cloud for sensitive data.",
"The job executed a Risk Analysis computation."
],
"location": "query",
"type": "string"
}
},
"path": "v2/{+parent}/dlpJobs",
"response": {
"$ref": "GooglePrivacyDlpV2ListDlpJobsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"fileStoreDataProfiles": {
"methods": {
"delete": {
"description": "Delete a FileStoreDataProfile. Will not prevent the profile from being regenerated if the resource is still included in a discovery configuration.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/fileStoreDataProfiles/{fileStoreDataProfilesId}",
"httpMethod": "DELETE",
"id": "dlp.projects.locations.fileStoreDataProfiles.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the file store data profile.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/fileStoreDataProfiles/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a file store data profile.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/fileStoreDataProfiles/{fileStoreDataProfilesId}",
"httpMethod": "GET",
"id": "dlp.projects.locations.fileStoreDataProfiles.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name, for example `organizations/12345/locations/us/fileStoreDataProfiles/53234423`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/fileStoreDataProfiles/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GooglePrivacyDlpV2FileStoreDataProfile"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists file store data profiles for an organization.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/fileStoreDataProfiles",
"httpMethod": "GET",
"id": "dlp.projects.locations.fileStoreDataProfiles.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "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: - `project_id`: The Google Cloud project ID - `account_id`: The AWS account ID - `file_store_path`: The path like \"gs://bucket\" - `data_source_type`: The profile's data source type, like \"google/storage/bucket\" - `data_storage_location`: The location where the file store's data is stored, like \"us-central1\" - `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 - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` or `!=`. The `profile_last_generated` filter also supports `<` and `>`. The syntax is based on https://google.aip.dev/160. 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\"` * `profile_last_generated < \"2025-01-01T00:00:00.000Z\"` The length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "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.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. Page token to continue retrieval.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/fileStoreDataProfiles",
"response": {
"$ref": "GooglePrivacyDlpV2ListFileStoreDataProfilesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"image": {
"methods": {
"redact": {
"description": "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. Only the first frame of each multiframe image is redacted. Metadata and other frames are omitted in the response.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/image:redact",
"httpMethod": "POST",
"id": "dlp.projects.locations.image.redact",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/image:redact",
"request": {
"$ref": "GooglePrivacyDlpV2RedactImageRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2RedactImageResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"infoTypes": {
"methods": {
"list": {
"description": "Returns a list of the sensitive information types that the DLP API supports. See https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/infoTypes",
"httpMethod": "GET",
"id": "dlp.projects.locations.infoTypes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT.",
"location": "query",
"type": "string"
},
"languageCode": {
"description": "BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned.",
"location": "query",
"type": "string"
},
"locationId": {
"description": "Deprecated. This field has no effect.",
"location": "query",
"type": "string"
},
"parent": {
"description": "The parent resource name. The format of this value is as follows: `locations/{location_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/infoTypes",
"response": {
"$ref": "GooglePrivacyDlpV2ListInfoTypesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"inspectTemplates": {
"methods": {
"create": {
"description": "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.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates",
"httpMethod": "POST",
"id": "dlp.projects.locations.inspectTemplates.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/inspectTemplates",
"request": {
"$ref": "GooglePrivacyDlpV2CreateInspectTemplateRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2InspectTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}",
"httpMethod": "DELETE",
"id": "dlp.projects.locations.inspectTemplates.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the organization and inspectTemplate to be deleted, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/inspectTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}",
"httpMethod": "GET",
"id": "dlp.projects.locations.inspectTemplates.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the organization and inspectTemplate to be read, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/inspectTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GooglePrivacyDlpV2InspectTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates",
"httpMethod": "GET",
"id": "dlp.projects.locations.inspectTemplates.list",
"parameterOrder": [
"parent"
],
"parameters": {
"locationId": {
"description": "Deprecated. This field has no effect.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "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. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Page token to continue retrieval. Comes from the previous call to `ListInspectTemplates`.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/inspectTemplates",
"response": {
"$ref": "GooglePrivacyDlpV2ListInspectTemplatesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/inspectTemplates/{inspectTemplatesId}",
"httpMethod": "PATCH",
"id": "dlp.projects.locations.inspectTemplates.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of organization and inspectTemplate to be updated, for example `organizations/433245324/inspectTemplates/432452342` or projects/project-id/inspectTemplates/432452342.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/inspectTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "GooglePrivacyDlpV2UpdateInspectTemplateRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2InspectTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"jobTriggers": {
"methods": {
"activate": {
"description": "Activate a job trigger. Causes the immediate execute of a trigger instead of waiting on the trigger event to occur.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}:activate",
"httpMethod": "POST",
"id": "dlp.projects.locations.jobTriggers.activate",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the trigger to activate, for example `projects/dlp-test-project/jobTriggers/53234423`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/jobTriggers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}:activate",
"request": {
"$ref": "GooglePrivacyDlpV2ActivateJobTriggerRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2DlpJob"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobTriggers",
"httpMethod": "POST",
"id": "dlp.projects.locations.jobTriggers.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/jobTriggers",
"request": {
"$ref": "GooglePrivacyDlpV2CreateJobTriggerRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2JobTrigger"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}",
"httpMethod": "DELETE",
"id": "dlp.projects.locations.jobTriggers.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/jobTriggers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}",
"httpMethod": "GET",
"id": "dlp.projects.locations.jobTriggers.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/jobTriggers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GooglePrivacyDlpV2JobTrigger"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"hybridInspect": {
"description": "Inspect hybrid content and store findings to a trigger. The inspection will be processed asynchronously. To review the findings monitor the jobs within the trigger.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}:hybridInspect",
"httpMethod": "POST",
"id": "dlp.projects.locations.jobTriggers.hybridInspect",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the trigger to execute a hybrid inspect on, for example `projects/dlp-test-project/jobTriggers/53234423`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/jobTriggers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}:hybridInspect",
"request": {
"$ref": "GooglePrivacyDlpV2HybridInspectJobTriggerRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2HybridInspectResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists job triggers. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobTriggers",
"httpMethod": "GET",
"id": "dlp.projects.locations.jobTriggers.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "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 for inspect triggers: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. The syntax is based on https://google.aip.dev/160. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \\\"2017-12-12T00:00:00+00:00\\\" The length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"locationId": {
"description": "Deprecated. This field has no effect.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Comma-separated list of triggeredJob 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. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Size of the page. This value can be limited by a server.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Page token to continue retrieval. Comes from the previous call to ListJobTriggers. `order_by` field must not change for subsequent calls.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"type": {
"description": "The type of jobs. Will use `DlpJobType.INSPECT` if not set.",
"enum": [
"DLP_JOB_TYPE_UNSPECIFIED",
"INSPECT_JOB",
"RISK_ANALYSIS_JOB"
],
"enumDescriptions": [
"Defaults to INSPECT_JOB.",
"The job inspected Google Cloud for sensitive data.",
"The job executed a Risk Analysis computation."
],
"location": "query",
"type": "string"
}
},
"path": "v2/{+parent}/jobTriggers",
"response": {
"$ref": "GooglePrivacyDlpV2ListJobTriggersResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/jobTriggers/{jobTriggersId}",
"httpMethod": "PATCH",
"id": "dlp.projects.locations.jobTriggers.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/jobTriggers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "GooglePrivacyDlpV2UpdateJobTriggerRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2JobTrigger"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"projectDataProfiles": {
"methods": {
"get": {
"description": "Gets a project data profile.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/projectDataProfiles/{projectDataProfilesId}",
"httpMethod": "GET",
"id": "dlp.projects.locations.projectDataProfiles.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name, for example `organizations/12345/locations/us/projectDataProfiles/53234423`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/projectDataProfiles/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GooglePrivacyDlpV2ProjectDataProfile"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists project data profiles for an organization.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/projectDataProfiles",
"httpMethod": "GET",
"id": "dlp.projects.locations.projectDataProfiles.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "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: - `project_id`: the Google Cloud project ID - `sensitivity_level`: HIGH|MODERATE|LOW - `data_risk_level`: HIGH|MODERATE|LOW - `status_code`: an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` or `!=`. The `profile_last_generated` filter also supports `<` and `>`. The syntax is based on https://google.aip.dev/160. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `profile_last_generated < \"2025-01-01T00:00:00.000Z\"` The length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "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` * `sensitivity_level desc` Supported fields: - `project_id`: Google Cloud project ID - `sensitivity_level`: How sensitive the data in a project is, at most - `data_risk_level`: How much risk is associated with this data - `profile_last_generated`: Date and time (in epoch seconds) the profile was last generated",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Page token to continue retrieval.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. organizations/{org_id}/locations/{loc_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/projectDataProfiles",
"response": {
"$ref": "GooglePrivacyDlpV2ListProjectDataProfilesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"storedInfoTypes": {
"methods": {
"create": {
"description": "Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes",
"httpMethod": "POST",
"id": "dlp.projects.locations.storedInfoTypes.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/storedInfoTypes",
"request": {
"$ref": "GooglePrivacyDlpV2CreateStoredInfoTypeRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2StoredInfoType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}",
"httpMethod": "DELETE",
"id": "dlp.projects.locations.storedInfoTypes.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the organization and storedInfoType to be deleted, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/storedInfoTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}",
"httpMethod": "GET",
"id": "dlp.projects.locations.storedInfoTypes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the organization and storedInfoType to be read, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/storedInfoTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GooglePrivacyDlpV2StoredInfoType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists stored infoTypes. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes",
"httpMethod": "GET",
"id": "dlp.projects.locations.storedInfoTypes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"locationId": {
"description": "Deprecated. This field has no effect.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "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. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Page token to continue retrieval. Comes from the previous call to `ListStoredInfoTypes`.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/storedInfoTypes",
"response": {
"$ref": "GooglePrivacyDlpV2ListStoredInfoTypesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/storedInfoTypes/{storedInfoTypesId}",
"httpMethod": "PATCH",
"id": "dlp.projects.locations.storedInfoTypes.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of organization and storedInfoType to be updated, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/storedInfoTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "GooglePrivacyDlpV2UpdateStoredInfoTypeRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2StoredInfoType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"tableDataProfiles": {
"methods": {
"delete": {
"description": "Delete a TableDataProfile. Will not prevent the profile from being regenerated if the table is still included in a discovery configuration.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/tableDataProfiles/{tableDataProfilesId}",
"httpMethod": "DELETE",
"id": "dlp.projects.locations.tableDataProfiles.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the table data profile.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/tableDataProfiles/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a table data profile.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/tableDataProfiles/{tableDataProfilesId}",
"httpMethod": "GET",
"id": "dlp.projects.locations.tableDataProfiles.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name, for example `organizations/12345/locations/us/tableDataProfiles/53234423`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/tableDataProfiles/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GooglePrivacyDlpV2TableDataProfile"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists table data profiles for an organization.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/tableDataProfiles",
"httpMethod": "GET",
"id": "dlp.projects.locations.tableDataProfiles.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "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: - `project_id`: The Google Cloud project ID - `dataset_id`: The BigQuery dataset ID - `table_id`: The ID of the BigQuery table - `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 - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` or `!=`. The `profile_last_generated` filter also supports `<` and `>`. The syntax is based on https://google.aip.dev/160. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `profile_last_generated < \"2025-01-01T00:00:00.000Z\"` The length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "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` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `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. - `row_count`: Number of rows in this resource.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Page token to continue retrieval.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/tableDataProfiles",
"response": {
"$ref": "GooglePrivacyDlpV2ListTableDataProfilesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"storedInfoTypes": {
"methods": {
"create": {
"description": "Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.",
"flatPath": "v2/projects/{projectsId}/storedInfoTypes",
"httpMethod": "POST",
"id": "dlp.projects.storedInfoTypes.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/storedInfoTypes",
"request": {
"$ref": "GooglePrivacyDlpV2CreateStoredInfoTypeRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2StoredInfoType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.",
"flatPath": "v2/projects/{projectsId}/storedInfoTypes/{storedInfoTypesId}",
"httpMethod": "DELETE",
"id": "dlp.projects.storedInfoTypes.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the organization and storedInfoType to be deleted, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342.",
"location": "path",
"pattern": "^projects/[^/]+/storedInfoTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GoogleProtobufEmpty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.",
"flatPath": "v2/projects/{projectsId}/storedInfoTypes/{storedInfoTypesId}",
"httpMethod": "GET",
"id": "dlp.projects.storedInfoTypes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the organization and storedInfoType to be read, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342.",
"location": "path",
"pattern": "^projects/[^/]+/storedInfoTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "GooglePrivacyDlpV2StoredInfoType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists stored infoTypes. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.",
"flatPath": "v2/projects/{projectsId}/storedInfoTypes",
"httpMethod": "GET",
"id": "dlp.projects.storedInfoTypes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"locationId": {
"description": "Deprecated. This field has no effect.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "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. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Page token to continue retrieval. Comes from the previous call to `ListStoredInfoTypes`.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/storedInfoTypes",
"response": {
"$ref": "GooglePrivacyDlpV2ListStoredInfoTypesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.",
"flatPath": "v2/projects/{projectsId}/storedInfoTypes/{storedInfoTypesId}",
"httpMethod": "PATCH",
"id": "dlp.projects.storedInfoTypes.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of organization and storedInfoType to be updated, for example `organizations/433245324/storedInfoTypes/432452342` or projects/project-id/storedInfoTypes/432452342.",
"location": "path",
"pattern": "^projects/[^/]+/storedInfoTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "GooglePrivacyDlpV2UpdateStoredInfoTypeRequest"
},
"response": {
"$ref": "GooglePrivacyDlpV2StoredInfoType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
},
"revision": "20260129",
"rootUrl": "https://dlp.googleapis.com/",
"schemas": {
"GooglePrivacyDlpV2Action": {
"description": "A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more.",
"id": "GooglePrivacyDlpV2Action",
"properties": {
"deidentify": {
"$ref": "GooglePrivacyDlpV2Deidentify",
"description": "Create a de-identified copy of the input data."
},
"jobNotificationEmails": {
"$ref": "GooglePrivacyDlpV2JobNotificationEmails",
"description": "Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts)."
},
"pubSub": {
"$ref": "GooglePrivacyDlpV2PublishToPubSub",
"description": "Publish a notification to a Pub/Sub topic."
},
"publishFindingsToCloudDataCatalog": {
"$ref": "GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog",
"deprecated": true,
"description": "Deprecated because Data Catalog is being turned down. Use publish_findings_to_dataplex_catalog to publish findings to Dataplex Universal Catalog."
},
"publishFindingsToDataplexCatalog": {
"$ref": "GooglePrivacyDlpV2PublishFindingsToDataplexCatalog",
"description": "Publish findings as an aspect to Dataplex Universal Catalog."
},
"publishSummaryToCscc": {
"$ref": "GooglePrivacyDlpV2PublishSummaryToCscc",
"description": "Publish summary to Cloud Security Command Center (Alpha)."
},
"publishToStackdriver": {
"$ref": "GooglePrivacyDlpV2PublishToStackdriver",
"description": "Enable Stackdriver metric dlp.googleapis.com/finding_count."
},
"saveFindings": {
"$ref": "GooglePrivacyDlpV2SaveFindings",
"description": "Save resulting findings in a provided location."
}
},
"type": "object"
},
"GooglePrivacyDlpV2ActionDetails": {
"description": "The results of an Action.",
"id": "GooglePrivacyDlpV2ActionDetails",
"properties": {
"deidentifyDetails": {
"$ref": "GooglePrivacyDlpV2DeidentifyDataSourceDetails",
"description": "Outcome of a de-identification action."
}
},
"type": "object"
},
"GooglePrivacyDlpV2ActivateJobTriggerRequest": {
"description": "Request message for ActivateJobTrigger.",
"id": "GooglePrivacyDlpV2ActivateJobTriggerRequest",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2AdjustByImageFindings": {
"description": "AdjustmentRule condition for image findings. This rule is silently ignored if the content being inspected is not an image.",
"id": "GooglePrivacyDlpV2AdjustByImageFindings",
"properties": {
"imageContainmentType": {
"$ref": "GooglePrivacyDlpV2ImageContainmentType",
"description": "Specifies the required spatial relationship between the bounding boxes of the target finding and the context infoType findings."
},
"infoTypes": {
"description": "A list of image-supported infoTypes\u2014excluding [document infoTypes](https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#documents)\u2014to be used as context for the adjustment rule. Sensitive Data Protection adjusts the likelihood of an image finding if its bounding box has the specified spatial relationship (defined by `image_containment_type`) with a finding of an infoType in this list. For example, you can create a rule to adjust the likelihood of a `US_PASSPORT` finding if it is enclosed by a finding of `OBJECT_TYPE/PERSON/PASSPORT`. To configure this, set `US_PASSPORT` in `InspectionRuleSet.info_types`. Add an `adjustment_rule` with an `adjust_by_image_findings.info_types` that contains `OBJECT_TYPE/PERSON/PASSPORT` and `image_containment_type` set to `encloses`. In this case, the likelihood of the `US_PASSPORT` finding is adjusted, but the likelihood of the `OBJECT_TYPE/PERSON/PASSPORT` finding is not.",
"items": {
"$ref": "GooglePrivacyDlpV2InfoType"
},
"type": "array"
},
"minLikelihood": {
"description": "Required. Minimum likelihood of the `adjust_by_image_findings.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding.",
"enum": [
"LIKELIHOOD_UNSPECIFIED",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Default value; same as POSSIBLE.",
"Highest chance of a false positive.",
"High chance of a false positive.",
"Some matching signals. The default value.",
"Low chance of a false positive.",
"Confidence level is high. Lowest chance of a false positive."
],
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2AdjustByMatchingInfoTypes": {
"description": "AdjustmentRule condition for matching infoTypes.",
"id": "GooglePrivacyDlpV2AdjustByMatchingInfoTypes",
"properties": {
"infoTypes": {
"description": "Sensitive Data Protection adjusts the likelihood of a finding if that finding also matches one of these infoTypes. For example, you can create a rule to adjust the likelihood of a `PHONE_NUMBER` finding if the string is found within a document that is classified as `DOCUMENT_TYPE/HR/RESUME`. To configure this, set `PHONE_NUMBER` in `InspectionRuleSet.info_types`. Add an `adjustment_rule` with an `adjust_by_matching_info_types.info_types` that contains `DOCUMENT_TYPE/HR/RESUME`. In this case, the likelihood of the `PHONE_NUMBER` finding is adjusted, but the likelihood of the `DOCUMENT_TYPE/HR/RESUME` finding is not.",
"items": {
"$ref": "GooglePrivacyDlpV2InfoType"
},
"type": "array"
},
"matchingType": {
"description": "How the adjustment rule is applied. Only MATCHING_TYPE_PARTIAL_MATCH is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule.",
"enum": [
"MATCHING_TYPE_UNSPECIFIED",
"MATCHING_TYPE_FULL_MATCH",
"MATCHING_TYPE_PARTIAL_MATCH",
"MATCHING_TYPE_INVERSE_MATCH",
"MATCHING_TYPE_RULE_SPECIFIC"
],
"enumDescriptions": [
"Invalid.",
"Full match. - Dictionary: join of Dictionary results matched the complete finding quote - Regex: all regex matches fill a finding quote from start to end - Exclude infoType: completely inside affecting infoTypes findings",
"Partial match. - Dictionary: at least one of the tokens in the finding matches - Regex: substring of the finding matches - Exclude infoType: intersects with affecting infoTypes findings",
"Inverse match. - Dictionary: no tokens in the finding match the dictionary - Regex: finding doesn't match the regex - Exclude infoType: no intersection with affecting infoTypes findings",
"Rule-specific match. The matching logic is based on the specific rule being used. This is required for rules where the matching behavior is not a simple string comparison (e.g., image containment). This matching type can only be used with the `ExcludeByImageFindings` rule. - Exclude by image findings: The matching logic is defined within `ExcludeByImageFindings` based on spatial relationships between bounding boxes."
],
"type": "string"
},
"minLikelihood": {
"description": "Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding.",
"enum": [
"LIKELIHOOD_UNSPECIFIED",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Default value; same as POSSIBLE.",
"Highest chance of a false positive.",
"High chance of a false positive.",
"Some matching signals. The default value.",
"Low chance of a false positive.",
"Confidence level is high. Lowest chance of a false positive."
],
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2AdjustmentRule": {
"description": "Rule that specifies conditions when a certain infoType's finding details should be adjusted.",
"id": "GooglePrivacyDlpV2AdjustmentRule",
"properties": {
"adjustByImageFindings": {
"$ref": "GooglePrivacyDlpV2AdjustByImageFindings",
"description": "AdjustmentRule condition for image findings."
},
"adjustByMatchingInfoTypes": {
"$ref": "GooglePrivacyDlpV2AdjustByMatchingInfoTypes",
"description": "Set of infoTypes for which findings would affect this rule."
},
"likelihoodAdjustment": {
"$ref": "GooglePrivacyDlpV2LikelihoodAdjustment",
"description": "Likelihood adjustment to apply to the infoType."
}
},
"type": "object"
},
"GooglePrivacyDlpV2AllInfoTypes": {
"description": "Apply transformation to all findings.",
"id": "GooglePrivacyDlpV2AllInfoTypes",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2AllOtherBigQueryTables": {
"description": "Catch-all for all other tables not specified by other filters. Should always be last, except for single-table configurations, which will only have a TableReference target.",
"id": "GooglePrivacyDlpV2AllOtherBigQueryTables",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2AllOtherDatabaseResources": {
"description": "Match database resources not covered by any other filter.",
"id": "GooglePrivacyDlpV2AllOtherDatabaseResources",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2AllOtherResources": {
"description": "Match discovery resources not covered by any other filter.",
"id": "GooglePrivacyDlpV2AllOtherResources",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2AllText": {
"description": "Apply to all text.",
"id": "GooglePrivacyDlpV2AllText",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2AmazonS3Bucket": {
"description": "Amazon S3 bucket.",
"id": "GooglePrivacyDlpV2AmazonS3Bucket",
"properties": {
"awsAccount": {
"$ref": "GooglePrivacyDlpV2AwsAccount",
"description": "The AWS account."
},
"bucketName": {
"description": "Required. The bucket name.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2AmazonS3BucketConditions": {
"description": "Amazon S3 bucket conditions.",
"id": "GooglePrivacyDlpV2AmazonS3BucketConditions",
"properties": {
"bucketTypes": {
"description": "Optional. Bucket types that should be profiled. Optional. Defaults to TYPE_ALL_SUPPORTED if unspecified.",
"items": {
"enum": [
"TYPE_UNSPECIFIED",
"TYPE_ALL_SUPPORTED",
"TYPE_GENERAL_PURPOSE"
],
"enumDescriptions": [
"Unused.",
"All supported classes.",
"A general purpose Amazon S3 bucket."
],
"type": "string"
},
"type": "array"
},
"objectStorageClasses": {
"description": "Optional. Object classes that should be profiled. Optional. Defaults to ALL_SUPPORTED_CLASSES if unspecified.",
"items": {
"enum": [
"UNSPECIFIED",
"ALL_SUPPORTED_CLASSES",
"STANDARD",
"STANDARD_INFREQUENT_ACCESS",
"GLACIER_INSTANT_RETRIEVAL",
"INTELLIGENT_TIERING"
],
"enumDescriptions": [
"Unused.",
"All supported classes.",
"Standard object class.",
"Standard - infrequent access object class.",
"Glacier - instant retrieval object class.",
"Objects in the S3 Intelligent-Tiering access tiers."
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2AmazonS3BucketRegex": {
"description": "Amazon S3 bucket regex.",
"id": "GooglePrivacyDlpV2AmazonS3BucketRegex",
"properties": {
"awsAccountRegex": {
"$ref": "GooglePrivacyDlpV2AwsAccountRegex",
"description": "The AWS account regex."
},
"bucketNameRegex": {
"description": "Optional. Regex to test the bucket name against. If empty, all buckets match.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails": {
"description": "Result of a risk analysis operation request.",
"id": "GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails",
"properties": {
"categoricalStatsResult": {
"$ref": "GooglePrivacyDlpV2CategoricalStatsResult",
"description": "Categorical stats result"
},
"deltaPresenceEstimationResult": {
"$ref": "GooglePrivacyDlpV2DeltaPresenceEstimationResult",
"description": "Delta-presence result"
},
"kAnonymityResult": {
"$ref": "GooglePrivacyDlpV2KAnonymityResult",
"description": "K-anonymity result"
},
"kMapEstimationResult": {
"$ref": "GooglePrivacyDlpV2KMapEstimationResult",
"description": "K-map result"
},
"lDiversityResult": {
"$ref": "GooglePrivacyDlpV2LDiversityResult",
"description": "L-divesity result"
},
"numericalStatsResult": {
"$ref": "GooglePrivacyDlpV2NumericalStatsResult",
"description": "Numerical stats result"
},
"requestedOptions": {
"$ref": "GooglePrivacyDlpV2RequestedRiskAnalysisOptions",
"description": "The configuration used for this job."
},
"requestedPrivacyMetric": {
"$ref": "GooglePrivacyDlpV2PrivacyMetric",
"description": "Privacy metric to compute."
},
"requestedSourceTable": {
"$ref": "GooglePrivacyDlpV2BigQueryTable",
"description": "Input dataset to compute metrics over."
}
},
"type": "object"
},
"GooglePrivacyDlpV2AuxiliaryTable": {
"description": "An auxiliary table contains statistical information on the relative frequency of different quasi-identifiers values. It has one or several quasi-identifiers columns, and one column that indicates the relative frequency of each quasi-identifier tuple. If a tuple is present in the data but not in the auxiliary table, the corresponding relative frequency is assumed to be zero (and thus, the tuple is highly reidentifiable).",
"id": "GooglePrivacyDlpV2AuxiliaryTable",
"properties": {
"quasiIds": {
"description": "Required. Quasi-identifier columns.",
"items": {
"$ref": "GooglePrivacyDlpV2QuasiIdField"
},
"type": "array"
},
"relativeFrequency": {
"$ref": "GooglePrivacyDlpV2FieldId",
"description": "Required. The relative frequency column must contain a floating-point number between 0 and 1 (inclusive). Null values are assumed to be zero."
},
"table": {
"$ref": "GooglePrivacyDlpV2BigQueryTable",
"description": "Required. Auxiliary table location."
}
},
"type": "object"
},
"GooglePrivacyDlpV2AwsAccount": {
"description": "AWS account.",
"id": "GooglePrivacyDlpV2AwsAccount",
"properties": {
"accountId": {
"description": "Required. AWS account ID.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2AwsAccountRegex": {
"description": "AWS account regex.",
"id": "GooglePrivacyDlpV2AwsAccountRegex",
"properties": {
"accountIdRegex": {
"description": "Optional. Regex to test the AWS account ID against. If empty, all accounts match.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2AwsDiscoveryStartingLocation": {
"description": "The AWS starting location for discovery.",
"id": "GooglePrivacyDlpV2AwsDiscoveryStartingLocation",
"properties": {
"accountId": {
"description": "The AWS account ID that this discovery config applies to. Within an AWS organization, you can find the AWS account ID inside an AWS account ARN. Example: arn:{partition}:organizations::{management_account_id}:account/{org_id}/{account_id}",
"type": "string"
},
"allAssetInventoryAssets": {
"description": "All AWS assets stored in Asset Inventory that didn't match other AWS discovery configs.",
"type": "boolean"
}
},
"type": "object"
},
"GooglePrivacyDlpV2BigQueryDiscoveryTarget": {
"description": "Target used to match against for discovery with BigQuery tables",
"id": "GooglePrivacyDlpV2BigQueryDiscoveryTarget",
"properties": {
"cadence": {
"$ref": "GooglePrivacyDlpV2DiscoveryGenerationCadence",
"description": "How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity."
},
"conditions": {
"$ref": "GooglePrivacyDlpV2DiscoveryBigQueryConditions",
"description": "In addition to matching the filter, these conditions must be true before a profile is generated."
},
"disabled": {
"$ref": "GooglePrivacyDlpV2Disabled",
"description": "Tables that match this filter will not have profiles created."
},
"filter": {
"$ref": "GooglePrivacyDlpV2DiscoveryBigQueryFilter",
"description": "Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table."
}
},
"type": "object"
},
"GooglePrivacyDlpV2BigQueryField": {
"description": "Message defining a field of a BigQuery table.",
"id": "GooglePrivacyDlpV2BigQueryField",
"properties": {
"field": {
"$ref": "GooglePrivacyDlpV2FieldId",
"description": "Designated field in the BigQuery table."
},
"table": {
"$ref": "GooglePrivacyDlpV2BigQueryTable",
"description": "Source table of the field."
}
},
"type": "object"
},
"GooglePrivacyDlpV2BigQueryKey": {
"description": "Row key for identifying a record in BigQuery table.",
"id": "GooglePrivacyDlpV2BigQueryKey",
"properties": {
"rowNumber": {
"description": "Row number inferred at the time the table was scanned. This value is nondeterministic, cannot be queried, and may be null for inspection jobs. To locate findings within a table, specify `inspect_job.storage_config.big_query_options.identifying_fields` in `CreateDlpJobRequest`.",
"format": "int64",
"type": "string"
},
"tableReference": {
"$ref": "GooglePrivacyDlpV2BigQueryTable",
"description": "Complete BigQuery table reference."
}
},
"type": "object"
},
"GooglePrivacyDlpV2BigQueryOptions": {
"description": "Options defining BigQuery table and row identifiers.",
"id": "GooglePrivacyDlpV2BigQueryOptions",
"properties": {
"excludedFields": {
"description": "References to fields excluded from scanning. This allows you to skip inspection of entire columns which you know have no findings. When inspecting a table, we recommend that you inspect all columns. Otherwise, findings might be affected because hints from excluded columns will not be used.",
"items": {
"$ref": "GooglePrivacyDlpV2FieldId"
},
"type": "array"
},
"identifyingFields": {
"description": "Table fields that may uniquely identify a row within the table. When `actions.saveFindings.outputConfig.table` is specified, the values of columns specified here are available in the output table under `location.content_locations.record_location.record_key.id_values`. Nested fields such as `person.birthdate.year` are allowed.",
"items": {
"$ref": "GooglePrivacyDlpV2FieldId"
},
"type": "array"
},
"includedFields": {
"description": "Limit scanning only to these fields. When inspecting a table, we recommend that you inspect all columns. Otherwise, findings might be affected because hints from excluded columns will not be used.",
"items": {
"$ref": "GooglePrivacyDlpV2FieldId"
},
"type": "array"
},
"rowsLimit": {
"description": "Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig.",
"format": "int64",
"type": "string"
},
"rowsLimitPercent": {
"description": "Max percentage of rows to scan. The rest are omitted. The number of rows scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of rows_limit and rows_limit_percent can be specified. Cannot be used in conjunction with TimespanConfig. Caution: A [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling) is causing the `rowsLimitPercent` field to behave unexpectedly. We recommend using `rowsLimit` instead.",
"format": "int32",
"type": "integer"
},
"sampleMethod": {
"description": "How to sample the data.",
"enum": [
"SAMPLE_METHOD_UNSPECIFIED",
"TOP",
"RANDOM_START"
],
"enumDescriptions": [
"No sampling.",
"Scan groups of rows in the order BigQuery provides (default). Multiple groups of rows may be scanned in parallel, so results may not appear in the same order the rows are read.",
"Randomly pick groups of rows to scan."
],
"type": "string"
},
"tableReference": {
"$ref": "GooglePrivacyDlpV2BigQueryTable",
"description": "Complete BigQuery table reference."
}
},
"type": "object"
},
"GooglePrivacyDlpV2BigQueryRegex": {
"description": "A pattern to match against one or more tables, datasets, or projects that contain BigQuery tables. At least one pattern must be specified. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub.",
"id": "GooglePrivacyDlpV2BigQueryRegex",
"properties": {
"datasetIdRegex": {
"description": "If unset, this property matches all datasets.",
"type": "string"
},
"projectIdRegex": {
"description": "For organizations, if unset, will match all projects. Has no effect for data profile configurations created within a project.",
"type": "string"
},
"tableIdRegex": {
"description": "If unset, this property matches all tables.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2BigQueryRegexes": {
"description": "A collection of regular expressions to determine what tables to match against.",
"id": "GooglePrivacyDlpV2BigQueryRegexes",
"properties": {
"patterns": {
"description": "A single BigQuery regular expression pattern to match against one or more tables, datasets, or projects that contain BigQuery tables.",
"items": {
"$ref": "GooglePrivacyDlpV2BigQueryRegex"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2BigQueryTable": {
"description": "Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`.",
"id": "GooglePrivacyDlpV2BigQueryTable",
"properties": {
"datasetId": {
"description": "Dataset ID of the table.",
"type": "string"
},
"projectId": {
"description": "The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.",
"type": "string"
},
"tableId": {
"description": "Name of the table.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2BigQueryTableCollection": {
"description": "Specifies a collection of BigQuery tables. Used for Discovery.",
"id": "GooglePrivacyDlpV2BigQueryTableCollection",
"properties": {
"includeRegexes": {
"$ref": "GooglePrivacyDlpV2BigQueryRegexes",
"description": "A collection of regular expressions to match a BigQuery table against."
}
},
"type": "object"
},
"GooglePrivacyDlpV2BigQueryTableTypes": {
"description": "The types of BigQuery tables supported by Cloud DLP.",
"id": "GooglePrivacyDlpV2BigQueryTableTypes",
"properties": {
"types": {
"description": "A set of BigQuery table types.",
"items": {
"enum": [
"BIG_QUERY_TABLE_TYPE_UNSPECIFIED",
"BIG_QUERY_TABLE_TYPE_TABLE",
"BIG_QUERY_TABLE_TYPE_EXTERNAL_BIG_LAKE",
"BIG_QUERY_TABLE_TYPE_SNAPSHOT"
],
"enumDescriptions": [
"Unused.",
"A normal BigQuery table.",
"A table that references data stored in Cloud Storage.",
"A snapshot of a BigQuery table."
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2BoundingBox": {
"description": "Bounding box encompassing detected text within an image.",
"id": "GooglePrivacyDlpV2BoundingBox",
"properties": {
"height": {
"description": "Height of the bounding box in pixels.",
"format": "int32",
"type": "integer"
},
"left": {
"description": "Left coordinate of the bounding box. (0,0) is upper left.",
"format": "int32",
"type": "integer"
},
"top": {
"description": "Top coordinate of the bounding box. (0,0) is upper left.",
"format": "int32",
"type": "integer"
},
"width": {
"description": "Width of the bounding box in pixels.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GooglePrivacyDlpV2Bucket": {
"description": "Bucket is represented as a range, along with replacement values.",
"id": "GooglePrivacyDlpV2Bucket",
"properties": {
"max": {
"$ref": "GooglePrivacyDlpV2Value",
"description": "Upper bound of the range, exclusive; type must match min."
},
"min": {
"$ref": "GooglePrivacyDlpV2Value",
"description": "Lower bound of the range, inclusive. Type should be the same as max if used."
},
"replacementValue": {
"$ref": "GooglePrivacyDlpV2Value",
"description": "Required. Replacement value for this bucket."
}
},
"type": "object"
},
"GooglePrivacyDlpV2BucketingConfig": {
"description": "Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW, 31-65 -> MEDIUM, 66-100 -> HIGH. This can be used on data of type: number, long, string, timestamp. If the bound `Value` type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more.",
"id": "GooglePrivacyDlpV2BucketingConfig",
"properties": {
"buckets": {
"description": "Set of buckets. Ranges must be non-overlapping.",
"items": {
"$ref": "GooglePrivacyDlpV2Bucket"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2ByteContentItem": {
"description": "Container for bytes to inspect or redact.",
"id": "GooglePrivacyDlpV2ByteContentItem",
"properties": {
"data": {
"description": "Content data to inspect or redact.",
"format": "byte",
"type": "string"
},
"type": {
"description": "The type of data stored in the bytes string. Default will be TEXT_UTF8.",
"enum": [
"BYTES_TYPE_UNSPECIFIED",
"IMAGE",
"IMAGE_JPEG",
"IMAGE_BMP",
"IMAGE_PNG",
"IMAGE_SVG",
"TEXT_UTF8",
"WORD_DOCUMENT",
"PDF",
"POWERPOINT_DOCUMENT",
"EXCEL_DOCUMENT",
"AVRO",
"CSV",
"TSV",
"AUDIO",
"VIDEO",
"EXECUTABLE",
"AI_MODEL"
],
"enumDescriptions": [
"Unused",
"Any image type.",
"jpeg",
"bmp",
"png",
"svg",
"plain text",
"docx, docm, dotx, dotm",
"pdf",
"pptx, pptm, potx, potm, pot",
"xlsx, xlsm, xltx, xltm",
"avro",
"csv",
"tsv",
"Audio file types. Only used for profiling.",
"Video file types. Only used for profiling.",
"Executable file types. Only used for profiling.",
"AI model file types. Only used for profiling."
],
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2CancelDlpJobRequest": {
"description": "The request message for canceling a DLP job.",
"id": "GooglePrivacyDlpV2CancelDlpJobRequest",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2CategoricalStatsConfig": {
"description": "Compute numerical stats over an individual column, including number of distinct values and value count distribution.",
"id": "GooglePrivacyDlpV2CategoricalStatsConfig",
"properties": {
"field": {
"$ref": "GooglePrivacyDlpV2FieldId",
"description": "Field to compute categorical stats on. All column types are supported except for arrays and structs. However, it may be more informative to use NumericalStats when the field type is supported, depending on the data."
}
},
"type": "object"
},
"GooglePrivacyDlpV2CategoricalStatsHistogramBucket": {
"description": "Histogram of value frequencies in the column.",
"id": "GooglePrivacyDlpV2CategoricalStatsHistogramBucket",
"properties": {
"bucketSize": {
"description": "Total number of values in this bucket.",
"format": "int64",
"type": "string"
},
"bucketValueCount": {
"description": "Total number of distinct values in this bucket.",
"format": "int64",
"type": "string"
},
"bucketValues": {
"description": "Sample of value frequencies in this bucket. The total number of values returned per bucket is capped at 20.",
"items": {
"$ref": "GooglePrivacyDlpV2ValueFrequency"
},
"type": "array"
},
"valueFrequencyLowerBound": {
"description": "Lower bound on the value frequency of the values in this bucket.",
"format": "int64",
"type": "string"
},
"valueFrequencyUpperBound": {
"description": "Upper bound on the value frequency of the values in this bucket.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2CategoricalStatsResult": {
"description": "Result of the categorical stats computation.",
"id": "GooglePrivacyDlpV2CategoricalStatsResult",
"properties": {
"valueFrequencyHistogramBuckets": {
"description": "Histogram of value frequencies in the column.",
"items": {
"$ref": "GooglePrivacyDlpV2CategoricalStatsHistogramBucket"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2CharacterMaskConfig": {
"description": "Partially mask a string by replacing a given number of characters with a fixed character. Masking can start from the beginning or end of the string. This can be used on data of any type (numbers, longs, and so on) and when de-identifying structured data we'll attempt to preserve the original data's type. (This allows you to take a long like 123 and modify it to a string like **3.",
"id": "GooglePrivacyDlpV2CharacterMaskConfig",
"properties": {
"charactersToIgnore": {
"description": "When masking a string, items in this list will be skipped when replacing characters. For example, if the input string is `555-555-5555` and you instruct Cloud DLP to skip `-` and mask 5 characters with `*`, Cloud DLP returns `***-**5-5555`.",
"items": {
"$ref": "GooglePrivacyDlpV2CharsToIgnore"
},
"type": "array"
},
"maskingCharacter": {
"description": "Character to use to mask the sensitive values\u2014for example, `*` for an alphabetic string such as a name, or `0` for a numeric string such as ZIP code or credit card number. This string must have a length of 1. If not supplied, this value defaults to `*` for strings, and `0` for digits.",
"type": "string"
},
"numberToMask": {
"description": "Number of characters to mask. If not set, all matching chars will be masked. Skipped characters do not count towards this tally. If `number_to_mask` is negative, this denotes inverse masking. Cloud DLP masks all but a number of characters. For example, suppose you have the following values: - `masking_character` is `*` - `number_to_mask` is `-4` - `reverse_order` is `false` - `CharsToIgnore` includes `-` - Input string is `1234-5678-9012-3456` The resulting de-identified string is `****-****-****-3456`. Cloud DLP masks all but the last four characters. If `reverse_order` is `true`, all but the first four characters are masked as `1234-****-****-****`.",
"format": "int32",
"type": "integer"
},
"reverseOrder": {
"description": "Mask characters in reverse order. For example, if `masking_character` is `0`, `number_to_mask` is `14`, and `reverse_order` is `false`, then the input string `1234-5678-9012-3456` is masked as `00000000000000-3456`. If `masking_character` is `*`, `number_to_mask` is `3`, and `reverse_order` is `true`, then the string `12345` is masked as `12***`.",
"type": "boolean"
}
},
"type": "object"
},
"GooglePrivacyDlpV2CharsToIgnore": {
"description": "Characters to skip when doing deidentification of a value. These will be left alone and skipped.",
"id": "GooglePrivacyDlpV2CharsToIgnore",
"properties": {
"charactersToSkip": {
"description": "Characters to not transform when masking.",
"type": "string"
},
"commonCharactersToIgnore": {
"description": "Common characters to not transform when masking. Useful to avoid removing punctuation.",
"enum": [
"COMMON_CHARS_TO_IGNORE_UNSPECIFIED",
"NUMERIC",
"ALPHA_UPPER_CASE",
"ALPHA_LOWER_CASE",
"PUNCTUATION",
"WHITESPACE"
],
"enumDescriptions": [
"Unused.",
"0-9",
"A-Z",
"a-z",
"US Punctuation, one of !\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~",
"Whitespace character, one of [ \\t\\n\\x0B\\f\\r]"
],
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2CloudSqlDiscoveryTarget": {
"description": "Target used to match against for discovery with Cloud SQL tables.",
"id": "GooglePrivacyDlpV2CloudSqlDiscoveryTarget",
"properties": {
"conditions": {
"$ref": "GooglePrivacyDlpV2DiscoveryCloudSqlConditions",
"description": "In addition to matching the filter, these conditions must be true before a profile is generated."
},
"disabled": {
"$ref": "GooglePrivacyDlpV2Disabled",
"description": "Disable profiling for database resources that match this filter."
},
"filter": {
"$ref": "GooglePrivacyDlpV2DiscoveryCloudSqlFilter",
"description": "Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table."
},
"generationCadence": {
"$ref": "GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence",
"description": "How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity."
}
},
"type": "object"
},
"GooglePrivacyDlpV2CloudSqlIamCredential": {
"description": "Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication.",
"id": "GooglePrivacyDlpV2CloudSqlIamCredential",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2CloudSqlProperties": {
"description": "Cloud SQL connection properties.",
"id": "GooglePrivacyDlpV2CloudSqlProperties",
"properties": {
"cloudSqlIam": {
"$ref": "GooglePrivacyDlpV2CloudSqlIamCredential",
"description": "Built-in IAM authentication (must be configured in Cloud SQL)."
},
"connectionName": {
"description": "Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1`",
"type": "string"
},
"databaseEngine": {
"description": "Required. The database engine used by the Cloud SQL instance that this connection configures.",
"enum": [
"DATABASE_ENGINE_UNKNOWN",
"DATABASE_ENGINE_MYSQL",
"DATABASE_ENGINE_POSTGRES"
],
"enumDescriptions": [
"An engine that is not currently supported by Sensitive Data Protection.",
"Cloud SQL for MySQL instance.",
"Cloud SQL for PostgreSQL instance."
],
"type": "string"
},
"maxConnections": {
"description": "Required. The DLP API will limit its connections to max_connections. Must be 2 or greater.",
"format": "int32",
"type": "integer"
},
"usernamePassword": {
"$ref": "GooglePrivacyDlpV2SecretManagerCredential",
"description": "A username and password stored in Secret Manager."
}
},
"type": "object"
},
"GooglePrivacyDlpV2CloudStorageDiscoveryTarget": {
"description": "Target used to match against for discovery with Cloud Storage buckets.",
"id": "GooglePrivacyDlpV2CloudStorageDiscoveryTarget",
"properties": {
"conditions": {
"$ref": "GooglePrivacyDlpV2DiscoveryFileStoreConditions",
"description": "Optional. In addition to matching the filter, these conditions must be true before a profile is generated."
},
"disabled": {
"$ref": "GooglePrivacyDlpV2Disabled",
"description": "Optional. Disable profiling for buckets that match this filter."
},
"filter": {
"$ref": "GooglePrivacyDlpV2DiscoveryCloudStorageFilter",
"description": "Required. The buckets the generation_cadence applies to. The first target with a matching filter will be the one to apply to a bucket."
},
"generationCadence": {
"$ref": "GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence",
"description": "Optional. How often and when to update profiles. New buckets that match both the filter and conditions are scanned as quickly as possible depending on system capacity."
}
},
"type": "object"
},
"GooglePrivacyDlpV2CloudStorageFileSet": {
"description": "Message representing a set of files in Cloud Storage.",
"id": "GooglePrivacyDlpV2CloudStorageFileSet",
"properties": {
"url": {
"description": "The url, in the format `gs:///`. Trailing wildcard in the path is allowed.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2CloudStorageOptions": {
"description": "Options defining a file or a set of files within a Cloud Storage bucket.",
"id": "GooglePrivacyDlpV2CloudStorageOptions",
"properties": {
"bytesLimitPerFile": {
"description": "Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted. Only one of `bytes_limit_per_file` and `bytes_limit_per_file_percent` can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file).",
"format": "int64",
"type": "string"
},
"bytesLimitPerFilePercent": {
"description": "Max percentage of bytes to scan from a file. The rest are omitted. The number of bytes scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one of bytes_limit_per_file and bytes_limit_per_file_percent can be specified. This field can't be set if de-identification is requested. For certain file types, setting this field has no effect. For more information, see [Limits on bytes scanned per file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file).",
"format": "int32",
"type": "integer"
},
"fileSet": {
"$ref": "GooglePrivacyDlpV2FileSet",
"description": "The set of one or more files to scan."
},
"fileTypes": {
"description": "List of file type groups to include in the scan. If empty, all files are scanned and available data format processors are applied. In addition, the binary content of the selected files is always scanned as well. Images are scanned only as binary if the specified region does not support image inspection and no file_types were specified. Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.",
"items": {
"enum": [
"FILE_TYPE_UNSPECIFIED",
"BINARY_FILE",
"TEXT_FILE",
"IMAGE",
"WORD",
"PDF",
"AVRO",
"CSV",
"TSV",
"POWERPOINT",
"EXCEL"
],
"enumDescriptions": [
"Includes all files.",
"Includes all file extensions not covered by another entry. Binary scanning attempts to convert the content of the file to utf_8 to scan the file. If you wish to avoid this fall back, specify one or more of the other file types in your storage scan.",
"Included file extensions: asc,asp, aspx, brf, c, cc,cfm, cgi, cpp, csv, cxx, c++, cs, css, dart, dat, dot, eml,, epbub, ged, go, h, hh, hpp, hxx, h++, hs, html, htm, mkd, markdown, m, ml, mli, perl, pl, plist, pm, php, phtml, pht, properties, py, pyw, rb, rbw, rs, rss, rc, scala, sh, sql, swift, tex, shtml, shtm, xhtml, lhs, ics, ini, java, js, json, jsonl, kix, kml, ocaml, md, txt, text, tsv, vb, vcard, vcs, wml, xcodeproj, xml, xsl, xsd, yml, yaml.",
"Included file extensions: bmp, gif, jpg, jpeg, jpe, png. Setting bytes_limit_per_file or bytes_limit_per_file_percent has no effect on image files. Image inspection is restricted to the `global`, `us`, `asia`, and `europe` regions.",
"Microsoft Word files larger than 30 MB will be scanned as binary files. Included file extensions: docx, dotx, docm, dotm. Setting `bytes_limit_per_file` or `bytes_limit_per_file_percent` has no effect on Word files.",
"PDF files larger than 30 MB will be scanned as binary files. Included file extensions: pdf. Setting `bytes_limit_per_file` or `bytes_limit_per_file_percent` has no effect on PDF files.",
"Included file extensions: avro",
"Included file extensions: csv",
"Included file extensions: tsv",
"Microsoft PowerPoint files larger than 30 MB will be scanned as binary files. Included file extensions: pptx, pptm, potx, potm, pot. Setting `bytes_limit_per_file` or `bytes_limit_per_file_percent` has no effect on PowerPoint files.",
"Microsoft Excel files larger than 30 MB will be scanned as binary files. Included file extensions: xlsx, xlsm, xltx, xltm. Setting `bytes_limit_per_file` or `bytes_limit_per_file_percent` has no effect on Excel files."
],
"type": "string"
},
"type": "array"
},
"filesLimitPercent": {
"description": "Limits the number of files to scan to this percentage of the input FileSet. Number of files scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and 100 means no limit. Defaults to 0.",
"format": "int32",
"type": "integer"
},
"sampleMethod": {
"description": "How to sample the data.",
"enum": [
"SAMPLE_METHOD_UNSPECIFIED",
"TOP",
"RANDOM_START"
],
"enumDescriptions": [
"No sampling.",
"Scan from the top (default).",
"For each file larger than bytes_limit_per_file, randomly pick the offset to start scanning. The scanned bytes are contiguous."
],
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2CloudStoragePath": {
"description": "Message representing a single file or path in Cloud Storage.",
"id": "GooglePrivacyDlpV2CloudStoragePath",
"properties": {
"path": {
"description": "A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2CloudStorageRegex": {
"description": "A pattern to match against one or more file stores. At least one pattern must be specified. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub.",
"id": "GooglePrivacyDlpV2CloudStorageRegex",
"properties": {
"bucketNameRegex": {
"description": "Optional. Regex to test the bucket name against. If empty, all buckets match. Example: \"marketing2021\" or \"(marketing)\\d{4}\" will both match the bucket gs://marketing2021",
"type": "string"
},
"projectIdRegex": {
"description": "Optional. For organizations, if unset, will match all projects.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2CloudStorageRegexFileSet": {
"description": "Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: \"mybucket\", include_regex: [\"directory1/.*\"], exclude_regex: [\"directory1/excluded.*\"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [\".*\"]`). Some other common use cases: * `{bucket_name: \"mybucket\", exclude_regex: [\".*\\.pdf\"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: \"mybucket\", include_regex: [\"directory/[^/]+\"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/`",
"id": "GooglePrivacyDlpV2CloudStorageRegexFileSet",
"properties": {
"bucketName": {
"description": "The name of a Cloud Storage bucket. Required.",
"type": "string"
},
"excludeRegex": {
"description": "A list of regular expressions matching file paths to exclude. All files in the bucket that match at least one of these regular expressions will be excluded from the scan. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub.",
"items": {
"type": "string"
},
"type": "array"
},
"includeRegex": {
"description": "A list of regular expressions matching file paths to include. All files in the bucket that match at least one of these regular expressions will be included in the set of files, except for those that also match an item in `exclude_regex`. Leaving this field empty will match all files by default (this is equivalent to including `.*` in the list). Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2CloudStorageResourceReference": {
"description": "Identifies a single Cloud Storage bucket.",
"id": "GooglePrivacyDlpV2CloudStorageResourceReference",
"properties": {
"bucketName": {
"description": "Required. The bucket to scan.",
"type": "string"
},
"projectId": {
"description": "Required. If within a project-level config, then this must match the config's project id.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2Color": {
"description": "Represents a color in the RGB color space.",
"id": "GooglePrivacyDlpV2Color",
"properties": {
"blue": {
"description": "The amount of blue in the color as a value in the interval [0, 1].",
"format": "float",
"type": "number"
},
"green": {
"description": "The amount of green in the color as a value in the interval [0, 1].",
"format": "float",
"type": "number"
},
"red": {
"description": "The amount of red in the color as a value in the interval [0, 1].",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GooglePrivacyDlpV2ColumnDataProfile": {
"description": "The profile for a scanned column within a table.",
"id": "GooglePrivacyDlpV2ColumnDataProfile",
"properties": {
"column": {
"description": "The name of the column.",
"type": "string"
},
"columnInfoType": {
"$ref": "GooglePrivacyDlpV2InfoTypeSummary",
"description": "If it's been determined this column can be identified as a single type, this will be set. Otherwise the column either has unidentifiable content or mixed types."
},
"columnType": {
"description": "The data type of a given column.",
"enum": [
"COLUMN_DATA_TYPE_UNSPECIFIED",
"TYPE_INT64",
"TYPE_BOOL",
"TYPE_FLOAT64",
"TYPE_STRING",
"TYPE_BYTES",
"TYPE_TIMESTAMP",
"TYPE_DATE",
"TYPE_TIME",
"TYPE_DATETIME",
"TYPE_GEOGRAPHY",
"TYPE_NUMERIC",
"TYPE_RECORD",
"TYPE_BIGNUMERIC",
"TYPE_JSON",
"TYPE_INTERVAL",
"TYPE_RANGE_DATE",
"TYPE_RANGE_DATETIME",
"TYPE_RANGE_TIMESTAMP"
],
"enumDescriptions": [
"Invalid type.",
"Encoded as a string in decimal format.",
"Encoded as a boolean \"false\" or \"true\".",
"Encoded as a number, or string \"NaN\", \"Infinity\" or \"-Infinity\".",
"Encoded as a string value.",
"Encoded as a base64 string per RFC 4648, section 4.",
"Encoded as an RFC 3339 timestamp with mandatory \"Z\" time zone string: 1985-04-12T23:20:50.52Z",
"Encoded as RFC 3339 full-date format string: 1985-04-12",
"Encoded as RFC 3339 partial-time format string: 23:20:50.52",
"Encoded as RFC 3339 full-date \"T\" partial-time: 1985-04-12T23:20:50.52",
"Encoded as WKT",
"Encoded as a decimal string.",
"Container of ordered fields, each with a type and field name.",
"Decimal type.",
"Json type.",
"Interval type.",
"`Range` type.",
"`Range` type.",
"`Range` type."
],
"type": "string"
},
"dataRiskLevel": {
"$ref": "GooglePrivacyDlpV2DataRiskLevel",
"description": "The data risk level for this column."
},
"datasetId": {
"description": "The BigQuery dataset ID, if the resource profiled is a BigQuery table.",
"type": "string"
},
"datasetLocation": {
"description": "If supported, the location where the dataset's data is stored. See https://cloud.google.com/bigquery/docs/locations for supported BigQuery locations.",
"type": "string"
},
"datasetProjectId": {
"description": "The Google Cloud project ID that owns the profiled resource.",
"type": "string"
},
"estimatedNullPercentage": {
"description": "Approximate percentage of entries being null in the column.",
"enum": [
"NULL_PERCENTAGE_LEVEL_UNSPECIFIED",
"NULL_PERCENTAGE_VERY_LOW",
"NULL_PERCENTAGE_LOW",
"NULL_PERCENTAGE_MEDIUM",
"NULL_PERCENTAGE_HIGH"
],
"enumDescriptions": [
"Unused.",
"Very few null entries.",
"Some null entries.",
"A few null entries.",
"A lot of null entries."
],
"type": "string"
},
"estimatedUniquenessScore": {
"description": "Approximate uniqueness of the column.",
"enum": [
"UNIQUENESS_SCORE_LEVEL_UNSPECIFIED",
"UNIQUENESS_SCORE_LOW",
"UNIQUENESS_SCORE_MEDIUM",
"UNIQUENESS_SCORE_HIGH"
],
"enumDescriptions": [
"Some columns do not have estimated uniqueness. Possible reasons include having too few values.",
"Low uniqueness, possibly a boolean, enum or similiarly typed column.",
"Medium uniqueness.",
"High uniqueness, possibly a column of free text or unique identifiers."
],
"type": "string"
},
"freeTextScore": {
"description": "The likelihood that this column contains free-form text. A value close to 1 may indicate the column is likely to contain free-form or natural language text. Range in 0-1.",
"format": "double",
"type": "number"
},
"name": {
"description": "The name of the profile.",
"type": "string"
},
"otherMatches": {
"description": "Other types found within this column. List will be unordered.",
"items": {
"$ref": "GooglePrivacyDlpV2OtherInfoTypeSummary"
},
"type": "array"
},
"policyState": {
"description": "Indicates if a policy tag has been applied to the column.",
"enum": [
"COLUMN_POLICY_STATE_UNSPECIFIED",
"COLUMN_POLICY_TAGGED"
],
"enumDescriptions": [
"No policy tags.",
"Column has policy tag applied."
],
"type": "string"
},
"profileLastGenerated": {
"description": "The last time the profile was generated.",
"format": "google-datetime",
"type": "string"
},
"profileStatus": {
"$ref": "GooglePrivacyDlpV2ProfileStatus",
"description": "Success or error status from the most recent profile generation attempt. May be empty if the profile is still being generated."
},
"sensitivityScore": {
"$ref": "GooglePrivacyDlpV2SensitivityScore",
"description": "The sensitivity of this column."
},
"state": {
"description": "State of a profile.",
"enum": [
"STATE_UNSPECIFIED",
"RUNNING",
"DONE"
],
"enumDescriptions": [
"Unused.",
"The profile is currently running. Once a profile has finished it will transition to DONE.",
"The profile is no longer generating. If profile_status.status.code is 0, the profile succeeded, otherwise, it failed."
],
"type": "string"
},
"tableDataProfile": {
"description": "The resource name of the table data profile.",
"type": "string"
},
"tableFullResource": {
"description": "The resource name of the resource this column is within.",
"type": "string"
},
"tableId": {
"description": "The table ID.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2Condition": {
"description": "The field type of `value` and `field` do not need to match to be considered equal, but not all comparisons are possible. EQUAL_TO and NOT_EQUAL_TO attempt to compare even with incompatible types, but all other comparisons are invalid with incompatible types. A `value` of type: - `string` can be compared against all other types - `boolean` can only be compared against other booleans - `integer` can be compared against doubles or a string if the string value can be parsed as an integer. - `double` can be compared against integers or a string if the string can be parsed as a double. - `Timestamp` can be compared against strings in RFC 3339 date string format. - `TimeOfDay` can be compared against timestamps and strings in the format of 'HH:mm:ss'. If we fail to compare do to type mismatch, a warning will be given and the condition will evaluate to false.",
"id": "GooglePrivacyDlpV2Condition",
"properties": {
"field": {
"$ref": "GooglePrivacyDlpV2FieldId",
"description": "Required. Field within the record this condition is evaluated against."
},
"operator": {
"description": "Required. Operator used to compare the field or infoType to the value.",
"enum": [
"RELATIONAL_OPERATOR_UNSPECIFIED",
"EQUAL_TO",
"NOT_EQUAL_TO",
"GREATER_THAN",
"LESS_THAN",
"GREATER_THAN_OR_EQUALS",
"LESS_THAN_OR_EQUALS",
"EXISTS"
],
"enumDescriptions": [
"Unused",
"Equal. Attempts to match even with incompatible types.",
"Not equal to. Attempts to match even with incompatible types.",
"Greater than.",
"Less than.",
"Greater than or equals.",
"Less than or equals.",
"Exists"
],
"type": "string"
},
"value": {
"$ref": "GooglePrivacyDlpV2Value",
"description": "Value to compare against. [Mandatory, except for `EXISTS` tests.]"
}
},
"type": "object"
},
"GooglePrivacyDlpV2Conditions": {
"description": "A collection of conditions.",
"id": "GooglePrivacyDlpV2Conditions",
"properties": {
"conditions": {
"description": "A collection of conditions.",
"items": {
"$ref": "GooglePrivacyDlpV2Condition"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2Connection": {
"description": "A data connection to allow the DLP API to profile data in locations that require additional configuration.",
"id": "GooglePrivacyDlpV2Connection",
"properties": {
"cloudSql": {
"$ref": "GooglePrivacyDlpV2CloudSqlProperties",
"description": "Connect to a Cloud SQL instance."
},
"errors": {
"description": "Output only. Set if status == ERROR, to provide additional details. Will store the last 10 errors sorted with the most recent first.",
"items": {
"$ref": "GooglePrivacyDlpV2Error"
},
"readOnly": true,
"type": "array"
},
"name": {
"description": "Output only. Name of the connection: `projects/{project}/locations/{location}/connections/{name}`.",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Required. The connection's state in its lifecycle.",
"enum": [
"CONNECTION_STATE_UNSPECIFIED",
"MISSING_CREDENTIALS",
"AVAILABLE",
"ERROR"
],
"enumDescriptions": [
"Unused",
"The DLP API automatically created this connection during an initial scan, and it is awaiting full configuration by a user.",
"A configured connection that has not encountered any errors.",
"A configured connection that encountered errors during its last use. It will not be used again until it is set to AVAILABLE. If the resolution requires external action, then the client must send a request to set the status to AVAILABLE when the connection is ready for use. If the resolution doesn't require external action, then any changes to the connection properties will automatically mark it as AVAILABLE."
],
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2Container": {
"description": "Represents a container that may contain DLP findings. Examples of a container include a file, table, or database record.",
"id": "GooglePrivacyDlpV2Container",
"properties": {
"fullPath": {
"description": "A string representation of the full container name. Examples: - BigQuery: 'Project:DataSetId.TableId' - Cloud Storage: 'gs://Bucket/folders/filename.txt'",
"type": "string"
},
"projectId": {
"description": "Project where the finding was found. Can be different from the project that owns the finding.",
"type": "string"
},
"relativePath": {
"description": "The rest of the path after the root. Examples: - For BigQuery table `project_id:dataset_id.table_id`, the relative path is `table_id` - For Cloud Storage file `gs://bucket/folder/filename.txt`, the relative path is `folder/filename.txt`",
"type": "string"
},
"rootPath": {
"description": "The root of the container. Examples: - For BigQuery table `project_id:dataset_id.table_id`, the root is `dataset_id` - For Cloud Storage file `gs://bucket/folder/filename.txt`, the root is `gs://bucket`",
"type": "string"
},
"type": {
"description": "Container type, for example BigQuery or Cloud Storage.",
"type": "string"
},
"updateTime": {
"description": "Findings container modification timestamp, if applicable. For Cloud Storage, this field contains the last file modification timestamp. For a BigQuery table, this field contains the last_modified_time property. For Datastore, this field isn't populated.",
"format": "google-datetime",
"type": "string"
},
"version": {
"description": "Findings container version, if available (\"generation\" for Cloud Storage).",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2ContentItem": {
"description": "Type of content to inspect.",
"id": "GooglePrivacyDlpV2ContentItem",
"properties": {
"byteItem": {
"$ref": "GooglePrivacyDlpV2ByteContentItem",
"description": "Content data to inspect or redact. Replaces `type` and `data`."
},
"table": {
"$ref": "GooglePrivacyDlpV2Table",
"description": "Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more."
},
"value": {
"description": "String data to inspect or redact.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2ContentLocation": {
"description": "Precise location of the finding within a document, record, image, or metadata container.",
"id": "GooglePrivacyDlpV2ContentLocation",
"properties": {
"containerName": {
"description": "Name of the container where the finding is located. The top level name is the source file name or table name. Names of some common storage containers are formatted as follows: * BigQuery tables: `{project_id}:{dataset_id}.{table_id}` * Cloud Storage files: `gs://{bucket}/{path}` * Datastore namespace: {namespace} Nested names could be absent if the embedded object has no string identifier (for example, an image contained within a document).",
"type": "string"
},
"containerTimestamp": {
"description": "Finding container modification timestamp, if applicable. For Cloud Storage, this field contains the last file modification timestamp. For a BigQuery table, this field contains the last_modified_time property. For Datastore, this field isn't populated.",
"format": "google-datetime",
"type": "string"
},
"containerVersion": {
"description": "Finding container version, if available (\"generation\" for Cloud Storage).",
"type": "string"
},
"documentLocation": {
"$ref": "GooglePrivacyDlpV2DocumentLocation",
"description": "Location data for document files."
},
"imageLocation": {
"$ref": "GooglePrivacyDlpV2ImageLocation",
"description": "Location within an image's pixels."
},
"metadataLocation": {
"$ref": "GooglePrivacyDlpV2MetadataLocation",
"description": "Location within the metadata for inspected content."
},
"recordLocation": {
"$ref": "GooglePrivacyDlpV2RecordLocation",
"description": "Location within a row or record of a database table."
}
},
"type": "object"
},
"GooglePrivacyDlpV2CreateConnectionRequest": {
"description": "Request message for CreateConnection.",
"id": "GooglePrivacyDlpV2CreateConnectionRequest",
"properties": {
"connection": {
"$ref": "GooglePrivacyDlpV2Connection",
"description": "Required. The connection resource."
}
},
"type": "object"
},
"GooglePrivacyDlpV2CreateDeidentifyTemplateRequest": {
"description": "Request message for CreateDeidentifyTemplate.",
"id": "GooglePrivacyDlpV2CreateDeidentifyTemplateRequest",
"properties": {
"deidentifyTemplate": {
"$ref": "GooglePrivacyDlpV2DeidentifyTemplate",
"description": "Required. The DeidentifyTemplate to create."
},
"locationId": {
"description": "Deprecated. This field has no effect.",
"type": "string"
},
"templateId": {
"description": "The template id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2CreateDiscoveryConfigRequest": {
"description": "Request message for CreateDiscoveryConfig.",
"id": "GooglePrivacyDlpV2CreateDiscoveryConfigRequest",
"properties": {
"configId": {
"description": "The config ID can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one.",
"type": "string"
},
"discoveryConfig": {
"$ref": "GooglePrivacyDlpV2DiscoveryConfig",
"description": "Required. The DiscoveryConfig to create."
}
},
"type": "object"
},
"GooglePrivacyDlpV2CreateDlpJobRequest": {
"description": "Request message for CreateDlpJobRequest. Used to initiate long running jobs such as calculating risk metrics or inspecting Google Cloud Storage.",
"id": "GooglePrivacyDlpV2CreateDlpJobRequest",
"properties": {
"inspectJob": {
"$ref": "GooglePrivacyDlpV2InspectJobConfig",
"description": "An inspection job scans a storage repository for InfoTypes."
},
"jobId": {
"description": "The job id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one.",
"type": "string"
},
"locationId": {
"description": "Deprecated. This field has no effect.",
"type": "string"
},
"riskJob": {
"$ref": "GooglePrivacyDlpV2RiskAnalysisJobConfig",
"description": "A risk analysis job calculates re-identification risk metrics for a BigQuery table."
}
},
"type": "object"
},
"GooglePrivacyDlpV2CreateInspectTemplateRequest": {
"description": "Request message for CreateInspectTemplate.",
"id": "GooglePrivacyDlpV2CreateInspectTemplateRequest",
"properties": {
"inspectTemplate": {
"$ref": "GooglePrivacyDlpV2InspectTemplate",
"description": "Required. The InspectTemplate to create."
},
"locationId": {
"description": "Deprecated. This field has no effect.",
"type": "string"
},
"templateId": {
"description": "The template id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2CreateJobTriggerRequest": {
"description": "Request message for CreateJobTrigger.",
"id": "GooglePrivacyDlpV2CreateJobTriggerRequest",
"properties": {
"jobTrigger": {
"$ref": "GooglePrivacyDlpV2JobTrigger",
"description": "Required. The JobTrigger to create."
},
"locationId": {
"description": "Deprecated. This field has no effect.",
"type": "string"
},
"triggerId": {
"description": "The trigger id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2CreateStoredInfoTypeRequest": {
"description": "Request message for CreateStoredInfoType.",
"id": "GooglePrivacyDlpV2CreateStoredInfoTypeRequest",
"properties": {
"config": {
"$ref": "GooglePrivacyDlpV2StoredInfoTypeConfig",
"description": "Required. Configuration of the storedInfoType to create."
},
"locationId": {
"description": "Deprecated. This field has no effect.",
"type": "string"
},
"storedInfoTypeId": {
"description": "The storedInfoType ID can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2CryptoDeterministicConfig": {
"description": "Pseudonymization method that generates deterministic encryption for the given input. Outputs a base64 encoded representation of the encrypted output. Uses AES-SIV based on the RFC https://tools.ietf.org/html/rfc5297.",
"id": "GooglePrivacyDlpV2CryptoDeterministicConfig",
"properties": {
"context": {
"$ref": "GooglePrivacyDlpV2FieldId",
"description": "A context may be used for higher security and maintaining referential integrity such that the same identifier in two different contexts will be given a distinct surrogate. The context is appended to plaintext value being encrypted. On decryption the provided context is validated against the value used during encryption. If a context was provided during encryption, same context must be provided during decryption as well. If the context is not set, plaintext would be used as is for encryption. If the context is set but: 1. there is no record present when transforming a given value or 2. the field is not present when transforming a given value, plaintext would be used as is for encryption. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s."
},
"cryptoKey": {
"$ref": "GooglePrivacyDlpV2CryptoKey",
"description": "The key used by the encryption function. For deterministic encryption using AES-SIV, the provided key is internally expanded to 64 bytes prior to use."
},
"surrogateInfoType": {
"$ref": "GooglePrivacyDlpV2InfoType",
"description": "The custom info type to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom info type followed by the number of characters comprising the surrogate. The following scheme defines the format: {info type name}({surrogate character count}):{surrogate} For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom info type 'Surrogate'. This facilitates reversal of the surrogate when it occurs in free text. Note: For record transformations where the entire cell in a table is being transformed, surrogates are not mandatory. Surrogates are used to denote the location of the token and are necessary for re-identification in free form text. In order for inspection to work properly, the name of this info type must not occur naturally anywhere in your data; otherwise, inspection may either - reverse a surrogate that does not correspond to an actual identifier - be unable to parse the surrogate and result in an error Therefore, choose your custom info type name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: \u29ddMY_TOKEN_TYPE."
}
},
"type": "object"
},
"GooglePrivacyDlpV2CryptoHashConfig": {
"description": "Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more.",
"id": "GooglePrivacyDlpV2CryptoHashConfig",
"properties": {
"cryptoKey": {
"$ref": "GooglePrivacyDlpV2CryptoKey",
"description": "The key used by the hash function."
}
},
"type": "object"
},
"GooglePrivacyDlpV2CryptoKey": {
"description": "This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS). When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK.",
"id": "GooglePrivacyDlpV2CryptoKey",
"properties": {
"kmsWrapped": {
"$ref": "GooglePrivacyDlpV2KmsWrappedCryptoKey",
"description": "Key wrapped using Cloud KMS"
},
"transient": {
"$ref": "GooglePrivacyDlpV2TransientCryptoKey",
"description": "Transient crypto key"
},
"unwrapped": {
"$ref": "GooglePrivacyDlpV2UnwrappedCryptoKey",
"description": "Unwrapped crypto key"
}
},
"type": "object"
},
"GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig": {
"description": "Replaces an identifier with a surrogate using Format Preserving Encryption (FPE) with the FFX mode of operation; however when used in the `ReidentifyContent` API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. FPE incurs significant latency costs.",
"id": "GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig",
"properties": {
"commonAlphabet": {
"description": "Common alphabets.",
"enum": [
"FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED",
"NUMERIC",
"HEXADECIMAL",
"UPPER_CASE_ALPHA_NUMERIC",
"ALPHA_NUMERIC"
],
"enumDescriptions": [
"Unused.",
"`[0-9]` (radix of 10)",
"`[0-9A-F]` (radix of 16)",
"`[0-9A-Z]` (radix of 36)",
"`[0-9A-Za-z]` (radix of 62)"
],
"type": "string"
},
"context": {
"$ref": "GooglePrivacyDlpV2FieldId",
"description": "The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used. If the context is set but: 1. there is no record present when transforming a given value or 1. the field is not present when transforming a given value, a default tweak will be used. Note that case (1) is expected when an `InfoTypeTransformation` is applied to both structured and unstructured `ContentItem`s. Currently, the referenced field may be of value type integer or string. The tweak is constructed as a sequence of bytes in big endian byte order such that: - a 64 bit integer is encoded followed by a single byte of value 1 - a string is encoded in UTF-8 format followed by a single byte of value 2"
},
"cryptoKey": {
"$ref": "GooglePrivacyDlpV2CryptoKey",
"description": "Required. The key used by the encryption algorithm."
},
"customAlphabet": {
"description": "This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\\:;\"'<,>.?/``",
"type": "string"
},
"radix": {
"description": "The native way to select the alphabet. Must be in the range [2, 95].",
"format": "int32",
"type": "integer"
},
"surrogateInfoType": {
"$ref": "GooglePrivacyDlpV2InfoType",
"description": "The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: \u29ddMY_TOKEN_TYPE"
}
},
"type": "object"
},
"GooglePrivacyDlpV2CustomInfoType": {
"description": "Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question.",
"id": "GooglePrivacyDlpV2CustomInfoType",
"properties": {
"detectionRules": {
"description": "Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in order that they are specified. Not supported for the `surrogate_type`, `metadata_key_value_expression`, and `prompt` CustomInfoType.",
"items": {
"$ref": "GooglePrivacyDlpV2DetectionRule"
},
"type": "array"
},
"dictionary": {
"$ref": "GooglePrivacyDlpV2Dictionary",
"description": "A list of phrases to detect as a CustomInfoType."
},
"exclusionType": {
"description": "If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Not supported for the `metadata_key_value_expression` and `prompt` CustomInfoType.",
"enum": [
"EXCLUSION_TYPE_UNSPECIFIED",
"EXCLUSION_TYPE_EXCLUDE"
],
"enumDescriptions": [
"A finding of this custom info type will not be excluded from results.",
"A finding of this custom info type will be excluded from final results, but can still affect rule execution."
],
"type": "string"
},
"infoType": {
"$ref": "GooglePrivacyDlpV2InfoType",
"description": "CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type."
},
"likelihood": {
"description": "Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified.",
"enum": [
"LIKELIHOOD_UNSPECIFIED",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Default value; same as POSSIBLE.",
"Highest chance of a false positive.",
"High chance of a false positive.",
"Some matching signals. The default value.",
"Low chance of a false positive.",
"Confidence level is high. Lowest chance of a false positive."
],
"type": "string"
},
"regex": {
"$ref": "GooglePrivacyDlpV2Regex",
"description": "Regular expression based CustomInfoType."
},
"sensitivityScore": {
"$ref": "GooglePrivacyDlpV2SensitivityScore",
"description": "Sensitivity for this CustomInfoType. If this CustomInfoType extends an existing InfoType, the sensitivity here will take precedence over that of the original InfoType. If unset for a CustomInfoType, it will default to HIGH. This only applies to data profiling."
},
"storedType": {
"$ref": "GooglePrivacyDlpV2StoredType",
"description": "Loads an existing `StoredInfoType` resource."
},
"surrogateType": {
"$ref": "GooglePrivacyDlpV2SurrogateType",
"description": "Message for detecting output from deidentification transformations that support reversing."
}
},
"type": "object"
},
"GooglePrivacyDlpV2DataProfileAction": {
"description": "A task to execute when a data profile has been generated.",
"id": "GooglePrivacyDlpV2DataProfileAction",
"properties": {
"exportData": {
"$ref": "GooglePrivacyDlpV2Export",
"description": "Export data profiles into a provided location."
},
"pubSubNotification": {
"$ref": "GooglePrivacyDlpV2PubSubNotification",
"description": "Publish a message into the Pub/Sub topic."
},
"publishToChronicle": {
"$ref": "GooglePrivacyDlpV2PublishToChronicle",
"description": "Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download)."
},
"publishToDataplexCatalog": {
"$ref": "GooglePrivacyDlpV2PublishToDataplexCatalog",
"description": "Publishes a portion of each profile to Dataplex Universal Catalog with the aspect type Sensitive Data Protection Profile."
},
"publishToScc": {
"$ref": "GooglePrivacyDlpV2PublishToSecurityCommandCenter",
"description": "Publishes findings to Security Command Center for each data profile."
},
"tagResources": {
"$ref": "GooglePrivacyDlpV2TagResources",
"description": "Tags the profiled resources with the specified tag values."
}
},
"type": "object"
},
"GooglePrivacyDlpV2DataProfileBigQueryRowSchema": {
"description": "The schema of data to be saved to the BigQuery table when the `DataProfileAction` is enabled.",
"id": "GooglePrivacyDlpV2DataProfileBigQueryRowSchema",
"properties": {
"columnProfile": {
"$ref": "GooglePrivacyDlpV2ColumnDataProfile",
"description": "Column data profile column"
},
"fileStoreProfile": {
"$ref": "GooglePrivacyDlpV2FileStoreDataProfile",
"description": "File store data profile column."
},
"tableProfile": {
"$ref": "GooglePrivacyDlpV2TableDataProfile",
"description": "Table data profile column"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DataProfileConfigSnapshot": {
"description": "Snapshot of the configurations used to generate the profile.",
"id": "GooglePrivacyDlpV2DataProfileConfigSnapshot",
"properties": {
"dataProfileJob": {
"$ref": "GooglePrivacyDlpV2DataProfileJobConfig",
"deprecated": true,
"description": "A copy of the configuration used to generate this profile. This is deprecated, and the DiscoveryConfig field is preferred moving forward. DataProfileJobConfig will still be written here for Discovery in BigQuery for backwards compatibility, but will not be updated with new fields, while DiscoveryConfig will."
},
"discoveryConfig": {
"$ref": "GooglePrivacyDlpV2DiscoveryConfig",
"description": "A copy of the configuration used to generate this profile."
},
"inspectConfig": {
"$ref": "GooglePrivacyDlpV2InspectConfig",
"description": "A copy of the inspection config used to generate this profile. This is a copy of the inspect_template specified in `DataProfileJobConfig`."
},
"inspectTemplateModifiedTime": {
"description": "Timestamp when the template was modified",
"format": "google-datetime",
"type": "string"
},
"inspectTemplateName": {
"description": "Name of the inspection template used to generate this profile",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DataProfileFinding": {
"description": "Details about a piece of potentially sensitive information that was detected when the data resource was profiled.",
"id": "GooglePrivacyDlpV2DataProfileFinding",
"properties": {
"dataProfileResourceName": {
"description": "Resource name of the data profile associated with the finding.",
"type": "string"
},
"dataSourceType": {
"$ref": "GooglePrivacyDlpV2DataSourceType",
"description": "The type of the resource that was profiled."
},
"findingId": {
"description": "A unique identifier for the finding.",
"type": "string"
},
"fullResourceName": {
"description": "The [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) of the resource profiled for this finding.",
"type": "string"
},
"infotype": {
"$ref": "GooglePrivacyDlpV2InfoType",
"description": "The [type of content](https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference) that might have been found."
},
"location": {
"$ref": "GooglePrivacyDlpV2DataProfileFindingLocation",
"description": "Where the content was found."
},
"quote": {
"description": "The content that was found. Even if the content is not textual, it may be converted to a textual representation here. If the finding exceeds 4096 bytes in length, the quote may be omitted.",
"type": "string"
},
"quoteInfo": {
"$ref": "GooglePrivacyDlpV2QuoteInfo",
"description": "Contains data parsed from quotes. Currently supported infoTypes: DATE, DATE_OF_BIRTH, and TIME."
},
"resourceVisibility": {
"description": "How broadly a resource has been shared.",
"enum": [
"RESOURCE_VISIBILITY_UNSPECIFIED",
"RESOURCE_VISIBILITY_PUBLIC",
"RESOURCE_VISIBILITY_INCONCLUSIVE",
"RESOURCE_VISIBILITY_RESTRICTED"
],
"enumDescriptions": [
"Unused.",
"Visible to any user.",
"May contain public items. For example, if a Cloud Storage bucket has uniform bucket level access disabled, some objects inside it may be public, but none are known yet.",
"Visible only to specific users."
],
"type": "string"
},
"timestamp": {
"description": "Timestamp when the finding was detected.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DataProfileFindingLocation": {
"description": "Location of a data profile finding within a resource.",
"id": "GooglePrivacyDlpV2DataProfileFindingLocation",
"properties": {
"containerName": {
"description": "Name of the container where the finding is located. The top-level name is the source file name or table name. Names of some common storage containers are formatted as follows: * BigQuery tables: `{project_id}:{dataset_id}.{table_id}` * Cloud Storage files: `gs://{bucket}/{path}`",
"type": "string"
},
"dataProfileFindingRecordLocation": {
"$ref": "GooglePrivacyDlpV2DataProfileFindingRecordLocation",
"description": "Location of a finding within a resource that produces a table data profile."
}
},
"type": "object"
},
"GooglePrivacyDlpV2DataProfileFindingRecordLocation": {
"description": "Location of a finding within a resource that produces a table data profile.",
"id": "GooglePrivacyDlpV2DataProfileFindingRecordLocation",
"properties": {
"field": {
"$ref": "GooglePrivacyDlpV2FieldId",
"description": "Field ID of the column containing the finding."
}
},
"type": "object"
},
"GooglePrivacyDlpV2DataProfileJobConfig": {
"description": "Configuration for setting up a job to scan resources for profile generation. Only one data profile configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention).",
"id": "GooglePrivacyDlpV2DataProfileJobConfig",
"properties": {
"dataProfileActions": {
"description": "Actions to execute at the completion of the job.",
"items": {
"$ref": "GooglePrivacyDlpV2DataProfileAction"
},
"type": "array"
},
"inspectTemplates": {
"description": "Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including \"global\"). Each region is scanned using the applicable template. If no region-specific template is specified, but a \"global\" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency.",
"items": {
"type": "string"
},
"type": "array"
},
"location": {
"$ref": "GooglePrivacyDlpV2DataProfileLocation",
"description": "The data to scan."
},
"otherCloudStartingLocation": {
"$ref": "GooglePrivacyDlpV2OtherCloudDiscoveryStartingLocation",
"description": "Must be set only when scanning other clouds."
},
"projectId": {
"description": "The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the DLP API must be enabled.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DataProfileLocation": {
"description": "The data that will be profiled.",
"id": "GooglePrivacyDlpV2DataProfileLocation",
"properties": {
"folderId": {
"description": "The ID of the folder within an organization to scan.",
"format": "int64",
"type": "string"
},
"organizationId": {
"description": "The ID of an organization to scan.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DataProfilePubSubCondition": {
"description": "A condition for determining whether a Pub/Sub should be triggered.",
"id": "GooglePrivacyDlpV2DataProfilePubSubCondition",
"properties": {
"expressions": {
"$ref": "GooglePrivacyDlpV2PubSubExpressions",
"description": "An expression."
}
},
"type": "object"
},
"GooglePrivacyDlpV2DataProfilePubSubMessage": {
"description": "Pub/Sub topic message for a DataProfileAction.PubSubNotification event. To receive a message of protocol buffer schema type, convert the message data to an object of this proto class.",
"id": "GooglePrivacyDlpV2DataProfilePubSubMessage",
"properties": {
"event": {
"description": "The event that caused the Pub/Sub message to be sent.",
"enum": [
"EVENT_TYPE_UNSPECIFIED",
"NEW_PROFILE",
"CHANGED_PROFILE",
"SCORE_INCREASED",
"ERROR_CHANGED"
],
"enumDescriptions": [
"Unused.",
"New profile (not a re-profile).",
"One of the following profile metrics changed: Data risk score, Sensitivity score, Resource visibility, Encryption type, Predicted infoTypes, Other infoTypes",
"Table data risk score or sensitivity score increased.",
"A user (non-internal) error occurred."
],
"type": "string"
},
"fileStoreProfile": {
"$ref": "GooglePrivacyDlpV2FileStoreDataProfile",
"description": "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."
},
"profile": {
"$ref": "GooglePrivacyDlpV2TableDataProfile",
"description": "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."
}
},
"type": "object"
},
"GooglePrivacyDlpV2DataRiskLevel": {
"description": "Score is a summary of all elements in the data profile. A higher number means more risk.",
"id": "GooglePrivacyDlpV2DataRiskLevel",
"properties": {
"score": {
"description": "The score applied to the resource.",
"enum": [
"RISK_SCORE_UNSPECIFIED",
"RISK_LOW",
"RISK_UNKNOWN",
"RISK_MODERATE",
"RISK_HIGH"
],
"enumDescriptions": [
"Unused.",
"Low risk - Lower indication of sensitive data that appears to have additional access restrictions in place or no indication of sensitive data found.",
"Unable to determine risk.",
"Medium risk - Sensitive data may be present but additional access or fine grain access restrictions appear to be present. Consider limiting access even further or transform data to mask.",
"High risk \u2013 SPII may be present. Access controls may include public ACLs. Exfiltration of data may lead to user data loss. Re-identification of users may be possible. Consider limiting usage and or removing SPII."
],
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DataSourceType": {
"description": "Message used to identify the type of resource being profiled.",
"id": "GooglePrivacyDlpV2DataSourceType",
"properties": {
"dataSource": {
"description": "A string that identifies the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DatabaseResourceCollection": {
"description": "Match database resources using regex filters. Examples of database resources are tables, views, and stored procedures.",
"id": "GooglePrivacyDlpV2DatabaseResourceCollection",
"properties": {
"includeRegexes": {
"$ref": "GooglePrivacyDlpV2DatabaseResourceRegexes",
"description": "A collection of regular expressions to match a database resource against."
}
},
"type": "object"
},
"GooglePrivacyDlpV2DatabaseResourceReference": {
"description": "Identifies a single database resource, like a table within a database.",
"id": "GooglePrivacyDlpV2DatabaseResourceReference",
"properties": {
"database": {
"description": "Required. Name of a database within the instance.",
"type": "string"
},
"databaseResource": {
"description": "Required. Name of a database resource, for example, a table within the database.",
"type": "string"
},
"instance": {
"description": "Required. The instance where this resource is located. For example: Cloud SQL instance ID.",
"type": "string"
},
"projectId": {
"description": "Required. If within a project-level config, then this must match the config's project ID.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DatabaseResourceRegex": {
"description": "A pattern to match against one or more database resources. At least one pattern must be specified. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub.",
"id": "GooglePrivacyDlpV2DatabaseResourceRegex",
"properties": {
"databaseRegex": {
"description": "Regex to test the database name against. If empty, all databases match.",
"type": "string"
},
"databaseResourceNameRegex": {
"description": "Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match.",
"type": "string"
},
"instanceRegex": {
"description": "Regex to test the instance name against. If empty, all instances match.",
"type": "string"
},
"projectIdRegex": {
"description": "For organizations, if unset, will match all projects. Has no effect for configurations created within a project.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DatabaseResourceRegexes": {
"description": "A collection of regular expressions to determine what database resources to match against.",
"id": "GooglePrivacyDlpV2DatabaseResourceRegexes",
"properties": {
"patterns": {
"description": "A group of regular expression patterns to match against one or more database resources. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB.",
"items": {
"$ref": "GooglePrivacyDlpV2DatabaseResourceRegex"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DatastoreKey": {
"description": "Record key for a finding in Cloud Datastore.",
"id": "GooglePrivacyDlpV2DatastoreKey",
"properties": {
"entityKey": {
"$ref": "GooglePrivacyDlpV2Key",
"description": "Datastore entity key."
}
},
"type": "object"
},
"GooglePrivacyDlpV2DatastoreOptions": {
"description": "Options defining a data set within Google Cloud Datastore.",
"id": "GooglePrivacyDlpV2DatastoreOptions",
"properties": {
"kind": {
"$ref": "GooglePrivacyDlpV2KindExpression",
"description": "The kind to process."
},
"partitionId": {
"$ref": "GooglePrivacyDlpV2PartitionId",
"description": "A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty."
}
},
"type": "object"
},
"GooglePrivacyDlpV2DateShiftConfig": {
"description": "Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting to learn more.",
"id": "GooglePrivacyDlpV2DateShiftConfig",
"properties": {
"context": {
"$ref": "GooglePrivacyDlpV2FieldId",
"description": "Points to the field that contains the context, for example, an entity id. If set, must also set cryptoKey. If set, shift will be consistent for the given context."
},
"cryptoKey": {
"$ref": "GooglePrivacyDlpV2CryptoKey",
"description": "Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key. If set, must also set context. Can only be applied to table items."
},
"lowerBoundDays": {
"description": "Required. For example, -5 means shift date to at most 5 days back in the past.",
"format": "int32",
"type": "integer"
},
"upperBoundDays": {
"description": "Required. Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction. For example, 3 means shift date to at most 3 days into the future.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DateTime": {
"description": "Message for a date time object. e.g. 2018-01-01, 5th August.",
"id": "GooglePrivacyDlpV2DateTime",
"properties": {
"date": {
"$ref": "GoogleTypeDate",
"description": "One or more of the following must be set. Must be a valid date or time value."
},
"dayOfWeek": {
"description": "Day of week",
"enum": [
"DAY_OF_WEEK_UNSPECIFIED",
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
],
"enumDescriptions": [
"The day of the week is unspecified.",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday",
"Sunday"
],
"type": "string"
},
"time": {
"$ref": "GoogleTypeTimeOfDay",
"description": "Time of day"
},
"timeZone": {
"$ref": "GooglePrivacyDlpV2TimeZone",
"description": "Time zone"
}
},
"type": "object"
},
"GooglePrivacyDlpV2Deidentify": {
"description": "Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage",
"id": "GooglePrivacyDlpV2Deidentify",
"properties": {
"cloudStorageOutput": {
"description": "Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket",
"type": "string"
},
"fileTypesToTransform": {
"description": "List of user-specified file type groups to transform. If specified, only the files with these file types are transformed. If empty, all supported files are transformed. Supported types may be automatically added over time. Any unsupported file types that are set in this field are excluded from de-identification. An error is recorded for each unsupported file in the TransformationDetails output table. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV.",
"items": {
"enum": [
"FILE_TYPE_UNSPECIFIED",
"BINARY_FILE",
"TEXT_FILE",
"IMAGE",
"WORD",
"PDF",
"AVRO",
"CSV",
"TSV",
"POWERPOINT",
"EXCEL"
],
"enumDescriptions": [
"Includes all files.",
"Includes all file extensions not covered by another entry. Binary scanning attempts to convert the content of the file to utf_8 to scan the file. If you wish to avoid this fall back, specify one or more of the other file types in your storage scan.",
"Included file extensions: asc,asp, aspx, brf, c, cc,cfm, cgi, cpp, csv, cxx, c++, cs, css, dart, dat, dot, eml,, epbub, ged, go, h, hh, hpp, hxx, h++, hs, html, htm, mkd, markdown, m, ml, mli, perl, pl, plist, pm, php, phtml, pht, properties, py, pyw, rb, rbw, rs, rss, rc, scala, sh, sql, swift, tex, shtml, shtm, xhtml, lhs, ics, ini, java, js, json, jsonl, kix, kml, ocaml, md, txt, text, tsv, vb, vcard, vcs, wml, xcodeproj, xml, xsl, xsd, yml, yaml.",
"Included file extensions: bmp, gif, jpg, jpeg, jpe, png. Setting bytes_limit_per_file or bytes_limit_per_file_percent has no effect on image files. Image inspection is restricted to the `global`, `us`, `asia`, and `europe` regions.",
"Microsoft Word files larger than 30 MB will be scanned as binary files. Included file extensions: docx, dotx, docm, dotm. Setting `bytes_limit_per_file` or `bytes_limit_per_file_percent` has no effect on Word files.",
"PDF files larger than 30 MB will be scanned as binary files. Included file extensions: pdf. Setting `bytes_limit_per_file` or `bytes_limit_per_file_percent` has no effect on PDF files.",
"Included file extensions: avro",
"Included file extensions: csv",
"Included file extensions: tsv",
"Microsoft PowerPoint files larger than 30 MB will be scanned as binary files. Included file extensions: pptx, pptm, potx, potm, pot. Setting `bytes_limit_per_file` or `bytes_limit_per_file_percent` has no effect on PowerPoint files.",
"Microsoft Excel files larger than 30 MB will be scanned as binary files. Included file extensions: xlsx, xlsm, xltx, xltm. Setting `bytes_limit_per_file` or `bytes_limit_per_file_percent` has no effect on Excel files."
],
"type": "string"
},
"type": "array"
},
"transformationConfig": {
"$ref": "GooglePrivacyDlpV2TransformationConfig",
"description": "User specified deidentify templates and configs for structured, unstructured, and image files."
},
"transformationDetailsStorageConfig": {
"$ref": "GooglePrivacyDlpV2TransformationDetailsStorageConfig",
"description": "Config for storing transformation details. This field specifies the configuration for storing detailed metadata about each transformation performed during a de-identification process. The metadata is stored separately from the de-identified content itself and provides a granular record of both successful transformations and any failures that occurred. Enabling this configuration is essential for users who need to access comprehensive information about the status, outcome, and specifics of each transformation. The details are captured in the TransformationDetails message for each operation. Key use cases: * **Auditing and compliance** * Provides a verifiable audit trail of de-identification activities, which is crucial for meeting regulatory requirements and internal data governance policies. * Logs what data was transformed, what transformations were applied, when they occurred, and their success status. This helps demonstrate accountability and due diligence in protecting sensitive data. * **Troubleshooting and debugging** * Offers detailed error messages and context if a transformation fails. This information is useful for diagnosing and resolving issues in the de-identification pipeline. * Helps pinpoint the exact location and nature of failures, speeding up the debugging process. * **Process verification and quality assurance** * Allows users to confirm that de-identification rules and transformations were applied correctly and consistently across the dataset as intended. * Helps in verifying the effectiveness of the chosen de-identification strategies. * **Data lineage and impact analysis** * Creates a record of how data elements were modified, contributing to data lineage. This is useful for understanding the provenance of de-identified data. * Aids in assessing the potential impact of de-identification choices on downstream analytical processes or data usability. * **Reporting and operational insights** * You can analyze the metadata stored in a queryable BigQuery table to generate reports on transformation success rates, common error types, processing volumes (e.g., transformedBytes), and the types of transformations applied. * These insights can inform optimization of de-identification configurations and resource planning. To take advantage of these benefits, set this configuration. The stored details include a description of the transformation, success or error codes, error messages, the number of bytes transformed, the location of the transformed content, and identifiers for the job and source data."
}
},
"type": "object"
},
"GooglePrivacyDlpV2DeidentifyConfig": {
"description": "The configuration that controls how the data will change.",
"id": "GooglePrivacyDlpV2DeidentifyConfig",
"properties": {
"imageTransformations": {
"$ref": "GooglePrivacyDlpV2ImageTransformations",
"description": "Treat the dataset as an image and redact."
},
"infoTypeTransformations": {
"$ref": "GooglePrivacyDlpV2InfoTypeTransformations",
"description": "Treat the dataset as free-form text and apply the same free text transformation everywhere."
},
"recordTransformations": {
"$ref": "GooglePrivacyDlpV2RecordTransformations",
"description": "Treat the dataset as structured. Transformations can be applied to specific locations within structured datasets, such as transforming a column within a table."
},
"transformationErrorHandling": {
"$ref": "GooglePrivacyDlpV2TransformationErrorHandling",
"description": "Mode for handling transformation errors. If left unspecified, the default mode is `TransformationErrorHandling.ThrowError`."
}
},
"type": "object"
},
"GooglePrivacyDlpV2DeidentifyContentRequest": {
"description": "Request to de-identify a ContentItem.",
"id": "GooglePrivacyDlpV2DeidentifyContentRequest",
"properties": {
"deidentifyConfig": {
"$ref": "GooglePrivacyDlpV2DeidentifyConfig",
"description": "Configuration for the de-identification of the content item. Items specified here will override the template referenced by the deidentify_template_name argument."
},
"deidentifyTemplateName": {
"description": "Template to use. Any configuration directly specified in deidentify_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.",
"type": "string"
},
"inspectConfig": {
"$ref": "GooglePrivacyDlpV2InspectConfig",
"description": "Configuration for the inspector. Items specified here will override the template referenced by the inspect_template_name argument."
},
"inspectTemplateName": {
"description": "Template to use. Any configuration directly specified in inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.",
"type": "string"
},
"item": {
"$ref": "GooglePrivacyDlpV2ContentItem",
"description": "The item to de-identify. Will be treated as text. This value must be of type Table if your deidentify_config is a RecordTransformations object."
},
"locationId": {
"description": "Deprecated. This field has no effect.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DeidentifyContentResponse": {
"description": "Results of de-identifying a ContentItem.",
"id": "GooglePrivacyDlpV2DeidentifyContentResponse",
"properties": {
"item": {
"$ref": "GooglePrivacyDlpV2ContentItem",
"description": "The de-identified item."
},
"overview": {
"$ref": "GooglePrivacyDlpV2TransformationOverview",
"description": "An overview of the changes that were made on the `item`."
}
},
"type": "object"
},
"GooglePrivacyDlpV2DeidentifyDataSourceDetails": {
"description": "The results of a Deidentify action from an inspect job.",
"id": "GooglePrivacyDlpV2DeidentifyDataSourceDetails",
"properties": {
"deidentifyStats": {
"$ref": "GooglePrivacyDlpV2DeidentifyDataSourceStats",
"description": "Stats about the de-identification operation."
},
"requestedOptions": {
"$ref": "GooglePrivacyDlpV2RequestedDeidentifyOptions",
"description": "De-identification config used for the request."
}
},
"type": "object"
},
"GooglePrivacyDlpV2DeidentifyDataSourceStats": {
"description": "Summary of what was modified during a transformation.",
"id": "GooglePrivacyDlpV2DeidentifyDataSourceStats",
"properties": {
"transformationCount": {
"description": "Number of successfully applied transformations.",
"format": "int64",
"type": "string"
},
"transformationErrorCount": {
"description": "Number of errors encountered while trying to apply transformations.",
"format": "int64",
"type": "string"
},
"transformedBytes": {
"description": "Total size in bytes that were transformed in some way.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DeidentifyTemplate": {
"description": "DeidentifyTemplates contains instructions on how to de-identify content. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more.",
"id": "GooglePrivacyDlpV2DeidentifyTemplate",
"properties": {
"createTime": {
"description": "Output only. The creation timestamp of an inspectTemplate.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"deidentifyConfig": {
"$ref": "GooglePrivacyDlpV2DeidentifyConfig",
"description": "The core content of the template."
},
"description": {
"description": "Short description (max 256 chars).",
"type": "string"
},
"displayName": {
"description": "Display name (max 256 chars).",
"type": "string"
},
"name": {
"description": "Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID`",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The last update timestamp of an inspectTemplate.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DeltaPresenceEstimationConfig": {
"description": "\u03b4-presence metric, used to estimate how likely it is for an attacker to figure out that one given individual appears in a de-identified dataset. Similarly to the k-map metric, we cannot compute \u03b4-presence exactly without knowing the attack dataset, so we use a statistical model instead.",
"id": "GooglePrivacyDlpV2DeltaPresenceEstimationConfig",
"properties": {
"auxiliaryTables": {
"description": "Several auxiliary tables can be used in the analysis. Each custom_tag used to tag a quasi-identifiers field must appear in exactly one field of one auxiliary table.",
"items": {
"$ref": "GooglePrivacyDlpV2StatisticalTable"
},
"type": "array"
},
"quasiIds": {
"description": "Required. Fields considered to be quasi-identifiers. No two fields can have the same tag.",
"items": {
"$ref": "GooglePrivacyDlpV2QuasiId"
},
"type": "array"
},
"regionCode": {
"description": "ISO 3166-1 alpha-2 region code to use in the statistical modeling. Set if no column is tagged with a region-specific InfoType (like US_ZIP_5) or a region code.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket": {
"description": "A DeltaPresenceEstimationHistogramBucket message with the following values: min_probability: 0.1 max_probability: 0.2 frequency: 42 means that there are 42 records for which \u03b4 is in [0.1, 0.2). An important particular case is when min_probability = max_probability = 1: then, every individual who shares this quasi-identifier combination is in the dataset.",
"id": "GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket",
"properties": {
"bucketSize": {
"description": "Number of records within these probability bounds.",
"format": "int64",
"type": "string"
},
"bucketValueCount": {
"description": "Total number of distinct quasi-identifier tuple values in this bucket.",
"format": "int64",
"type": "string"
},
"bucketValues": {
"description": "Sample of quasi-identifier tuple values in this bucket. The total number of classes returned per bucket is capped at 20.",
"items": {
"$ref": "GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues"
},
"type": "array"
},
"maxProbability": {
"description": "Always greater than or equal to min_probability.",
"format": "double",
"type": "number"
},
"minProbability": {
"description": "Between 0 and 1.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues": {
"description": "A tuple of values for the quasi-identifier columns.",
"id": "GooglePrivacyDlpV2DeltaPresenceEstimationQuasiIdValues",
"properties": {
"estimatedProbability": {
"description": "The estimated probability that a given individual sharing these quasi-identifier values is in the dataset. This value, typically called \u03b4, is the ratio between the number of records in the dataset with these quasi-identifier values, and the total number of individuals (inside *and* outside the dataset) with these quasi-identifier values. For example, if there are 15 individuals in the dataset who share the same quasi-identifier values, and an estimated 100 people in the entire population with these values, then \u03b4 is 0.15.",
"format": "double",
"type": "number"
},
"quasiIdsValues": {
"description": "The quasi-identifier values.",
"items": {
"$ref": "GooglePrivacyDlpV2Value"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DeltaPresenceEstimationResult": {
"description": "Result of the \u03b4-presence computation. Note that these results are an estimation, not exact values.",
"id": "GooglePrivacyDlpV2DeltaPresenceEstimationResult",
"properties": {
"deltaPresenceEstimationHistogram": {
"description": "The intervals [min_probability, max_probability) do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_probability: 0, max_probability: 0.1, frequency: 17} {min_probability: 0.2, max_probability: 0.3, frequency: 42} {min_probability: 0.3, max_probability: 0.4, frequency: 99} mean that there are no record with an estimated probability in [0.1, 0.2) nor larger or equal to 0.4.",
"items": {
"$ref": "GooglePrivacyDlpV2DeltaPresenceEstimationHistogramBucket"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DetectionRule": {
"description": "Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType.",
"id": "GooglePrivacyDlpV2DetectionRule",
"properties": {
"hotwordRule": {
"$ref": "GooglePrivacyDlpV2HotwordRule",
"description": "Hotword-based detection rule."
}
},
"type": "object"
},
"GooglePrivacyDlpV2Dictionary": {
"description": "Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase \"Sam Johnson\" will match all three phrases \"sam johnson\", \"Sam, Johnson\", and \"Sam (Johnson)\". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word \"jen\" will match the first three letters of the text \"jen123\" but will return no matches for \"jennifer\". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API.",
"id": "GooglePrivacyDlpV2Dictionary",
"properties": {
"cloudStoragePath": {
"$ref": "GooglePrivacyDlpV2CloudStoragePath",
"description": "Newline-delimited file of words in Cloud Storage. Only a single file is accepted."
},
"wordList": {
"$ref": "GooglePrivacyDlpV2WordList",
"description": "List of words or phrases to search for."
}
},
"type": "object"
},
"GooglePrivacyDlpV2Disabled": {
"description": "Do not profile the tables.",
"id": "GooglePrivacyDlpV2Disabled",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2DiscoveryBigQueryConditions": {
"description": "Requirements that must be true before a table is scanned in discovery for the first time. There is an AND relationship between the top-level attributes. Additionally, minimum conditions with an OR relationship that must be met before Cloud DLP scans a table can be set (like a minimum row count or a minimum table age).",
"id": "GooglePrivacyDlpV2DiscoveryBigQueryConditions",
"properties": {
"createdAfter": {
"description": "BigQuery table must have been created after this date. Used to avoid backfilling.",
"format": "google-datetime",
"type": "string"
},
"orConditions": {
"$ref": "GooglePrivacyDlpV2OrConditions",
"description": "At least one of the conditions must be true for a table to be scanned."
},
"typeCollection": {
"description": "Restrict discovery to categories of table types.",
"enum": [
"BIG_QUERY_COLLECTION_UNSPECIFIED",
"BIG_QUERY_COLLECTION_ALL_TYPES",
"BIG_QUERY_COLLECTION_ONLY_SUPPORTED_TYPES"
],
"enumDescriptions": [
"Unused.",
"Automatically generate profiles for all tables, even if the table type is not yet fully supported for analysis. Profiles for unsupported tables will be generated with errors to indicate their partial support. When full support is added, the tables will automatically be profiled during the next scheduled run.",
"Only those types fully supported will be profiled. Will expand automatically as Cloud DLP adds support for new table types. Unsupported table types will not have partial profiles generated."
],
"type": "string"
},
"types": {
"$ref": "GooglePrivacyDlpV2BigQueryTableTypes",
"description": "Restrict discovery to specific table types."
}
},
"type": "object"
},
"GooglePrivacyDlpV2DiscoveryBigQueryFilter": {
"description": "Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, dataset ID, and table ID.",
"id": "GooglePrivacyDlpV2DiscoveryBigQueryFilter",
"properties": {
"otherTables": {
"$ref": "GooglePrivacyDlpV2AllOtherBigQueryTables",
"description": "Catch-all. This should always be the last filter in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically."
},
"tableReference": {
"$ref": "GooglePrivacyDlpV2TableReference",
"description": "The table to scan. Discovery configurations including this can only include one DiscoveryTarget (the DiscoveryTarget with this TableReference)."
},
"tables": {
"$ref": "GooglePrivacyDlpV2BigQueryTableCollection",
"description": "A specific set of tables for this filter to apply to. A table collection must be specified in only one filter per config. If a table id or dataset is empty, Cloud DLP assumes all tables in that collection must be profiled. Must specify a project ID."
}
},
"type": "object"
},
"GooglePrivacyDlpV2DiscoveryCloudSqlConditions": {
"description": "Requirements that must be true before a table is profiled for the first time.",
"id": "GooglePrivacyDlpV2DiscoveryCloudSqlConditions",
"properties": {
"databaseEngines": {
"description": "Optional. Database engines that should be profiled. Optional. Defaults to ALL_SUPPORTED_DATABASE_ENGINES if unspecified.",
"items": {
"enum": [
"DATABASE_ENGINE_UNSPECIFIED",
"ALL_SUPPORTED_DATABASE_ENGINES",
"MYSQL",
"POSTGRES"
],
"enumDescriptions": [
"Unused.",
"Include all supported database engines.",
"MySQL database.",
"PostgreSQL database."
],
"type": "string"
},
"type": "array"
},
"types": {
"description": "Data profiles will only be generated for the database resource types specified in this field. If not specified, defaults to [DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES].",
"items": {
"enum": [
"DATABASE_RESOURCE_TYPE_UNSPECIFIED",
"DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES",
"DATABASE_RESOURCE_TYPE_TABLE"
],
"enumDescriptions": [
"Unused.",
"Includes database resource types that become supported at a later time.",
"Tables."
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DiscoveryCloudSqlFilter": {
"description": "Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, location, instance, database, and database resource name.",
"id": "GooglePrivacyDlpV2DiscoveryCloudSqlFilter",
"properties": {
"collection": {
"$ref": "GooglePrivacyDlpV2DatabaseResourceCollection",
"description": "A specific set of database resources for this filter to apply to."
},
"databaseResourceReference": {
"$ref": "GooglePrivacyDlpV2DatabaseResourceReference",
"description": "The database resource to scan. Targets including this can only include one target (the target with this database resource reference)."
},
"others": {
"$ref": "GooglePrivacyDlpV2AllOtherDatabaseResources",
"description": "Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically."
}
},
"type": "object"
},
"GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence": {
"description": "How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity.",
"id": "GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence",
"properties": {
"inspectTemplateModifiedCadence": {
"$ref": "GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence",
"description": "Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update."
},
"refreshFrequency": {
"description": "Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changed. Defaults to never.",
"enum": [
"UPDATE_FREQUENCY_UNSPECIFIED",
"UPDATE_FREQUENCY_NEVER",
"UPDATE_FREQUENCY_DAILY",
"UPDATE_FREQUENCY_MONTHLY"
],
"enumDescriptions": [
"Unspecified.",
"After the data profile is created, it will never be updated.",
"The data profile can be updated up to once every 24 hours.",
"The data profile can be updated up to once every 30 days. Default."
],
"type": "string"
},
"schemaModifiedCadence": {
"$ref": "GooglePrivacyDlpV2SchemaModifiedCadence",
"description": "When to reprofile if the schema has changed."
}
},
"type": "object"
},
"GooglePrivacyDlpV2DiscoveryCloudStorageConditions": {
"description": "Requirements that must be true before a Cloud Storage bucket or object is scanned in discovery for the first time. There is an AND relationship between the top-level attributes.",
"id": "GooglePrivacyDlpV2DiscoveryCloudStorageConditions",
"properties": {
"includedBucketAttributes": {
"description": "Required. Only objects with the specified attributes will be scanned. Defaults to [ALL_SUPPORTED_BUCKETS] if unset.",
"items": {
"enum": [
"CLOUD_STORAGE_BUCKET_ATTRIBUTE_UNSPECIFIED",
"ALL_SUPPORTED_BUCKETS",
"AUTOCLASS_DISABLED",
"AUTOCLASS_ENABLED"
],
"enumDescriptions": [
"Unused.",
"Scan buckets regardless of the attribute.",
"Buckets with [Autoclass](https://cloud.google.com/storage/docs/autoclass) disabled. Only one of AUTOCLASS_DISABLED or AUTOCLASS_ENABLED should be set.",
"Buckets with [Autoclass](https://cloud.google.com/storage/docs/autoclass) enabled. Only one of AUTOCLASS_DISABLED or AUTOCLASS_ENABLED should be set. Scanning Autoclass-enabled buckets can affect object storage classes."
],
"type": "string"
},
"type": "array"
},
"includedObjectAttributes": {
"description": "Required. Only objects with the specified attributes will be scanned. If an object has one of the specified attributes but is inside an excluded bucket, it will not be scanned. Defaults to [ALL_SUPPORTED_OBJECTS]. A profile will be created even if no objects match the included_object_attributes.",
"items": {
"enum": [
"CLOUD_STORAGE_OBJECT_ATTRIBUTE_UNSPECIFIED",
"ALL_SUPPORTED_OBJECTS",
"STANDARD",
"NEARLINE",
"COLDLINE",
"ARCHIVE",
"REGIONAL",
"MULTI_REGIONAL",
"DURABLE_REDUCED_AVAILABILITY"
],
"enumDescriptions": [
"Unused.",
"Scan objects regardless of the attribute.",
"Scan objects with the standard storage class.",
"Scan objects with the nearline storage class. This will incur retrieval fees.",
"Scan objects with the coldline storage class. This will incur retrieval fees.",
"Scan objects with the archive storage class. This will incur retrieval fees.",
"Scan objects with the regional storage class.",
"Scan objects with the multi-regional storage class.",
"Scan objects with the dual-regional storage class. This will incur retrieval fees."
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DiscoveryCloudStorageFilter": {
"description": "Determines which buckets will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID and bucket name.",
"id": "GooglePrivacyDlpV2DiscoveryCloudStorageFilter",
"properties": {
"cloudStorageResourceReference": {
"$ref": "GooglePrivacyDlpV2CloudStorageResourceReference",
"description": "Optional. The bucket to scan. Targets including this can only include one target (the target with this bucket). This enables profiling the contents of a single bucket, while the other options allow for easy profiling of many bucets within a project or an organization."
},
"collection": {
"$ref": "GooglePrivacyDlpV2FileStoreCollection",
"description": "Optional. A specific set of buckets for this filter to apply to."
},
"others": {
"$ref": "GooglePrivacyDlpV2AllOtherResources",
"description": "Optional. Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically."
}
},
"type": "object"
},
"GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence": {
"description": "How often existing buckets should have their profiles refreshed. New buckets are scanned as quickly as possible depending on system capacity.",
"id": "GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence",
"properties": {
"inspectTemplateModifiedCadence": {
"$ref": "GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence",
"description": "Optional. Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update."
},
"refreshFrequency": {
"description": "Optional. Data changes in Cloud Storage can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying buckets have changed. Defaults to never.",
"enum": [
"UPDATE_FREQUENCY_UNSPECIFIED",
"UPDATE_FREQUENCY_NEVER",
"UPDATE_FREQUENCY_DAILY",
"UPDATE_FREQUENCY_MONTHLY"
],
"enumDescriptions": [
"Unspecified.",
"After the data profile is created, it will never be updated.",
"The data profile can be updated up to once every 24 hours.",
"The data profile can be updated up to once every 30 days. Default."
],
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DiscoveryConfig": {
"description": "Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention).",
"id": "GooglePrivacyDlpV2DiscoveryConfig",
"properties": {
"actions": {
"description": "Actions to execute at the completion of scanning.",
"items": {
"$ref": "GooglePrivacyDlpV2DataProfileAction"
},
"type": "array"
},
"createTime": {
"description": "Output only. The creation timestamp of a DiscoveryConfig.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"displayName": {
"description": "Display name (max 100 chars)",
"type": "string"
},
"errors": {
"description": "Output only. A stream of errors encountered when the config was activated. Repeated errors may result in the config automatically being paused. Output only field. Will return the last 100 errors. Whenever the config is modified this list will be cleared.",
"items": {
"$ref": "GooglePrivacyDlpV2Error"
},
"readOnly": true,
"type": "array"
},
"inspectTemplates": {
"description": "Detection logic for profile generation. Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including \"global\"). Each region is scanned using the applicable template. If no region-specific template is specified, but a \"global\" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency.",
"items": {
"type": "string"
},
"type": "array"
},
"lastRunTime": {
"description": "Output only. The timestamp of the last time this config was executed.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`.",
"type": "string"
},
"orgConfig": {
"$ref": "GooglePrivacyDlpV2OrgConfig",
"description": "Only set when the parent is an org."
},
"otherCloudStartingLocation": {
"$ref": "GooglePrivacyDlpV2OtherCloudDiscoveryStartingLocation",
"description": "Must be set only when scanning other clouds."
},
"processingLocation": {
"$ref": "GooglePrivacyDlpV2ProcessingLocation",
"description": "Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default."
},
"status": {
"description": "Required. A status for this configuration.",
"enum": [
"STATUS_UNSPECIFIED",
"RUNNING",
"PAUSED"
],
"enumDescriptions": [
"Unused",
"The discovery config is currently active.",
"The discovery config is paused temporarily."
],
"type": "string"
},
"targets": {
"description": "Target to match against for determining what to scan and how frequently.",
"items": {
"$ref": "GooglePrivacyDlpV2DiscoveryTarget"
},
"type": "array"
},
"updateTime": {
"description": "Output only. The last update timestamp of a DiscoveryConfig.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DiscoveryFileStoreConditions": {
"description": "Requirements that must be true before a file store is scanned in discovery for the first time. There is an AND relationship between the top-level attributes.",
"id": "GooglePrivacyDlpV2DiscoveryFileStoreConditions",
"properties": {
"cloudStorageConditions": {
"$ref": "GooglePrivacyDlpV2DiscoveryCloudStorageConditions",
"description": "Optional. Cloud Storage conditions."
},
"createdAfter": {
"description": "Optional. File store must have been created after this date. Used to avoid backfilling.",
"format": "google-datetime",
"type": "string"
},
"minAge": {
"description": "Optional. Minimum age a file store must have. If set, the value must be 1 hour or greater.",
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DiscoveryGenerationCadence": {
"description": "What must take place for a profile to be updated and how frequently it should occur. New tables are scanned as quickly as possible depending on system capacity.",
"id": "GooglePrivacyDlpV2DiscoveryGenerationCadence",
"properties": {
"inspectTemplateModifiedCadence": {
"$ref": "GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence",
"description": "Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update."
},
"refreshFrequency": {
"description": "Frequency at which profiles should be updated, regardless of whether the underlying resource has changed. Defaults to never.",
"enum": [
"UPDATE_FREQUENCY_UNSPECIFIED",
"UPDATE_FREQUENCY_NEVER",
"UPDATE_FREQUENCY_DAILY",
"UPDATE_FREQUENCY_MONTHLY"
],
"enumDescriptions": [
"Unspecified.",
"After the data profile is created, it will never be updated.",
"The data profile can be updated up to once every 24 hours.",
"The data profile can be updated up to once every 30 days. Default."
],
"type": "string"
},
"schemaModifiedCadence": {
"$ref": "GooglePrivacyDlpV2DiscoverySchemaModifiedCadence",
"description": "Governs when to update data profiles when a schema is modified."
},
"tableModifiedCadence": {
"$ref": "GooglePrivacyDlpV2DiscoveryTableModifiedCadence",
"description": "Governs when to update data profiles when a table is modified."
}
},
"type": "object"
},
"GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence": {
"description": "The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change.",
"id": "GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence",
"properties": {
"frequency": {
"description": "How frequently data profiles can be updated when the template is modified. Defaults to never.",
"enum": [
"UPDATE_FREQUENCY_UNSPECIFIED",
"UPDATE_FREQUENCY_NEVER",
"UPDATE_FREQUENCY_DAILY",
"UPDATE_FREQUENCY_MONTHLY"
],
"enumDescriptions": [
"Unspecified.",
"After the data profile is created, it will never be updated.",
"The data profile can be updated up to once every 24 hours.",
"The data profile can be updated up to once every 30 days. Default."
],
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DiscoveryOtherCloudConditions": {
"description": "Requirements that must be true before a resource is profiled for the first time.",
"id": "GooglePrivacyDlpV2DiscoveryOtherCloudConditions",
"properties": {
"amazonS3BucketConditions": {
"$ref": "GooglePrivacyDlpV2AmazonS3BucketConditions",
"description": "Amazon S3 bucket conditions."
},
"minAge": {
"description": "Minimum age a resource must be before Cloud DLP can profile it. Value must be 1 hour or greater.",
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DiscoveryOtherCloudFilter": {
"description": "Determines which resources from the other cloud will have profiles generated. Includes the ability to filter by resource names.",
"id": "GooglePrivacyDlpV2DiscoveryOtherCloudFilter",
"properties": {
"collection": {
"$ref": "GooglePrivacyDlpV2OtherCloudResourceCollection",
"description": "A collection of resources for this filter to apply to."
},
"others": {
"$ref": "GooglePrivacyDlpV2AllOtherResources",
"description": "Optional. Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically."
},
"singleResource": {
"$ref": "GooglePrivacyDlpV2OtherCloudSingleResourceReference",
"description": "The resource to scan. Configs using this filter can only have one target (the target with this single resource reference)."
}
},
"type": "object"
},
"GooglePrivacyDlpV2DiscoveryOtherCloudGenerationCadence": {
"description": "How often existing resources should have their profiles refreshed. New resources are scanned as quickly as possible depending on system capacity.",
"id": "GooglePrivacyDlpV2DiscoveryOtherCloudGenerationCadence",
"properties": {
"inspectTemplateModifiedCadence": {
"$ref": "GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence",
"description": "Optional. Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update."
},
"refreshFrequency": {
"description": "Optional. Frequency to update profiles regardless of whether the underlying resource has changes. Defaults to never.",
"enum": [
"UPDATE_FREQUENCY_UNSPECIFIED",
"UPDATE_FREQUENCY_NEVER",
"UPDATE_FREQUENCY_DAILY",
"UPDATE_FREQUENCY_MONTHLY"
],
"enumDescriptions": [
"Unspecified.",
"After the data profile is created, it will never be updated.",
"The data profile can be updated up to once every 24 hours.",
"The data profile can be updated up to once every 30 days. Default."
],
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DiscoverySchemaModifiedCadence": {
"description": "The cadence at which to update data profiles when a schema is modified.",
"id": "GooglePrivacyDlpV2DiscoverySchemaModifiedCadence",
"properties": {
"frequency": {
"description": "How frequently profiles may be updated when schemas are modified. Defaults to monthly.",
"enum": [
"UPDATE_FREQUENCY_UNSPECIFIED",
"UPDATE_FREQUENCY_NEVER",
"UPDATE_FREQUENCY_DAILY",
"UPDATE_FREQUENCY_MONTHLY"
],
"enumDescriptions": [
"Unspecified.",
"After the data profile is created, it will never be updated.",
"The data profile can be updated up to once every 24 hours.",
"The data profile can be updated up to once every 30 days. Default."
],
"type": "string"
},
"types": {
"description": "The type of events to consider when deciding if the table's schema has been modified and should have the profile updated. Defaults to NEW_COLUMNS.",
"items": {
"enum": [
"SCHEMA_MODIFICATION_UNSPECIFIED",
"SCHEMA_NEW_COLUMNS",
"SCHEMA_REMOVED_COLUMNS"
],
"enumDescriptions": [
"Unused",
"Profiles should be regenerated when new columns are added to the table. Default.",
"Profiles should be regenerated when columns are removed from the table."
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DiscoveryStartingLocation": {
"description": "The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization.",
"id": "GooglePrivacyDlpV2DiscoveryStartingLocation",
"properties": {
"folderId": {
"description": "The ID of the folder within an organization to be scanned.",
"format": "int64",
"type": "string"
},
"organizationId": {
"description": "The ID of an organization to scan.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DiscoveryTableModifiedCadence": {
"description": "The cadence at which to update data profiles when a table is modified.",
"id": "GooglePrivacyDlpV2DiscoveryTableModifiedCadence",
"properties": {
"frequency": {
"description": "How frequently data profiles can be updated when tables are modified. Defaults to never.",
"enum": [
"UPDATE_FREQUENCY_UNSPECIFIED",
"UPDATE_FREQUENCY_NEVER",
"UPDATE_FREQUENCY_DAILY",
"UPDATE_FREQUENCY_MONTHLY"
],
"enumDescriptions": [
"Unspecified.",
"After the data profile is created, it will never be updated.",
"The data profile can be updated up to once every 24 hours.",
"The data profile can be updated up to once every 30 days. Default."
],
"type": "string"
},
"types": {
"description": "The type of events to consider when deciding if the table has been modified and should have the profile updated. Defaults to MODIFIED_TIMESTAMP.",
"items": {
"enum": [
"TABLE_MODIFICATION_UNSPECIFIED",
"TABLE_MODIFIED_TIMESTAMP"
],
"enumDescriptions": [
"Unused.",
"A table will be considered modified when the last_modified_time from BigQuery has been updated."
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DiscoveryTarget": {
"description": "Target used to match against for Discovery.",
"id": "GooglePrivacyDlpV2DiscoveryTarget",
"properties": {
"bigQueryTarget": {
"$ref": "GooglePrivacyDlpV2BigQueryDiscoveryTarget",
"description": "BigQuery target for Discovery. The first target to match a table will be the one applied."
},
"cloudSqlTarget": {
"$ref": "GooglePrivacyDlpV2CloudSqlDiscoveryTarget",
"description": "Cloud SQL target for Discovery. The first target to match a table will be the one applied."
},
"cloudStorageTarget": {
"$ref": "GooglePrivacyDlpV2CloudStorageDiscoveryTarget",
"description": "Cloud Storage target for Discovery. The first target to match a table will be the one applied."
},
"otherCloudTarget": {
"$ref": "GooglePrivacyDlpV2OtherCloudDiscoveryTarget",
"description": "Other clouds target for discovery. The first target to match a resource will be the one applied."
},
"secretsTarget": {
"$ref": "GooglePrivacyDlpV2SecretsDiscoveryTarget",
"description": "Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed."
},
"vertexDatasetTarget": {
"$ref": "GooglePrivacyDlpV2VertexDatasetDiscoveryTarget",
"description": "Vertex AI dataset target for Discovery. The first target to match a dataset will be the one applied. Note that discovery for Vertex AI can incur Cloud Storage Class B operation charges for storage.objects.get operations and retrieval fees. For more information, see [Cloud Storage pricing](https://cloud.google.com/storage/pricing#price-tables). Note that discovery for Vertex AI dataset will not be able to scan images unless DiscoveryConfig.processing_location.image_fallback_location has multi_region_processing or global_processing configured."
}
},
"type": "object"
},
"GooglePrivacyDlpV2DiscoveryVertexDatasetConditions": {
"description": "Requirements that must be true before a dataset is profiled for the first time.",
"id": "GooglePrivacyDlpV2DiscoveryVertexDatasetConditions",
"properties": {
"createdAfter": {
"description": "Vertex AI dataset must have been created after this date. Used to avoid backfilling.",
"format": "google-datetime",
"type": "string"
},
"minAge": {
"description": "Minimum age a Vertex AI dataset must have. If set, the value must be 1 hour or greater.",
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DiscoveryVertexDatasetFilter": {
"description": "Determines what datasets will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID or dataset regex.",
"id": "GooglePrivacyDlpV2DiscoveryVertexDatasetFilter",
"properties": {
"collection": {
"$ref": "GooglePrivacyDlpV2VertexDatasetCollection",
"description": "A specific set of Vertex AI datasets for this filter to apply to."
},
"others": {
"$ref": "GooglePrivacyDlpV2AllOtherResources",
"description": "Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically."
},
"vertexDatasetResourceReference": {
"$ref": "GooglePrivacyDlpV2VertexDatasetResourceReference",
"description": "The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference)."
}
},
"type": "object"
},
"GooglePrivacyDlpV2DiscoveryVertexDatasetGenerationCadence": {
"description": "How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity.",
"id": "GooglePrivacyDlpV2DiscoveryVertexDatasetGenerationCadence",
"properties": {
"inspectTemplateModifiedCadence": {
"$ref": "GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence",
"description": "Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to be updated."
},
"refreshFrequency": {
"description": "If you set this field, profiles are refreshed at this frequency regardless of whether the underlying datasets have changed. Defaults to never.",
"enum": [
"UPDATE_FREQUENCY_UNSPECIFIED",
"UPDATE_FREQUENCY_NEVER",
"UPDATE_FREQUENCY_DAILY",
"UPDATE_FREQUENCY_MONTHLY"
],
"enumDescriptions": [
"Unspecified.",
"After the data profile is created, it will never be updated.",
"The data profile can be updated up to once every 24 hours.",
"The data profile can be updated up to once every 30 days. Default."
],
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DlpJob": {
"description": "Combines all of the information about a DLP job.",
"id": "GooglePrivacyDlpV2DlpJob",
"properties": {
"actionDetails": {
"description": "Events that should occur after the job has completed.",
"items": {
"$ref": "GooglePrivacyDlpV2ActionDetails"
},
"type": "array"
},
"createTime": {
"description": "Time when the job was created.",
"format": "google-datetime",
"type": "string"
},
"endTime": {
"description": "Time when the job finished.",
"format": "google-datetime",
"type": "string"
},
"errors": {
"description": "A stream of errors encountered running the job.",
"items": {
"$ref": "GooglePrivacyDlpV2Error"
},
"type": "array"
},
"inspectDetails": {
"$ref": "GooglePrivacyDlpV2InspectDataSourceDetails",
"description": "Results from inspecting a data source."
},
"jobTriggerName": {
"description": "If created by a job trigger, the resource name of the trigger that instantiated the job.",
"type": "string"
},
"lastModified": {
"description": "Time when the job was last modified by the system.",
"format": "google-datetime",
"type": "string"
},
"name": {
"description": "The server-assigned name.",
"type": "string"
},
"riskDetails": {
"$ref": "GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails",
"description": "Results from analyzing risk of a data source."
},
"startTime": {
"description": "Time when the job started.",
"format": "google-datetime",
"type": "string"
},
"state": {
"description": "State of a job.",
"enum": [
"JOB_STATE_UNSPECIFIED",
"PENDING",
"RUNNING",
"DONE",
"CANCELED",
"FAILED",
"ACTIVE"
],
"enumDescriptions": [
"Unused.",
"The job has not yet started.",
"The job is currently running. Once a job has finished it will transition to FAILED or DONE.",
"The job is no longer running.",
"The job was canceled before it could be completed.",
"The job had an error and did not complete.",
"The job is currently accepting findings via hybridInspect. A hybrid job in ACTIVE state may continue to have findings added to it through the calling of hybridInspect. After the job has finished no more calls to hybridInspect may be made. ACTIVE jobs can transition to DONE."
],
"type": "string"
},
"type": {
"description": "The type of job.",
"enum": [
"DLP_JOB_TYPE_UNSPECIFIED",
"INSPECT_JOB",
"RISK_ANALYSIS_JOB"
],
"enumDescriptions": [
"Defaults to INSPECT_JOB.",
"The job inspected Google Cloud for sensitive data.",
"The job executed a Risk Analysis computation."
],
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DocumentFallbackLocation": {
"description": "Configure document processing to fall back to any of the following processing options if document processing is unavailable in the original request location.",
"id": "GooglePrivacyDlpV2DocumentFallbackLocation",
"properties": {
"globalProcessing": {
"$ref": "GooglePrivacyDlpV2GlobalProcessing",
"description": "Processing occurs in the global region."
},
"multiRegionProcessing": {
"$ref": "GooglePrivacyDlpV2MultiRegionProcessing",
"description": "Processing occurs in a multi-region that contains the current region if available."
}
},
"type": "object"
},
"GooglePrivacyDlpV2DocumentLocation": {
"description": "Location of a finding within a document.",
"id": "GooglePrivacyDlpV2DocumentLocation",
"properties": {
"fileOffset": {
"description": "Offset of the line, from the beginning of the file, where the finding is located.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2Domain": {
"description": "A domain represents a thematic category that a data profile can fall under.",
"id": "GooglePrivacyDlpV2Domain",
"properties": {
"category": {
"description": "A domain category that this profile is related to.",
"enum": [
"CATEGORY_UNSPECIFIED",
"AI",
"CODE"
],
"enumDescriptions": [
"Category unspecified.",
"Indicates that the data profile is related to artificial intelligence. When set, all findings stored to Security Command Center will set the corresponding AI domain field of `Finding` objects.",
"Indicates that the data profile is related to code."
],
"type": "string"
},
"signals": {
"description": "The collection of signals that influenced selection of the category.",
"items": {
"enum": [
"SIGNAL_UNSPECIFIED",
"MODEL",
"TEXT_EMBEDDING",
"VERTEX_PLUGIN",
"VECTOR_PLUGIN",
"SOURCE_CODE",
"SERVICE"
],
"enumDescriptions": [
"Unused.",
"One or more machine learning models are present.",
"A table appears to be a text embedding.",
"The [Cloud SQL Vertex AI](https://cloud.google.com/sql/docs/postgres/integrate-cloud-sql-with-vertex-ai) plugin is installed on the database.",
"Support for [Cloud SQL vector embeddings](https://cloud.google.com/sql/docs/mysql/enable-vector-search) is enabled on the database.",
"Source code is present.",
"If the service determines the category type. For example, Vertex AI assets would always have a `Category` of `AI`."
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2Encloses": {
"description": "Defines a condition where one bounding box encloses another.",
"id": "GooglePrivacyDlpV2Encloses",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2EntityId": {
"description": "An entity in a dataset is a field or set of fields that correspond to a single person. For example, in medical records the `EntityId` might be a patient identifier, or for financial records it might be an account identifier. This message is used when generalizations or analysis must take into account that multiple rows correspond to the same entity.",
"id": "GooglePrivacyDlpV2EntityId",
"properties": {
"field": {
"$ref": "GooglePrivacyDlpV2FieldId",
"description": "Composite key indicating which field contains the entity identifier."
}
},
"type": "object"
},
"GooglePrivacyDlpV2Error": {
"description": "Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger.",
"id": "GooglePrivacyDlpV2Error",
"properties": {
"details": {
"$ref": "GoogleRpcStatus",
"description": "Detailed error codes and messages."
},
"extraInfo": {
"description": "Additional information about the error.",
"enum": [
"ERROR_INFO_UNSPECIFIED",
"IMAGE_SCAN_UNAVAILABLE_IN_REGION",
"FILE_STORE_CLUSTER_UNSUPPORTED"
],
"enumDescriptions": [
"Unused.",
"Image scan is not available in the region.",
"File store cluster is not supported for profile generation."
],
"type": "string"
},
"timestamps": {
"description": "The times the error occurred. List includes the oldest timestamp and the last 9 timestamps.",
"items": {
"format": "google-datetime",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2ExcludeByHotword": {
"description": "The rule to exclude findings based on a hotword. For record inspection of tables, column names are considered hotwords. An example of this is to exclude a finding if it belongs to a BigQuery column that matches a specific pattern.",
"id": "GooglePrivacyDlpV2ExcludeByHotword",
"properties": {
"hotwordRegex": {
"$ref": "GooglePrivacyDlpV2Regex",
"description": "Regular expression pattern defining what qualifies as a hotword."
},
"proximity": {
"$ref": "GooglePrivacyDlpV2Proximity",
"description": "Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The windowBefore property in proximity should be set to 1 if the hotword needs to be included in a column header."
}
},
"type": "object"
},
"GooglePrivacyDlpV2ExcludeByImageFindings": {
"description": "The rule to exclude image findings based on spatial relationships with other image findings. For example, exclude an image finding if it overlaps with another image finding. This rule is silently ignored if the content being inspected is not an image.",
"id": "GooglePrivacyDlpV2ExcludeByImageFindings",
"properties": {
"imageContainmentType": {
"$ref": "GooglePrivacyDlpV2ImageContainmentType",
"description": "Specifies the required spatial relationship between the bounding boxes of the target finding and the context infoType findings."
},
"infoTypes": {
"description": "A list of image-supported infoTypes\u2014excluding [document infoTypes](https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#documents)\u2014to be used as context for the exclusion rule. A finding is excluded if its bounding box has the specified spatial relationship (defined by `image_containment_type`) with a finding of an infoType in this list. For example, if `InspectionRuleSet.info_types` includes `OBJECT_TYPE/PERSON` and this `exclusion_rule` specifies `info_types` as `OBJECT_TYPE/PERSON/PASSPORT` with `image_containment_type` set to `encloses`, then `OBJECT_TYPE/PERSON` findings will be excluded if they are fully contained within the bounding box of an `OBJECT_TYPE/PERSON/PASSPORT` finding.",
"items": {
"$ref": "GooglePrivacyDlpV2InfoType"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2ExcludeInfoTypes": {
"description": "List of excluded infoTypes.",
"id": "GooglePrivacyDlpV2ExcludeInfoTypes",
"properties": {
"infoTypes": {
"description": "InfoType list in ExclusionRule rule drops a finding when it overlaps or contained within with a finding of an infoType from this list. For example, for `InspectionRuleSet.info_types` containing \"PHONE_NUMBER\"` and `exclusion_rule` containing `exclude_info_types.info_types` with \"EMAIL_ADDRESS\" the phone number findings are dropped if they overlap with EMAIL_ADDRESS finding. That leads to \"555-222-2222@example.org\" to generate only a single finding, namely email address.",
"items": {
"$ref": "GooglePrivacyDlpV2InfoType"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2ExclusionRule": {
"description": "The rule that specifies conditions when findings of infoTypes specified in `InspectionRuleSet` are removed from results.",
"id": "GooglePrivacyDlpV2ExclusionRule",
"properties": {
"dictionary": {
"$ref": "GooglePrivacyDlpV2Dictionary",
"description": "Dictionary which defines the rule."
},
"excludeByHotword": {
"$ref": "GooglePrivacyDlpV2ExcludeByHotword",
"description": "Drop if the hotword rule is contained in the proximate context. For tabular data, the context includes the column name."
},
"excludeByImageFindings": {
"$ref": "GooglePrivacyDlpV2ExcludeByImageFindings",
"description": "Exclude findings based on image containment rules. For example, exclude an image finding if it overlaps with another image finding."
},
"excludeInfoTypes": {
"$ref": "GooglePrivacyDlpV2ExcludeInfoTypes",
"description": "Set of infoTypes for which findings would affect this rule."
},
"matchingType": {
"description": "How the rule is applied, see MatchingType documentation for details.",
"enum": [
"MATCHING_TYPE_UNSPECIFIED",
"MATCHING_TYPE_FULL_MATCH",
"MATCHING_TYPE_PARTIAL_MATCH",
"MATCHING_TYPE_INVERSE_MATCH",
"MATCHING_TYPE_RULE_SPECIFIC"
],
"enumDescriptions": [
"Invalid.",
"Full match. - Dictionary: join of Dictionary results matched the complete finding quote - Regex: all regex matches fill a finding quote from start to end - Exclude infoType: completely inside affecting infoTypes findings",
"Partial match. - Dictionary: at least one of the tokens in the finding matches - Regex: substring of the finding matches - Exclude infoType: intersects with affecting infoTypes findings",
"Inverse match. - Dictionary: no tokens in the finding match the dictionary - Regex: finding doesn't match the regex - Exclude infoType: no intersection with affecting infoTypes findings",
"Rule-specific match. The matching logic is based on the specific rule being used. This is required for rules where the matching behavior is not a simple string comparison (e.g., image containment). This matching type can only be used with the `ExcludeByImageFindings` rule. - Exclude by image findings: The matching logic is defined within `ExcludeByImageFindings` based on spatial relationships between bounding boxes."
],
"type": "string"
},
"regex": {
"$ref": "GooglePrivacyDlpV2Regex",
"description": "Regular expression which defines the rule."
}
},
"type": "object"
},
"GooglePrivacyDlpV2Export": {
"description": "If set, the detailed data profiles will be persisted to the location of your choice whenever updated.",
"id": "GooglePrivacyDlpV2Export",
"properties": {
"profileTable": {
"$ref": "GooglePrivacyDlpV2BigQueryTable",
"description": "Store all profiles to BigQuery. * The system will create a new dataset and table for you if none are are provided. The dataset will be named `sensitive_data_protection_discovery` and table will be named `discovery_profiles`. This table will be placed in the same project as the container project running the scan. After the first profile is generated and the dataset and table are created, the discovery scan configuration will be updated with the dataset and table names. * See [Analyze data profiles stored in BigQuery](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles). * See [Sample queries for your BigQuery table](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#sample_sql_queries). * Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished. * The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification. * The best practice is to use the same table for an entire organization so that you can take advantage of the [provided Looker reports](https://cloud.google.com/sensitive-data-protection/docs/analyze-data-profiles#use_a_premade_report). If you use VPC Service Controls to define security perimeters, then you must use a separate table for each boundary."
},
"sampleFindingsTable": {
"$ref": "GooglePrivacyDlpV2BigQueryTable",
"description": "Store sample data profile findings in an existing table or a new table in an existing dataset. Each regeneration will result in new rows in BigQuery. Data is inserted using [streaming insert](https://cloud.google.com/blog/products/bigquery/life-of-a-bigquery-streaming-insert) and so data may be in the buffer for a period of time after the profile has finished."
}
},
"type": "object"
},
"GooglePrivacyDlpV2Expressions": {
"description": "An expression, consisting of an operator and conditions.",
"id": "GooglePrivacyDlpV2Expressions",
"properties": {
"conditions": {
"$ref": "GooglePrivacyDlpV2Conditions",
"description": "Conditions to apply to the expression."
},
"logicalOperator": {
"description": "The operator to apply to the result of conditions. Default and currently only supported value is `AND`.",
"enum": [
"LOGICAL_OPERATOR_UNSPECIFIED",
"AND"
],
"enumDescriptions": [
"Unused",
"Conditional AND"
],
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2FieldId": {
"description": "General identifier of a data field in a storage service.",
"id": "GooglePrivacyDlpV2FieldId",
"properties": {
"name": {
"description": "Name describing the field.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2FieldTransformation": {
"description": "The transformation to apply to the field.",
"id": "GooglePrivacyDlpV2FieldTransformation",
"properties": {
"condition": {
"$ref": "GooglePrivacyDlpV2RecordCondition",
"description": "Only apply the transformation if the condition evaluates to true for the given `RecordCondition`. The conditions are allowed to reference fields that are not used in the actual transformation. Example Use Cases: - Apply a different bucket transformation to an age column if the zip code column for the same record is within a specific range. - Redact a field if the date of birth field is greater than 85."
},
"fields": {
"description": "Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of \"contact.nums[0].type\", use \"contact.nums.type\".",
"items": {
"$ref": "GooglePrivacyDlpV2FieldId"
},
"type": "array"
},
"infoTypeTransformations": {
"$ref": "GooglePrivacyDlpV2InfoTypeTransformations",
"description": "Treat the contents of the field as free text, and selectively transform content that matches an `InfoType`."
},
"primitiveTransformation": {
"$ref": "GooglePrivacyDlpV2PrimitiveTransformation",
"description": "Apply the transformation to the entire field."
}
},
"type": "object"
},
"GooglePrivacyDlpV2FileClusterSummary": {
"description": "The file cluster summary.",
"id": "GooglePrivacyDlpV2FileClusterSummary",
"properties": {
"dataRiskLevel": {
"$ref": "GooglePrivacyDlpV2DataRiskLevel",
"description": "The data risk level of this cluster. RISK_LOW if nothing has been scanned."
},
"errors": {
"description": "A list of errors detected while scanning this cluster. The list is truncated to 10 per cluster.",
"items": {
"$ref": "GooglePrivacyDlpV2Error"
},
"type": "array"
},
"fileClusterType": {
"$ref": "GooglePrivacyDlpV2FileClusterType",
"description": "The file cluster type."
},
"fileExtensionsScanned": {
"description": "A sample of file types scanned in this cluster. Empty if no files were scanned. File extensions can be derived from the file name or the file content.",
"items": {
"$ref": "GooglePrivacyDlpV2FileExtensionInfo"
},
"type": "array"
},
"fileExtensionsSeen": {
"description": "A sample of file types seen in this cluster. Empty if no files were seen. File extensions can be derived from the file name or the file content.",
"items": {
"$ref": "GooglePrivacyDlpV2FileExtensionInfo"
},
"type": "array"
},
"fileStoreInfoTypeSummaries": {
"description": "InfoTypes detected in this cluster.",
"items": {
"$ref": "GooglePrivacyDlpV2FileStoreInfoTypeSummary"
},
"type": "array"
},
"noFilesExist": {
"description": "True if no files exist in this cluster. If the file store 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.",
"type": "boolean"
},
"sensitivityScore": {
"$ref": "GooglePrivacyDlpV2SensitivityScore",
"description": "The sensitivity score of this cluster. The score will be SENSITIVITY_LOW if nothing has been scanned."
}
},
"type": "object"
},
"GooglePrivacyDlpV2FileClusterType": {
"description": "Message used to identify file cluster type being profiled.",
"id": "GooglePrivacyDlpV2FileClusterType",
"properties": {
"cluster": {
"description": "Cluster type.",
"enum": [
"CLUSTER_UNSPECIFIED",
"CLUSTER_UNKNOWN",
"CLUSTER_TEXT",
"CLUSTER_STRUCTURED_DATA",
"CLUSTER_SOURCE_CODE",
"CLUSTER_RICH_DOCUMENT",
"CLUSTER_IMAGE",
"CLUSTER_ARCHIVE",
"CLUSTER_MULTIMEDIA",
"CLUSTER_EXECUTABLE",
"CLUSTER_AI_MODEL"
],
"enumDescriptions": [
"Unused.",
"Unsupported files.",
"Plain text.",
"Structured data like CSV, TSV etc.",
"Source code.",
"Rich document like docx, xlsx etc.",
"Images like jpeg, bmp.",
"Archives and containers like .zip, .tar etc.",
"Multimedia like .mp4, .avi etc.",
"Executable files like .exe, .class, .apk etc.",
"AI models like .tflite etc."
],
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2FileExtensionInfo": {
"description": "Information regarding the discovered file extension.",
"id": "GooglePrivacyDlpV2FileExtensionInfo",
"properties": {
"fileExtension": {
"description": "The file extension if set. (aka .pdf, .jpg, .txt)",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2FileSet": {
"description": "Set of files to scan.",
"id": "GooglePrivacyDlpV2FileSet",
"properties": {
"regexFileSet": {
"$ref": "GooglePrivacyDlpV2CloudStorageRegexFileSet",
"description": "The regex-filtered set of files to scan. Exactly one of `url` or `regex_file_set` must be set."
},
"url": {
"description": "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.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2FileStoreCollection": {
"description": "Match file stores (e.g. buckets) using filters.",
"id": "GooglePrivacyDlpV2FileStoreCollection",
"properties": {
"includeRegexes": {
"$ref": "GooglePrivacyDlpV2FileStoreRegexes",
"description": "Optional. A collection of regular expressions to match a file store against."
},
"includeTags": {
"$ref": "GooglePrivacyDlpV2TagFilters",
"description": "Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. For more information, see [Manage schedules](https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules)."
}
},
"type": "object"
},
"GooglePrivacyDlpV2FileStoreDataProfile": {
"description": "The profile for a file store. * Cloud Storage: maps 1:1 with a bucket. * Amazon S3: maps 1:1 with a bucket.",
"id": "GooglePrivacyDlpV2FileStoreDataProfile",
"properties": {
"configSnapshot": {
"$ref": "GooglePrivacyDlpV2DataProfileConfigSnapshot",
"description": "The snapshot of the configurations used to generate the profile."
},
"createTime": {
"description": "The time the file store was first created.",
"format": "google-datetime",
"type": "string"
},
"dataRiskLevel": {
"$ref": "GooglePrivacyDlpV2DataRiskLevel",
"description": "The data risk level of this resource."
},
"dataSourceType": {
"$ref": "GooglePrivacyDlpV2DataSourceType",
"description": "The resource type that was profiled."
},
"dataStorageLocations": {
"description": "For resources that have multiple storage locations, these are those regions. For 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.",
"items": {
"type": "string"
},
"type": "array"
},
"domains": {
"description": "Domains associated with the profile.",
"items": {
"$ref": "GooglePrivacyDlpV2Domain"
},
"type": "array"
},
"fileClusterSummaries": {
"description": "FileClusterSummary per each cluster.",
"items": {
"$ref": "GooglePrivacyDlpV2FileClusterSummary"
},
"type": "array"
},
"fileStoreInfoTypeSummaries": {
"description": "InfoTypes detected in this file store.",
"items": {
"$ref": "GooglePrivacyDlpV2FileStoreInfoTypeSummary"
},
"type": "array"
},
"fileStoreIsEmpty": {
"description": "The file store does not have any files. If the profiling operation failed, this is false.",
"type": "boolean"
},
"fileStoreLocation": {
"description": "The location of the file store. * Cloud Storage: https://cloud.google.com/storage/docs/locations#available-locations * Amazon S3: https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints",
"type": "string"
},
"fileStorePath": {
"description": "The file store path. * Cloud Storage: `gs://{bucket}` * Amazon S3: `s3://{bucket}` * Vertex AI dataset: `projects/{project_number}/locations/{location}/datasets/{dataset_id}`",
"type": "string"
},
"fullResource": {
"description": "The resource name of the resource profiled. https://cloud.google.com/apis/design/resource_names#full_resource_name Example format of an S3 bucket full resource name: `//cloudasset.googleapis.com/organizations/{org_id}/otherCloudConnections/aws/arn:aws:s3:::{bucket_name}`",
"type": "string"
},
"lastModifiedTime": {
"description": "The time the file store was last modified.",
"format": "google-datetime",
"type": "string"
},
"locationType": {
"description": "The location type of the file store (region, dual-region, multi-region, etc). If dual-region, expect data_storage_locations to be populated.",
"type": "string"
},
"name": {
"description": "The name of the profile.",
"type": "string"
},
"profileLastGenerated": {
"description": "The last time the profile was generated.",
"format": "google-datetime",
"type": "string"
},
"profileStatus": {
"$ref": "GooglePrivacyDlpV2ProfileStatus",
"description": "Success or error status from the most recent profile generation attempt. May be empty if the profile is still being generated."
},
"projectDataProfile": {
"description": "The resource name of the project data profile for this file store.",
"type": "string"
},
"projectId": {
"description": "The Google Cloud project ID that owns the resource. For Amazon S3 buckets, this is the AWS Account Id.",
"type": "string"
},
"relatedResources": {
"description": "Resources related to this profile.",
"items": {
"$ref": "GooglePrivacyDlpV2RelatedResource"
},
"type": "array"
},
"resourceAttributes": {
"additionalProperties": {
"$ref": "GooglePrivacyDlpV2Value"
},
"description": "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.",
"type": "object"
},
"resourceLabels": {
"additionalProperties": {
"type": "string"
},
"description": "The labels applied to the resource at the time the profile was generated.",
"type": "object"
},
"resourceVisibility": {
"description": "How broadly a resource has been shared.",
"enum": [
"RESOURCE_VISIBILITY_UNSPECIFIED",
"RESOURCE_VISIBILITY_PUBLIC",
"RESOURCE_VISIBILITY_INCONCLUSIVE",
"RESOURCE_VISIBILITY_RESTRICTED"
],
"enumDescriptions": [
"Unused.",
"Visible to any user.",
"May contain public items. For example, if a Cloud Storage bucket has uniform bucket level access disabled, some objects inside it may be public, but none are known yet.",
"Visible only to specific users."
],
"type": "string"
},
"sampleFindingsTable": {
"$ref": "GooglePrivacyDlpV2BigQueryTable",
"description": "The BigQuery table to which the sample findings are written."
},
"sensitivityScore": {
"$ref": "GooglePrivacyDlpV2SensitivityScore",
"description": "The sensitivity score of this resource."
},
"state": {
"description": "State of a profile.",
"enum": [
"STATE_UNSPECIFIED",
"RUNNING",
"DONE"
],
"enumDescriptions": [
"Unused.",
"The profile is currently running. Once a profile has finished it will transition to DONE.",
"The profile is no longer generating. If profile_status.status.code is 0, the profile succeeded, otherwise, it failed."
],
"type": "string"
},
"tags": {
"description": "The tags attached to the resource, including any tags attached during profiling.",
"items": {
"$ref": "GooglePrivacyDlpV2Tag"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2FileStoreInfoTypeSummary": {
"description": "Information regarding the discovered InfoType.",
"id": "GooglePrivacyDlpV2FileStoreInfoTypeSummary",
"properties": {
"infoType": {
"$ref": "GooglePrivacyDlpV2InfoType",
"description": "The InfoType seen."
}
},
"type": "object"
},
"GooglePrivacyDlpV2FileStoreRegex": {
"description": "A pattern to match against one or more file stores.",
"id": "GooglePrivacyDlpV2FileStoreRegex",
"properties": {
"cloudStorageRegex": {
"$ref": "GooglePrivacyDlpV2CloudStorageRegex",
"description": "Optional. Regex for Cloud Storage."
}
},
"type": "object"
},
"GooglePrivacyDlpV2FileStoreRegexes": {
"description": "A collection of regular expressions to determine what file store to match against.",
"id": "GooglePrivacyDlpV2FileStoreRegexes",
"properties": {
"patterns": {
"description": "Required. The group of regular expression patterns to match against one or more file stores. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB.",
"items": {
"$ref": "GooglePrivacyDlpV2FileStoreRegex"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2Finding": {
"description": "Represents a piece of potentially sensitive content.",
"id": "GooglePrivacyDlpV2Finding",
"properties": {
"createTime": {
"description": "Timestamp when finding was detected.",
"format": "google-datetime",
"type": "string"
},
"findingId": {
"description": "The unique finding id.",
"type": "string"
},
"infoType": {
"$ref": "GooglePrivacyDlpV2InfoType",
"description": "The type of content that might have been found. Provided if `excluded_types` is false."
},
"jobCreateTime": {
"description": "Time the job started that produced this finding.",
"format": "google-datetime",
"type": "string"
},
"jobName": {
"description": "The job that stored the finding.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "The labels associated with this `Finding`. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels can be associated with a given finding. Examples: * `\"environment\" : \"production\"` * `\"pipeline\" : \"etl\"`",
"type": "object"
},
"likelihood": {
"description": "Confidence of how likely it is that the `info_type` is correct.",
"enum": [
"LIKELIHOOD_UNSPECIFIED",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Default value; same as POSSIBLE.",
"Highest chance of a false positive.",
"High chance of a false positive.",
"Some matching signals. The default value.",
"Low chance of a false positive.",
"Confidence level is high. Lowest chance of a false positive."
],
"type": "string"
},
"location": {
"$ref": "GooglePrivacyDlpV2Location",
"description": "Where the content was found."
},
"name": {
"description": "Resource name in format projects/{project}/locations/{location}/findings/{finding} Populated only when viewing persisted findings.",
"type": "string"
},
"quote": {
"description": "The content that was found. Even if the content is not textual, it may be converted to a textual representation here. Provided if `include_quote` is true and the finding is less than or equal to 4096 bytes long. If the finding exceeds 4096 bytes in length, the quote may be omitted.",
"type": "string"
},
"quoteInfo": {
"$ref": "GooglePrivacyDlpV2QuoteInfo",
"description": "Contains data parsed from quotes. Only populated if include_quote was set to true and a supported infoType was requested. Currently supported infoTypes: DATE, DATE_OF_BIRTH and TIME."
},
"resourceName": {
"description": "The job that stored the finding.",
"type": "string"
},
"triggerName": {
"description": "Job trigger name, if applicable, for this finding.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2FindingLimits": {
"description": "Configuration to control the number of findings returned for inspection. This is not used for de-identification or 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 requests. Otherwise, Cloud DLP returns an error.",
"id": "GooglePrivacyDlpV2FindingLimits",
"properties": {
"maxFindingsPerInfoType": {
"description": "Configuration of findings limit given for specified infoTypes.",
"items": {
"$ref": "GooglePrivacyDlpV2InfoTypeLimit"
},
"type": "array"
},
"maxFindingsPerItem": {
"description": "Max number of findings that are returned for each item scanned. When set within an InspectContentRequest, this field is ignored. This value isn't a hard limit. If the number of findings for an item reaches this limit, the inspection of that item ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns for the item can be multiple times higher than this value.",
"format": "int32",
"type": "integer"
},
"maxFindingsPerRequest": {
"description": "Max number of findings that are returned per request or job. If you set this field in an InspectContentRequest, the resulting maximum value is the value that you set or 3,000, whichever is lower. This value isn't a hard limit. If an inspection reaches this limit, the inspection ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns can be multiple times higher than this value.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GooglePrivacyDlpV2FinishDlpJobRequest": {
"description": "The request message for finishing a DLP hybrid job.",
"id": "GooglePrivacyDlpV2FinishDlpJobRequest",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2FixedSizeBucketingConfig": {
"description": "Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with \"10-20\". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to learn more.",
"id": "GooglePrivacyDlpV2FixedSizeBucketingConfig",
"properties": {
"bucketSize": {
"description": "Required. Size of each bucket (except for minimum and maximum buckets). So if `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works.",
"format": "double",
"type": "number"
},
"lowerBound": {
"$ref": "GooglePrivacyDlpV2Value",
"description": "Required. Lower bound value of buckets. All values less than `lower_bound` are grouped together into a single bucket; for example if `lower_bound` = 10, then all values less than 10 are replaced with the value \"-10\"."
},
"upperBound": {
"$ref": "GooglePrivacyDlpV2Value",
"description": "Required. Upper bound value of buckets. All values greater than upper_bound are grouped together into a single bucket; for example if `upper_bound` = 89, then all values greater than 89 are replaced with the value \"89+\"."
}
},
"type": "object"
},
"GooglePrivacyDlpV2FullyInside": {
"description": "Defines a condition where one bounding box is fully inside another.",
"id": "GooglePrivacyDlpV2FullyInside",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2GlobalProcessing": {
"description": "Processing occurs in the global region.",
"id": "GooglePrivacyDlpV2GlobalProcessing",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2HotwordRule": {
"description": "The rule that adjusts the likelihood of findings within a certain proximity of hotwords.",
"id": "GooglePrivacyDlpV2HotwordRule",
"properties": {
"hotwordRegex": {
"$ref": "GooglePrivacyDlpV2Regex",
"description": "Regular expression pattern defining what qualifies as a hotword."
},
"likelihoodAdjustment": {
"$ref": "GooglePrivacyDlpV2LikelihoodAdjustment",
"description": "Likelihood adjustment to apply to all matching findings."
},
"proximity": {
"$ref": "GooglePrivacyDlpV2Proximity",
"description": "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/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values)."
}
},
"type": "object"
},
"GooglePrivacyDlpV2HybridContentItem": {
"description": "An individual hybrid item to inspect. Will be stored temporarily during processing.",
"id": "GooglePrivacyDlpV2HybridContentItem",
"properties": {
"findingDetails": {
"$ref": "GooglePrivacyDlpV2HybridFindingDetails",
"description": "Supplementary information that will be added to each finding."
},
"item": {
"$ref": "GooglePrivacyDlpV2ContentItem",
"description": "The item to inspect."
}
},
"type": "object"
},
"GooglePrivacyDlpV2HybridFindingDetails": {
"description": "Populate to associate additional data with each finding.",
"id": "GooglePrivacyDlpV2HybridFindingDetails",
"properties": {
"containerDetails": {
"$ref": "GooglePrivacyDlpV2Container",
"description": "Details about the container where the content being inspected is from."
},
"fileOffset": {
"description": "Offset in bytes of the line, from the beginning of the file, where the finding is located. Populate if the item being scanned is only part of a bigger item, such as a shard of a file and you want to track the absolute position of the finding.",
"format": "int64",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to represent user provided metadata about the data being inspected. If configured by the job, some key values may be required. The labels associated with `Finding`'s produced by hybrid inspection. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels can be associated with a given finding. Examples: * `\"environment\" : \"production\"` * `\"pipeline\" : \"etl\"`",
"type": "object"
},
"rowOffset": {
"description": "Offset of the row for tables. Populate if the row(s) being scanned are part of a bigger dataset and you want to keep track of their absolute position.",
"format": "int64",
"type": "string"
},
"tableOptions": {
"$ref": "GooglePrivacyDlpV2TableOptions",
"description": "If the container is a table, additional information to make findings meaningful such as the columns that are primary keys. If not known ahead of time, can also be set within each inspect hybrid call and the two will be merged. Note that identifying_fields will only be stored to BigQuery, and only if the BigQuery action has been included."
}
},
"type": "object"
},
"GooglePrivacyDlpV2HybridInspectDlpJobRequest": {
"description": "Request to search for potentially sensitive info in a custom location.",
"id": "GooglePrivacyDlpV2HybridInspectDlpJobRequest",
"properties": {
"hybridItem": {
"$ref": "GooglePrivacyDlpV2HybridContentItem",
"description": "The item to inspect."
}
},
"type": "object"
},
"GooglePrivacyDlpV2HybridInspectJobTriggerRequest": {
"description": "Request to search for potentially sensitive info in a custom location.",
"id": "GooglePrivacyDlpV2HybridInspectJobTriggerRequest",
"properties": {
"hybridItem": {
"$ref": "GooglePrivacyDlpV2HybridContentItem",
"description": "The item to inspect."
}
},
"type": "object"
},
"GooglePrivacyDlpV2HybridInspectResponse": {
"description": "Quota exceeded errors will be thrown once quota has been met.",
"id": "GooglePrivacyDlpV2HybridInspectResponse",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2HybridInspectStatistics": {
"description": "Statistics related to processing hybrid inspect requests.",
"id": "GooglePrivacyDlpV2HybridInspectStatistics",
"properties": {
"abortedCount": {
"description": "The number of hybrid inspection requests aborted because the job ran out of quota or was ended before they could be processed.",
"format": "int64",
"type": "string"
},
"pendingCount": {
"description": "The number of hybrid requests currently being processed. Only populated when called via method `getDlpJob`. A burst of traffic may cause hybrid inspect requests to be enqueued. Processing will take place as quickly as possible, but resource limitations may impact how long a request is enqueued for.",
"format": "int64",
"type": "string"
},
"processedCount": {
"description": "The number of hybrid inspection requests processed within this job.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2HybridOptions": {
"description": "Configuration to control jobs where the content being inspected is outside of Google Cloud Platform.",
"id": "GooglePrivacyDlpV2HybridOptions",
"properties": {
"description": {
"description": "A short description of where the data is coming from. Will be stored once in the job. 256 max length.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "To organize findings, these labels will be added to each finding. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels can be associated with a given finding. Examples: * `\"environment\" : \"production\"` * `\"pipeline\" : \"etl\"`",
"type": "object"
},
"requiredFindingLabelKeys": {
"description": "These are labels that each inspection request must include within their 'finding_labels' map. Request may contain others, but any missing one of these will be rejected. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. No more than 10 keys can be required.",
"items": {
"type": "string"
},
"type": "array"
},
"tableOptions": {
"$ref": "GooglePrivacyDlpV2TableOptions",
"description": "If the container is a table, additional information to make findings meaningful such as the columns that are primary keys."
}
},
"type": "object"
},
"GooglePrivacyDlpV2ImageContainmentType": {
"description": "Specifies the relationship between bounding boxes for image findings.",
"id": "GooglePrivacyDlpV2ImageContainmentType",
"properties": {
"encloses": {
"$ref": "GooglePrivacyDlpV2Encloses",
"description": "The context finding's bounding box must fully contain the target finding's bounding box."
},
"fullyInside": {
"$ref": "GooglePrivacyDlpV2FullyInside",
"description": "The context finding's bounding box must be fully inside the target finding's bounding box."
},
"overlaps": {
"$ref": "GooglePrivacyDlpV2Overlap",
"description": "The context finding's bounding box and the target finding's bounding box must have a non-zero intersection."
}
},
"type": "object"
},
"GooglePrivacyDlpV2ImageFallbackLocation": {
"description": "Configure image processing to fall back to any of the following processing options if image processing is unavailable in the original request location.",
"id": "GooglePrivacyDlpV2ImageFallbackLocation",
"properties": {
"globalProcessing": {
"$ref": "GooglePrivacyDlpV2GlobalProcessing",
"description": "Processing occurs in the global region."
},
"multiRegionProcessing": {
"$ref": "GooglePrivacyDlpV2MultiRegionProcessing",
"description": "Processing occurs in a multi-region that contains the current region if available."
}
},
"type": "object"
},
"GooglePrivacyDlpV2ImageLocation": {
"description": "Location of the finding within an image.",
"id": "GooglePrivacyDlpV2ImageLocation",
"properties": {
"boundingBoxes": {
"description": "Bounding boxes locating the pixels within the image containing the finding.",
"items": {
"$ref": "GooglePrivacyDlpV2BoundingBox"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2ImageRedactionConfig": {
"description": "Configuration for determining how redaction of images should occur.",
"id": "GooglePrivacyDlpV2ImageRedactionConfig",
"properties": {
"infoType": {
"$ref": "GooglePrivacyDlpV2InfoType",
"description": "Only one per info_type should be provided per request. If not specified, and redact_all_text is false, the DLP API will redact all text that it matches against all info_types that are found, but not specified in another ImageRedactionConfig."
},
"redactAllText": {
"description": "If true, all text found in the image, regardless whether it matches an info_type, is redacted. Only one should be provided.",
"type": "boolean"
},
"redactionColor": {
"$ref": "GooglePrivacyDlpV2Color",
"description": "The color to use when redacting content from an image. If not specified, the default is black."
}
},
"type": "object"
},
"GooglePrivacyDlpV2ImageTransformation": {
"description": "Configuration for determining how redaction of images should occur.",
"id": "GooglePrivacyDlpV2ImageTransformation",
"properties": {
"allInfoTypes": {
"$ref": "GooglePrivacyDlpV2AllInfoTypes",
"description": "Apply transformation to all findings not specified in other ImageTransformation's selected_info_types. Only one instance is allowed within the ImageTransformations message."
},
"allText": {
"$ref": "GooglePrivacyDlpV2AllText",
"description": "Apply transformation to all text that doesn't match an infoType. Only one instance is allowed within the ImageTransformations message."
},
"redactionColor": {
"$ref": "GooglePrivacyDlpV2Color",
"description": "The color to use when redacting content from an image. If not specified, the default is black."
},
"selectedInfoTypes": {
"$ref": "GooglePrivacyDlpV2SelectedInfoTypes",
"description": "Apply transformation to the selected info_types."
}
},
"type": "object"
},
"GooglePrivacyDlpV2ImageTransformations": {
"description": "A type of transformation that is applied over images.",
"id": "GooglePrivacyDlpV2ImageTransformations",
"properties": {
"transforms": {
"description": "List of transforms to make.",
"items": {
"$ref": "GooglePrivacyDlpV2ImageTransformation"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2InfoType": {
"description": "Type of information detected by the API.",
"id": "GooglePrivacyDlpV2InfoType",
"properties": {
"name": {
"description": "Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`.",
"type": "string"
},
"sensitivityScore": {
"$ref": "GooglePrivacyDlpV2SensitivityScore",
"description": "Optional custom sensitivity for this InfoType. This only applies to data profiling."
},
"version": {
"description": "Optional version name for this InfoType.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2InfoTypeCategory": {
"description": "Classification of infoTypes to organize them according to geographic location, industry, and data type.",
"id": "GooglePrivacyDlpV2InfoTypeCategory",
"properties": {
"industryCategory": {
"description": "The group of relevant businesses where this infoType is commonly used",
"enum": [
"INDUSTRY_UNSPECIFIED",
"FINANCE",
"HEALTH",
"TELECOMMUNICATIONS"
],
"enumDescriptions": [
"Unused industry",
"The infoType is typically used in the finance industry.",
"The infoType is typically used in the health industry.",
"The infoType is typically used in the telecommunications industry."
],
"type": "string"
},
"locationCategory": {
"description": "The region or country that issued the ID or document represented by the infoType.",
"enum": [
"LOCATION_UNSPECIFIED",
"GLOBAL",
"ARGENTINA",
"ARMENIA",
"AUSTRALIA",
"AUSTRIA",
"AZERBAIJAN",
"BELARUS",
"BELGIUM",
"BRAZIL",
"CANADA",
"CHILE",
"CHINA",
"COLOMBIA",
"CROATIA",
"CZECHIA",
"DENMARK",
"FRANCE",
"FINLAND",
"GERMANY",
"HONG_KONG",
"INDIA",
"INDONESIA",
"IRELAND",
"ISRAEL",
"ITALY",
"JAPAN",
"KAZAKHSTAN",
"KOREA",
"MEXICO",
"THE_NETHERLANDS",
"NEW_ZEALAND",
"NORWAY",
"PARAGUAY",
"PERU",
"POLAND",
"PORTUGAL",
"RUSSIA",
"SINGAPORE",
"SOUTH_AFRICA",
"SPAIN",
"SWEDEN",
"SWITZERLAND",
"TAIWAN",
"THAILAND",
"TURKEY",
"UKRAINE",
"UNITED_KINGDOM",
"UNITED_STATES",
"URUGUAY",
"UZBEKISTAN",
"VENEZUELA",
"INTERNAL"
],
"enumDescriptions": [
"Unused location",
"The infoType is not issued by or tied to a specific region, but is used almost everywhere.",
"The infoType is typically used in Argentina.",
"The infoType is typically used in Armenia.",
"The infoType is typically used in Australia.",
"The infoType is typically used in Austria.",
"The infoType is typically used in Azerbaijan.",
"The infoType is typically used in Belarus.",
"The infoType is typically used in Belgium.",
"The infoType is typically used in Brazil.",
"The infoType is typically used in Canada.",
"The infoType is typically used in Chile.",
"The infoType is typically used in China.",
"The infoType is typically used in Colombia.",
"The infoType is typically used in Croatia.",
"The infoType is typically used in Czechia.",
"The infoType is typically used in Denmark.",
"The infoType is typically used in France.",
"The infoType is typically used in Finland.",
"The infoType is typically used in Germany.",
"The infoType is typically used in Hong Kong.",
"The infoType is typically used in India.",
"The infoType is typically used in Indonesia.",
"The infoType is typically used in Ireland.",
"The infoType is typically used in Israel.",
"The infoType is typically used in Italy.",
"The infoType is typically used in Japan.",
"The infoType is typically used in Kazakhstan.",
"The infoType is typically used in Korea.",
"The infoType is typically used in Mexico.",
"The infoType is typically used in the Netherlands.",
"The infoType is typically used in New Zealand.",
"The infoType is typically used in Norway.",
"The infoType is typically used in Paraguay.",
"The infoType is typically used in Peru.",
"The infoType is typically used in Poland.",
"The infoType is typically used in Portugal.",
"The infoType is typically used in Russia.",
"The infoType is typically used in Singapore.",
"The infoType is typically used in South Africa.",
"The infoType is typically used in Spain.",
"The infoType is typically used in Sweden.",
"The infoType is typically used in Switzerland.",
"The infoType is typically used in Taiwan.",
"The infoType is typically used in Thailand.",
"The infoType is typically used in Turkey.",
"The infoType is typically used in Ukraine.",
"The infoType is typically used in the United Kingdom.",
"The infoType is typically used in the United States.",
"The infoType is typically used in Uruguay.",
"The infoType is typically used in Uzbekistan.",
"The infoType is typically used in Venezuela.",
"The infoType is typically used in Google internally."
],
"type": "string"
},
"typeCategory": {
"description": "The class of identifiers where this infoType belongs",
"enum": [
"TYPE_UNSPECIFIED",
"PII",
"SPII",
"DEMOGRAPHIC",
"CREDENTIAL",
"GOVERNMENT_ID",
"DOCUMENT",
"CONTEXTUAL_INFORMATION",
"CUSTOM"
],
"enumDescriptions": [
"Unused type",
"Personally identifiable information, for example, a name or phone number",
"Personally identifiable information that is especially sensitive, for example, a passport number.",
"Attributes that can partially identify someone, especially in combination with other attributes, like age, height, and gender.",
"Confidential or secret information, for example, a password.",
"An identification document issued by a government.",
"A document, for example, a resume or source code.",
"Information that is not sensitive on its own, but provides details about the circumstances surrounding an entity or an event.",
"Category for `CustomInfoType` types."
],
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2InfoTypeDescription": {
"description": "InfoType description.",
"id": "GooglePrivacyDlpV2InfoTypeDescription",
"properties": {
"categories": {
"description": "The category of the infoType.",
"items": {
"$ref": "GooglePrivacyDlpV2InfoTypeCategory"
},
"type": "array"
},
"description": {
"description": "Description of the infotype. Translated when language is provided in the request.",
"type": "string"
},
"displayName": {
"description": "Human readable form of the infoType name.",
"type": "string"
},
"example": {
"description": "A sample that is a true positive for this infoType.",
"type": "string"
},
"launchStatus": {
"description": "The launch status of the infoType.",
"enum": [
"INFO_TYPE_LAUNCH_STATUS_UNSPECIFIED",
"GENERAL_AVAILABILITY",
"PUBLIC_PREVIEW",
"PRIVATE_PREVIEW"
],
"enumDescriptions": [
"Unspecified.",
"InfoType is generally available.",
"InfoType is in public preview.",
"InfoType is in private preview."
],
"type": "string"
},
"locationSupport": {
"$ref": "GooglePrivacyDlpV2LocationSupport",
"description": "Locations at which this feature can be used. May change over time."
},
"name": {
"description": "Internal name of the infoType.",
"type": "string"
},
"sensitivityScore": {
"$ref": "GooglePrivacyDlpV2SensitivityScore",
"description": "The default sensitivity of the infoType."
},
"specificInfoTypes": {
"description": "If this field is set, this infoType is a general infoType and these specific infoTypes are contained within it. General infoTypes are infoTypes that encompass multiple specific infoTypes. For example, the \"GEOGRAPHIC_DATA\" general infoType would have set for this field \"LOCATION\", \"LOCATION_COORDINATES\", and \"STREET_ADDRESS\".",
"items": {
"type": "string"
},
"type": "array"
},
"supportedBy": {
"description": "Which parts of the API supports this InfoType.",
"items": {
"enum": [
"ENUM_TYPE_UNSPECIFIED",
"INSPECT",
"RISK_ANALYSIS"
],
"enumDescriptions": [
"Unused.",
"Supported by the inspect operations.",
"Supported by the risk analysis operations."
],
"type": "string"
},
"type": "array"
},
"versions": {
"description": "A list of available versions for the infotype.",
"items": {
"$ref": "GooglePrivacyDlpV2VersionDescription"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2InfoTypeLikelihood": {
"description": "Configuration for setting a minimum likelihood per infotype. Used to customize the minimum likelihood level for specific infotypes in the request. For example, use this if you want to lower the precision for PERSON_NAME without lowering the precision for the other infotypes in the request.",
"id": "GooglePrivacyDlpV2InfoTypeLikelihood",
"properties": {
"infoType": {
"$ref": "GooglePrivacyDlpV2InfoType",
"description": "Type of information the likelihood threshold applies to. Only one likelihood per info_type should be provided. If InfoTypeLikelihood does not have an info_type, the configuration fails."
},
"minLikelihood": {
"description": "Only returns findings equal to or above this threshold. This field is required or else the configuration fails.",
"enum": [
"LIKELIHOOD_UNSPECIFIED",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Default value; same as POSSIBLE.",
"Highest chance of a false positive.",
"High chance of a false positive.",
"Some matching signals. The default value.",
"Low chance of a false positive.",
"Confidence level is high. Lowest chance of a false positive."
],
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2InfoTypeLimit": {
"description": "Max findings configuration per infoType, per content item or long running DlpJob.",
"id": "GooglePrivacyDlpV2InfoTypeLimit",
"properties": {
"infoType": {
"$ref": "GooglePrivacyDlpV2InfoType",
"description": "Type of information the findings limit applies to. Only one limit per info_type should be provided. If InfoTypeLimit does not have an info_type, the DLP API applies the limit against all info_types that are found but not specified in another InfoTypeLimit."
},
"maxFindings": {
"description": "Max findings limit for the given infoType.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GooglePrivacyDlpV2InfoTypeStats": {
"description": "Statistics regarding a specific InfoType.",
"id": "GooglePrivacyDlpV2InfoTypeStats",
"properties": {
"count": {
"description": "Number of findings for this infoType.",
"format": "int64",
"type": "string"
},
"infoType": {
"$ref": "GooglePrivacyDlpV2InfoType",
"description": "The type of finding this stat is for."
}
},
"type": "object"
},
"GooglePrivacyDlpV2InfoTypeSummary": {
"description": "The infoType details for this column.",
"id": "GooglePrivacyDlpV2InfoTypeSummary",
"properties": {
"estimatedPrevalence": {
"deprecated": true,
"description": "Not populated for predicted infotypes.",
"format": "int32",
"type": "integer"
},
"infoType": {
"$ref": "GooglePrivacyDlpV2InfoType",
"description": "The infoType."
}
},
"type": "object"
},
"GooglePrivacyDlpV2InfoTypeTransformation": {
"description": "A transformation to apply to text that is identified as a specific info_type.",
"id": "GooglePrivacyDlpV2InfoTypeTransformation",
"properties": {
"infoTypes": {
"description": "InfoTypes to apply the transformation to. An empty list will cause this transformation to apply to all findings that correspond to infoTypes that were requested in `InspectConfig`.",
"items": {
"$ref": "GooglePrivacyDlpV2InfoType"
},
"type": "array"
},
"primitiveTransformation": {
"$ref": "GooglePrivacyDlpV2PrimitiveTransformation",
"description": "Required. Primitive transformation to apply to the infoType."
}
},
"type": "object"
},
"GooglePrivacyDlpV2InfoTypeTransformations": {
"description": "A type of transformation that will scan unstructured text and apply various `PrimitiveTransformation`s to each finding, where the transformation is applied to only values that were identified as a specific info_type.",
"id": "GooglePrivacyDlpV2InfoTypeTransformations",
"properties": {
"transformations": {
"description": "Required. Transformation for each infoType. Cannot specify more than one for a given infoType.",
"items": {
"$ref": "GooglePrivacyDlpV2InfoTypeTransformation"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2InspectConfig": {
"description": "Configuration description of the scanning process. When used with redactContent only info_types and min_likelihood are currently used.",
"id": "GooglePrivacyDlpV2InspectConfig",
"properties": {
"contentOptions": {
"description": "Deprecated and unused.",
"items": {
"enum": [
"CONTENT_UNSPECIFIED",
"CONTENT_TEXT",
"CONTENT_IMAGE"
],
"enumDescriptions": [
"Includes entire content of a file or a data stream.",
"Text content within the data, excluding any metadata.",
"Images found in the data."
],
"type": "string"
},
"type": "array"
},
"customInfoTypes": {
"description": "CustomInfoTypes provided by the user. See https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more.",
"items": {
"$ref": "GooglePrivacyDlpV2CustomInfoType"
},
"type": "array"
},
"excludeInfoTypes": {
"description": "When true, excludes type information of the findings. This is not used for data profiling.",
"type": "boolean"
},
"includeQuote": {
"description": "When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote. This is not used for data profiling.",
"type": "boolean"
},
"infoTypes": {
"description": "Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose a default list of detectors to run, which may change over time. 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.",
"items": {
"$ref": "GooglePrivacyDlpV2InfoType"
},
"type": "array"
},
"limits": {
"$ref": "GooglePrivacyDlpV2FindingLimits",
"description": "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 requests. Otherwise, Cloud DLP returns an error. When set within an InspectJobConfig, the specified maximum values aren't hard limits. If an inspection job reaches these limits, the job ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns can be multiple times higher than these maximum values."
},
"minLikelihood": {
"description": "Only returns findings equal to or above this threshold. The default is POSSIBLE. In general, the highest likelihood setting yields the fewest findings in results and the lowest chance of a false positive. For more information, see [Match likelihood](https://cloud.google.com/sensitive-data-protection/docs/likelihood).",
"enum": [
"LIKELIHOOD_UNSPECIFIED",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Default value; same as POSSIBLE.",
"Highest chance of a false positive.",
"High chance of a false positive.",
"Some matching signals. The default value.",
"Low chance of a false positive.",
"Confidence level is high. Lowest chance of a false positive."
],
"type": "string"
},
"minLikelihoodPerInfoType": {
"description": "Minimum likelihood per infotype. For each infotype, a user can specify a minimum likelihood. The system only returns a finding if its likelihood is above this threshold. If this field is not set, the system uses the InspectConfig min_likelihood.",
"items": {
"$ref": "GooglePrivacyDlpV2InfoTypeLikelihood"
},
"type": "array"
},
"ruleSet": {
"description": "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.",
"items": {
"$ref": "GooglePrivacyDlpV2InspectionRuleSet"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2InspectContentRequest": {
"description": "Request to search for potentially sensitive info in a ContentItem.",
"id": "GooglePrivacyDlpV2InspectContentRequest",
"properties": {
"inspectConfig": {
"$ref": "GooglePrivacyDlpV2InspectConfig",
"description": "Configuration for the inspector. What specified here will override the template referenced by the inspect_template_name argument."
},
"inspectTemplateName": {
"description": "Template to use. Any configuration directly specified in inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.",
"type": "string"
},
"item": {
"$ref": "GooglePrivacyDlpV2ContentItem",
"description": "The item to inspect."
},
"locationId": {
"description": "Deprecated. This field has no effect.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2InspectContentResponse": {
"description": "Results of inspecting an item.",
"id": "GooglePrivacyDlpV2InspectContentResponse",
"properties": {
"result": {
"$ref": "GooglePrivacyDlpV2InspectResult",
"description": "The findings."
}
},
"type": "object"
},
"GooglePrivacyDlpV2InspectDataSourceDetails": {
"description": "The results of an inspect DataSource job.",
"id": "GooglePrivacyDlpV2InspectDataSourceDetails",
"properties": {
"requestedOptions": {
"$ref": "GooglePrivacyDlpV2RequestedOptions",
"description": "The configuration used for this job."
},
"result": {
"$ref": "GooglePrivacyDlpV2Result",
"description": "A summary of the outcome of this inspection job."
}
},
"type": "object"
},
"GooglePrivacyDlpV2InspectJobConfig": {
"description": "Controls what and how to inspect for findings.",
"id": "GooglePrivacyDlpV2InspectJobConfig",
"properties": {
"actions": {
"description": "Actions to execute at the completion of the job.",
"items": {
"$ref": "GooglePrivacyDlpV2Action"
},
"type": "array"
},
"inspectConfig": {
"$ref": "GooglePrivacyDlpV2InspectConfig",
"description": "How and what to scan for."
},
"inspectTemplateName": {
"description": "If provided, will be used as the default for all values in InspectConfig. `inspect_config` will be merged into the values persisted as part of the template.",
"type": "string"
},
"storageConfig": {
"$ref": "GooglePrivacyDlpV2StorageConfig",
"description": "The data to scan."
}
},
"type": "object"
},
"GooglePrivacyDlpV2InspectResult": {
"description": "All the findings for a single scanned item.",
"id": "GooglePrivacyDlpV2InspectResult",
"properties": {
"findings": {
"description": "List of findings for an item.",
"items": {
"$ref": "GooglePrivacyDlpV2Finding"
},
"type": "array"
},
"findingsTruncated": {
"description": "If true, then this item might have more findings than were returned, and the findings returned are an arbitrary subset of all findings. The findings list might be truncated because the input items were too large, or because the server reached the maximum amount of resources allowed for a single API call. For best results, divide the input into smaller batches.",
"type": "boolean"
}
},
"type": "object"
},
"GooglePrivacyDlpV2InspectTemplate": {
"description": "The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more.",
"id": "GooglePrivacyDlpV2InspectTemplate",
"properties": {
"createTime": {
"description": "Output only. The creation timestamp of an inspectTemplate.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Short description (max 256 chars).",
"type": "string"
},
"displayName": {
"description": "Display name (max 256 chars).",
"type": "string"
},
"inspectConfig": {
"$ref": "GooglePrivacyDlpV2InspectConfig",
"description": "The core content of the template. Configuration of the scanning process."
},
"name": {
"description": "Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`;",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. The last update timestamp of an inspectTemplate.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2InspectionRule": {
"description": "A single inspection rule to be applied to infoTypes, specified in `InspectionRuleSet`.",
"id": "GooglePrivacyDlpV2InspectionRule",
"properties": {
"adjustmentRule": {
"$ref": "GooglePrivacyDlpV2AdjustmentRule",
"description": "Adjustment rule."
},
"exclusionRule": {
"$ref": "GooglePrivacyDlpV2ExclusionRule",
"description": "Exclusion rule."
},
"hotwordRule": {
"$ref": "GooglePrivacyDlpV2HotwordRule",
"description": "Hotword-based detection rule."
}
},
"type": "object"
},
"GooglePrivacyDlpV2InspectionRuleSet": {
"description": "Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set.",
"id": "GooglePrivacyDlpV2InspectionRuleSet",
"properties": {
"infoTypes": {
"description": "List of infoTypes this rule set is applied to.",
"items": {
"$ref": "GooglePrivacyDlpV2InfoType"
},
"type": "array"
},
"rules": {
"description": "Set of rules to be applied to infoTypes. The rules are applied in order.",
"items": {
"$ref": "GooglePrivacyDlpV2InspectionRule"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2JobNotificationEmails": {
"description": "Sends an email when the job completes. The email goes to IAM project owners and technical [Essential Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts).",
"id": "GooglePrivacyDlpV2JobNotificationEmails",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2JobTrigger": {
"description": "Contains a configuration to make API calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.",
"id": "GooglePrivacyDlpV2JobTrigger",
"properties": {
"createTime": {
"description": "Output only. The creation timestamp of a triggeredJob.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "User provided description (max 256 chars)",
"type": "string"
},
"displayName": {
"description": "Display name (max 100 chars)",
"type": "string"
},
"errors": {
"description": "Output only. A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automatically being paused. Will return the last 100 errors. Whenever the JobTrigger is modified this list will be cleared.",
"items": {
"$ref": "GooglePrivacyDlpV2Error"
},
"readOnly": true,
"type": "array"
},
"inspectJob": {
"$ref": "GooglePrivacyDlpV2InspectJobConfig",
"description": "For inspect jobs, a snapshot of the configuration."
},
"lastRunTime": {
"description": "Output only. The timestamp of the last time this trigger executed.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`.",
"type": "string"
},
"status": {
"description": "Required. A status for this trigger.",
"enum": [
"STATUS_UNSPECIFIED",
"HEALTHY",
"PAUSED",
"CANCELLED"
],
"enumDescriptions": [
"Unused.",
"Trigger is healthy.",
"Trigger is temporarily paused.",
"Trigger is cancelled and can not be resumed."
],
"type": "string"
},
"triggers": {
"description": "A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object.",
"items": {
"$ref": "GooglePrivacyDlpV2Trigger"
},
"type": "array"
},
"updateTime": {
"description": "Output only. The last update timestamp of a triggeredJob.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2KAnonymityConfig": {
"description": "k-anonymity metric, used for analysis of reidentification risk.",
"id": "GooglePrivacyDlpV2KAnonymityConfig",
"properties": {
"entityId": {
"$ref": "GooglePrivacyDlpV2EntityId",
"description": "Message indicating that multiple rows might be associated to a single individual. If the same entity_id is associated to multiple quasi-identifier tuples over distinct rows, we consider the entire collection of tuples as the composite quasi-identifier. This collection is a multiset: the order in which the different tuples appear in the dataset is ignored, but their frequency is taken into account. Important note: a maximum of 1000 rows can be associated to a single entity ID. If more rows are associated with the same entity ID, some might be ignored."
},
"quasiIds": {
"description": "Set of fields to compute k-anonymity over. When multiple fields are specified, they are considered a single composite key. Structs and repeated data types are not supported; however, nested fields are supported so long as they are not structs themselves or nested within a repeated field.",
"items": {
"$ref": "GooglePrivacyDlpV2FieldId"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2KAnonymityEquivalenceClass": {
"description": "The set of columns' values that share the same ldiversity value",
"id": "GooglePrivacyDlpV2KAnonymityEquivalenceClass",
"properties": {
"equivalenceClassSize": {
"description": "Size of the equivalence class, for example number of rows with the above set of values.",
"format": "int64",
"type": "string"
},
"quasiIdsValues": {
"description": "Set of values defining the equivalence class. One value per quasi-identifier column in the original KAnonymity metric message. The order is always the same as the original request.",
"items": {
"$ref": "GooglePrivacyDlpV2Value"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2KAnonymityHistogramBucket": {
"description": "Histogram of k-anonymity equivalence classes.",
"id": "GooglePrivacyDlpV2KAnonymityHistogramBucket",
"properties": {
"bucketSize": {
"description": "Total number of equivalence classes in this bucket.",
"format": "int64",
"type": "string"
},
"bucketValueCount": {
"description": "Total number of distinct equivalence classes in this bucket.",
"format": "int64",
"type": "string"
},
"bucketValues": {
"description": "Sample of equivalence classes in this bucket. The total number of classes returned per bucket is capped at 20.",
"items": {
"$ref": "GooglePrivacyDlpV2KAnonymityEquivalenceClass"
},
"type": "array"
},
"equivalenceClassSizeLowerBound": {
"description": "Lower bound on the size of the equivalence classes in this bucket.",
"format": "int64",
"type": "string"
},
"equivalenceClassSizeUpperBound": {
"description": "Upper bound on the size of the equivalence classes in this bucket.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2KAnonymityResult": {
"description": "Result of the k-anonymity computation.",
"id": "GooglePrivacyDlpV2KAnonymityResult",
"properties": {
"equivalenceClassHistogramBuckets": {
"description": "Histogram of k-anonymity equivalence classes.",
"items": {
"$ref": "GooglePrivacyDlpV2KAnonymityHistogramBucket"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2KMapEstimationConfig": {
"description": "Reidentifiability metric. This corresponds to a risk model similar to what is called \"journalist risk\" in the literature, except the attack dataset is statistically modeled instead of being perfectly known. This can be done using publicly available data (like the US Census), or using a custom statistical model (indicated as one or several BigQuery tables), or by extrapolating from the distribution of values in the input dataset.",
"id": "GooglePrivacyDlpV2KMapEstimationConfig",
"properties": {
"auxiliaryTables": {
"description": "Several auxiliary tables can be used in the analysis. Each custom_tag used to tag a quasi-identifiers column must appear in exactly one column of one auxiliary table.",
"items": {
"$ref": "GooglePrivacyDlpV2AuxiliaryTable"
},
"type": "array"
},
"quasiIds": {
"description": "Required. Fields considered to be quasi-identifiers. No two columns can have the same tag.",
"items": {
"$ref": "GooglePrivacyDlpV2TaggedField"
},
"type": "array"
},
"regionCode": {
"description": "ISO 3166-1 alpha-2 region code to use in the statistical modeling. Set if no column is tagged with a region-specific InfoType (like US_ZIP_5) or a region code.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2KMapEstimationHistogramBucket": {
"description": "A KMapEstimationHistogramBucket message with the following values: min_anonymity: 3 max_anonymity: 5 frequency: 42 means that there are 42 records whose quasi-identifier values correspond to 3, 4 or 5 people in the overlying population. An important particular case is when min_anonymity = max_anonymity = 1: the frequency field then corresponds to the number of uniquely identifiable records.",
"id": "GooglePrivacyDlpV2KMapEstimationHistogramBucket",
"properties": {
"bucketSize": {
"description": "Number of records within these anonymity bounds.",
"format": "int64",
"type": "string"
},
"bucketValueCount": {
"description": "Total number of distinct quasi-identifier tuple values in this bucket.",
"format": "int64",
"type": "string"
},
"bucketValues": {
"description": "Sample of quasi-identifier tuple values in this bucket. The total number of classes returned per bucket is capped at 20.",
"items": {
"$ref": "GooglePrivacyDlpV2KMapEstimationQuasiIdValues"
},
"type": "array"
},
"maxAnonymity": {
"description": "Always greater than or equal to min_anonymity.",
"format": "int64",
"type": "string"
},
"minAnonymity": {
"description": "Always positive.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2KMapEstimationQuasiIdValues": {
"description": "A tuple of values for the quasi-identifier columns.",
"id": "GooglePrivacyDlpV2KMapEstimationQuasiIdValues",
"properties": {
"estimatedAnonymity": {
"description": "The estimated anonymity for these quasi-identifier values.",
"format": "int64",
"type": "string"
},
"quasiIdsValues": {
"description": "The quasi-identifier values.",
"items": {
"$ref": "GooglePrivacyDlpV2Value"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2KMapEstimationResult": {
"description": "Result of the reidentifiability analysis. Note that these results are an estimation, not exact values.",
"id": "GooglePrivacyDlpV2KMapEstimationResult",
"properties": {
"kMapEstimationHistogram": {
"description": "The intervals [min_anonymity, max_anonymity] do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_anonymity: 1, max_anonymity: 1, frequency: 17} {min_anonymity: 2, max_anonymity: 3, frequency: 42} {min_anonymity: 5, max_anonymity: 10, frequency: 99} mean that there are no record with an estimated anonymity of 4, 5, or larger than 10.",
"items": {
"$ref": "GooglePrivacyDlpV2KMapEstimationHistogramBucket"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2Key": {
"description": "A unique identifier for a Datastore entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts.",
"id": "GooglePrivacyDlpV2Key",
"properties": {
"partitionId": {
"$ref": "GooglePrivacyDlpV2PartitionId",
"description": "Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition."
},
"path": {
"description": "The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. A path can never be empty, and a path can have at most 100 elements.",
"items": {
"$ref": "GooglePrivacyDlpV2PathElement"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2KindExpression": {
"description": "A representation of a Datastore kind.",
"id": "GooglePrivacyDlpV2KindExpression",
"properties": {
"name": {
"description": "The name of the kind.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2KmsWrappedCryptoKey": {
"description": "Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. Authorization requires the following IAM permissions when sending a request to perform a crypto transformation using a KMS-wrapped crypto key: dlp.kms.encrypt For more information, see [Creating a wrapped key] (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key). Note: When you use Cloud KMS for cryptographic operations, [charges apply](https://cloud.google.com/kms/pricing).",
"id": "GooglePrivacyDlpV2KmsWrappedCryptoKey",
"properties": {
"cryptoKeyName": {
"description": "Required. The resource name of the KMS CryptoKey to use for unwrapping.",
"type": "string"
},
"wrappedKey": {
"description": "Required. The wrapped data crypto key.",
"format": "byte",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2LDiversityConfig": {
"description": "l-diversity metric, used for analysis of reidentification risk.",
"id": "GooglePrivacyDlpV2LDiversityConfig",
"properties": {
"quasiIds": {
"description": "Set of quasi-identifiers indicating how equivalence classes are defined for the l-diversity computation. When multiple fields are specified, they are considered a single composite key.",
"items": {
"$ref": "GooglePrivacyDlpV2FieldId"
},
"type": "array"
},
"sensitiveAttribute": {
"$ref": "GooglePrivacyDlpV2FieldId",
"description": "Sensitive field for computing the l-value."
}
},
"type": "object"
},
"GooglePrivacyDlpV2LDiversityEquivalenceClass": {
"description": "The set of columns' values that share the same ldiversity value.",
"id": "GooglePrivacyDlpV2LDiversityEquivalenceClass",
"properties": {
"equivalenceClassSize": {
"description": "Size of the k-anonymity equivalence class.",
"format": "int64",
"type": "string"
},
"numDistinctSensitiveValues": {
"description": "Number of distinct sensitive values in this equivalence class.",
"format": "int64",
"type": "string"
},
"quasiIdsValues": {
"description": "Quasi-identifier values defining the k-anonymity equivalence class. The order is always the same as the original request.",
"items": {
"$ref": "GooglePrivacyDlpV2Value"
},
"type": "array"
},
"topSensitiveValues": {
"description": "Estimated frequencies of top sensitive values.",
"items": {
"$ref": "GooglePrivacyDlpV2ValueFrequency"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2LDiversityHistogramBucket": {
"description": "Histogram of l-diversity equivalence class sensitive value frequencies.",
"id": "GooglePrivacyDlpV2LDiversityHistogramBucket",
"properties": {
"bucketSize": {
"description": "Total number of equivalence classes in this bucket.",
"format": "int64",
"type": "string"
},
"bucketValueCount": {
"description": "Total number of distinct equivalence classes in this bucket.",
"format": "int64",
"type": "string"
},
"bucketValues": {
"description": "Sample of equivalence classes in this bucket. The total number of classes returned per bucket is capped at 20.",
"items": {
"$ref": "GooglePrivacyDlpV2LDiversityEquivalenceClass"
},
"type": "array"
},
"sensitiveValueFrequencyLowerBound": {
"description": "Lower bound on the sensitive value frequencies of the equivalence classes in this bucket.",
"format": "int64",
"type": "string"
},
"sensitiveValueFrequencyUpperBound": {
"description": "Upper bound on the sensitive value frequencies of the equivalence classes in this bucket.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2LDiversityResult": {
"description": "Result of the l-diversity computation.",
"id": "GooglePrivacyDlpV2LDiversityResult",
"properties": {
"sensitiveValueFrequencyHistogramBuckets": {
"description": "Histogram of l-diversity equivalence class sensitive value frequencies.",
"items": {
"$ref": "GooglePrivacyDlpV2LDiversityHistogramBucket"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2LargeCustomDictionaryConfig": {
"description": "Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The artifacts of dictionary creation are stored in the specified Cloud Storage location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries that satisfy the size requirements.",
"id": "GooglePrivacyDlpV2LargeCustomDictionaryConfig",
"properties": {
"bigQueryField": {
"$ref": "GooglePrivacyDlpV2BigQueryField",
"description": "Field in a BigQuery table where each cell represents a dictionary phrase."
},
"cloudStorageFileSet": {
"$ref": "GooglePrivacyDlpV2CloudStorageFileSet",
"description": "Set of files containing newline-delimited lists of dictionary phrases."
},
"outputPath": {
"$ref": "GooglePrivacyDlpV2CloudStoragePath",
"description": "Location to store dictionary artifacts in Cloud Storage. These files will only be accessible by project owners and the DLP API. If any of these artifacts are modified, the dictionary is considered invalid and can no longer be used."
}
},
"type": "object"
},
"GooglePrivacyDlpV2LargeCustomDictionaryStats": {
"description": "Summary statistics of a custom dictionary.",
"id": "GooglePrivacyDlpV2LargeCustomDictionaryStats",
"properties": {
"approxNumPhrases": {
"description": "Approximate number of distinct phrases in the dictionary.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2LeaveUntransformed": {
"description": "Skips the data without modifying it if the requested transformation would cause an error. For example, if a `DateShift` transformation were applied an an IP address, this mode would leave the IP address unchanged in the response.",
"id": "GooglePrivacyDlpV2LeaveUntransformed",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2LikelihoodAdjustment": {
"description": "Message for specifying an adjustment to the likelihood of a finding as part of a detection rule.",
"id": "GooglePrivacyDlpV2LikelihoodAdjustment",
"properties": {
"fixedLikelihood": {
"description": "Set the likelihood of a finding to a fixed value.",
"enum": [
"LIKELIHOOD_UNSPECIFIED",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Default value; same as POSSIBLE.",
"Highest chance of a false positive.",
"High chance of a false positive.",
"Some matching signals. The default value.",
"Low chance of a false positive.",
"Confidence level is high. Lowest chance of a false positive."
],
"type": "string"
},
"relativeLikelihood": {
"description": "Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GooglePrivacyDlpV2ListColumnDataProfilesResponse": {
"description": "List of profiles generated for a given organization or project.",
"id": "GooglePrivacyDlpV2ListColumnDataProfilesResponse",
"properties": {
"columnDataProfiles": {
"description": "List of data profiles.",
"items": {
"$ref": "GooglePrivacyDlpV2ColumnDataProfile"
},
"type": "array"
},
"nextPageToken": {
"description": "The next page token.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2ListConnectionsResponse": {
"description": "Response message for ListConnections.",
"id": "GooglePrivacyDlpV2ListConnectionsResponse",
"properties": {
"connections": {
"description": "List of connections.",
"items": {
"$ref": "GooglePrivacyDlpV2Connection"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results. An empty value means there are no more results.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2ListDeidentifyTemplatesResponse": {
"description": "Response message for ListDeidentifyTemplates.",
"id": "GooglePrivacyDlpV2ListDeidentifyTemplatesResponse",
"properties": {
"deidentifyTemplates": {
"description": "List of deidentify templates, up to page_size in ListDeidentifyTemplatesRequest.",
"items": {
"$ref": "GooglePrivacyDlpV2DeidentifyTemplate"
},
"type": "array"
},
"nextPageToken": {
"description": "If the next page is available then the next page token to be used in the following ListDeidentifyTemplates request.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2ListDiscoveryConfigsResponse": {
"description": "Response message for ListDiscoveryConfigs.",
"id": "GooglePrivacyDlpV2ListDiscoveryConfigsResponse",
"properties": {
"discoveryConfigs": {
"description": "List of configs, up to page_size in ListDiscoveryConfigsRequest.",
"items": {
"$ref": "GooglePrivacyDlpV2DiscoveryConfig"
},
"type": "array"
},
"nextPageToken": {
"description": "If the next page is available then this value is the next page token to be used in the following ListDiscoveryConfigs request.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2ListDlpJobsResponse": {
"description": "The response message for listing DLP jobs.",
"id": "GooglePrivacyDlpV2ListDlpJobsResponse",
"properties": {
"jobs": {
"description": "A list of DlpJobs that matches the specified filter in the request.",
"items": {
"$ref": "GooglePrivacyDlpV2DlpJob"
},
"type": "array"
},
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2ListFileStoreDataProfilesResponse": {
"description": "List of file store data profiles generated for a given organization or project.",
"id": "GooglePrivacyDlpV2ListFileStoreDataProfilesResponse",
"properties": {
"fileStoreDataProfiles": {
"description": "List of data profiles.",
"items": {
"$ref": "GooglePrivacyDlpV2FileStoreDataProfile"
},
"type": "array"
},
"nextPageToken": {
"description": "The next page token.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2ListInfoTypesResponse": {
"description": "Response to the ListInfoTypes request.",
"id": "GooglePrivacyDlpV2ListInfoTypesResponse",
"properties": {
"infoTypes": {
"description": "Set of sensitive infoTypes.",
"items": {
"$ref": "GooglePrivacyDlpV2InfoTypeDescription"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2ListInspectTemplatesResponse": {
"description": "Response message for ListInspectTemplates.",
"id": "GooglePrivacyDlpV2ListInspectTemplatesResponse",
"properties": {
"inspectTemplates": {
"description": "List of inspectTemplates, up to page_size in ListInspectTemplatesRequest.",
"items": {
"$ref": "GooglePrivacyDlpV2InspectTemplate"
},
"type": "array"
},
"nextPageToken": {
"description": "If the next page is available then the next page token to be used in the following ListInspectTemplates request.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2ListJobTriggersResponse": {
"description": "Response message for ListJobTriggers.",
"id": "GooglePrivacyDlpV2ListJobTriggersResponse",
"properties": {
"jobTriggers": {
"description": "List of triggeredJobs, up to page_size in ListJobTriggersRequest.",
"items": {
"$ref": "GooglePrivacyDlpV2JobTrigger"
},
"type": "array"
},
"nextPageToken": {
"description": "If the next page is available then this value is the next page token to be used in the following ListJobTriggers request.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2ListProjectDataProfilesResponse": {
"description": "List of profiles generated for a given organization or project.",
"id": "GooglePrivacyDlpV2ListProjectDataProfilesResponse",
"properties": {
"nextPageToken": {
"description": "The next page token.",
"type": "string"
},
"projectDataProfiles": {
"description": "List of data profiles.",
"items": {
"$ref": "GooglePrivacyDlpV2ProjectDataProfile"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2ListStoredInfoTypesResponse": {
"description": "Response message for ListStoredInfoTypes.",
"id": "GooglePrivacyDlpV2ListStoredInfoTypesResponse",
"properties": {
"nextPageToken": {
"description": "If the next page is available then the next page token to be used in the following ListStoredInfoTypes request.",
"type": "string"
},
"storedInfoTypes": {
"description": "List of storedInfoTypes, up to page_size in ListStoredInfoTypesRequest.",
"items": {
"$ref": "GooglePrivacyDlpV2StoredInfoType"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2ListTableDataProfilesResponse": {
"description": "List of profiles generated for a given organization or project.",
"id": "GooglePrivacyDlpV2ListTableDataProfilesResponse",
"properties": {
"nextPageToken": {
"description": "The next page token.",
"type": "string"
},
"tableDataProfiles": {
"description": "List of data profiles.",
"items": {
"$ref": "GooglePrivacyDlpV2TableDataProfile"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2Location": {
"description": "Specifies the location of the finding.",
"id": "GooglePrivacyDlpV2Location",
"properties": {
"byteRange": {
"$ref": "GooglePrivacyDlpV2Range",
"description": "Zero-based byte offsets delimiting the finding. These are relative to the finding's containing element. Note that when the content is not textual, this references the UTF-8 encoded textual representation of the content. Omitted if content is an image."
},
"codepointRange": {
"$ref": "GooglePrivacyDlpV2Range",
"description": "Unicode character offsets delimiting the finding. These are relative to the finding's containing element. Provided when the content is text."
},
"container": {
"$ref": "GooglePrivacyDlpV2Container",
"description": "Information about the container where this finding occurred, if available."
},
"contentLocations": {
"description": "List of nested objects pointing to the precise location of the finding within the file or record.",
"items": {
"$ref": "GooglePrivacyDlpV2ContentLocation"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2LocationSupport": {
"description": "Locations at which a feature can be used.",
"id": "GooglePrivacyDlpV2LocationSupport",
"properties": {
"locations": {
"description": "Specific locations where the feature may be used. Examples: us-central1, us, asia, global If scope is ANY_LOCATION, no regions will be listed.",
"items": {
"type": "string"
},
"type": "array"
},
"regionalizationScope": {
"description": "The current scope for location on this feature. This may expand over time.",
"enum": [
"REGIONALIZATION_SCOPE_UNSPECIFIED",
"REGIONAL",
"ANY_LOCATION"
],
"enumDescriptions": [
"Invalid.",
"Feature may be used with one or more regions. See locations for details.",
"Feature may be used anywhere. Default value."
],
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2Manual": {
"description": "Job trigger option for hybrid jobs. Jobs must be manually created and finished.",
"id": "GooglePrivacyDlpV2Manual",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2MetadataLocation": {
"description": "Metadata Location",
"id": "GooglePrivacyDlpV2MetadataLocation",
"properties": {
"storageLabel": {
"$ref": "GooglePrivacyDlpV2StorageMetadataLabel",
"description": "Storage metadata."
},
"type": {
"description": "Type of metadata containing the finding.",
"enum": [
"METADATATYPE_UNSPECIFIED",
"STORAGE_METADATA"
],
"enumDescriptions": [
"Unused",
"General file metadata provided by Cloud Storage."
],
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2MultiRegionProcessing": {
"description": "Processing occurs in a multi-region that contains the current region if available.",
"id": "GooglePrivacyDlpV2MultiRegionProcessing",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2NumericalStatsConfig": {
"description": "Compute numerical stats over an individual column, including min, max, and quantiles.",
"id": "GooglePrivacyDlpV2NumericalStatsConfig",
"properties": {
"field": {
"$ref": "GooglePrivacyDlpV2FieldId",
"description": "Field to compute numerical stats on. Supported types are integer, float, date, datetime, timestamp, time."
}
},
"type": "object"
},
"GooglePrivacyDlpV2NumericalStatsResult": {
"description": "Result of the numerical stats computation.",
"id": "GooglePrivacyDlpV2NumericalStatsResult",
"properties": {
"maxValue": {
"$ref": "GooglePrivacyDlpV2Value",
"description": "Maximum value appearing in the column."
},
"minValue": {
"$ref": "GooglePrivacyDlpV2Value",
"description": "Minimum value appearing in the column."
},
"quantileValues": {
"description": "List of 99 values that partition the set of field values into 100 equal sized buckets.",
"items": {
"$ref": "GooglePrivacyDlpV2Value"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2OrConditions": {
"description": "There is an OR relationship between these attributes. They are used to determine if a table should be scanned or not in Discovery.",
"id": "GooglePrivacyDlpV2OrConditions",
"properties": {
"minAge": {
"description": "Minimum age a table must have before Cloud DLP can profile it. Value must be 1 hour or greater.",
"format": "google-duration",
"type": "string"
},
"minRowCount": {
"description": "Minimum number of rows that should be present before Cloud DLP profiles a table",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GooglePrivacyDlpV2OrgConfig": {
"description": "Project and scan location information. Only set when the parent is an org.",
"id": "GooglePrivacyDlpV2OrgConfig",
"properties": {
"location": {
"$ref": "GooglePrivacyDlpV2DiscoveryStartingLocation",
"description": "The data to scan: folder, org, or project"
},
"projectId": {
"description": "The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the DLP API must be enabled.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2OtherCloudDiscoveryStartingLocation": {
"description": "The other cloud starting location for discovery.",
"id": "GooglePrivacyDlpV2OtherCloudDiscoveryStartingLocation",
"properties": {
"awsLocation": {
"$ref": "GooglePrivacyDlpV2AwsDiscoveryStartingLocation",
"description": "The AWS starting location for discovery."
}
},
"type": "object"
},
"GooglePrivacyDlpV2OtherCloudDiscoveryTarget": {
"description": "Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature.",
"id": "GooglePrivacyDlpV2OtherCloudDiscoveryTarget",
"properties": {
"conditions": {
"$ref": "GooglePrivacyDlpV2DiscoveryOtherCloudConditions",
"description": "Optional. In addition to matching the filter, these conditions must be true before a profile is generated."
},
"dataSourceType": {
"$ref": "GooglePrivacyDlpV2DataSourceType",
"description": "Required. The type of data profiles generated by this discovery target. Supported values are: * aws/s3/bucket"
},
"disabled": {
"$ref": "GooglePrivacyDlpV2Disabled",
"description": "Disable profiling for resources that match this filter."
},
"filter": {
"$ref": "GooglePrivacyDlpV2DiscoveryOtherCloudFilter",
"description": "Required. The resources that the discovery cadence applies to. The first target with a matching filter will be the one to apply to a resource."
},
"generationCadence": {
"$ref": "GooglePrivacyDlpV2DiscoveryOtherCloudGenerationCadence",
"description": "How often and when to update data profiles. New resources that match both the filter and conditions are scanned as quickly as possible depending on system capacity."
}
},
"type": "object"
},
"GooglePrivacyDlpV2OtherCloudResourceCollection": {
"description": "Match resources using regex filters.",
"id": "GooglePrivacyDlpV2OtherCloudResourceCollection",
"properties": {
"includeRegexes": {
"$ref": "GooglePrivacyDlpV2OtherCloudResourceRegexes",
"description": "A collection of regular expressions to match a resource against."
}
},
"type": "object"
},
"GooglePrivacyDlpV2OtherCloudResourceRegex": {
"description": "A pattern to match against one or more resources. At least one pattern must be specified. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub.",
"id": "GooglePrivacyDlpV2OtherCloudResourceRegex",
"properties": {
"amazonS3BucketRegex": {
"$ref": "GooglePrivacyDlpV2AmazonS3BucketRegex",
"description": "Regex for Amazon S3 buckets."
}
},
"type": "object"
},
"GooglePrivacyDlpV2OtherCloudResourceRegexes": {
"description": "A collection of regular expressions to determine what resources to match against.",
"id": "GooglePrivacyDlpV2OtherCloudResourceRegexes",
"properties": {
"patterns": {
"description": "A group of regular expression patterns to match against one or more resources. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB.",
"items": {
"$ref": "GooglePrivacyDlpV2OtherCloudResourceRegex"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2OtherCloudSingleResourceReference": {
"description": "Identifies a single resource, like a single Amazon S3 bucket.",
"id": "GooglePrivacyDlpV2OtherCloudSingleResourceReference",
"properties": {
"amazonS3Bucket": {
"$ref": "GooglePrivacyDlpV2AmazonS3Bucket",
"description": "Amazon S3 bucket."
}
},
"type": "object"
},
"GooglePrivacyDlpV2OtherInfoTypeSummary": {
"description": "Infotype details for other infoTypes found within a column.",
"id": "GooglePrivacyDlpV2OtherInfoTypeSummary",
"properties": {
"estimatedPrevalence": {
"description": "Approximate percentage of non-null rows that contained data detected by this infotype.",
"format": "int32",
"type": "integer"
},
"excludedFromAnalysis": {
"description": "Whether this infoType was excluded from sensitivity and risk analysis due to factors such as low prevalence (subject to change).",
"type": "boolean"
},
"infoType": {
"$ref": "GooglePrivacyDlpV2InfoType",
"description": "The other infoType."
}
},
"type": "object"
},
"GooglePrivacyDlpV2OutputStorageConfig": {
"description": "Cloud repository for storing output.",
"id": "GooglePrivacyDlpV2OutputStorageConfig",
"properties": {
"outputSchema": {
"description": "Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.",
"enum": [
"OUTPUT_SCHEMA_UNSPECIFIED",
"BASIC_COLUMNS",
"GCS_COLUMNS",
"DATASTORE_COLUMNS",
"BIG_QUERY_COLUMNS",
"ALL_COLUMNS"
],
"enumDescriptions": [
"Unused.",
"Basic schema including only `info_type`, `quote`, `certainty`, and `timestamp`.",
"Schema tailored to findings from scanning Cloud Storage.",
"Schema tailored to findings from scanning Google Datastore.",
"Schema tailored to findings from scanning Google BigQuery.",
"Schema containing all columns."
],
"type": "string"
},
"storagePath": {
"$ref": "GooglePrivacyDlpV2CloudStoragePath",
"description": "Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename and will contain findings in textproto format as SaveToGcsFindingsOutput. The filename will follow the naming convention `-`. Example: `my-job-id-2`. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored."
},
"table": {
"$ref": "GooglePrivacyDlpV2BigQueryTable",
"description": "Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table."
}
},
"type": "object"
},
"GooglePrivacyDlpV2Overlap": {
"description": "Defines a condition for overlapping bounding boxes.",
"id": "GooglePrivacyDlpV2Overlap",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2PartitionId": {
"description": "Datastore partition ID. A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID.",
"id": "GooglePrivacyDlpV2PartitionId",
"properties": {
"namespaceId": {
"description": "If not empty, the ID of the namespace to which the entities belong.",
"type": "string"
},
"projectId": {
"description": "The ID of the project to which the entities belong.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2PathElement": {
"description": "A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.",
"id": "GooglePrivacyDlpV2PathElement",
"properties": {
"id": {
"description": "The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.",
"format": "int64",
"type": "string"
},
"kind": {
"description": "The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `\"\"`.",
"type": "string"
},
"name": {
"description": "The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `\"\"`.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2PrimitiveTransformation": {
"description": "A rule for transforming a value.",
"id": "GooglePrivacyDlpV2PrimitiveTransformation",
"properties": {
"bucketingConfig": {
"$ref": "GooglePrivacyDlpV2BucketingConfig",
"description": "Bucketing"
},
"characterMaskConfig": {
"$ref": "GooglePrivacyDlpV2CharacterMaskConfig",
"description": "Mask"
},
"cryptoDeterministicConfig": {
"$ref": "GooglePrivacyDlpV2CryptoDeterministicConfig",
"description": "Deterministic Crypto"
},
"cryptoHashConfig": {
"$ref": "GooglePrivacyDlpV2CryptoHashConfig",
"description": "Crypto"
},
"cryptoReplaceFfxFpeConfig": {
"$ref": "GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig",
"description": "Ffx-Fpe. Strongly discouraged, consider using CryptoDeterministicConfig instead. Fpe is computationally expensive incurring latency costs."
},
"dateShiftConfig": {
"$ref": "GooglePrivacyDlpV2DateShiftConfig",
"description": "Date Shift"
},
"fixedSizeBucketingConfig": {
"$ref": "GooglePrivacyDlpV2FixedSizeBucketingConfig",
"description": "Fixed size bucketing"
},
"redactConfig": {
"$ref": "GooglePrivacyDlpV2RedactConfig",
"description": "Redact"
},
"replaceConfig": {
"$ref": "GooglePrivacyDlpV2ReplaceValueConfig",
"description": "Replace with a specified value."
},
"replaceDictionaryConfig": {
"$ref": "GooglePrivacyDlpV2ReplaceDictionaryConfig",
"description": "Replace with a value randomly drawn (with replacement) from a dictionary."
},
"replaceWithInfoTypeConfig": {
"$ref": "GooglePrivacyDlpV2ReplaceWithInfoTypeConfig",
"description": "Replace with infotype"
},
"timePartConfig": {
"$ref": "GooglePrivacyDlpV2TimePartConfig",
"description": "Time extraction"
}
},
"type": "object"
},
"GooglePrivacyDlpV2PrivacyMetric": {
"description": "Privacy metric to compute for reidentification risk analysis.",
"id": "GooglePrivacyDlpV2PrivacyMetric",
"properties": {
"categoricalStatsConfig": {
"$ref": "GooglePrivacyDlpV2CategoricalStatsConfig",
"description": "Categorical stats"
},
"deltaPresenceEstimationConfig": {
"$ref": "GooglePrivacyDlpV2DeltaPresenceEstimationConfig",
"description": "delta-presence"
},
"kAnonymityConfig": {
"$ref": "GooglePrivacyDlpV2KAnonymityConfig",
"description": "K-anonymity"
},
"kMapEstimationConfig": {
"$ref": "GooglePrivacyDlpV2KMapEstimationConfig",
"description": "k-map"
},
"lDiversityConfig": {
"$ref": "GooglePrivacyDlpV2LDiversityConfig",
"description": "l-diversity"
},
"numericalStatsConfig": {
"$ref": "GooglePrivacyDlpV2NumericalStatsConfig",
"description": "Numerical stats"
}
},
"type": "object"
},
"GooglePrivacyDlpV2ProcessingLocation": {
"description": "Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided.",
"id": "GooglePrivacyDlpV2ProcessingLocation",
"properties": {
"documentFallbackLocation": {
"$ref": "GooglePrivacyDlpV2DocumentFallbackLocation",
"description": "Document processing falls back using this configuration."
},
"imageFallbackLocation": {
"$ref": "GooglePrivacyDlpV2ImageFallbackLocation",
"description": "Image processing falls back using this configuration."
}
},
"type": "object"
},
"GooglePrivacyDlpV2ProfileStatus": {
"description": "Success or errors for the profile generation.",
"id": "GooglePrivacyDlpV2ProfileStatus",
"properties": {
"status": {
"$ref": "GoogleRpcStatus",
"description": "Profiling status code and optional message. The `status.code` value is 0 (default value) for OK."
},
"timestamp": {
"description": "Time when the profile generation status was updated",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2ProjectDataProfile": {
"description": "An aggregated profile for this project, based on the resources profiled within it.",
"id": "GooglePrivacyDlpV2ProjectDataProfile",
"properties": {
"dataRiskLevel": {
"$ref": "GooglePrivacyDlpV2DataRiskLevel",
"description": "The data risk level of this project."
},
"fileStoreDataProfileCount": {
"description": "The number of file store data profiles generated for this project.",
"format": "int64",
"type": "string"
},
"name": {
"description": "The resource name of the profile.",
"type": "string"
},
"profileLastGenerated": {
"description": "The last time the profile was generated.",
"format": "google-datetime",
"type": "string"
},
"profileStatus": {
"$ref": "GooglePrivacyDlpV2ProfileStatus",
"description": "Success or error status of the last attempt to profile the project."
},
"projectId": {
"description": "Project ID or account that was profiled.",
"type": "string"
},
"sensitivityScore": {
"$ref": "GooglePrivacyDlpV2SensitivityScore",
"description": "The sensitivity score of this project."
},
"tableDataProfileCount": {
"description": "The number of table data profiles generated for this project.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2Proximity": {
"description": "Message for specifying a window around a finding to apply a detection rule.",
"id": "GooglePrivacyDlpV2Proximity",
"properties": {
"windowAfter": {
"description": "Number of characters after the finding to consider.",
"format": "int32",
"type": "integer"
},
"windowBefore": {
"description": "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/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values).",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GooglePrivacyDlpV2PubSubCondition": {
"description": "A condition consisting of a value.",
"id": "GooglePrivacyDlpV2PubSubCondition",
"properties": {
"minimumRiskScore": {
"description": "The minimum data risk score that triggers the condition.",
"enum": [
"PROFILE_SCORE_BUCKET_UNSPECIFIED",
"HIGH",
"MEDIUM_OR_HIGH"
],
"enumDescriptions": [
"Unused.",
"High risk/sensitivity detected.",
"Medium or high risk/sensitivity detected."
],
"type": "string"
},
"minimumSensitivityScore": {
"description": "The minimum sensitivity level that triggers the condition.",
"enum": [
"PROFILE_SCORE_BUCKET_UNSPECIFIED",
"HIGH",
"MEDIUM_OR_HIGH"
],
"enumDescriptions": [
"Unused.",
"High risk/sensitivity detected.",
"Medium or high risk/sensitivity detected."
],
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2PubSubExpressions": {
"description": "An expression, consisting of an operator and conditions.",
"id": "GooglePrivacyDlpV2PubSubExpressions",
"properties": {
"conditions": {
"description": "Conditions to apply to the expression.",
"items": {
"$ref": "GooglePrivacyDlpV2PubSubCondition"
},
"type": "array"
},
"logicalOperator": {
"description": "The operator to apply to the collection of conditions.",
"enum": [
"LOGICAL_OPERATOR_UNSPECIFIED",
"OR",
"AND"
],
"enumDescriptions": [
"Unused.",
"Conditional OR.",
"Conditional AND."
],
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2PubSubNotification": {
"description": "Send a Pub/Sub message into the given Pub/Sub topic to connect other systems to data profile generation. The message payload data will be the byte serialization of `DataProfilePubSubMessage`.",
"id": "GooglePrivacyDlpV2PubSubNotification",
"properties": {
"detailOfMessage": {
"description": "How much data to include in the Pub/Sub message. If the user wishes to limit the size of the message, they can use resource_name and fetch the profile fields they wish to. Per table profile (not per column).",
"enum": [
"DETAIL_LEVEL_UNSPECIFIED",
"TABLE_PROFILE",
"RESOURCE_NAME",
"FILE_STORE_PROFILE"
],
"enumDescriptions": [
"Unused.",
"The full table data profile.",
"The name of the profiled resource.",
"The full file store data profile."
],
"type": "string"
},
"event": {
"description": "The type of event that triggers a Pub/Sub. At most one `PubSubNotification` per EventType is permitted.",
"enum": [
"EVENT_TYPE_UNSPECIFIED",
"NEW_PROFILE",
"CHANGED_PROFILE",
"SCORE_INCREASED",
"ERROR_CHANGED"
],
"enumDescriptions": [
"Unused.",
"New profile (not a re-profile).",
"One of the following profile metrics changed: Data risk score, Sensitivity score, Resource visibility, Encryption type, Predicted infoTypes, Other infoTypes",
"Table data risk score or sensitivity score increased.",
"A user (non-internal) error occurred."
],
"type": "string"
},
"pubsubCondition": {
"$ref": "GooglePrivacyDlpV2DataProfilePubSubCondition",
"description": "Conditions (e.g., data risk or sensitivity level) for triggering a Pub/Sub."
},
"topic": {
"description": "Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog": {
"description": "Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect",
"id": "GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2PublishFindingsToDataplexCatalog": {
"description": "Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. For more information, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are stored in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect",
"id": "GooglePrivacyDlpV2PublishFindingsToDataplexCatalog",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2PublishSummaryToCscc": {
"description": "Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect",
"id": "GooglePrivacyDlpV2PublishSummaryToCscc",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2PublishToChronicle": {
"description": "Message expressing intention to publish to Google Security Operations.",
"id": "GooglePrivacyDlpV2PublishToChronicle",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2PublishToDataplexCatalog": {
"description": "Create Dataplex Universal Catalog aspects for profiled resources with the aspect type Sensitive Data Protection Profile. To learn more about aspects, see https://cloud.google.com/sensitive-data-protection/docs/add-aspects.",
"id": "GooglePrivacyDlpV2PublishToDataplexCatalog",
"properties": {
"lowerDataRiskToLow": {
"description": "Whether creating a Dataplex Universal Catalog aspect for a profiled resource should lower the risk of the profile for that resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles.",
"type": "boolean"
}
},
"type": "object"
},
"GooglePrivacyDlpV2PublishToPubSub": {
"description": "Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk",
"id": "GooglePrivacyDlpV2PublishToPubSub",
"properties": {
"topic": {
"description": "Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications. Format is projects/{project}/topics/{topic}.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2PublishToSecurityCommandCenter": {
"description": "If set, a summary finding will be created or updated in Security Command Center for each profile.",
"id": "GooglePrivacyDlpV2PublishToSecurityCommandCenter",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2PublishToStackdriver": {
"description": "Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'.",
"id": "GooglePrivacyDlpV2PublishToStackdriver",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2QuasiId": {
"description": "A column with a semantic tag attached.",
"id": "GooglePrivacyDlpV2QuasiId",
"properties": {
"customTag": {
"description": "A column can be tagged with a custom tag. In this case, the user must indicate an auxiliary table that contains statistical information on the possible values of this column.",
"type": "string"
},
"field": {
"$ref": "GooglePrivacyDlpV2FieldId",
"description": "Required. Identifies the column."
},
"inferred": {
"$ref": "GoogleProtobufEmpty",
"description": "If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data"
},
"infoType": {
"$ref": "GooglePrivacyDlpV2InfoType",
"description": "A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter."
}
},
"type": "object"
},
"GooglePrivacyDlpV2QuasiIdField": {
"description": "A quasi-identifier column has a custom_tag, used to know which column in the data corresponds to which column in the statistical model.",
"id": "GooglePrivacyDlpV2QuasiIdField",
"properties": {
"customTag": {
"description": "A auxiliary field.",
"type": "string"
},
"field": {
"$ref": "GooglePrivacyDlpV2FieldId",
"description": "Identifies the column."
}
},
"type": "object"
},
"GooglePrivacyDlpV2QuasiIdentifierField": {
"description": "A quasi-identifier column has a custom_tag, used to know which column in the data corresponds to which column in the statistical model.",
"id": "GooglePrivacyDlpV2QuasiIdentifierField",
"properties": {
"customTag": {
"description": "A column can be tagged with a custom tag. In this case, the user must indicate an auxiliary table that contains statistical information on the possible values of this column.",
"type": "string"
},
"field": {
"$ref": "GooglePrivacyDlpV2FieldId",
"description": "Identifies the column."
}
},
"type": "object"
},
"GooglePrivacyDlpV2QuoteInfo": {
"description": "Message for infoType-dependent details parsed from quote.",
"id": "GooglePrivacyDlpV2QuoteInfo",
"properties": {
"dateTime": {
"$ref": "GooglePrivacyDlpV2DateTime",
"description": "The date time indicated by the quote."
}
},
"type": "object"
},
"GooglePrivacyDlpV2Range": {
"description": "Generic half-open interval [start, end)",
"id": "GooglePrivacyDlpV2Range",
"properties": {
"end": {
"description": "Index of the last character of the range (exclusive).",
"format": "int64",
"type": "string"
},
"start": {
"description": "Index of the first character of the range (inclusive).",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2RecordCondition": {
"description": "A condition for determining whether a transformation should be applied to a field.",
"id": "GooglePrivacyDlpV2RecordCondition",
"properties": {
"expressions": {
"$ref": "GooglePrivacyDlpV2Expressions",
"description": "An expression."
}
},
"type": "object"
},
"GooglePrivacyDlpV2RecordKey": {
"description": "Message for a unique key indicating a record that contains a finding.",
"id": "GooglePrivacyDlpV2RecordKey",
"properties": {
"bigQueryKey": {
"$ref": "GooglePrivacyDlpV2BigQueryKey",
"description": "Datastore key"
},
"datastoreKey": {
"$ref": "GooglePrivacyDlpV2DatastoreKey",
"description": "BigQuery key"
},
"idValues": {
"description": "Values of identifying columns in the given row. Order of values matches the order of `identifying_fields` specified in the scanning request.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2RecordLocation": {
"description": "Location of a finding within a row or record.",
"id": "GooglePrivacyDlpV2RecordLocation",
"properties": {
"fieldId": {
"$ref": "GooglePrivacyDlpV2FieldId",
"description": "Field id of the field containing the finding."
},
"recordKey": {
"$ref": "GooglePrivacyDlpV2RecordKey",
"description": "Key of the finding."
},
"tableLocation": {
"$ref": "GooglePrivacyDlpV2TableLocation",
"description": "Location within a `ContentItem.Table`."
}
},
"type": "object"
},
"GooglePrivacyDlpV2RecordSuppression": {
"description": "Configuration to suppress records whose suppression conditions evaluate to true.",
"id": "GooglePrivacyDlpV2RecordSuppression",
"properties": {
"condition": {
"$ref": "GooglePrivacyDlpV2RecordCondition",
"description": "A condition that when it evaluates to true will result in the record being evaluated to be suppressed from the transformed content."
}
},
"type": "object"
},
"GooglePrivacyDlpV2RecordTransformation": {
"description": "The field in a record to transform.",
"id": "GooglePrivacyDlpV2RecordTransformation",
"properties": {
"containerTimestamp": {
"description": "Findings container modification timestamp, if applicable.",
"format": "google-datetime",
"type": "string"
},
"containerVersion": {
"description": "Container version, if available (\"generation\" for Cloud Storage).",
"type": "string"
},
"fieldId": {
"$ref": "GooglePrivacyDlpV2FieldId",
"description": "For record transformations, provide a field."
}
},
"type": "object"
},
"GooglePrivacyDlpV2RecordTransformations": {
"description": "A type of transformation that is applied over structured data such as a table.",
"id": "GooglePrivacyDlpV2RecordTransformations",
"properties": {
"fieldTransformations": {
"description": "Transform the record by applying various field transformations.",
"items": {
"$ref": "GooglePrivacyDlpV2FieldTransformation"
},
"type": "array"
},
"recordSuppressions": {
"description": "Configuration defining which records get suppressed entirely. Records that match any suppression rule are omitted from the output.",
"items": {
"$ref": "GooglePrivacyDlpV2RecordSuppression"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2RedactConfig": {
"description": "Redact a given value. For example, if used with an `InfoTypeTransformation` transforming PHONE_NUMBER, and input 'My phone number is 206-555-0123', the output would be 'My phone number is '.",
"id": "GooglePrivacyDlpV2RedactConfig",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2RedactImageRequest": {
"description": "Request to search for potentially sensitive info in an image and redact it by covering it with a colored rectangle.",
"id": "GooglePrivacyDlpV2RedactImageRequest",
"properties": {
"byteItem": {
"$ref": "GooglePrivacyDlpV2ByteContentItem",
"description": "The content must be PNG, JPEG, SVG or BMP."
},
"deidentifyTemplate": {
"description": "The full resource name of the de-identification template to use. Settings in the main `image_redaction_configs` field override the corresponding settings in this de-identification template. The request fails if the type of the template's deidentify_config is not image_transformations.",
"type": "string"
},
"imageRedactionConfigs": {
"description": "The configuration for specifying what content to redact from images.",
"items": {
"$ref": "GooglePrivacyDlpV2ImageRedactionConfig"
},
"type": "array"
},
"includeFindings": {
"description": "Whether the response should include findings along with the redacted image.",
"type": "boolean"
},
"inspectConfig": {
"$ref": "GooglePrivacyDlpV2InspectConfig",
"description": "Configuration for the inspector."
},
"inspectTemplate": {
"description": "The full resource name of the inspection template to use. Settings in the main `inspect_config` field override the corresponding settings in this inspection template. The merge behavior is as follows: - Singular field: The main field's value replaces the value of the corresponding field in the template. - Repeated fields: The field values are appended to the list defined in the template. - Sub-messages and groups: The fields are recursively merged.",
"type": "string"
},
"locationId": {
"description": "Deprecated. This field has no effect.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2RedactImageResponse": {
"description": "Results of redacting an image.",
"id": "GooglePrivacyDlpV2RedactImageResponse",
"properties": {
"extractedText": {
"description": "If an image was being inspected and the InspectConfig's include_quote was set to true, then this field will include all text, if any, that was found in the image.",
"type": "string"
},
"inspectResult": {
"$ref": "GooglePrivacyDlpV2InspectResult",
"description": "The findings. Populated when include_findings in the request is true."
},
"redactedImage": {
"description": "The redacted image. The type will be the same as the original image.",
"format": "byte",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2Regex": {
"description": "Message defining a custom regular expression.",
"id": "GooglePrivacyDlpV2Regex",
"properties": {
"groupIndexes": {
"description": "The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included.",
"items": {
"format": "int32",
"type": "integer"
},
"type": "array"
},
"pattern": {
"description": "Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2ReidentifyContentRequest": {
"description": "Request to re-identify an item.",
"id": "GooglePrivacyDlpV2ReidentifyContentRequest",
"properties": {
"inspectConfig": {
"$ref": "GooglePrivacyDlpV2InspectConfig",
"description": "Configuration for the inspector."
},
"inspectTemplateName": {
"description": "Template to use. Any configuration directly specified in `inspect_config` will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.",
"type": "string"
},
"item": {
"$ref": "GooglePrivacyDlpV2ContentItem",
"description": "The item to re-identify. Will be treated as text."
},
"locationId": {
"description": "Deprecated. This field has no effect.",
"type": "string"
},
"reidentifyConfig": {
"$ref": "GooglePrivacyDlpV2DeidentifyConfig",
"description": "Configuration for the re-identification of the content item. This field shares the same proto message type that is used for de-identification, however its usage here is for the reversal of the previous de-identification. Re-identification is performed by examining the transformations used to de-identify the items and executing the reverse. This requires that only reversible transformations be provided here. The reversible transformations are: - `CryptoDeterministicConfig` - `CryptoReplaceFfxFpeConfig`"
},
"reidentifyTemplateName": {
"description": "Template to use. References an instance of `DeidentifyTemplate`. Any configuration directly specified in `reidentify_config` or `inspect_config` will override those set in the template. The `DeidentifyTemplate` used must include only reversible transformations. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2ReidentifyContentResponse": {
"description": "Results of re-identifying an item.",
"id": "GooglePrivacyDlpV2ReidentifyContentResponse",
"properties": {
"item": {
"$ref": "GooglePrivacyDlpV2ContentItem",
"description": "The re-identified item."
},
"overview": {
"$ref": "GooglePrivacyDlpV2TransformationOverview",
"description": "An overview of the changes that were made to the `item`."
}
},
"type": "object"
},
"GooglePrivacyDlpV2RelatedResource": {
"description": "A related resource. Examples: * The source BigQuery table for a Vertex AI dataset. * The source Cloud Storage bucket for a Vertex AI dataset.",
"id": "GooglePrivacyDlpV2RelatedResource",
"properties": {
"fullResource": {
"description": "The full resource name of the related resource.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2ReplaceDictionaryConfig": {
"description": "Replace each input value with a value randomly selected from the dictionary.",
"id": "GooglePrivacyDlpV2ReplaceDictionaryConfig",
"properties": {
"wordList": {
"$ref": "GooglePrivacyDlpV2WordList",
"description": "A list of words to select from for random replacement. The [limits](https://cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries."
}
},
"type": "object"
},
"GooglePrivacyDlpV2ReplaceValueConfig": {
"description": "Replace each input value with a given `Value`.",
"id": "GooglePrivacyDlpV2ReplaceValueConfig",
"properties": {
"newValue": {
"$ref": "GooglePrivacyDlpV2Value",
"description": "Value to replace it with."
}
},
"type": "object"
},
"GooglePrivacyDlpV2ReplaceWithInfoTypeConfig": {
"description": "Replace each matching finding with the name of the info_type.",
"id": "GooglePrivacyDlpV2ReplaceWithInfoTypeConfig",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2RequestedDeidentifyOptions": {
"description": "De-identification options.",
"id": "GooglePrivacyDlpV2RequestedDeidentifyOptions",
"properties": {
"snapshotDeidentifyTemplate": {
"$ref": "GooglePrivacyDlpV2DeidentifyTemplate",
"description": "Snapshot of the state of the `DeidentifyTemplate` from the Deidentify action at the time this job was run."
},
"snapshotImageRedactTemplate": {
"$ref": "GooglePrivacyDlpV2DeidentifyTemplate",
"description": "Snapshot of the state of the image transformation `DeidentifyTemplate` from the `Deidentify` action at the time this job was run."
},
"snapshotStructuredDeidentifyTemplate": {
"$ref": "GooglePrivacyDlpV2DeidentifyTemplate",
"description": "Snapshot of the state of the structured `DeidentifyTemplate` from the `Deidentify` action at the time this job was run."
}
},
"type": "object"
},
"GooglePrivacyDlpV2RequestedOptions": {
"description": "Snapshot of the inspection configuration.",
"id": "GooglePrivacyDlpV2RequestedOptions",
"properties": {
"jobConfig": {
"$ref": "GooglePrivacyDlpV2InspectJobConfig",
"description": "Inspect config."
},
"snapshotInspectTemplate": {
"$ref": "GooglePrivacyDlpV2InspectTemplate",
"description": "If run with an InspectTemplate, a snapshot of its state at the time of this run."
}
},
"type": "object"
},
"GooglePrivacyDlpV2RequestedRiskAnalysisOptions": {
"description": "Risk analysis options.",
"id": "GooglePrivacyDlpV2RequestedRiskAnalysisOptions",
"properties": {
"jobConfig": {
"$ref": "GooglePrivacyDlpV2RiskAnalysisJobConfig",
"description": "The job config for the risk job."
}
},
"type": "object"
},
"GooglePrivacyDlpV2Result": {
"description": "All Result fields are updated while the job is processing.",
"id": "GooglePrivacyDlpV2Result",
"properties": {
"hybridStats": {
"$ref": "GooglePrivacyDlpV2HybridInspectStatistics",
"description": "Statistics related to the processing of hybrid inspect."
},
"infoTypeStats": {
"description": "Statistics of how many instances of each info type were found during inspect job.",
"items": {
"$ref": "GooglePrivacyDlpV2InfoTypeStats"
},
"type": "array"
},
"numRowsProcessed": {
"description": "Number of rows scanned after sampling and time filtering (applicable for row based stores such as BigQuery).",
"format": "int64",
"type": "string"
},
"processedBytes": {
"description": "Total size in bytes that were processed.",
"format": "int64",
"type": "string"
},
"totalEstimatedBytes": {
"description": "Estimate of the number of bytes to process.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2RiskAnalysisJobConfig": {
"description": "Configuration for a risk analysis job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis to learn more.",
"id": "GooglePrivacyDlpV2RiskAnalysisJobConfig",
"properties": {
"actions": {
"description": "Actions to execute at the completion of the job. Are executed in the order provided.",
"items": {
"$ref": "GooglePrivacyDlpV2Action"
},
"type": "array"
},
"privacyMetric": {
"$ref": "GooglePrivacyDlpV2PrivacyMetric",
"description": "Privacy metric to compute."
},
"sourceTable": {
"$ref": "GooglePrivacyDlpV2BigQueryTable",
"description": "Input dataset to compute metrics over."
}
},
"type": "object"
},
"GooglePrivacyDlpV2Row": {
"description": "Values of the row.",
"id": "GooglePrivacyDlpV2Row",
"properties": {
"values": {
"description": "Individual cells.",
"items": {
"$ref": "GooglePrivacyDlpV2Value"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2SaveFindings": {
"description": "If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk",
"id": "GooglePrivacyDlpV2SaveFindings",
"properties": {
"outputConfig": {
"$ref": "GooglePrivacyDlpV2OutputStorageConfig",
"description": "Location to store findings outside of DLP."
}
},
"type": "object"
},
"GooglePrivacyDlpV2SaveToGcsFindingsOutput": {
"description": "Collection of findings saved to a Cloud Storage bucket. This is used as the proto schema for textproto files created when specifying a cloud storage path to save Inspect findings.",
"id": "GooglePrivacyDlpV2SaveToGcsFindingsOutput",
"properties": {
"findings": {
"description": "List of findings.",
"items": {
"$ref": "GooglePrivacyDlpV2Finding"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2Schedule": {
"description": "Schedule for inspect job triggers.",
"id": "GooglePrivacyDlpV2Schedule",
"properties": {
"recurrencePeriodDuration": {
"description": "With this option a job is started on a regular periodic basis. For example: every day (86400 seconds). A scheduled start time will be skipped if the previous execution has not ended when its scheduled time occurs. This value must be set to a time duration greater than or equal to 1 day and can be no longer than 60 days.",
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2SchemaModifiedCadence": {
"description": "How frequently to modify the profile when the table's schema is modified.",
"id": "GooglePrivacyDlpV2SchemaModifiedCadence",
"properties": {
"frequency": {
"description": "Frequency to regenerate data profiles when the schema is modified. Defaults to monthly.",
"enum": [
"UPDATE_FREQUENCY_UNSPECIFIED",
"UPDATE_FREQUENCY_NEVER",
"UPDATE_FREQUENCY_DAILY",
"UPDATE_FREQUENCY_MONTHLY"
],
"enumDescriptions": [
"Unspecified.",
"After the data profile is created, it will never be updated.",
"The data profile can be updated up to once every 24 hours.",
"The data profile can be updated up to once every 30 days. Default."
],
"type": "string"
},
"types": {
"description": "The types of schema modifications to consider. Defaults to NEW_COLUMNS.",
"items": {
"enum": [
"SQL_SCHEMA_MODIFICATION_UNSPECIFIED",
"NEW_COLUMNS",
"REMOVED_COLUMNS"
],
"enumDescriptions": [
"Unused.",
"New columns have appeared.",
"Columns have been removed from the table."
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2SearchConnectionsResponse": {
"description": "Response message for SearchConnections.",
"id": "GooglePrivacyDlpV2SearchConnectionsResponse",
"properties": {
"connections": {
"description": "List of connections that match the search query. Note that only a subset of the fields will be populated, and only \"name\" is guaranteed to be set. For full details of a Connection, call GetConnection with the name.",
"items": {
"$ref": "GooglePrivacyDlpV2Connection"
},
"type": "array"
},
"nextPageToken": {
"description": "Token to retrieve the next page of results. An empty value means there are no more results.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2SecretManagerCredential": {
"description": "A credential consisting of a username and password, where the password is stored in a Secret Manager resource. Note: Secret Manager [charges apply](https://cloud.google.com/secret-manager/pricing).",
"id": "GooglePrivacyDlpV2SecretManagerCredential",
"properties": {
"passwordSecretVersionName": {
"description": "Required. The name of the Secret Manager resource that stores the password, in the form `projects/project-id/secrets/secret-name/versions/version`.",
"type": "string"
},
"username": {
"description": "Required. The username.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2SecretsDiscoveryTarget": {
"description": "Discovery target for credentials and secrets in cloud resource metadata. This target does not include any filtering or frequency controls. Cloud DLP will scan cloud resource metadata for secrets daily. No inspect template should be included in the discovery config for a security benchmarks scan. Instead, the built-in list of secrets and credentials infoTypes will be used (see https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference#credentials_and_secrets). Credentials and secrets discovered will be reported as vulnerabilities to Security Command Center.",
"id": "GooglePrivacyDlpV2SecretsDiscoveryTarget",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2SelectedInfoTypes": {
"description": "Apply transformation to the selected info_types.",
"id": "GooglePrivacyDlpV2SelectedInfoTypes",
"properties": {
"infoTypes": {
"description": "Required. InfoTypes to apply the transformation to. Required. Provided InfoType must be unique within the ImageTransformations message.",
"items": {
"$ref": "GooglePrivacyDlpV2InfoType"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2SensitivityScore": {
"description": "Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive.",
"id": "GooglePrivacyDlpV2SensitivityScore",
"properties": {
"score": {
"description": "The sensitivity score applied to the resource.",
"enum": [
"SENSITIVITY_SCORE_UNSPECIFIED",
"SENSITIVITY_LOW",
"SENSITIVITY_UNKNOWN",
"SENSITIVITY_MODERATE",
"SENSITIVITY_HIGH"
],
"enumDescriptions": [
"Unused.",
"No sensitive information detected. The resource isn't publicly accessible.",
"Unable to determine sensitivity.",
"Medium risk. Contains personally identifiable information (PII), potentially sensitive data, or fields with free-text data that are at a higher risk of having intermittent sensitive data. Consider limiting access.",
"High risk. Sensitive personally identifiable information (SPII) can be present. Exfiltration of data can lead to user data loss. Re-identification of users might be possible. Consider limiting usage and or removing SPII."
],
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2StatisticalTable": {
"description": "An auxiliary table containing statistical information on the relative frequency of different quasi-identifiers values. It has one or several quasi-identifiers columns, and one column that indicates the relative frequency of each quasi-identifier tuple. If a tuple is present in the data but not in the auxiliary table, the corresponding relative frequency is assumed to be zero (and thus, the tuple is highly reidentifiable).",
"id": "GooglePrivacyDlpV2StatisticalTable",
"properties": {
"quasiIds": {
"description": "Required. Quasi-identifier columns.",
"items": {
"$ref": "GooglePrivacyDlpV2QuasiIdentifierField"
},
"type": "array"
},
"relativeFrequency": {
"$ref": "GooglePrivacyDlpV2FieldId",
"description": "Required. The relative frequency column must contain a floating-point number between 0 and 1 (inclusive). Null values are assumed to be zero."
},
"table": {
"$ref": "GooglePrivacyDlpV2BigQueryTable",
"description": "Required. Auxiliary table location."
}
},
"type": "object"
},
"GooglePrivacyDlpV2StorageConfig": {
"description": "Shared message indicating Cloud storage type.",
"id": "GooglePrivacyDlpV2StorageConfig",
"properties": {
"bigQueryOptions": {
"$ref": "GooglePrivacyDlpV2BigQueryOptions",
"description": "BigQuery options."
},
"cloudStorageOptions": {
"$ref": "GooglePrivacyDlpV2CloudStorageOptions",
"description": "Cloud Storage options."
},
"datastoreOptions": {
"$ref": "GooglePrivacyDlpV2DatastoreOptions",
"description": "Google Cloud Datastore options."
},
"hybridOptions": {
"$ref": "GooglePrivacyDlpV2HybridOptions",
"description": "Hybrid inspection options."
},
"timespanConfig": {
"$ref": "GooglePrivacyDlpV2TimespanConfig",
"description": "Configuration of the timespan of the items to include in scanning."
}
},
"type": "object"
},
"GooglePrivacyDlpV2StorageMetadataLabel": {
"description": "Storage metadata label to indicate which metadata entry contains findings.",
"id": "GooglePrivacyDlpV2StorageMetadataLabel",
"properties": {
"key": {
"description": "Label name.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2StoredInfoType": {
"description": "StoredInfoType resource message that contains information about the current version and any pending updates.",
"id": "GooglePrivacyDlpV2StoredInfoType",
"properties": {
"currentVersion": {
"$ref": "GooglePrivacyDlpV2StoredInfoTypeVersion",
"description": "Current version of the stored info type."
},
"name": {
"description": "Resource name.",
"type": "string"
},
"pendingVersions": {
"description": "Pending versions of the stored info type. Empty if no versions are pending.",
"items": {
"$ref": "GooglePrivacyDlpV2StoredInfoTypeVersion"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2StoredInfoTypeConfig": {
"description": "Configuration for stored infoTypes. All fields and subfield are provided by the user. For more information, see https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes.",
"id": "GooglePrivacyDlpV2StoredInfoTypeConfig",
"properties": {
"description": {
"description": "Description of the StoredInfoType (max 256 characters).",
"type": "string"
},
"dictionary": {
"$ref": "GooglePrivacyDlpV2Dictionary",
"description": "Store dictionary-based CustomInfoType."
},
"displayName": {
"description": "Display name of the StoredInfoType (max 256 characters).",
"type": "string"
},
"largeCustomDictionary": {
"$ref": "GooglePrivacyDlpV2LargeCustomDictionaryConfig",
"description": "StoredInfoType where findings are defined by a dictionary of phrases."
},
"regex": {
"$ref": "GooglePrivacyDlpV2Regex",
"description": "Store regular expression-based StoredInfoType."
}
},
"type": "object"
},
"GooglePrivacyDlpV2StoredInfoTypeStats": {
"description": "Statistics for a StoredInfoType.",
"id": "GooglePrivacyDlpV2StoredInfoTypeStats",
"properties": {
"largeCustomDictionary": {
"$ref": "GooglePrivacyDlpV2LargeCustomDictionaryStats",
"description": "StoredInfoType where findings are defined by a dictionary of phrases."
}
},
"type": "object"
},
"GooglePrivacyDlpV2StoredInfoTypeVersion": {
"description": "Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state.",
"id": "GooglePrivacyDlpV2StoredInfoTypeVersion",
"properties": {
"config": {
"$ref": "GooglePrivacyDlpV2StoredInfoTypeConfig",
"description": "StoredInfoType configuration."
},
"createTime": {
"description": "Create timestamp of the version. Read-only, determined by the system when the version is created.",
"format": "google-datetime",
"type": "string"
},
"errors": {
"description": "Errors that occurred when creating this storedInfoType version, or anomalies detected in the storedInfoType data that render it unusable. Only the five most recent errors will be displayed, with the most recent error appearing first. For example, some of the data for stored custom dictionaries is put in the user's Cloud Storage bucket, and if this data is modified or deleted by the user or another system, the dictionary becomes invalid. If any errors occur, fix the problem indicated by the error message and use the UpdateStoredInfoType API method to create another version of the storedInfoType to continue using it, reusing the same `config` if it was not the source of the error.",
"items": {
"$ref": "GooglePrivacyDlpV2Error"
},
"type": "array"
},
"state": {
"description": "Stored info type version state. Read-only, updated by the system during dictionary creation.",
"enum": [
"STORED_INFO_TYPE_STATE_UNSPECIFIED",
"PENDING",
"READY",
"FAILED",
"INVALID"
],
"enumDescriptions": [
"Unused",
"StoredInfoType version is being created.",
"StoredInfoType version is ready for use.",
"StoredInfoType creation failed. All relevant error messages are returned in the `StoredInfoTypeVersion` message.",
"StoredInfoType is no longer valid because artifacts stored in user-controlled storage were modified. To fix an invalid StoredInfoType, use the `UpdateStoredInfoType` method to create a new version."
],
"type": "string"
},
"stats": {
"$ref": "GooglePrivacyDlpV2StoredInfoTypeStats",
"description": "Statistics about this storedInfoType version."
}
},
"type": "object"
},
"GooglePrivacyDlpV2StoredType": {
"description": "A reference to a StoredInfoType to use with scanning.",
"id": "GooglePrivacyDlpV2StoredType",
"properties": {
"createTime": {
"description": "Timestamp indicating when the version of the `StoredInfoType` used for inspection was created. Output-only field, populated by the system.",
"format": "google-datetime",
"type": "string"
},
"name": {
"description": "Resource name of the requested `StoredInfoType`, for example `organizations/433245324/storedInfoTypes/432452342` or `projects/project-id/storedInfoTypes/432452342`.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2SummaryResult": {
"description": "A collection that informs the user the number of times a particular `TransformationResultCode` and error details occurred.",
"id": "GooglePrivacyDlpV2SummaryResult",
"properties": {
"code": {
"description": "Outcome of the transformation.",
"enum": [
"TRANSFORMATION_RESULT_CODE_UNSPECIFIED",
"SUCCESS",
"ERROR"
],
"enumDescriptions": [
"Unused",
"Transformation completed without an error.",
"Transformation had an error."
],
"type": "string"
},
"count": {
"description": "Number of transformations counted by this result.",
"format": "int64",
"type": "string"
},
"details": {
"description": "A place for warnings or errors to show up if a transformation didn't work as expected.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2SurrogateType": {
"description": "Message for detecting output from deidentification transformations such as [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). These types of transformations are those that perform pseudonymization, thereby producing a \"surrogate\" as output. This should be used in conjunction with a field on the transformation such as `surrogate_info_type`. This CustomInfoType does not support the use of `detection_rules`.",
"id": "GooglePrivacyDlpV2SurrogateType",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2Table": {
"description": "Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more.",
"id": "GooglePrivacyDlpV2Table",
"properties": {
"headers": {
"description": "Headers of the table.",
"items": {
"$ref": "GooglePrivacyDlpV2FieldId"
},
"type": "array"
},
"rows": {
"description": "Rows of the table.",
"items": {
"$ref": "GooglePrivacyDlpV2Row"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2TableDataProfile": {
"description": "The profile for a scanned table.",
"id": "GooglePrivacyDlpV2TableDataProfile",
"properties": {
"configSnapshot": {
"$ref": "GooglePrivacyDlpV2DataProfileConfigSnapshot",
"description": "The snapshot of the configurations used to generate the profile."
},
"createTime": {
"description": "The time at which the table was created.",
"format": "google-datetime",
"type": "string"
},
"dataRiskLevel": {
"$ref": "GooglePrivacyDlpV2DataRiskLevel",
"description": "The data risk level of this table."
},
"dataSourceType": {
"$ref": "GooglePrivacyDlpV2DataSourceType",
"description": "The resource type that was profiled."
},
"datasetId": {
"description": "If the resource is BigQuery, the dataset ID.",
"type": "string"
},
"datasetLocation": {
"description": "If supported, the location where the dataset's data is stored. See https://cloud.google.com/bigquery/docs/locations for supported locations.",
"type": "string"
},
"datasetProjectId": {
"description": "The Google Cloud project ID that owns the resource.",
"type": "string"
},
"domains": {
"description": "Domains associated with the profile.",
"items": {
"$ref": "GooglePrivacyDlpV2Domain"
},
"type": "array"
},
"encryptionStatus": {
"description": "How the table is encrypted.",
"enum": [
"ENCRYPTION_STATUS_UNSPECIFIED",
"ENCRYPTION_GOOGLE_MANAGED",
"ENCRYPTION_CUSTOMER_MANAGED"
],
"enumDescriptions": [
"Unused.",
"Google manages server-side encryption keys on your behalf.",
"Customer provides the key."
],
"type": "string"
},
"expirationTime": {
"description": "Optional. The time when this table expires.",
"format": "google-datetime",
"type": "string"
},
"failedColumnCount": {
"description": "The number of columns skipped in the table because of an error.",
"format": "int64",
"type": "string"
},
"fullResource": {
"description": "The Cloud Asset Inventory resource that was profiled in order to generate this TableDataProfile. https://cloud.google.com/apis/design/resource_names#full_resource_name",
"type": "string"
},
"lastModifiedTime": {
"description": "The time when this table was last modified",
"format": "google-datetime",
"type": "string"
},
"name": {
"description": "The name of the profile.",
"type": "string"
},
"otherInfoTypes": {
"description": "Other infoTypes found in this table's data.",
"items": {
"$ref": "GooglePrivacyDlpV2OtherInfoTypeSummary"
},
"type": "array"
},
"predictedInfoTypes": {
"description": "The infoTypes predicted from this table's data.",
"items": {
"$ref": "GooglePrivacyDlpV2InfoTypeSummary"
},
"type": "array"
},
"profileLastGenerated": {
"description": "The last time the profile was generated.",
"format": "google-datetime",
"type": "string"
},
"profileStatus": {
"$ref": "GooglePrivacyDlpV2ProfileStatus",
"description": "Success or error status from the most recent profile generation attempt. May be empty if the profile is still being generated."
},
"projectDataProfile": {
"description": "The resource name of the project data profile for this table.",
"type": "string"
},
"relatedResources": {
"description": "Resources related to this profile.",
"items": {
"$ref": "GooglePrivacyDlpV2RelatedResource"
},
"type": "array"
},
"resourceLabels": {
"additionalProperties": {
"type": "string"
},
"description": "The labels applied to the resource at the time the profile was generated.",
"type": "object"
},
"resourceVisibility": {
"description": "How broadly a resource has been shared.",
"enum": [
"RESOURCE_VISIBILITY_UNSPECIFIED",
"RESOURCE_VISIBILITY_PUBLIC",
"RESOURCE_VISIBILITY_INCONCLUSIVE",
"RESOURCE_VISIBILITY_RESTRICTED"
],
"enumDescriptions": [
"Unused.",
"Visible to any user.",
"May contain public items. For example, if a Cloud Storage bucket has uniform bucket level access disabled, some objects inside it may be public, but none are known yet.",
"Visible only to specific users."
],
"type": "string"
},
"rowCount": {
"description": "Number of rows in the table when the profile was generated. This will not be populated for BigLake tables.",
"format": "int64",
"type": "string"
},
"sampleFindingsTable": {
"$ref": "GooglePrivacyDlpV2BigQueryTable",
"description": "The BigQuery table to which the sample findings are written."
},
"scannedColumnCount": {
"description": "The number of columns profiled in the table.",
"format": "int64",
"type": "string"
},
"sensitivityScore": {
"$ref": "GooglePrivacyDlpV2SensitivityScore",
"description": "The sensitivity score of this table."
},
"state": {
"description": "State of a profile. This will always be set to DONE when the table data profile is written to another service like BigQuery or Pub/Sub.",
"enum": [
"STATE_UNSPECIFIED",
"RUNNING",
"DONE"
],
"enumDescriptions": [
"Unused.",
"The profile is currently running. Once a profile has finished it will transition to DONE.",
"The profile is no longer generating. If profile_status.status.code is 0, the profile succeeded, otherwise, it failed."
],
"type": "string"
},
"tableId": {
"description": "The table ID.",
"type": "string"
},
"tableSizeBytes": {
"description": "The size of the table when the profile was generated.",
"format": "int64",
"type": "string"
},
"tags": {
"description": "The tags attached to the table, including any tags attached during profiling. Because tags are attached to Cloud SQL instances rather than Cloud SQL tables, this field is empty for Cloud SQL table profiles.",
"items": {
"$ref": "GooglePrivacyDlpV2Tag"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2TableLocation": {
"description": "Location of a finding within a table.",
"id": "GooglePrivacyDlpV2TableLocation",
"properties": {
"rowIndex": {
"description": "The zero-based index of the row where the finding is located. Only populated for resources that have a natural ordering, not BigQuery. In BigQuery, to identify the row a finding came from, populate BigQueryOptions.identifying_fields with your primary key column names and when you store the findings the value of those columns will be stored inside of Finding.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2TableOptions": {
"description": "Instructions regarding the table content being inspected.",
"id": "GooglePrivacyDlpV2TableOptions",
"properties": {
"identifyingFields": {
"description": "The columns that are the primary keys for table objects included in ContentItem. A copy of this cell's value will stored alongside alongside each finding so that the finding can be traced to the specific row it came from. No more than 3 may be provided.",
"items": {
"$ref": "GooglePrivacyDlpV2FieldId"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2TableReference": {
"description": "Message defining the location of a BigQuery table with the projectId inferred from the parent project.",
"id": "GooglePrivacyDlpV2TableReference",
"properties": {
"datasetId": {
"description": "Dataset ID of the table.",
"type": "string"
},
"projectId": {
"description": "The Google Cloud project ID of the project containing the table. If omitted, the project ID is inferred from the parent project. This field is required if the parent resource is an organization.",
"type": "string"
},
"tableId": {
"description": "Name of the table.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2Tag": {
"description": "A tag associated with a resource.",
"id": "GooglePrivacyDlpV2Tag",
"properties": {
"key": {
"description": "The key of a tag key-value pair. For Google Cloud resources, this is the resource name of the key, for example, \"tagKeys/123456\".",
"type": "string"
},
"namespacedTagValue": {
"description": "The namespaced name for the tag value to attach to Google Cloud resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, \"123456/environment/prod\" for an organization parent, or \"my-project/environment/prod\" for a project parent. This is only set for Google Cloud resources.",
"type": "string"
},
"value": {
"description": "The value of a tag key-value pair. For Google Cloud resources, this is the resource name of the value, for example, \"tagValues/123456\".",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2TagCondition": {
"description": "The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level.",
"id": "GooglePrivacyDlpV2TagCondition",
"properties": {
"sensitivityScore": {
"$ref": "GooglePrivacyDlpV2SensitivityScore",
"description": "Conditions attaching the tag to a resource on its profile having this sensitivity score."
},
"tag": {
"$ref": "GooglePrivacyDlpV2TagValue",
"description": "The tag value to attach to resources."
}
},
"type": "object"
},
"GooglePrivacyDlpV2TagFilter": {
"description": "A single tag to filter against.",
"id": "GooglePrivacyDlpV2TagFilter",
"properties": {
"namespacedTagKey": {
"description": "The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, \"123456/sensitive\" for an organization parent, or \"my-project/sensitive\" for a project parent.",
"type": "string"
},
"namespacedTagValue": {
"description": "The namespaced name for the tag value. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, \"123456/environment/prod\" for an organization parent, or \"my-project/environment/prod\" for a project parent.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2TagFilters": {
"description": "Tags to match against for filtering.",
"id": "GooglePrivacyDlpV2TagFilters",
"properties": {
"tagFilters": {
"description": "Required. A resource must match ALL of the specified tag filters to be included in the collection.",
"items": {
"$ref": "GooglePrivacyDlpV2TagFilter"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2TagResources": {
"description": "If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag.",
"id": "GooglePrivacyDlpV2TagResources",
"properties": {
"lowerDataRiskToLow": {
"description": "Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles.",
"type": "boolean"
},
"profileGenerationsToTag": {
"description": "The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`.",
"items": {
"enum": [
"PROFILE_GENERATION_UNSPECIFIED",
"PROFILE_GENERATION_NEW",
"PROFILE_GENERATION_UPDATE"
],
"enumDescriptions": [
"Unused.",
"The profile is the first profile for the resource.",
"The profile is an update to a previous profile."
],
"type": "string"
},
"type": "array"
},
"tagConditions": {
"description": "The tags to associate with different conditions.",
"items": {
"$ref": "GooglePrivacyDlpV2TagCondition"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2TagValue": {
"description": "A value of a tag.",
"id": "GooglePrivacyDlpV2TagValue",
"properties": {
"namespacedValue": {
"description": "The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, \"123456/environment/prod\" for an organization parent, or \"my-project/environment/prod\" for a project parent.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2TaggedField": {
"description": "A column with a semantic tag attached.",
"id": "GooglePrivacyDlpV2TaggedField",
"properties": {
"customTag": {
"description": "A column can be tagged with a custom tag. In this case, the user must indicate an auxiliary table that contains statistical information on the possible values of this column.",
"type": "string"
},
"field": {
"$ref": "GooglePrivacyDlpV2FieldId",
"description": "Required. Identifies the column."
},
"inferred": {
"$ref": "GoogleProtobufEmpty",
"description": "If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data"
},
"infoType": {
"$ref": "GooglePrivacyDlpV2InfoType",
"description": "A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders. To programmatically obtain the list of supported InfoTypes, use ListInfoTypes with the supported_by=RISK_ANALYSIS filter."
}
},
"type": "object"
},
"GooglePrivacyDlpV2ThrowError": {
"description": "Throw an error and fail the request when a transformation error occurs.",
"id": "GooglePrivacyDlpV2ThrowError",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2TimePartConfig": {
"description": "For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a portion of the value.",
"id": "GooglePrivacyDlpV2TimePartConfig",
"properties": {
"partToExtract": {
"description": "The part of the time to keep.",
"enum": [
"TIME_PART_UNSPECIFIED",
"YEAR",
"MONTH",
"DAY_OF_MONTH",
"DAY_OF_WEEK",
"WEEK_OF_YEAR",
"HOUR_OF_DAY"
],
"enumDescriptions": [
"Unused",
"[0-9999]",
"[1-12]",
"[1-31]",
"[1-7]",
"[1-53]",
"[0-23]"
],
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2TimeZone": {
"description": "Time zone of the date time object.",
"id": "GooglePrivacyDlpV2TimeZone",
"properties": {
"offsetMinutes": {
"description": "Set only if the offset can be determined. Positive for time ahead of UTC. E.g. For \"UTC-9\", this value is -540.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GooglePrivacyDlpV2TimespanConfig": {
"description": "Configuration of the timespan of the items to include in scanning. Currently only supported when inspecting Cloud Storage and BigQuery.",
"id": "GooglePrivacyDlpV2TimespanConfig",
"properties": {
"enableAutoPopulationOfTimespanConfig": {
"description": "When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation.",
"type": "boolean"
},
"endTime": {
"description": "Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied.",
"format": "google-datetime",
"type": "string"
},
"startTime": {
"description": "Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied.",
"format": "google-datetime",
"type": "string"
},
"timestampField": {
"$ref": "GooglePrivacyDlpV2FieldId",
"description": "Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation."
}
},
"type": "object"
},
"GooglePrivacyDlpV2TransformationConfig": {
"description": "User specified templates and configs for how to deidentify structured, unstructures, and image files. User must provide either a unstructured deidentify template or at least one redact image config.",
"id": "GooglePrivacyDlpV2TransformationConfig",
"properties": {
"deidentifyTemplate": {
"description": "De-identify template. If this template is specified, it will serve as the default de-identify template. This template cannot contain `record_transformations` since it can be used for unstructured content such as free-form text files. If this template is not set, a default `ReplaceWithInfoTypeConfig` will be used to de-identify unstructured content.",
"type": "string"
},
"imageRedactTemplate": {
"description": "Image redact template. If this template is specified, it will serve as the de-identify template for images. If this template is not set, all findings in the image will be redacted with a black box.",
"type": "string"
},
"structuredDeidentifyTemplate": {
"description": "Structured de-identify template. If this template is specified, it will serve as the de-identify template for structured content such as delimited files and tables. If this template is not set but the `deidentify_template` is set, then `deidentify_template` will also apply to the structured content. If neither template is set, a default `ReplaceWithInfoTypeConfig` will be used to de-identify structured content.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2TransformationDescription": {
"description": "A flattened description of a `PrimitiveTransformation` or `RecordSuppression`.",
"id": "GooglePrivacyDlpV2TransformationDescription",
"properties": {
"condition": {
"description": "A human-readable string representation of the `RecordCondition` corresponding to this transformation. Set if a `RecordCondition` was used to determine whether or not to apply this transformation. Examples: * (age_field > 85) * (age_field <= 18) * (zip_field exists) * (zip_field == 01234) && (city_field != \"Springville\") * (zip_field == 01234) && (age_field <= 18) && (city_field exists)",
"type": "string"
},
"description": {
"description": "A description of the transformation. This is empty for a RECORD_SUPPRESSION, or is the output of calling toString() on the `PrimitiveTransformation` protocol buffer message for any other type of transformation.",
"type": "string"
},
"infoType": {
"$ref": "GooglePrivacyDlpV2InfoType",
"description": "Set if the transformation was limited to a specific `InfoType`."
},
"type": {
"description": "The transformation type.",
"enum": [
"TRANSFORMATION_TYPE_UNSPECIFIED",
"RECORD_SUPPRESSION",
"REPLACE_VALUE",
"REPLACE_DICTIONARY",
"REDACT",
"CHARACTER_MASK",
"CRYPTO_REPLACE_FFX_FPE",
"FIXED_SIZE_BUCKETING",
"BUCKETING",
"REPLACE_WITH_INFO_TYPE",
"TIME_PART",
"CRYPTO_HASH",
"DATE_SHIFT",
"CRYPTO_DETERMINISTIC_CONFIG",
"REDACT_IMAGE"
],
"enumDescriptions": [
"Unused",
"Record suppression",
"Replace value",
"Replace value using a dictionary.",
"Redact",
"Character mask",
"FFX-FPE",
"Fixed size bucketing",
"Bucketing",
"Replace with info type",
"Time part",
"Crypto hash",
"Date shift",
"Deterministic crypto",
"Redact image"
],
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2TransformationDetails": {
"description": "Details about a single transformation. This object contains a description of the transformation, information about whether the transformation was successfully applied, and the precise location where the transformation occurred. These details are stored in a user-specified BigQuery table.",
"id": "GooglePrivacyDlpV2TransformationDetails",
"properties": {
"containerName": {
"description": "The top level name of the container where the transformation is located (this will be the source file name or table name).",
"type": "string"
},
"resourceName": {
"description": "The name of the job that completed the transformation.",
"type": "string"
},
"statusDetails": {
"$ref": "GooglePrivacyDlpV2TransformationResultStatus",
"description": "Status of the transformation, if transformation was not successful, this will specify what caused it to fail, otherwise it will show that the transformation was successful."
},
"transformation": {
"description": "Description of transformation. This would only contain more than one element if there were multiple matching transformations and which one to apply was ambiguous. Not set for states that contain no transformation, currently only state that contains no transformation is TransformationResultStateType.METADATA_UNRETRIEVABLE.",
"items": {
"$ref": "GooglePrivacyDlpV2TransformationDescription"
},
"type": "array"
},
"transformationLocation": {
"$ref": "GooglePrivacyDlpV2TransformationLocation",
"description": "The precise location of the transformed content in the original container."
},
"transformedBytes": {
"description": "The number of bytes that were transformed. If transformation was unsuccessful or did not take place because there was no content to transform, this will be zero.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2TransformationDetailsStorageConfig": {
"description": "Config for storing transformation details.",
"id": "GooglePrivacyDlpV2TransformationDetailsStorageConfig",
"properties": {
"table": {
"$ref": "GooglePrivacyDlpV2BigQueryTable",
"description": "The BigQuery table in which to store the output. This may be an existing table or in a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_transformation_details_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details."
}
},
"type": "object"
},
"GooglePrivacyDlpV2TransformationErrorHandling": {
"description": "How to handle transformation errors during de-identification. A transformation error occurs when the requested transformation is incompatible with the data. For example, trying to de-identify an IP address using a `DateShift` transformation would result in a transformation error, since date info cannot be extracted from an IP address. Information about any incompatible transformations, and how they were handled, is returned in the response as part of the `TransformationOverviews`.",
"id": "GooglePrivacyDlpV2TransformationErrorHandling",
"properties": {
"leaveUntransformed": {
"$ref": "GooglePrivacyDlpV2LeaveUntransformed",
"description": "Ignore errors"
},
"throwError": {
"$ref": "GooglePrivacyDlpV2ThrowError",
"description": "Throw an error"
}
},
"type": "object"
},
"GooglePrivacyDlpV2TransformationLocation": {
"description": "Specifies the location of a transformation.",
"id": "GooglePrivacyDlpV2TransformationLocation",
"properties": {
"containerType": {
"description": "Information about the functionality of the container where this finding occurred, if available.",
"enum": [
"TRANSFORM_UNKNOWN_CONTAINER",
"TRANSFORM_BODY",
"TRANSFORM_METADATA",
"TRANSFORM_TABLE"
],
"enumDescriptions": [
"Unused.",
"Body of a file.",
"Metadata for a file.",
"A table."
],
"type": "string"
},
"findingId": {
"description": "For infotype transformations, link to the corresponding findings ID so that location information does not need to be duplicated. Each findings ID correlates to an entry in the findings output table, this table only gets created when users specify to save findings (add the save findings action to the request).",
"type": "string"
},
"recordTransformation": {
"$ref": "GooglePrivacyDlpV2RecordTransformation",
"description": "For record transformations, provide a field and container information."
}
},
"type": "object"
},
"GooglePrivacyDlpV2TransformationOverview": {
"description": "Overview of the modifications that occurred.",
"id": "GooglePrivacyDlpV2TransformationOverview",
"properties": {
"transformationSummaries": {
"description": "Transformations applied to the dataset.",
"items": {
"$ref": "GooglePrivacyDlpV2TransformationSummary"
},
"type": "array"
},
"transformedBytes": {
"description": "Total size in bytes that were transformed in some way.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2TransformationResultStatus": {
"description": "The outcome of a transformation.",
"id": "GooglePrivacyDlpV2TransformationResultStatus",
"properties": {
"details": {
"$ref": "GoogleRpcStatus",
"description": "Detailed error codes and messages"
},
"resultStatusType": {
"description": "Transformation result status type, this will be either SUCCESS, or it will be the reason for why the transformation was not completely successful.",
"enum": [
"STATE_TYPE_UNSPECIFIED",
"INVALID_TRANSFORM",
"BIGQUERY_MAX_ROW_SIZE_EXCEEDED",
"METADATA_UNRETRIEVABLE",
"SUCCESS"
],
"enumDescriptions": [
"Unused.",
"This will be set when a finding could not be transformed (i.e. outside user set bucket range).",
"This will be set when a BigQuery transformation was successful but could not be stored back in BigQuery because the transformed row exceeds BigQuery's max row size.",
"This will be set when there is a finding in the custom metadata of a file, but at the write time of the transformed file, this key / value pair is unretrievable.",
"This will be set when the transformation and storing of it is successful."
],
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2TransformationSummary": {
"description": "Summary of a single transformation. Only one of 'transformation', 'field_transformation', or 'record_suppress' will be set.",
"id": "GooglePrivacyDlpV2TransformationSummary",
"properties": {
"field": {
"$ref": "GooglePrivacyDlpV2FieldId",
"description": "Set if the transformation was limited to a specific FieldId."
},
"fieldTransformations": {
"description": "The field transformation that was applied. If multiple field transformations are requested for a single field, this list will contain all of them; otherwise, only one is supplied.",
"items": {
"$ref": "GooglePrivacyDlpV2FieldTransformation"
},
"type": "array"
},
"infoType": {
"$ref": "GooglePrivacyDlpV2InfoType",
"description": "Set if the transformation was limited to a specific InfoType."
},
"recordSuppress": {
"$ref": "GooglePrivacyDlpV2RecordSuppression",
"description": "The specific suppression option these stats apply to."
},
"results": {
"description": "Collection of all transformations that took place or had an error.",
"items": {
"$ref": "GooglePrivacyDlpV2SummaryResult"
},
"type": "array"
},
"transformation": {
"$ref": "GooglePrivacyDlpV2PrimitiveTransformation",
"description": "The specific transformation these stats apply to."
},
"transformedBytes": {
"description": "Total size in bytes that were transformed in some way.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2TransientCryptoKey": {
"description": "Use this to have a random data crypto key generated. It will be discarded after the request finishes.",
"id": "GooglePrivacyDlpV2TransientCryptoKey",
"properties": {
"name": {
"description": "Required. Name of the key. This is an arbitrary string used to differentiate different keys. A unique key is generated per name: two separate `TransientCryptoKey` protos share the same generated key if their names are the same. When the data crypto key is generated, this name is not used in any way (repeating the api call will result in a different key being generated).",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2Trigger": {
"description": "What event needs to occur for a new job to be started.",
"id": "GooglePrivacyDlpV2Trigger",
"properties": {
"manual": {
"$ref": "GooglePrivacyDlpV2Manual",
"description": "For use with hybrid jobs. Jobs must be manually created and finished."
},
"schedule": {
"$ref": "GooglePrivacyDlpV2Schedule",
"description": "Create a job on a repeating basis based on the elapse of time."
}
},
"type": "object"
},
"GooglePrivacyDlpV2UnwrappedCryptoKey": {
"description": "Using raw keys is prone to security risks due to accidentally leaking the key. Choose another type of key if possible.",
"id": "GooglePrivacyDlpV2UnwrappedCryptoKey",
"properties": {
"key": {
"description": "Required. A 128/192/256 bit key.",
"format": "byte",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2UpdateConnectionRequest": {
"description": "Request message for UpdateConnection.",
"id": "GooglePrivacyDlpV2UpdateConnectionRequest",
"properties": {
"connection": {
"$ref": "GooglePrivacyDlpV2Connection",
"description": "Required. The connection with new values for the relevant fields."
},
"updateMask": {
"description": "Optional. Mask to control which fields get updated.",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest": {
"description": "Request message for UpdateDeidentifyTemplate.",
"id": "GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest",
"properties": {
"deidentifyTemplate": {
"$ref": "GooglePrivacyDlpV2DeidentifyTemplate",
"description": "New DeidentifyTemplate value."
},
"updateMask": {
"description": "Mask to control which fields get updated.",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2UpdateDiscoveryConfigRequest": {
"description": "Request message for UpdateDiscoveryConfig.",
"id": "GooglePrivacyDlpV2UpdateDiscoveryConfigRequest",
"properties": {
"discoveryConfig": {
"$ref": "GooglePrivacyDlpV2DiscoveryConfig",
"description": "Required. New DiscoveryConfig value."
},
"updateMask": {
"description": "Mask to control which fields get updated.",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2UpdateInspectTemplateRequest": {
"description": "Request message for UpdateInspectTemplate.",
"id": "GooglePrivacyDlpV2UpdateInspectTemplateRequest",
"properties": {
"inspectTemplate": {
"$ref": "GooglePrivacyDlpV2InspectTemplate",
"description": "New InspectTemplate value."
},
"updateMask": {
"description": "Mask to control which fields get updated.",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2UpdateJobTriggerRequest": {
"description": "Request message for UpdateJobTrigger.",
"id": "GooglePrivacyDlpV2UpdateJobTriggerRequest",
"properties": {
"jobTrigger": {
"$ref": "GooglePrivacyDlpV2JobTrigger",
"description": "New JobTrigger value."
},
"updateMask": {
"description": "Mask to control which fields get updated.",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2UpdateStoredInfoTypeRequest": {
"description": "Request message for UpdateStoredInfoType.",
"id": "GooglePrivacyDlpV2UpdateStoredInfoTypeRequest",
"properties": {
"config": {
"$ref": "GooglePrivacyDlpV2StoredInfoTypeConfig",
"description": "Updated configuration for the storedInfoType. If not provided, a new version of the storedInfoType will be created with the existing configuration."
},
"updateMask": {
"description": "Mask to control which fields get updated.",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2Value": {
"description": "Set of primitive values supported by the system. Note that for the purposes of inspection or transformation, the number of bytes considered to comprise a 'Value' is based on its representation as a UTF-8 encoded string. For example, if 'integer_value' is set to 123456789, the number of bytes would be counted as 9, even though an int64 only holds up to 8 bytes of data.",
"id": "GooglePrivacyDlpV2Value",
"properties": {
"booleanValue": {
"description": "boolean",
"type": "boolean"
},
"dateValue": {
"$ref": "GoogleTypeDate",
"description": "date"
},
"dayOfWeekValue": {
"description": "day of week",
"enum": [
"DAY_OF_WEEK_UNSPECIFIED",
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
],
"enumDescriptions": [
"The day of the week is unspecified.",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday",
"Sunday"
],
"type": "string"
},
"floatValue": {
"description": "float",
"format": "double",
"type": "number"
},
"integerValue": {
"description": "integer",
"format": "int64",
"type": "string"
},
"stringValue": {
"description": "string",
"type": "string"
},
"timeValue": {
"$ref": "GoogleTypeTimeOfDay",
"description": "time of day"
},
"timestampValue": {
"description": "timestamp",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2ValueFrequency": {
"description": "A value of a field, including its frequency.",
"id": "GooglePrivacyDlpV2ValueFrequency",
"properties": {
"count": {
"description": "How many times the value is contained in the field.",
"format": "int64",
"type": "string"
},
"value": {
"$ref": "GooglePrivacyDlpV2Value",
"description": "A value contained in the field in question."
}
},
"type": "object"
},
"GooglePrivacyDlpV2VersionDescription": {
"description": "Details about each available version for an infotype.",
"id": "GooglePrivacyDlpV2VersionDescription",
"properties": {
"description": {
"description": "Description of the version.",
"type": "string"
},
"version": {
"description": "Name of the version",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2VertexDatasetCollection": {
"description": "Match dataset resources using regex filters.",
"id": "GooglePrivacyDlpV2VertexDatasetCollection",
"properties": {
"vertexDatasetRegexes": {
"$ref": "GooglePrivacyDlpV2VertexDatasetRegexes",
"description": "The regex used to filter dataset resources."
}
},
"type": "object"
},
"GooglePrivacyDlpV2VertexDatasetDiscoveryTarget": {
"description": "Target used to match against for discovery with Vertex AI datasets.",
"id": "GooglePrivacyDlpV2VertexDatasetDiscoveryTarget",
"properties": {
"conditions": {
"$ref": "GooglePrivacyDlpV2DiscoveryVertexDatasetConditions",
"description": "In addition to matching the filter, these conditions must be true before a profile is generated."
},
"disabled": {
"$ref": "GooglePrivacyDlpV2Disabled",
"description": "Disable profiling for datasets that match this filter."
},
"filter": {
"$ref": "GooglePrivacyDlpV2DiscoveryVertexDatasetFilter",
"description": "Required. The datasets the discovery cadence applies to. The first target with a matching filter will be the one to apply to a dataset."
},
"generationCadence": {
"$ref": "GooglePrivacyDlpV2DiscoveryVertexDatasetGenerationCadence",
"description": "How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity."
}
},
"type": "object"
},
"GooglePrivacyDlpV2VertexDatasetRegex": {
"description": "A pattern to match against one or more dataset resources.",
"id": "GooglePrivacyDlpV2VertexDatasetRegex",
"properties": {
"projectIdRegex": {
"description": "For organizations, if unset, will match all projects. Has no effect for configurations created within a project.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2VertexDatasetRegexes": {
"description": "A collection of regular expressions to determine what datasets to match against.",
"id": "GooglePrivacyDlpV2VertexDatasetRegexes",
"properties": {
"patterns": {
"description": "Required. The group of regular expression patterns to match against one or more datasets. Maximum of 100 entries. The sum of the lengths of all regular expressions can't exceed 10 KiB.",
"items": {
"$ref": "GooglePrivacyDlpV2VertexDatasetRegex"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2VertexDatasetResourceReference": {
"description": "Identifies a single Vertex AI resource. Only datasets are supported.",
"id": "GooglePrivacyDlpV2VertexDatasetResourceReference",
"properties": {
"datasetResourceName": {
"description": "Required. The name of the Vertex AI resource. If set within a project-level configuration, the specified resource must be within the project. Examples: * `projects/{project}/locations/{location}/datasets/{dataset}`",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2WordList": {
"description": "Message defining a list of words or phrases to search for in the data.",
"id": "GooglePrivacyDlpV2WordList",
"properties": {
"words": {
"description": "Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required]",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleProtobufEmpty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
"id": "GoogleProtobufEmpty",
"properties": {},
"type": "object"
},
"GoogleRpcStatus": {
"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
"id": "GoogleRpcStatus",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
"type": "object"
},
"GoogleTypeDate": {
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
"id": "GoogleTypeDate",
"properties": {
"day": {
"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
"format": "int32",
"type": "integer"
},
"month": {
"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
"format": "int32",
"type": "integer"
},
"year": {
"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleTypeTimeOfDay": {
"description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.",
"id": "GoogleTypeTimeOfDay",
"properties": {
"hours": {
"description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.",
"format": "int32",
"type": "integer"
},
"minutes": {
"description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.",
"format": "int32",
"type": "integer"
},
"nanos": {
"description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.",
"format": "int32",
"type": "integer"
},
"seconds": {
"description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"Proto2BridgeMessageSet": {
"deprecated": true,
"description": "This is proto2's version of MessageSet. DEPRECATED: DO NOT USE FOR NEW FIELDS. If you are using editions or proto2, please make your own extendable messages for your use case. If you are using proto3, please use `Any` instead. MessageSet was the implementation of extensions for proto1. When proto2 was introduced, extensions were implemented as a first-class feature. This schema for MessageSet was meant to be a \"bridge\" solution to migrate MessageSet-bearing messages from proto1 to proto2. This schema has been open-sourced only to facilitate the migration of Google products with MessageSet-bearing messages to open-source environments.",
"id": "Proto2BridgeMessageSet",
"properties": {},
"type": "object"
},
"UtilStatusProto": {
"description": "Wire-format for a Status object",
"id": "UtilStatusProto",
"properties": {
"canonicalCode": {
"description": "copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6;",
"format": "int32",
"type": "integer"
},
"code": {
"description": "Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 code = 1;",
"format": "int32",
"type": "integer"
},
"message": {
"description": "Detail message copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string message = 3;",
"type": "string"
},
"messageSet": {
"$ref": "Proto2BridgeMessageSet",
"description": "message_set associates an arbitrary proto message with the status. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional proto2.bridge.MessageSet message_set = 5;"
},
"space": {
"description": "copybara:strip_begin(b/383363683) Space to which this status belongs copybara:strip_end_and_replace optional string space = 2; // Space to which this status belongs",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Sensitive Data Protection (DLP)",
"version": "v2",
"version_module": true
}