mirror
/
restic
mirror of https://github.com/restic/restic.git
1
0
Fork 0
Code Issues Releases Wiki Activity
restic/vendor/google.golang.org/api/dlp/v2/dlp-api.json

5102 lines
218 KiB
JSON
Raw Blame History

{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"basePath": "",
"baseUrl": "https://dlp.googleapis.com/",
"batchPath": "batch",
"canonicalName": "DLP",
"description": "Provides methods for detection, risk analysis, and de-identification of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/dlp/docs/",
"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",
"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"
},
"bearer_token": {
"description": "OAuth bearer token.",
"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"
},
"pp": {
"default": "true",
"description": "Pretty-print response.",
"location": "query",
"type": "boolean"
},
"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\nsupports. For more information, see [Listing supported predefined\ninfoTypes](/dlp/docs/listing-infotypes).",
"flatPath": "v2/infoTypes",
"httpMethod": "GET",
"id": "dlp.infoTypes.list",
"parameterOrder": [],
"parameters": {
"filter": {
"description": "Optional filter to only return infoTypes supported by certain parts of the\nAPI. Defaults to supported_by=INSPECT.",
"location": "query",
"type": "string"
},
"languageCode": {
"description": "Optional BCP-47 language code for localized infoType friendly\nnames. If omitted, or if localized strings are not available,\nen-US strings will be returned.",
"location": "query",
"type": "string"
}
},
"path": "v2/infoTypes",
"response": {
"$ref": "GooglePrivacyDlpV2ListInfoTypesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"organizations": {
"resources": {
"deidentifyTemplates": {
"methods": {
"create": {
"description": "Creates a de-identify template for re-using frequently used configuration\nfor Deidentifying content, images, and storage.",
"flatPath": "v2/organizations/{organizationsId}/deidentifyTemplates",
"httpMethod": "POST",
"id": "dlp.organizations.deidentifyTemplates.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.",
"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 de-identify template.",
"flatPath": "v2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}",
"httpMethod": "DELETE",
"id": "dlp.organizations.deidentifyTemplates.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name of the organization and deidentify template to be deleted,\nfor example `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/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 de-identify template.",
"flatPath": "v2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}",
"httpMethod": "GET",
"id": "dlp.organizations.deidentifyTemplates.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name of the organization and deidentify template to be read, for\nexample `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/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 de-identify templates.",
"flatPath": "v2/organizations/{organizationsId}/deidentifyTemplates",
"httpMethod": "GET",
"id": "dlp.organizations.deidentifyTemplates.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional size of the page, can be limited by server. If zero server returns\na page of max size 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional page token to continue retrieval. Comes from previous call\nto `ListDeidentifyTemplates`.",
"location": "query",
"type": "string"
},
"parent": {
"description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.",
"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 de-identify template.",
"flatPath": "v2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}",
"httpMethod": "PATCH",
"id": "dlp.organizations.deidentifyTemplates.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name of organization and deidentify template to be updated, for\nexample `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/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 inspect template for re-using frequently used configuration\nfor inspecting content, images, and storage.",
"flatPath": "v2/organizations/{organizationsId}/inspectTemplates",
"httpMethod": "POST",
"id": "dlp.organizations.inspectTemplates.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.",
"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 inspect template.",
"flatPath": "v2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}",
"httpMethod": "DELETE",
"id": "dlp.organizations.inspectTemplates.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name of the organization and inspectTemplate to be deleted, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/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 inspect template.",
"flatPath": "v2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}",
"httpMethod": "GET",
"id": "dlp.organizations.inspectTemplates.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name of the organization and inspectTemplate to be read, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/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 inspect templates.",
"flatPath": "v2/organizations/{organizationsId}/inspectTemplates",
"httpMethod": "GET",
"id": "dlp.organizations.inspectTemplates.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional size of the page, can be limited by server. If zero server returns\na page of max size 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional page token to continue retrieval. Comes from previous call\nto `ListInspectTemplates`.",
"location": "query",
"type": "string"
},
"parent": {
"description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.",
"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 inspect template.",
"flatPath": "v2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}",
"httpMethod": "PATCH",
"id": "dlp.organizations.inspectTemplates.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name of organization and inspectTemplate to be updated, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/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"
]
}
}
}
}
},
"projects": {
"resources": {
"content": {
"methods": {
"deidentify": {
"description": "De-identifies potentially sensitive info from a ContentItem.\nThis method has limits on input size and output size.\n[How-to guide](/dlp/docs/deidentify-sensitive-data)",
"flatPath": "v2/projects/{projectsId}/content:deidentify",
"httpMethod": "POST",
"id": "dlp.projects.content.deidentify",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "The parent resource name, for example projects/my-project-id.",
"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.\nThis method has limits on input size, processing time, and output size.\n[How-to guide for text](/dlp/docs/inspecting-text), [How-to guide for\nimages](/dlp/docs/inspecting-images)",
"flatPath": "v2/projects/{projectsId}/content:inspect",
"httpMethod": "POST",
"id": "dlp.projects.content.inspect",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "The parent resource name, for example projects/my-project-id.",
"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.",
"flatPath": "v2/projects/{projectsId}/content:reidentify",
"httpMethod": "POST",
"id": "dlp.projects.content.reidentify",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "The parent resource name.",
"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 de-identify template for re-using frequently used configuration\nfor Deidentifying content, images, and storage.",
"flatPath": "v2/projects/{projectsId}/deidentifyTemplates",
"httpMethod": "POST",
"id": "dlp.projects.deidentifyTemplates.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.",
"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 de-identify template.",
"flatPath": "v2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}",
"httpMethod": "DELETE",
"id": "dlp.projects.deidentifyTemplates.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name of the organization and deidentify template to be deleted,\nfor example `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/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 de-identify template.",
"flatPath": "v2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}",
"httpMethod": "GET",
"id": "dlp.projects.deidentifyTemplates.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name of the organization and deidentify template to be read, for\nexample `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/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 de-identify templates.",
"flatPath": "v2/projects/{projectsId}/deidentifyTemplates",
"httpMethod": "GET",
"id": "dlp.projects.deidentifyTemplates.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional size of the page, can be limited by server. If zero server returns\na page of max size 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional page token to continue retrieval. Comes from previous call\nto `ListDeidentifyTemplates`.",
"location": "query",
"type": "string"
},
"parent": {
"description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.",
"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 de-identify template.",
"flatPath": "v2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}",
"httpMethod": "PATCH",
"id": "dlp.projects.deidentifyTemplates.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name of organization and deidentify template to be updated, for\nexample `organizations/433245324/deidentifyTemplates/432452342` or\nprojects/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\nmakes a best effort to cancel the DlpJob, but success is not\nguaranteed.",
"flatPath": "v2/projects/{projectsId}/dlpJobs/{dlpJobsId}:cancel",
"httpMethod": "POST",
"id": "dlp.projects.dlpJobs.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "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 [How-to\nguide](/dlp/docs/compute-risk-analysis).",
"flatPath": "v2/projects/{projectsId}/dlpJobs",
"httpMethod": "POST",
"id": "dlp.projects.dlpJobs.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "The parent resource name, for example projects/my-project-id.",
"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\nno longer interested in the DlpJob result. The job will be cancelled if\npossible.",
"flatPath": "v2/projects/{projectsId}/dlpJobs/{dlpJobsId}",
"httpMethod": "DELETE",
"id": "dlp.projects.dlpJobs.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "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.",
"flatPath": "v2/projects/{projectsId}/dlpJobs/{dlpJobsId}",
"httpMethod": "GET",
"id": "dlp.projects.dlpJobs.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "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.",
"flatPath": "v2/projects/{projectsId}/dlpJobs",
"httpMethod": "GET",
"id": "dlp.projects.dlpJobs.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Allows filtering.\n\nSupported syntax:\n\n* Filter expressions are made up of one or more restrictions.\n* Restrictions can be combined by `AND` or `OR` logical operators. A\nsequence of restrictions implicitly uses `AND`.\n* A restriction has the form of `\u003cfield\u003e \u003coperator\u003e \u003cvalue\u003e`.\n* Supported fields/values for inspect jobs:\n - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED\n - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY\n - `trigger_name` - The resource name of the trigger that created job.\n* Supported fields for risk analysis jobs:\n - `state` - RUNNING|CANCELED|FINISHED|FAILED\n* The operator must be `=` or `!=`.\n\nExamples:\n\n* inspected_storage = cloud_storage AND state = done\n* inspected_storage = cloud_storage OR inspected_storage = bigquery\n* inspected_storage = cloud_storage AND (state = done OR state = canceled)\n\nThe length of this field should be no more than 500 characters.",
"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": "The parent resource name, for example projects/my-project-id.",
"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"
],
"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.\nThis method has limits on input size, processing time, and output size.\n[How-to guide](/dlp/docs/redacting-sensitive-data-images)",
"flatPath": "v2/projects/{projectsId}/image:redact",
"httpMethod": "POST",
"id": "dlp.projects.image.redact",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "The parent resource name, for example projects/my-project-id.",
"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 inspect template for re-using frequently used configuration\nfor inspecting content, images, and storage.",
"flatPath": "v2/projects/{projectsId}/inspectTemplates",
"httpMethod": "POST",
"id": "dlp.projects.inspectTemplates.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.",
"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 inspect template.",
"flatPath": "v2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}",
"httpMethod": "DELETE",
"id": "dlp.projects.inspectTemplates.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name of the organization and inspectTemplate to be deleted, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/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 inspect template.",
"flatPath": "v2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}",
"httpMethod": "GET",
"id": "dlp.projects.inspectTemplates.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name of the organization and inspectTemplate to be read, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/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 inspect templates.",
"flatPath": "v2/projects/{projectsId}/inspectTemplates",
"httpMethod": "GET",
"id": "dlp.projects.inspectTemplates.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional size of the page, can be limited by server. If zero server returns\na page of max size 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional page token to continue retrieval. Comes from previous call\nto `ListInspectTemplates`.",
"location": "query",
"type": "string"
},
"parent": {
"description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.",
"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 inspect template.",
"flatPath": "v2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}",
"httpMethod": "PATCH",
"id": "dlp.projects.inspectTemplates.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name of organization and inspectTemplate to be updated, for\nexample `organizations/433245324/inspectTemplates/432452342` or\nprojects/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": {
"create": {
"description": "Creates a job trigger to run DLP actions such as scanning storage for\nsensitive information on a set schedule.",
"flatPath": "v2/projects/{projectsId}/jobTriggers",
"httpMethod": "POST",
"id": "dlp.projects.jobTriggers.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "The parent resource name, for example projects/my-project-id.",
"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.",
"flatPath": "v2/projects/{projectsId}/jobTriggers/{jobTriggersId}",
"httpMethod": "DELETE",
"id": "dlp.projects.jobTriggers.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name of the project and the triggeredJob, for example\n`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.",
"flatPath": "v2/projects/{projectsId}/jobTriggers/{jobTriggersId}",
"httpMethod": "GET",
"id": "dlp.projects.jobTriggers.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name of the project and the triggeredJob, for example\n`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.",
"flatPath": "v2/projects/{projectsId}/jobTriggers",
"httpMethod": "GET",
"id": "dlp.projects.jobTriggers.list",
"parameterOrder": [
"parent"
],
"parameters": {
"orderBy": {
"description": "Optional comma separated list of triggeredJob fields to order by,\nfollowed by 'asc/desc' postfix, i.e.\n`\"create_time asc,name desc,schedule_mode asc\"`. This list is\ncase-insensitive.\n\nExample: `\"name asc,schedule_mode desc, status desc\"`\n\nSupported filters keys and values are:\n\n- `create_time`: corresponds to time the triggeredJob was created.\n- `update_time`: corresponds to time the triggeredJob was last updated.\n- `name`: corresponds to JobTrigger's display name.\n- `status`: corresponds to the triggeredJob status.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional size of the page, can be limited by a server.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional page token to continue retrieval. Comes from previous call\nto ListJobTriggers. `order_by` and `filter` should not change for\nsubsequent calls, but can be omitted if token is specified.",
"location": "query",
"type": "string"
},
"parent": {
"description": "The parent resource name, for example projects/my-project-id.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/jobTriggers",
"response": {
"$ref": "GooglePrivacyDlpV2ListJobTriggersResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a job trigger.",
"flatPath": "v2/projects/{projectsId}/jobTriggers/{jobTriggersId}",
"httpMethod": "PATCH",
"id": "dlp.projects.jobTriggers.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name of the project and the triggeredJob, for example\n`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"
]
}
}
}
}
}
},
"revision": "20180328",
"rootUrl": "https://dlp.googleapis.com/",
"schemas": {
"GooglePrivacyDlpV2Action": {
"description": "A task to execute on the completion of a job.",
"id": "GooglePrivacyDlpV2Action",
"properties": {
"pubSub": {
"$ref": "GooglePrivacyDlpV2PublishToPubSub",
"description": "Publish a notification to a pubsub topic."
},
"saveFindings": {
"$ref": "GooglePrivacyDlpV2SaveFindings",
"description": "Save resulting findings in a provided location."
}
},
"type": "object"
},
"GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails": {
"description": "Result of a risk analysis operation request.",
"id": "GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails",
"properties": {
"categoricalStatsResult": {
"$ref": "GooglePrivacyDlpV2CategoricalStatsResult"
},
"kAnonymityResult": {
"$ref": "GooglePrivacyDlpV2KAnonymityResult"
},
"kMapEstimationResult": {
"$ref": "GooglePrivacyDlpV2KMapEstimationResult"
},
"lDiversityResult": {
"$ref": "GooglePrivacyDlpV2LDiversityResult"
},
"numericalStatsResult": {
"$ref": "GooglePrivacyDlpV2NumericalStatsResult"
},
"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\nfrequency of different quasi-identifiers values. It has one or several\nquasi-identifiers columns, and one column that indicates the relative\nfrequency of each quasi-identifier tuple.\nIf a tuple is present in the data but not in the auxiliary table, the\ncorresponding relative frequency is assumed to be zero (and thus, the\ntuple is highly reidentifiable).",
"id": "GooglePrivacyDlpV2AuxiliaryTable",
"properties": {
"quasiIds": {
"description": "Quasi-identifier columns. [required]",
"items": {
"$ref": "GooglePrivacyDlpV2QuasiIdField"
},
"type": "array"
},
"relativeFrequency": {
"$ref": "GooglePrivacyDlpV2FieldId",
"description": "The relative frequency column must contain a floating-point number\nbetween 0 and 1 (inclusive). Null values are assumed to be zero.\n[required]"
},
"table": {
"$ref": "GooglePrivacyDlpV2BigQueryTable",
"description": "Auxiliary table location. [required]"
}
},
"type": "object"
},
"GooglePrivacyDlpV2BigQueryKey": {
"description": "Row key for identifying a record in BigQuery table.",
"id": "GooglePrivacyDlpV2BigQueryKey",
"properties": {
"rowNumber": {
"description": "Absolute number of the row from the beginning of the table at the time\nof scanning.",
"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": {
"identifyingFields": {
"description": "References to fields uniquely identifying rows within the table.\nNested fields in the format, like `person.birthdate.year`, are allowed.",
"items": {
"$ref": "GooglePrivacyDlpV2FieldId"
},
"type": "array"
},
"tableReference": {
"$ref": "GooglePrivacyDlpV2BigQueryTable",
"description": "Complete BigQuery table reference."
}
},
"type": "object"
},
"GooglePrivacyDlpV2BigQueryTable": {
"description": "Message defining the location of a BigQuery table. A table is uniquely\nidentified by its project_id, dataset_id, and table_name. Within a query\na table is often referenced with a string in the format of:\n`\u003cproject_id\u003e:\u003cdataset_id\u003e.\u003ctable_id\u003e` or\n`\u003cproject_id\u003e.\u003cdataset_id\u003e.\u003ctable_id\u003e`.",
"id": "GooglePrivacyDlpV2BigQueryTable",
"properties": {
"datasetId": {
"description": "Dataset ID of the table.",
"type": "string"
},
"projectId": {
"description": "The Google Cloud Platform project ID of the project containing the table.\nIf omitted, project ID is inferred from the API call.",
"type": "string"
},
"tableId": {
"description": "Name of the table.",
"type": "string"
}
},
"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\nused."
},
"replacementValue": {
"$ref": "GooglePrivacyDlpV2Value",
"description": "Replacement value for this bucket. If not provided\nthe default behavior will be to hyphenate the min-max range."
}
},
"type": "object"
},
"GooglePrivacyDlpV2BucketingConfig": {
"description": "Generalization function that buckets values based on ranges. The ranges and\nreplacement values are dynamically provided by the user for custom behavior,\nsuch as 1-30 -\u003e LOW 31-65 -\u003e MEDIUM 66-100 -\u003e HIGH\nThis can be used on\ndata of type: number, long, string, timestamp.\nIf the bound `Value` type differs from the type of data being transformed, we\nwill first attempt converting the type of the data to be transformed to match\nthe type of the bound before comparing.",
"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"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
""
],
"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\nnumber of distinct values and value count distribution.",
"id": "GooglePrivacyDlpV2CategoricalStatsConfig",
"properties": {
"field": {
"$ref": "GooglePrivacyDlpV2FieldId",
"description": "Field to compute categorical stats on. All column types are\nsupported except for arrays and structs. However, it may be more\ninformative to use NumericalStats when the field type is supported,\ndepending on the data."
}
},
"type": "object"
},
"GooglePrivacyDlpV2CategoricalStatsHistogramBucket": {
"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\nvalues 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\nfixed character. Masking can start from the beginning or end of the string.\nThis can be used on data of any type (numbers, longs, and so on) and when\nde-identifying structured data we'll attempt to preserve the original data's\ntype. (This allows you to take a long like 123 and modify it to a string like\n**3.",
"id": "GooglePrivacyDlpV2CharacterMaskConfig",
"properties": {
"charactersToIgnore": {
"description": "When masking a string, items in this list will be skipped when replacing.\nFor example, if your string is 555-555-5555 and you ask us to skip `-` and\nmask 5 chars with * we would produce ***-*55-5555.",
"items": {
"$ref": "GooglePrivacyDlpV2CharsToIgnore"
},
"type": "array"
},
"maskingCharacter": {
"description": "Character to mask the sensitive values\u0026mdash;for example, \"*\" for an\nalphabetic string such as name, or \"0\" for a numeric string such as ZIP\ncode or credit card number. String must have length 1. If not supplied, we\nwill default to \"*\" for strings, 0 for digits.",
"type": "string"
},
"numberToMask": {
"description": "Number of characters to mask. If not set, all matching chars will be\nmasked. Skipped characters do not count towards this tally.",
"format": "int32",
"type": "integer"
},
"reverseOrder": {
"description": "Mask characters in reverse order. For example, if `masking_character` is\n'0', number_to_mask is 14, and `reverse_order` is false, then\n1234-5678-9012-3456 -\u003e 00000000000000-3456\nIf `masking_character` is '*', `number_to_mask` is 3, and `reverse_order`\nis true, then 12345 -\u003e 12***",
"type": "boolean"
}
},
"type": "object"
},
"GooglePrivacyDlpV2CharsToIgnore": {
"description": "Characters to skip when doing deidentification of a value. These will be left\nalone and skipped.",
"id": "GooglePrivacyDlpV2CharsToIgnore",
"properties": {
"charactersToSkip": {
"type": "string"
},
"commonCharactersToIgnore": {
"enum": [
"COMMON_CHARS_TO_IGNORE_UNSPECIFIED",
"NUMERIC",
"ALPHA_UPPER_CASE",
"ALPHA_LOWER_CASE",
"PUNCTUATION",
"WHITESPACE"
],
"enumDescriptions": [
"",
"0-9",
"A-Z",
"a-z",
"US Punctuation, one of !\"#$%\u0026'()*+,-./:;\u003c=\u003e?@[\\]^_`{|}~",
"Whitespace character, one of [ \\t\\n\\x0B\\f\\r]"
],
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2CloudStorageOptions": {
"description": "Options defining a file or a set of files (path ending with *) within\na Google 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\nthan this value then the rest of the bytes are omitted.",
"format": "int64",
"type": "string"
},
"fileSet": {
"$ref": "GooglePrivacyDlpV2FileSet"
},
"fileTypes": {
"description": "List of file type groups to include in the scan.\nIf empty, all files are scanned and available data format processors\nare applied.",
"enumDescriptions": [
"Includes all files.",
"Includes all file extensions not covered by other types.",
"Included file extensions:\n c, cc, cpp, cxx, c++, cs, css, dart, eml, go, h, hh, hpp, hxx, h++, hs,\n html, htm, shtml, shtm, xhtml, lhs, ini, java, js, json, ocaml, md, mkd,\n markdown, m, ml, mli, pl, pm, php, phtml, pht, py, pyw, rb, rbw, rs, rc,\n scala, sh, sql, tex, txt, asc, text, brf, vcard, vcs, wml, xml, xsl, xsd,\n yml, yaml."
],
"items": {
"enum": [
"FILE_TYPE_UNSPECIFIED",
"BINARY_FILE",
"TEXT_FILE"
],
"type": "string"
},
"type": "array"
}
},
"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"
},
"GooglePrivacyDlpV2Condition": {
"description": "The field type of `value` and `field` do not need to match to be\nconsidered equal, but not all comparisons are possible.\n\nA `value` of type:\n\n- `string` can be compared against all other types\n- `boolean` can only be compared against other booleans\n- `integer` can be compared against doubles or a string if the string value\ncan be parsed as an integer.\n- `double` can be compared against integers or a string if the string can\nbe parsed as a double.\n- `Timestamp` can be compared against strings in RFC 3339 date string\nformat.\n- `TimeOfDay` can be compared against timestamps and strings in the format\nof 'HH:mm:ss'.\n\nIf we fail to compare do to type mismatch, a warning will be given and\nthe condition will evaluate to false.",
"id": "GooglePrivacyDlpV2Condition",
"properties": {
"field": {
"$ref": "GooglePrivacyDlpV2FieldId",
"description": "Field within the record this condition is evaluated against. [required]"
},
"operator": {
"description": "Operator used to compare the field or infoType to the value. [required]",
"enum": [
"RELATIONAL_OPERATOR_UNSPECIFIED",
"EQUAL_TO",
"NOT_EQUAL_TO",
"GREATER_THAN",
"LESS_THAN",
"GREATER_THAN_OR_EQUALS",
"LESS_THAN_OR_EQUALS",
"EXISTS"
],
"enumDescriptions": [
"",
"Equal.",
"Not equal to.",
"Greater than.",
"Less than.",
"Greater than or equals.",
"Less than or equals.",
"Exists"
],
"type": "string"
},
"value": {
"$ref": "GooglePrivacyDlpV2Value",
"description": "Value to compare against. [Required, except for `EXISTS` tests.]"
}
},
"type": "object"
},
"GooglePrivacyDlpV2Conditions": {
"description": "A collection of conditions.",
"id": "GooglePrivacyDlpV2Conditions",
"properties": {
"conditions": {
"items": {
"$ref": "GooglePrivacyDlpV2Condition"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2ContentItem": {
"description": "Container structure for the 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."
},
"value": {
"description": "String data to inspect or redact.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2ContentLocation": {
"description": "Findings container location data.",
"id": "GooglePrivacyDlpV2ContentLocation",
"properties": {
"containerName": {
"description": "Name of the container where the finding is located.\nThe top level name is the source file name or table name. Nested names\ncould be absent if the embedded object has no string identifier\n(for an example an image contained within a document).",
"type": "string"
},
"containerTimestamp": {
"description": "Findings container modification timestamp, if applicable.\nFor Google Cloud Storage contains last file modification timestamp.\nFor BigQuery table contains last_modified_time property.\nFor Datastore - not populated.",
"format": "google-datetime",
"type": "string"
},
"containerVersion": {
"description": "Findings container version, if available\n(\"generation\" for Google Cloud Storage).",
"type": "string"
},
"documentLocation": {
"$ref": "GooglePrivacyDlpV2DocumentLocation",
"description": "Location data for document files."
},
"imageLocation": {
"$ref": "GooglePrivacyDlpV2ImageLocation",
"description": "Location within an image's pixels."
},
"recordLocation": {
"$ref": "GooglePrivacyDlpV2RecordLocation",
"description": "Location within a row or record of a database table."
}
},
"type": "object"
},
"GooglePrivacyDlpV2CreateDeidentifyTemplateRequest": {
"description": "Request message for CreateDeidentifyTemplate.",
"id": "GooglePrivacyDlpV2CreateDeidentifyTemplateRequest",
"properties": {
"deidentifyTemplate": {
"$ref": "GooglePrivacyDlpV2DeidentifyTemplate",
"description": "The DeidentifyTemplate to create."
},
"templateId": {
"description": "The template id can contain uppercase and lowercase letters,\nnumbers, and hyphens; that is, it must match the regular\nexpression: `[a-zA-Z\\\\d-]+`. The maximum length is 100\ncharacters. Can be empty to allow the system to generate one.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2CreateDlpJobRequest": {
"description": "Request message for CreateDlpJobRequest. Used to initiate long running\njobs such as calculating risk metrics or inspecting Google Cloud\nStorage.",
"id": "GooglePrivacyDlpV2CreateDlpJobRequest",
"properties": {
"inspectJob": {
"$ref": "GooglePrivacyDlpV2InspectJobConfig"
},
"jobId": {
"description": "The job id can contain uppercase and lowercase letters,\nnumbers, and hyphens; that is, it must match the regular\nexpression: `[a-zA-Z\\\\d-]+`. The maximum length is 100\ncharacters. Can be empty to allow the system to generate one.",
"type": "string"
},
"riskJob": {
"$ref": "GooglePrivacyDlpV2RiskAnalysisJobConfig"
}
},
"type": "object"
},
"GooglePrivacyDlpV2CreateInspectTemplateRequest": {
"description": "Request message for CreateInspectTemplate.",
"id": "GooglePrivacyDlpV2CreateInspectTemplateRequest",
"properties": {
"inspectTemplate": {
"$ref": "GooglePrivacyDlpV2InspectTemplate",
"description": "The InspectTemplate to create."
},
"templateId": {
"description": "The template id can contain uppercase and lowercase letters,\nnumbers, and hyphens; that is, it must match the regular\nexpression: `[a-zA-Z\\\\d-]+`. The maximum length is 100\ncharacters. 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": "The JobTrigger to create."
},
"triggerId": {
"description": "The trigger id can contain uppercase and lowercase letters,\nnumbers, and hyphens; that is, it must match the regular\nexpression: `[a-zA-Z\\\\d-]+`. The maximum length is 100\ncharacters. Can be empty to allow the system to generate one.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2CryptoHashConfig": {
"description": "Pseudonymization method that generates surrogates via cryptographic hashing.\nUses SHA-256.\nThe key size must be either 32 or 64 bytes.\nOutputs a 32 byte digest as an uppercase hex string\n(for example, 41D1567F7F99F1DC2A5FAB886DEE5BEE).\nCurrently, only string and integer values can be hashed.",
"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\na key encryption key (KEK) stored by KMS).\nWhen using KMS to wrap/unwrap DEKs, be sure to set an appropriate\nIAM policy on the KMS CryptoKey (KEK) to ensure an attacker cannot\nunwrap the data crypto key.",
"id": "GooglePrivacyDlpV2CryptoKey",
"properties": {
"kmsWrapped": {
"$ref": "GooglePrivacyDlpV2KmsWrappedCryptoKey"
},
"transient": {
"$ref": "GooglePrivacyDlpV2TransientCryptoKey"
},
"unwrapped": {
"$ref": "GooglePrivacyDlpV2UnwrappedCryptoKey"
}
},
"type": "object"
},
"GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig": {
"description": "Replaces an identifier with a surrogate using FPE with the FFX\nmode of operation; however when used in the `ReidentifyContent` API method,\nit serves the opposite function by reversing the surrogate back into\nthe original identifier.\nThe identifier must be encoded as ASCII.\nFor a given crypto key and context, the same identifier will be\nreplaced with the same surrogate.\nIdentifiers must be at least two characters long.\nIn the case that the identifier is the empty string, it will be skipped.\nSee [Pseudonymization](/dlp/docs/pseudonymization) for example usage.",
"id": "GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig",
"properties": {
"commonAlphabet": {
"enum": [
"FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED",
"NUMERIC",
"HEXADECIMAL",
"UPPER_CASE_ALPHA_NUMERIC",
"ALPHA_NUMERIC"
],
"enumDescriptions": [
"",
"[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\nidentifier in two different contexts won't be given the same surrogate. If\nthe context is not set, a default tweak will be used.\n\nIf the context is set but:\n\n1. there is no record present when transforming a given value or\n1. the field is not present when transforming a given value,\n\na default tweak will be used.\n\nNote that case (1) is expected when an `InfoTypeTransformation` is\napplied to both structured and non-structured `ContentItem`s.\nCurrently, the referenced field may be of value type integer or string.\n\nThe tweak is constructed as a sequence of bytes in big endian byte order\nsuch that:\n\n- a 64 bit integer is encoded followed by a single byte of value 1\n- a string is encoded in UTF-8 format followed by a single byte of value\n å 2"
},
"cryptoKey": {
"$ref": "GooglePrivacyDlpV2CryptoKey",
"description": "The key used by the encryption algorithm. [required]"
},
"customAlphabet": {
"description": "This is supported by mapping these to the alphanumeric characters\nthat the FFX mode natively supports. This happens before/after\nencryption/decryption.\nEach character listed must appear only once.\nNumber of characters must be in the range [2, 62].\nThis must be encoded as ASCII.\nThe order of characters does not matter.",
"type": "string"
},
"radix": {
"description": "The native way to select the alphabet. Must be in the range [2, 62].",
"format": "int32",
"type": "integer"
},
"surrogateInfoType": {
"$ref": "GooglePrivacyDlpV2InfoType",
"description": "The custom infoType to annotate the surrogate with.\nThis annotation will be applied to the surrogate by prefixing it with\nthe name of the custom infoType followed by the number of\ncharacters comprising the surrogate. The following scheme defines the\nformat: info_type_name(surrogate_character_count):surrogate\n\nFor example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and\nthe surrogate is 'abc', the full replacement value\nwill be: 'MY_TOKEN_INFO_TYPE(3):abc'\n\nThis annotation identifies the surrogate when inspecting content using the\ncustom infoType\n[`SurrogateType`](/dlp/docs/reference/rest/v2/InspectConfig#surrogatetype).\nThis facilitates reversal of the surrogate when it occurs in free text.\n\nIn order for inspection to work properly, the name of this infoType must\nnot occur naturally anywhere in your data; otherwise, inspection may\nfind a surrogate that does not correspond to an actual identifier.\nTherefore, choose your custom infoType name carefully after considering\nwhat your data looks like. One way to select a name that has a high chance\nof yielding reliable detection is to include one or more unicode characters\nthat are highly improbable to exist in your data.\nFor example, assuming your data is entered from a regular ASCII keyboard,\nthe symbol with the hex code point 29DD might be used like so:\n⧝MY_TOKEN_TYPE"
}
},
"type": "object"
},
"GooglePrivacyDlpV2CustomInfoType": {
"description": "Custom information type provided by the user. Used to find domain-specific\nsensitive information configurable to the data in question.",
"id": "GooglePrivacyDlpV2CustomInfoType",
"properties": {
"detectionRules": {
"description": "Set of detection rules to apply to all findings of this custom info type.\nRules are applied in order that they are specified. Not supported for the\n`surrogate_type` custom info type.",
"items": {
"$ref": "GooglePrivacyDlpV2DetectionRule"
},
"type": "array"
},
"dictionary": {
"$ref": "GooglePrivacyDlpV2Dictionary",
"description": "Dictionary-based custom info type."
},
"infoType": {
"$ref": "GooglePrivacyDlpV2InfoType",
"description": "Info type configuration. All custom info types must have configurations\nthat do not conflict with built-in info types or other custom info types."
},
"likelihood": {
"description": "Likelihood to return for this custom info type. This base value can be\naltered by a detection rule if the finding meets the criteria specified by\nthe rule. Defaults to `VERY_LIKELY` if not specified.",
"enum": [
"LIKELIHOOD_UNSPECIFIED",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Default value; information with all likelihoods is included.",
"Few matching elements.",
"",
"Some matching elements.",
"",
"Many matching elements."
],
"type": "string"
},
"regex": {
"$ref": "GooglePrivacyDlpV2Regex",
"description": "Regex-based custom info type."
},
"surrogateType": {
"$ref": "GooglePrivacyDlpV2SurrogateType",
"description": "Surrogate info type."
}
},
"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\nby 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\nsame context.",
"id": "GooglePrivacyDlpV2DateShiftConfig",
"properties": {
"context": {
"$ref": "GooglePrivacyDlpV2FieldId",
"description": "Points to the field that contains the context, for example, an entity id.\nIf set, must also set method. If set, shift will be consistent for the\ngiven context."
},
"cryptoKey": {
"$ref": "GooglePrivacyDlpV2CryptoKey",
"description": "Causes the shift to be computed based on this key and the context. This\nresults in the same shift for the same context and crypto_key."
},
"lowerBoundDays": {
"description": "For example, -5 means shift date to at most 5 days back in the past.\n[Required]",
"format": "int32",
"type": "integer"
},
"upperBoundDays": {
"description": "Range of shift in days. Actual shift will be selected at random within this\nrange (inclusive ends). Negative means shift to earlier in time. Must not\nbe more than 365250 days (1000 years) each direction.\n\nFor example, 3 means shift date to at most 3 days into the future.\n[Required]",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DateTime": {
"description": "Message for a date time object.",
"id": "GooglePrivacyDlpV2DateTime",
"properties": {
"date": {
"$ref": "GoogleTypeDate",
"description": "One or more of the following must be set. All fields are optional, but\nwhen set must be valid date or time values."
},
"dayOfWeek": {
"enum": [
"DAY_OF_WEEK_UNSPECIFIED",
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
],
"enumDescriptions": [
"The unspecified day-of-week.",
"The day-of-week of Monday.",
"The day-of-week of Tuesday.",
"The day-of-week of Wednesday.",
"The day-of-week of Thursday.",
"The day-of-week of Friday.",
"The day-of-week of Saturday.",
"The day-of-week of Sunday."
],
"type": "string"
},
"time": {
"$ref": "GoogleTypeTimeOfDay"
},
"timeZone": {
"$ref": "GooglePrivacyDlpV2TimeZone"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DeidentifyConfig": {
"description": "The configuration that controls how the data will change.",
"id": "GooglePrivacyDlpV2DeidentifyConfig",
"properties": {
"infoTypeTransformations": {
"$ref": "GooglePrivacyDlpV2InfoTypeTransformations",
"description": "Treat the dataset as free-form text and apply the same free text\ntransformation everywhere."
},
"recordTransformations": {
"$ref": "GooglePrivacyDlpV2RecordTransformations",
"description": "Treat the dataset as structured. Transformations can be applied to\nspecific locations within structured datasets, such as transforming\na column within a table."
}
},
"type": "object"
},
"GooglePrivacyDlpV2DeidentifyContentRequest": {
"description": "Request to de-identify a list of items.",
"id": "GooglePrivacyDlpV2DeidentifyContentRequest",
"properties": {
"deidentifyConfig": {
"$ref": "GooglePrivacyDlpV2DeidentifyConfig",
"description": "Configuration for the de-identification of the content item.\nItems specified here will override the template referenced by the\ndeidentify_template_name argument."
},
"deidentifyTemplateName": {
"description": "Optional template to use. Any configuration directly specified in\ndeidentify_config will override those set in the template. Singular fields\nthat are set in this request will replace their corresponding fields in the\ntemplate. Repeated fields are appended. Singular sub-messages and groups\nare recursively merged.",
"type": "string"
},
"inspectConfig": {
"$ref": "GooglePrivacyDlpV2InspectConfig",
"description": "Configuration for the inspector.\nItems specified here will override the template referenced by the\ninspect_template_name argument."
},
"inspectTemplateName": {
"description": "Optional template to use. Any configuration directly specified in\ninspect_config will override those set in the template. Singular fields\nthat are set in this request will replace their corresponding fields in the\ntemplate. Repeated fields are appended. Singular sub-messages and groups\nare recursively merged.",
"type": "string"
},
"item": {
"$ref": "GooglePrivacyDlpV2ContentItem",
"description": "The item to de-identify. Will be treated as text."
}
},
"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"
},
"GooglePrivacyDlpV2DeidentifyTemplate": {
"description": "The DeidentifyTemplates contains instructions on how to deidentify content.",
"id": "GooglePrivacyDlpV2DeidentifyTemplate",
"properties": {
"createTime": {
"description": "The creation timestamp of a inspectTemplate, output only field.",
"format": "google-datetime",
"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": "The template name. Output only.\n\nThe template will have one of the following formats:\n`projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR\n`organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID`",
"type": "string"
},
"updateTime": {
"description": "The last update timestamp of a inspectTemplate, output only field.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2DetectionRule": {
"description": "Rule for modifying a custom info type to alter behavior under certain\ncircumstances, depending on the specific details of the rule. Not supported\nfor the `surrogate_type` custom info type.",
"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\nbe used to match sensitive information specific to the data, such as a list\nof employee IDs or job titles.\n\nDictionary words are case-insensitive and all characters other than letters\nand digits in the unicode [Basic Multilingual\nPlane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)\nwill be replaced with whitespace when scanning for matches, so the\ndictionary phrase \"Sam Johnson\" will match all three phrases \"sam johnson\",\n\"Sam, Johnson\", and \"Sam (Johnson)\". Additionally, the characters\nsurrounding any match must be of a different type than the adjacent\ncharacters within the word, so letters must be next to non-letters and\ndigits next to non-digits. For example, the dictionary word \"jen\" will\nmatch the first three letters of the text \"jen123\" but will return no\nmatches for \"jennifer\".\n\nDictionary words containing a large number of characters that are not\nletters or digits may result in unexpected findings because such characters\nare treated as whitespace.",
"id": "GooglePrivacyDlpV2Dictionary",
"properties": {
"wordList": {
"$ref": "GooglePrivacyDlpV2WordList",
"description": "List of words or phrases to search for."
}
},
"type": "object"
},
"GooglePrivacyDlpV2DlpJob": {
"description": "Combines all of the information about a DLP job.",
"id": "GooglePrivacyDlpV2DlpJob",
"properties": {
"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\ninstantiated the job.",
"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"
],
"enumDescriptions": [
"",
"The job has not yet started.",
"The job is currently running.",
"The job is no longer running.",
"The job was canceled before it could complete.",
"The job had an error and did not complete."
],
"type": "string"
},
"type": {
"description": "The type of job.",
"enum": [
"DLP_JOB_TYPE_UNSPECIFIED",
"INSPECT_JOB",
"RISK_ANALYSIS_JOB"
],
"enumDescriptions": [
"",
"The job inspected Google Cloud for sensitive data.",
"The job executed a Risk Analysis computation."
],
"type": "string"
}
},
"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\nis located.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2Error": {
"description": "Details information about an error encountered during job execution or\nthe results of an unsuccessful activation of the JobTrigger.\nOutput only field.",
"id": "GooglePrivacyDlpV2Error",
"properties": {
"details": {
"$ref": "GoogleRpcStatus"
},
"timestamps": {
"description": "The times the error occurred.",
"items": {
"format": "google-datetime",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2Expressions": {
"description": "An expression, consisting or an operator and conditions.",
"id": "GooglePrivacyDlpV2Expressions",
"properties": {
"conditions": {
"$ref": "GooglePrivacyDlpV2Conditions"
},
"logicalOperator": {
"description": "The operator to apply to the result of conditions. Default and currently\nonly supported value is `AND`.",
"enum": [
"LOGICAL_OPERATOR_UNSPECIFIED",
"AND"
],
"enumDescriptions": [
"",
""
],
"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\ngiven `RecordCondition`. The conditions are allowed to reference fields\nthat are not used in the actual transformation. [optional]\n\nExample Use Cases:\n\n- Apply a different bucket transformation to an age column if the zip code\ncolumn for the same record is within a specific range.\n- Redact a field if the date of birth field is greater than 85."
},
"fields": {
"description": "Input field(s) to apply the transformation to. [required]",
"items": {
"$ref": "GooglePrivacyDlpV2FieldId"
},
"type": "array"
},
"infoTypeTransformations": {
"$ref": "GooglePrivacyDlpV2InfoTypeTransformations",
"description": "Treat the contents of the field as free text, and selectively\ntransform content that matches an `InfoType`."
},
"primitiveTransformation": {
"$ref": "GooglePrivacyDlpV2PrimitiveTransformation",
"description": "Apply the transformation to the entire field."
}
},
"type": "object"
},
"GooglePrivacyDlpV2FileSet": {
"description": "Set of files to scan.",
"id": "GooglePrivacyDlpV2FileSet",
"properties": {
"url": {
"description": "The url, in the format `gs://\u003cbucket\u003e/\u003cpath\u003e`. Trailing wildcard in the\npath is allowed.",
"type": "string"
}
},
"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"
},
"infoType": {
"$ref": "GooglePrivacyDlpV2InfoType",
"description": "The type of content that might have been found.\nProvided if requested by the `InspectConfig`."
},
"likelihood": {
"description": "Estimate of how likely it is that the `info_type` is correct.",
"enum": [
"LIKELIHOOD_UNSPECIFIED",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Default value; information with all likelihoods is included.",
"Few matching elements.",
"",
"Some matching elements.",
"",
"Many matching elements."
],
"type": "string"
},
"location": {
"$ref": "GooglePrivacyDlpV2Location",
"description": "Where the content was found."
},
"quote": {
"description": "The content that was found. Even if the content is not textual, it\nmay be converted to a textual representation here.\nProvided if requested by the `InspectConfig` and the finding is\nless than or equal to 4096 bytes long. If the finding exceeds 4096 bytes\nin length, the quote may be omitted.",
"type": "string"
},
"quoteInfo": {
"$ref": "GooglePrivacyDlpV2QuoteInfo",
"description": "Contains data parsed from quotes. Only populated if include_quote was set\nto true and a supported infoType was requested. Currently supported\ninfoTypes: DATE, DATE_OF_BIRTH and TIME."
}
},
"type": "object"
},
"GooglePrivacyDlpV2FindingLimits": {
"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 will be returned for each item scanned.\nWhen set within `InspectDataSourceRequest`,\nthe maximum returned is 1000 regardless if this is set higher.\nWhen set within `InspectContentRequest`, this field is ignored.",
"format": "int32",
"type": "integer"
},
"maxFindingsPerRequest": {
"description": "Max number of findings that will be returned per request/job.\nWhen set within `InspectContentRequest`, the maximum returned is 1000\nregardless if this is set higher.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GooglePrivacyDlpV2FixedSizeBucketingConfig": {
"description": "Buckets values based on fixed size ranges. The\nBucketing transformation can provide all of this functionality,\nbut requires more configuration. This message is provided as a convenience to\nthe user for simple bucketing strategies.\n\nThe transformed value will be a hyphenated string of\n\u003clower_bound\u003e-\u003cupper_bound\u003e, i.e if lower_bound = 10 and upper_bound = 20\nall values that are within this bucket will be replaced with \"10-20\".\n\nThis can be used on data of type: double, long.\n\nIf the bound Value type differs from the type of data\nbeing transformed, we will first attempt converting the type of the data to\nbe transformed to match the type of the bound before comparing.",
"id": "GooglePrivacyDlpV2FixedSizeBucketingConfig",
"properties": {
"bucketSize": {
"description": "Size of each bucket (except for minimum and maximum buckets). So if\n`lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the\nfollowing buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60,\n60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. [Required].",
"format": "double",
"type": "number"
},
"lowerBound": {
"$ref": "GooglePrivacyDlpV2Value",
"description": "Lower bound value of buckets. All values less than `lower_bound` are\ngrouped together into a single bucket; for example if `lower_bound` = 10,\nthen all values less than 10 are replaced with the value “-10”. [Required]."
},
"upperBound": {
"$ref": "GooglePrivacyDlpV2Value",
"description": "Upper bound value of buckets. All values greater than upper_bound are\ngrouped together into a single bucket; for example if `upper_bound` = 89,\nthen all values greater than 89 are replaced with the value “89+”.\n[Required]."
}
},
"type": "object"
},
"GooglePrivacyDlpV2HotwordRule": {
"description": "Detection rule that adjusts the likelihood of findings within a certain\nproximity of hotwords.",
"id": "GooglePrivacyDlpV2HotwordRule",
"properties": {
"hotwordRegex": {
"$ref": "GooglePrivacyDlpV2Regex",
"description": "Regex pattern defining what qualifies as a hotword."
},
"likelihoodAdjustment": {
"$ref": "GooglePrivacyDlpV2LikelihoodAdjustment",
"description": "Likelihood adjustment to apply to all matching findings."
},
"proximity": {
"$ref": "GooglePrivacyDlpV2Proximity",
"description": "Proximity of the finding within which the entire hotword must reside.\nThe total length of the window cannot exceed 1000 characters. Note that\nthe finding itself will be included in the window, so that hotwords may\nbe used to match substrings of the finding itself. For example, the\ncertainty of a phone number regex \"\\(\\d{3}\\) \\d{3}-\\d{4}\" could be\nadjusted upwards if the area code is known to be the local area code of\na company office using the hotword regex \"\\(xxx\\)\", where \"xxx\"\nis the area code in question."
}
},
"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\nspecified, and redact_all_text is false, the DLP API will redact all\ntext that it matches against all info_types that are found, but not\nspecified in another ImageRedactionConfig."
},
"redactAllText": {
"description": "If true, all text found in the image, regardless whether it matches an\ninfo_type, is redacted.",
"type": "boolean"
},
"redactionColor": {
"$ref": "GooglePrivacyDlpV2Color",
"description": "The color to use when redacting content from an image. If not specified,\nthe default is black."
}
},
"type": "object"
},
"GooglePrivacyDlpV2InfoType": {
"description": "Type of information detected by the API.",
"id": "GooglePrivacyDlpV2InfoType",
"properties": {
"name": {
"description": "Name of the information type.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2InfoTypeDescription": {
"description": "InfoType description.",
"id": "GooglePrivacyDlpV2InfoTypeDescription",
"properties": {
"displayName": {
"description": "Human readable form of the infoType name.",
"type": "string"
},
"name": {
"description": "Internal name of the infoType.",
"type": "string"
},
"supportedBy": {
"description": "Which parts of the API supports this InfoType.",
"enumDescriptions": [
"",
"Supported by the inspect operations.",
"Supported by the risk analysis operations."
],
"items": {
"enum": [
"ENUM_TYPE_UNSPECIFIED",
"INSPECT",
"RISK_ANALYSIS"
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2InfoTypeLimit": {
"description": "Max findings configuration per infoType, per content item or long\nrunning DlpJob.",
"id": "GooglePrivacyDlpV2InfoTypeLimit",
"properties": {
"infoType": {
"$ref": "GooglePrivacyDlpV2InfoType",
"description": "Type of information the findings limit applies to. Only one limit per\ninfo_type should be provided. If InfoTypeLimit does not have an\ninfo_type, the DLP API applies the limit against all info_types that\nare 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"
},
"GooglePrivacyDlpV2InfoTypeTransformation": {
"description": "A transformation to apply to text that is identified as a specific\ninfo_type.",
"id": "GooglePrivacyDlpV2InfoTypeTransformation",
"properties": {
"infoTypes": {
"description": "InfoTypes to apply the transformation to. Empty list will match all\navailable infoTypes for this transformation.",
"items": {
"$ref": "GooglePrivacyDlpV2InfoType"
},
"type": "array"
},
"primitiveTransformation": {
"$ref": "GooglePrivacyDlpV2PrimitiveTransformation",
"description": "Primitive transformation to apply to the infoType. [required]"
}
},
"type": "object"
},
"GooglePrivacyDlpV2InfoTypeTransformations": {
"description": "A type of transformation that will scan unstructured text and\napply various `PrimitiveTransformation`s to each finding, where the\ntransformation is applied to only values that were identified as a specific\ninfo_type.",
"id": "GooglePrivacyDlpV2InfoTypeTransformations",
"properties": {
"transformations": {
"description": "Transformation for each infoType. Cannot specify more than one\nfor a given infoType. [required]",
"items": {
"$ref": "GooglePrivacyDlpV2InfoTypeTransformation"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2InspectConfig": {
"description": "Configuration description of the scanning process.\nWhen used with redactContent only info_types and min_likelihood are currently\nused.",
"id": "GooglePrivacyDlpV2InspectConfig",
"properties": {
"contentOptions": {
"description": "List of options defining data content to scan.\nIf empty, text, images, and other content will be included.",
"enumDescriptions": [
"Includes entire content of a file or a data stream.",
"Text content within the data, excluding any metadata.",
"Images found in the data."
],
"items": {
"enum": [
"CONTENT_UNSPECIFIED",
"CONTENT_TEXT",
"CONTENT_IMAGE"
],
"type": "string"
},
"type": "array"
},
"customInfoTypes": {
"description": "Custom infoTypes provided by the user.",
"items": {
"$ref": "GooglePrivacyDlpV2CustomInfoType"
},
"type": "array"
},
"excludeInfoTypes": {
"description": "When true, excludes type information of the findings.",
"type": "boolean"
},
"includeQuote": {
"description": "When true, a contextual quote from the data that triggered a finding is\nincluded in the response; see Finding.quote.",
"type": "boolean"
},
"infoTypes": {
"description": "Restricts what info_types to look for. The values must correspond to\nInfoType values returned by ListInfoTypes or found in documentation.",
"items": {
"$ref": "GooglePrivacyDlpV2InfoType"
},
"type": "array"
},
"limits": {
"$ref": "GooglePrivacyDlpV2FindingLimits"
},
"minLikelihood": {
"description": "Only returns findings equal or above this threshold. The default is\nPOSSIBLE.",
"enum": [
"LIKELIHOOD_UNSPECIFIED",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Default value; information with all likelihoods is included.",
"Few matching elements.",
"",
"Some matching elements.",
"",
"Many matching elements."
],
"type": "string"
}
},
"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\nthe template referenced by the inspect_template_name argument."
},
"inspectTemplateName": {
"description": "Optional template to use. Any configuration directly specified in\ninspect_config will override those set in the template. Singular fields\nthat are set in this request will replace their corresponding fields in the\ntemplate. Repeated fields are appended. Singular sub-messages and groups\nare recursively merged.",
"type": "string"
},
"item": {
"$ref": "GooglePrivacyDlpV2ContentItem",
"description": "The item to inspect."
}
},
"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 inspect job."
}
},
"type": "object"
},
"GooglePrivacyDlpV2InspectJobConfig": {
"id": "GooglePrivacyDlpV2InspectJobConfig",
"properties": {
"actions": {
"description": "Actions to execute at the completion of the job. Are executed in the order\nprovided.",
"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.\n`inspect_config` will be merged into the values persisted as part of the\ntemplate.",
"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,\nand the findings returned are an arbitrary subset of all findings.\nThe findings list might be truncated because the input items were too\nlarge, or because the server reached the maximum amount of resources\nallowed for a single API call. For best results, divide the input into\nsmaller batches.",
"type": "boolean"
}
},
"type": "object"
},
"GooglePrivacyDlpV2InspectTemplate": {
"description": "The inspectTemplate contains a configuration (set of types of sensitive data\nto be detected) to be used anywhere you otherwise would normally specify\nInspectConfig.",
"id": "GooglePrivacyDlpV2InspectTemplate",
"properties": {
"createTime": {
"description": "The creation timestamp of a inspectTemplate, output only field.",
"format": "google-datetime",
"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": "The template name. Output only.\n\nThe template will have one of the following formats:\n`projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR\n`organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`",
"type": "string"
},
"updateTime": {
"description": "The last update timestamp of a inspectTemplate, output only field.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2JobTrigger": {
"description": "Contains a configuration to make dlp api calls on a repeating basis.",
"id": "GooglePrivacyDlpV2JobTrigger",
"properties": {
"createTime": {
"description": "The creation timestamp of a triggeredJob, output only field.",
"format": "google-datetime",
"type": "string"
},
"description": {
"description": "User provided description (max 256 chars)",
"type": "string"
},
"displayName": {
"description": "Display name (max 100 chars)",
"type": "string"
},
"errors": {
"description": "A stream of errors encountered when the trigger was activated. Repeated\nerrors may result in the JobTrigger automaticaly being paused.\nWill return the last 100 errors. Whenever the JobTrigger is modified\nthis list will be cleared. Output only field.",
"items": {
"$ref": "GooglePrivacyDlpV2Error"
},
"type": "array"
},
"inspectJob": {
"$ref": "GooglePrivacyDlpV2InspectJobConfig"
},
"lastRunTime": {
"description": "The timestamp of the last time this trigger executed, output only field.",
"format": "google-datetime",
"type": "string"
},
"name": {
"description": "Unique resource name for the triggeredJob, assigned by the service when the\ntriggeredJob is created, for example\n`projects/dlp-test-project/triggeredJobs/53234423`.",
"type": "string"
},
"status": {
"description": "A status for this trigger. [required]",
"enum": [
"STATUS_UNSPECIFIED",
"HEALTHY",
"PAUSED",
"CANCELLED"
],
"enumDescriptions": [
"",
"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\nneeds to trigger for a job to be started. The list may contain only\na single Schedule trigger and must have at least one object.",
"items": {
"$ref": "GooglePrivacyDlpV2Trigger"
},
"type": "array"
},
"updateTime": {
"description": "The last update timestamp of a triggeredJob, output only field.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2KAnonymityConfig": {
"description": "k-anonymity metric, used for analysis of reidentification risk.",
"id": "GooglePrivacyDlpV2KAnonymityConfig",
"properties": {
"quasiIds": {
"description": "Set of fields to compute k-anonymity over. When multiple fields are\nspecified, they are considered a single composite key. Structs and\nrepeated data types are not supported; however, nested fields are\nsupported so long as they are not structs themselves or nested within\na 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\nabove set of values.",
"format": "int64",
"type": "string"
},
"quasiIdsValues": {
"description": "Set of values defining the equivalence class. One value per\nquasi-identifier column in the original KAnonymity metric message.\nThe order is always the same as the original request.",
"items": {
"$ref": "GooglePrivacyDlpV2Value"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2KAnonymityHistogramBucket": {
"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\nclasses 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\nis called \"journalist risk\" in the literature, except the attack dataset is\nstatistically modeled instead of being perfectly known. This can be done\nusing publicly available data (like the US Census), or using a custom\nstatistical model (indicated as one or several BigQuery tables), or by\nextrapolating 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\nused to tag a quasi-identifiers column must appear in exactly one column\nof one auxiliary table.",
"items": {
"$ref": "GooglePrivacyDlpV2AuxiliaryTable"
},
"type": "array"
},
"quasiIds": {
"description": "Fields considered to be quasi-identifiers. No two columns can have the\nsame tag. [required]",
"items": {
"$ref": "GooglePrivacyDlpV2TaggedField"
},
"type": "array"
},
"regionCode": {
"description": "ISO 3166-1 alpha-2 region code to use in the statistical modeling.\nRequired if no column is tagged with a region-specific InfoType (like\nUS_ZIP_5) or a region code.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2KMapEstimationHistogramBucket": {
"description": "A KMapEstimationHistogramBucket message with the following values:\n min_anonymity: 3\n max_anonymity: 5\n frequency: 42\nmeans that there are 42 records whose quasi-identifier values correspond\nto 3, 4 or 5 people in the overlying population. An important particular\ncase is when min_anonymity = max_anonymity = 1: the frequency field then\ncorresponds 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\nnumber 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\nestimation, not exact values.",
"id": "GooglePrivacyDlpV2KMapEstimationResult",
"properties": {
"kMapEstimationHistogram": {
"description": "The intervals [min_anonymity, max_anonymity] do not overlap. If a value\ndoesn't correspond to any such interval, the associated frequency is\nzero. For example, the following records:\n {min_anonymity: 1, max_anonymity: 1, frequency: 17}\n {min_anonymity: 2, max_anonymity: 3, frequency: 42}\n {min_anonymity: 5, max_anonymity: 10, frequency: 99}\nmean that there are no record with an estimated anonymity of 4, 5, or\nlarger than 10.",
"items": {
"$ref": "GooglePrivacyDlpV2KMapEstimationHistogramBucket"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2Key": {
"description": "A unique identifier for a Datastore entity.\nIf a key's partition ID or any of its path kinds or names are\nreserved/read-only, the key is reserved/read-only.\nA 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\nID and namespace ID.\nQueries are scoped to a single partition."
},
"path": {
"description": "The entity path.\nAn entity path consists of one or more elements composed of a kind and a\nstring or numerical identifier, which identify entities. The first\nelement identifies a _root entity_, the second element identifies\na _child_ of the root entity, the third element identifies a child of the\nsecond entity, and so forth. The entities identified by all prefixes of\nthe path are called the element's _ancestors_.\n\nA 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.\nAuthorization requires the following IAM permissions when sending a request\nto perform a crypto transformation using a kms-wrapped crypto key:\ndlp.kms.encrypt",
"id": "GooglePrivacyDlpV2KmsWrappedCryptoKey",
"properties": {
"cryptoKeyName": {
"description": "The resource name of the KMS CryptoKey to use for unwrapping. [required]",
"type": "string"
},
"wrappedKey": {
"description": "The wrapped data crypto key. [required]",
"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\ndefined for the l-diversity computation. When multiple fields are\nspecified, 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\nclass. 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": {
"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\nclasses returned per bucket is capped at 20.",
"items": {
"$ref": "GooglePrivacyDlpV2LDiversityEquivalenceClass"
},
"type": "array"
},
"sensitiveValueFrequencyLowerBound": {
"description": "Lower bound on the sensitive value frequencies of the equivalence\nclasses in this bucket.",
"format": "int64",
"type": "string"
},
"sensitiveValueFrequencyUpperBound": {
"description": "Upper bound on the sensitive value frequencies of the equivalence\nclasses 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"
},
"GooglePrivacyDlpV2LikelihoodAdjustment": {
"description": "Message for specifying an adjustment to the likelihood of a finding as\npart 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; information with all likelihoods is included.",
"Few matching elements.",
"",
"Some matching elements.",
"",
"Many matching elements."
],
"type": "string"
},
"relativeLikelihood": {
"description": "Increase or decrease the likelihood by the specified number of\nlevels. For example, if a finding would be `POSSIBLE` without the\ndetection rule and `relative_likelihood` is 1, then it is upgraded to\n`LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.\nLikelihood may never drop below `VERY_UNLIKELY` or exceed\n`VERY_LIKELY`, so applying an adjustment of 1 followed by an\nadjustment of -1 when base likelihood is `VERY_LIKELY` will result in\na final likelihood of `LIKELY`.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GooglePrivacyDlpV2ListDeidentifyTemplatesResponse": {
"description": "Response message for ListDeidentifyTemplates.",
"id": "GooglePrivacyDlpV2ListDeidentifyTemplatesResponse",
"properties": {
"deidentifyTemplates": {
"description": "List of deidentify templates, up to page_size in\nListDeidentifyTemplatesRequest.",
"items": {
"$ref": "GooglePrivacyDlpV2DeidentifyTemplate"
},
"type": "array"
},
"nextPageToken": {
"description": "If the next page is available then the next page token to be used\nin following ListDeidentifyTemplates 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"
},
"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\nin 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 the next page token to be used\nin following ListJobTriggers request.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2Location": {
"description": "Specifies the location of the finding.",
"id": "GooglePrivacyDlpV2Location",
"properties": {
"byteRange": {
"$ref": "GooglePrivacyDlpV2Range",
"description": "Zero-based byte offsets delimiting the finding.\nThese are relative to the finding's containing element.\nNote that when the content is not textual, this references\nthe UTF-8 encoded textual representation of the content.\nOmitted if content is an image."
},
"codepointRange": {
"$ref": "GooglePrivacyDlpV2Range",
"description": "Unicode character offsets delimiting the finding.\nThese are relative to the finding's containing element.\nProvided when the content is text."
},
"contentLocations": {
"description": "List of nested objects pointing to the precise location of the finding\nwithin the file or record.",
"items": {
"$ref": "GooglePrivacyDlpV2ContentLocation"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2NumericalStatsConfig": {
"description": "Compute numerical stats over an individual column, including\nmin, max, and quantiles.",
"id": "GooglePrivacyDlpV2NumericalStatsConfig",
"properties": {
"field": {
"$ref": "GooglePrivacyDlpV2FieldId",
"description": "Field to compute numerical stats on. Supported types are\ninteger, 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\nsized buckets.",
"items": {
"$ref": "GooglePrivacyDlpV2Value"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2OutputStorageConfig": {
"description": "Cloud repository for storing output.",
"id": "GooglePrivacyDlpV2OutputStorageConfig",
"properties": {
"outputSchema": {
"description": "Schema used for writing the findings. Columns are derived from the\n`Finding` object. If appending to an existing table, any columns from the\npredefined schema that are missing will be added. No columns in the\nexisting table will be deleted.\n\nIf unspecified, then all available columns will be used for a new table,\nand no changes will be made to an existing table.",
"enum": [
"OUTPUT_SCHEMA_UNSPECIFIED",
"BASIC_COLUMNS",
"GCS_COLUMNS",
"DATASTORE_COLUMNS",
"BIG_QUERY_COLUMNS",
"ALL_COLUMNS"
],
"enumDescriptions": [
"",
"Basic schema including only `info_type`, `quote`, `certainty`, and\n`timestamp`.",
"Schema tailored to findings from scanning Google Cloud Storage.",
"Schema tailored to findings from scanning Google Datastore.",
"Schema tailored to findings from scanning Google BigQuery.",
"Schema containing all columns."
],
"type": "string"
},
"table": {
"$ref": "GooglePrivacyDlpV2BigQueryTable",
"description": "Store findings in an existing table or a new table in an existing\ndataset. Each column in an existing table must have the same name, type,\nand mode of a field in the `Finding` object. If table_id is not set a new\none will be generated for you with the following format:\ndlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for\ngenerating the date details."
}
},
"type": "object"
},
"GooglePrivacyDlpV2PartitionId": {
"description": "Datastore partition ID.\nA partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.\n\nA partition ID contains several dimensions:\nproject 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.\n\nIf either name or ID is set, the element is complete.\nIf neither is set, the element is incomplete.",
"id": "GooglePrivacyDlpV2PathElement",
"properties": {
"id": {
"description": "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future.",
"format": "int64",
"type": "string"
},
"kind": {
"description": "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
"type": "string"
},
"name": {
"description": "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2PrimitiveTransformation": {
"description": "A rule for transforming a value.",
"id": "GooglePrivacyDlpV2PrimitiveTransformation",
"properties": {
"bucketingConfig": {
"$ref": "GooglePrivacyDlpV2BucketingConfig"
},
"characterMaskConfig": {
"$ref": "GooglePrivacyDlpV2CharacterMaskConfig"
},
"cryptoHashConfig": {
"$ref": "GooglePrivacyDlpV2CryptoHashConfig"
},
"cryptoReplaceFfxFpeConfig": {
"$ref": "GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig"
},
"dateShiftConfig": {
"$ref": "GooglePrivacyDlpV2DateShiftConfig"
},
"fixedSizeBucketingConfig": {
"$ref": "GooglePrivacyDlpV2FixedSizeBucketingConfig"
},
"redactConfig": {
"$ref": "GooglePrivacyDlpV2RedactConfig"
},
"replaceConfig": {
"$ref": "GooglePrivacyDlpV2ReplaceValueConfig"
},
"replaceWithInfoTypeConfig": {
"$ref": "GooglePrivacyDlpV2ReplaceWithInfoTypeConfig"
},
"timePartConfig": {
"$ref": "GooglePrivacyDlpV2TimePartConfig"
}
},
"type": "object"
},
"GooglePrivacyDlpV2PrivacyMetric": {
"description": "Privacy metric to compute for reidentification risk analysis.",
"id": "GooglePrivacyDlpV2PrivacyMetric",
"properties": {
"categoricalStatsConfig": {
"$ref": "GooglePrivacyDlpV2CategoricalStatsConfig"
},
"kAnonymityConfig": {
"$ref": "GooglePrivacyDlpV2KAnonymityConfig"
},
"kMapEstimationConfig": {
"$ref": "GooglePrivacyDlpV2KMapEstimationConfig"
},
"lDiversityConfig": {
"$ref": "GooglePrivacyDlpV2LDiversityConfig"
},
"numericalStatsConfig": {
"$ref": "GooglePrivacyDlpV2NumericalStatsConfig"
}
},
"type": "object"
},
"GooglePrivacyDlpV2Proximity": {
"description": "Message for specifying a window around a finding to apply a detection\nrule.",
"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.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GooglePrivacyDlpV2PublishToPubSub": {
"description": "Publish the results of a DlpJob to a pub sub channel.\nCompatible with: Inpect, Risk",
"id": "GooglePrivacyDlpV2PublishToPubSub",
"properties": {
"topic": {
"description": "Cloud Pub/Sub topic to send notifications to. The topic must have given\npublishing access rights to the DLP API service account executing\nthe long running DlpJob sending the notifications.\nFormat is projects/{project}/topics/{topic}.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2QuasiIdField": {
"description": "A quasi-identifier column has a custom_tag, used to know which column\nin the data corresponds to which column in the statistical model.",
"id": "GooglePrivacyDlpV2QuasiIdField",
"properties": {
"customTag": {
"type": "string"
},
"field": {
"$ref": "GooglePrivacyDlpV2FieldId"
}
},
"type": "object"
},
"GooglePrivacyDlpV2QuoteInfo": {
"description": "Message for infoType-dependent details parsed from quote.",
"id": "GooglePrivacyDlpV2QuoteInfo",
"properties": {
"dateTime": {
"$ref": "GooglePrivacyDlpV2DateTime"
}
},
"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\na 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"
},
"datastoreKey": {
"$ref": "GooglePrivacyDlpV2DatastoreKey"
}
},
"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\ntrue.",
"id": "GooglePrivacyDlpV2RecordSuppression",
"properties": {
"condition": {
"$ref": "GooglePrivacyDlpV2RecordCondition",
"description": "A condition that when it evaluates to true will result in the record being\nevaluated to be suppressed from the transformed content."
}
},
"type": "object"
},
"GooglePrivacyDlpV2RecordTransformations": {
"description": "A type of transformation that is applied over structured data such as a\ntable.",
"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\nmatch any suppression rule are omitted from the output [optional].",
"items": {
"$ref": "GooglePrivacyDlpV2RecordSuppression"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2RedactConfig": {
"description": "Redact a given value. For example, if used with an `InfoTypeTransformation`\ntransforming PHONE_NUMBER, and input 'My phone number is 206-555-0123', the\noutput would be 'My phone number is '.",
"id": "GooglePrivacyDlpV2RedactConfig",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2RedactImageRequest": {
"description": "Request to search for potentially sensitive info in a list of items\nand replace it with a default or provided content.",
"id": "GooglePrivacyDlpV2RedactImageRequest",
"properties": {
"byteItem": {
"$ref": "GooglePrivacyDlpV2ByteContentItem",
"description": "The content must be PNG, JPEG, SVG or BMP."
},
"imageRedactionConfigs": {
"description": "The configuration for specifying what content to redact from images.",
"items": {
"$ref": "GooglePrivacyDlpV2ImageRedactionConfig"
},
"type": "array"
},
"inspectConfig": {
"$ref": "GooglePrivacyDlpV2InspectConfig",
"description": "Configuration for the inspector."
}
},
"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\nset to true, then this field will include all text, if any, that was found\nin the image.",
"type": "string"
},
"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": {
"pattern": {
"description": "Pattern defining the regular expression.",
"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": "Optional template to use. Any configuration directly specified in\n`inspect_config` will override those set in the template. Singular fields\nthat are set in this request will replace their corresponding fields in the\ntemplate. Repeated fields are appended. Singular sub-messages and groups\nare recursively merged.",
"type": "string"
},
"item": {
"$ref": "GooglePrivacyDlpV2ContentItem",
"description": "The item to re-identify. Will be treated as text."
},
"reidentifyConfig": {
"$ref": "GooglePrivacyDlpV2DeidentifyConfig",
"description": "Configuration for the re-identification of the content item.\nThis field shares the same proto message type that is used for\nde-identification, however its usage here is for the reversal of the\nprevious de-identification. Re-identification is performed by examining\nthe transformations used to de-identify the items and executing the\nreverse. This requires that only reversible transformations\nbe provided here. The reversible transformations are:\n\n - `CryptoReplaceFfxFpeConfig`"
},
"reidentifyTemplateName": {
"description": "Optional template to use. References an instance of `DeidentifyTemplate`.\nAny configuration directly specified in `reidentify_config` or\n`inspect_config` will override those set in the template. Singular fields\nthat are set in this request will replace their corresponding fields in the\ntemplate. Repeated fields are appended. Singular sub-messages and groups\nare recursively merged.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2ReidentifyContentResponse": {
"description": "Results of re-identifying a 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"
},
"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"
},
"GooglePrivacyDlpV2RequestedOptions": {
"id": "GooglePrivacyDlpV2RequestedOptions",
"properties": {
"jobConfig": {
"$ref": "GooglePrivacyDlpV2InspectJobConfig"
},
"snapshotInspectTemplate": {
"$ref": "GooglePrivacyDlpV2InspectTemplate",
"description": "If run with an inspect template, a snapshot of it's state at the time of\nthis run."
}
},
"type": "object"
},
"GooglePrivacyDlpV2Result": {
"id": "GooglePrivacyDlpV2Result",
"properties": {
"infoTypeStats": {
"description": "Statistics of how many instances of each info type were found during\ninspect job.",
"items": {
"$ref": "GooglePrivacyDlpV2InfoTypeStats"
},
"type": "array"
},
"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.",
"id": "GooglePrivacyDlpV2RiskAnalysisJobConfig",
"properties": {
"actions": {
"description": "Actions to execute at the completion of the job. Are executed in the order\nprovided.",
"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": {
"id": "GooglePrivacyDlpV2Row",
"properties": {
"values": {
"items": {
"$ref": "GooglePrivacyDlpV2Value"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2SaveFindings": {
"description": "If set, the detailed findings will be persisted to the specified\nOutputStorageConfig. Compatible with: Inspect",
"id": "GooglePrivacyDlpV2SaveFindings",
"properties": {
"outputConfig": {
"$ref": "GooglePrivacyDlpV2OutputStorageConfig"
}
},
"type": "object"
},
"GooglePrivacyDlpV2Schedule": {
"description": "Schedule for triggeredJobs.",
"id": "GooglePrivacyDlpV2Schedule",
"properties": {
"recurrencePeriodDuration": {
"description": "With this option a job is started a regular periodic basis. For\nexample: every 10 minutes.\n\nA scheduled start time will be skipped if the previous\nexecution has not ended when its scheduled time occurs.\n\nThis value must be set to a time duration greater than or equal\nto 60 minutes and can be no longer than 60 days.",
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2StorageConfig": {
"description": "Shared message indicating Cloud storage type.",
"id": "GooglePrivacyDlpV2StorageConfig",
"properties": {
"bigQueryOptions": {
"$ref": "GooglePrivacyDlpV2BigQueryOptions",
"description": "BigQuery options specification."
},
"cloudStorageOptions": {
"$ref": "GooglePrivacyDlpV2CloudStorageOptions",
"description": "Google Cloud Storage options specification."
},
"datastoreOptions": {
"$ref": "GooglePrivacyDlpV2DatastoreOptions",
"description": "Google Cloud Datastore options specification."
},
"timespanConfig": {
"$ref": "GooglePrivacyDlpV2TimespanConfig"
}
},
"type": "object"
},
"GooglePrivacyDlpV2SummaryResult": {
"description": "A collection that informs the user the number of times a particular\n`TransformationResultCode` and error details occurred.",
"id": "GooglePrivacyDlpV2SummaryResult",
"properties": {
"code": {
"enum": [
"TRANSFORMATION_RESULT_CODE_UNSPECIFIED",
"SUCCESS",
"ERROR"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"count": {
"format": "int64",
"type": "string"
},
"details": {
"description": "A place for warnings or errors to show up if a transformation didn't\nwork as expected.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2SurrogateType": {
"description": "Message for detecting output from deidentification transformations\nsuch as\n[`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig).\nThese types of transformations are\nthose that perform pseudonymization, thereby producing a \"surrogate\" as\noutput. This should be used in conjunction with a field on the\ntransformation such as `surrogate_info_type`. This custom info type does\nnot 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.",
"id": "GooglePrivacyDlpV2Table",
"properties": {
"headers": {
"items": {
"$ref": "GooglePrivacyDlpV2FieldId"
},
"type": "array"
},
"rows": {
"items": {
"$ref": "GooglePrivacyDlpV2Row"
},
"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.",
"format": "int64",
"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\nindicate an auxiliary table that contains statistical information on\nthe possible values of this column (below).",
"type": "string"
},
"field": {
"$ref": "GooglePrivacyDlpV2FieldId",
"description": "Identifies the column. [required]"
},
"inferred": {
"$ref": "GoogleProtobufEmpty",
"description": "If no semantic tag is indicated, we infer the statistical model from\nthe distribution of values in the input data"
},
"infoType": {
"$ref": "GooglePrivacyDlpV2InfoType",
"description": "A column can be tagged with a InfoType to use the relevant public\ndataset as a statistical model of population, if available. We\ncurrently support US ZIP codes, region codes, ages and genders.\nTo programmatically obtain the list of supported InfoTypes, use\nListInfoTypes with the supported_by=RISK_ANALYSIS filter."
}
},
"type": "object"
},
"GooglePrivacyDlpV2TimePartConfig": {
"description": "For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a\nportion of the value.",
"id": "GooglePrivacyDlpV2TimePartConfig",
"properties": {
"partToExtract": {
"enum": [
"TIME_PART_UNSPECIFIED",
"YEAR",
"MONTH",
"DAY_OF_MONTH",
"DAY_OF_WEEK",
"WEEK_OF_YEAR",
"HOUR_OF_DAY"
],
"enumDescriptions": [
"",
"[0-9999]",
"[1-12]",
"[1-31]",
"[1-7]",
"[1-52]",
"[0-23]"
],
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2TimeZone": {
"id": "GooglePrivacyDlpV2TimeZone",
"properties": {
"offsetMinutes": {
"description": "Set only if the offset can be determined. Positive for time ahead of UTC.\nE.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.\nCurrently only supported when inspecting Google Cloud Storage and BigQuery.",
"id": "GooglePrivacyDlpV2TimespanConfig",
"properties": {
"enableAutoPopulationOfTimespanConfig": {
"description": "When the job is started by a JobTrigger we will automatically figure out\na valid start_time to avoid scanning files that have not been modified\nsince the last time the JobTrigger executed. This will be based on the\ntime of the execution of the last run of the JobTrigger.",
"type": "boolean"
},
"endTime": {
"description": "Exclude files newer than this value.\nIf set to zero, no upper time limit is applied.",
"format": "google-datetime",
"type": "string"
},
"startTime": {
"description": "Exclude files older than this value.",
"format": "google-datetime",
"type": "string"
},
"timestampField": {
"$ref": "GooglePrivacyDlpV2FieldId",
"description": "Specification of the field containing the timestamp of scanned items.\nRequired for data sources like Datastore or BigQuery.\nThe valid data types of the timestamp field are:\nfor BigQuery - timestamp, date, datetime;\nfor Datastore - timestamp.\nDatastore entity will be scanned if the timestamp property does not exist\nor its value is empty or invalid."
}
},
"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"
},
"GooglePrivacyDlpV2TransformationSummary": {
"description": "Summary of a single tranformation.\nOnly one of 'transformation', 'field_transformation', or 'record_suppress'\nwill 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.\nIf multiple field transformations are requested for a single field,\nthis 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 info_type."
},
"recordSuppress": {
"$ref": "GooglePrivacyDlpV2RecordSuppression",
"description": "The specific suppression option these stats apply to."
},
"results": {
"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.\nIt will be discarded after the request finishes.",
"id": "GooglePrivacyDlpV2TransientCryptoKey",
"properties": {
"name": {
"description": "Name of the key. [required]\nThis is an arbitrary string used to differentiate different keys.\nA unique key is generated per name: two separate `TransientCryptoKey`\nprotos share the same generated key if their names are the same.\nWhen the data crypto key is generated, this name is not used in any way\n(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": {
"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\nleaking the key. Choose another type of key if possible.",
"id": "GooglePrivacyDlpV2UnwrappedCryptoKey",
"properties": {
"key": {
"description": "The AES 128/192/256 bit key. [required]",
"format": "byte",
"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"
},
"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"
},
"GooglePrivacyDlpV2Value": {
"description": "Set of primitive values supported by the system.\nNote that for the purposes of inspection or transformation, the number\nof bytes considered to comprise a 'Value' is based on its representation\nas a UTF-8 encoded string. For example, if 'integer_value' is set to\n123456789, the number of bytes would be counted as 9, even though an\nint64 only holds up to 8 bytes of data.",
"id": "GooglePrivacyDlpV2Value",
"properties": {
"booleanValue": {
"type": "boolean"
},
"dateValue": {
"$ref": "GoogleTypeDate"
},
"dayOfWeekValue": {
"enum": [
"DAY_OF_WEEK_UNSPECIFIED",
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
],
"enumDescriptions": [
"The unspecified day-of-week.",
"The day-of-week of Monday.",
"The day-of-week of Tuesday.",
"The day-of-week of Wednesday.",
"The day-of-week of Thursday.",
"The day-of-week of Friday.",
"The day-of-week of Saturday.",
"The day-of-week of Sunday."
],
"type": "string"
},
"floatValue": {
"format": "double",
"type": "number"
},
"integerValue": {
"format": "int64",
"type": "string"
},
"stringValue": {
"type": "string"
},
"timeValue": {
"$ref": "GoogleTypeTimeOfDay"
},
"timestampValue": {
"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"
},
"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\nat least one phrase and every phrase must contain at least 2 characters\nthat are letters or digits. [required]",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1AuxiliaryTable": {
"description": "An auxiliary table contains statistical information on the relative\nfrequency of different quasi-identifiers values. It has one or several\nquasi-identifiers columns, and one column that indicates the relative\nfrequency of each quasi-identifier tuple.\nIf a tuple is present in the data but not in the auxiliary table, the\ncorresponding relative frequency is assumed to be zero (and thus, the\ntuple is highly reidentifiable).",
"id": "GooglePrivacyDlpV2beta1AuxiliaryTable",
"properties": {
"quasiIds": {
"description": "Quasi-identifier columns. [required]",
"items": {
"$ref": "GooglePrivacyDlpV2beta1QuasiIdField"
},
"type": "array"
},
"relativeFrequency": {
"$ref": "GooglePrivacyDlpV2beta1FieldId",
"description": "The relative frequency column must contain a floating-point number\nbetween 0 and 1 (inclusive). Null values are assumed to be zero.\n[required]"
},
"table": {
"$ref": "GooglePrivacyDlpV2beta1BigQueryTable",
"description": "Auxiliary table location. [required]"
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1BigQueryOptions": {
"description": "Options defining BigQuery table and row identifiers.",
"id": "GooglePrivacyDlpV2beta1BigQueryOptions",
"properties": {
"identifyingFields": {
"description": "References to fields uniquely identifying rows within the table.\nNested fields in the format, like `person.birthdate.year`, are allowed.",
"items": {
"$ref": "GooglePrivacyDlpV2beta1FieldId"
},
"type": "array"
},
"tableReference": {
"$ref": "GooglePrivacyDlpV2beta1BigQueryTable",
"description": "Complete BigQuery table reference."
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1BigQueryTable": {
"description": "Message defining the location of a BigQuery table. A table is uniquely\nidentified by its project_id, dataset_id, and table_name. Within a query\na table is often referenced with a string in the format of:\n`\u003cproject_id\u003e:\u003cdataset_id\u003e.\u003ctable_id\u003e` or\n`\u003cproject_id\u003e.\u003cdataset_id\u003e.\u003ctable_id\u003e`.",
"id": "GooglePrivacyDlpV2beta1BigQueryTable",
"properties": {
"datasetId": {
"description": "Dataset ID of the table.",
"type": "string"
},
"projectId": {
"description": "The Google Cloud Platform project ID of the project containing the table.\nIf omitted, project ID is inferred from the API call.",
"type": "string"
},
"tableId": {
"description": "Name of the table.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1CategoricalStatsConfig": {
"description": "Compute numerical stats over an individual column, including\nnumber of distinct values and value count distribution.",
"id": "GooglePrivacyDlpV2beta1CategoricalStatsConfig",
"properties": {
"field": {
"$ref": "GooglePrivacyDlpV2beta1FieldId",
"description": "Field to compute categorical stats on. All column types are\nsupported except for arrays and structs. However, it may be more\ninformative to use NumericalStats when the field type is supported,\ndepending on the data."
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket": {
"description": "Histogram bucket of value frequencies in the column.",
"id": "GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket",
"properties": {
"bucketSize": {
"description": "Total number of records in this bucket.",
"format": "int64",
"type": "string"
},
"bucketValues": {
"description": "Sample of value frequencies in this bucket. The total number of\nvalues returned per bucket is capped at 20.",
"items": {
"$ref": "GooglePrivacyDlpV2beta1ValueFrequency"
},
"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"
},
"GooglePrivacyDlpV2beta1CategoricalStatsResult": {
"description": "Result of the categorical stats computation.",
"id": "GooglePrivacyDlpV2beta1CategoricalStatsResult",
"properties": {
"valueFrequencyHistogramBuckets": {
"description": "Histogram of value frequencies in the column.",
"items": {
"$ref": "GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1CloudStorageOptions": {
"description": "Options defining a file or a set of files (path ending with *) within\na Google Cloud Storage bucket.",
"id": "GooglePrivacyDlpV2beta1CloudStorageOptions",
"properties": {
"fileSet": {
"$ref": "GooglePrivacyDlpV2beta1FileSet"
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1CloudStoragePath": {
"description": "A location in Cloud Storage.",
"id": "GooglePrivacyDlpV2beta1CloudStoragePath",
"properties": {
"path": {
"description": "The url, in the format of `gs://bucket/\u003cpath\u003e`.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1CustomInfoType": {
"description": "Custom information type provided by the user. Used to find domain-specific\nsensitive information configurable to the data in question.",
"id": "GooglePrivacyDlpV2beta1CustomInfoType",
"properties": {
"dictionary": {
"$ref": "GooglePrivacyDlpV2beta1Dictionary",
"description": "Dictionary-based custom info type."
},
"infoType": {
"$ref": "GooglePrivacyDlpV2beta1InfoType",
"description": "Info type configuration. All custom info types must have configurations\nthat do not conflict with built-in info types or other custom info types."
},
"surrogateType": {
"$ref": "GooglePrivacyDlpV2beta1SurrogateType",
"description": "Surrogate info type."
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1DatastoreOptions": {
"description": "Options defining a data set within Google Cloud Datastore.",
"id": "GooglePrivacyDlpV2beta1DatastoreOptions",
"properties": {
"kind": {
"$ref": "GooglePrivacyDlpV2beta1KindExpression",
"description": "The kind to process."
},
"partitionId": {
"$ref": "GooglePrivacyDlpV2beta1PartitionId",
"description": "A partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty."
},
"projection": {
"description": "Properties to scan. If none are specified, all properties will be scanned\nby default.",
"items": {
"$ref": "GooglePrivacyDlpV2beta1Projection"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1Dictionary": {
"description": "Custom information type based on a dictionary of words or phrases. This can\nbe used to match sensitive information specific to the data, such as a list\nof employee IDs or job titles.\n\nDictionary words are case-insensitive and all characters other than letters\nand digits in the unicode [Basic Multilingual\nPlane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)\nwill be replaced with whitespace when scanning for matches, so the\ndictionary phrase \"Sam Johnson\" will match all three phrases \"sam johnson\",\n\"Sam, Johnson\", and \"Sam (Johnson)\". Additionally, the characters\nsurrounding any match must be of a different type than the adjacent\ncharacters within the word, so letters must be next to non-letters and\ndigits next to non-digits. For example, the dictionary word \"jen\" will\nmatch the first three letters of the text \"jen123\" but will return no\nmatches for \"jennifer\".\n\nDictionary words containing a large number of characters that are not\nletters or digits may result in unexpected findings because such characters\nare treated as whitespace.",
"id": "GooglePrivacyDlpV2beta1Dictionary",
"properties": {
"wordList": {
"$ref": "GooglePrivacyDlpV2beta1WordList",
"description": "List of words or phrases to search for."
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1EntityId": {
"description": "An entity in a dataset is a field or set of fields that correspond to a\nsingle person. For example, in medical records the `EntityId` might be\na patient identifier, or for financial records it might be an account\nidentifier. This message is used when generalizations or analysis must be\nconsistent across multiple rows pertaining to the same entity.",
"id": "GooglePrivacyDlpV2beta1EntityId",
"properties": {
"field": {
"$ref": "GooglePrivacyDlpV2beta1FieldId",
"description": "Composite key indicating which field contains the entity identifier."
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1FieldId": {
"description": "General identifier of a data field in a storage service.",
"id": "GooglePrivacyDlpV2beta1FieldId",
"properties": {
"columnName": {
"description": "Name describing the field.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1FileSet": {
"description": "Set of files to scan.",
"id": "GooglePrivacyDlpV2beta1FileSet",
"properties": {
"url": {
"description": "The url, in the format `gs://\u003cbucket\u003e/\u003cpath\u003e`. Trailing wildcard in the\npath is allowed.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1InfoType": {
"description": "Type of information detected by the API.",
"id": "GooglePrivacyDlpV2beta1InfoType",
"properties": {
"name": {
"description": "Name of the information type.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1InfoTypeLimit": {
"description": "Max findings configuration per info type, per content item or long running\noperation.",
"id": "GooglePrivacyDlpV2beta1InfoTypeLimit",
"properties": {
"infoType": {
"$ref": "GooglePrivacyDlpV2beta1InfoType",
"description": "Type of information the findings limit applies to. Only one limit per\ninfo_type should be provided. If InfoTypeLimit does not have an\ninfo_type, the DLP API applies the limit against all info_types that are\nfound but not specified in another InfoTypeLimit."
},
"maxFindings": {
"description": "Max findings limit for the given infoType.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1InfoTypeStatistics": {
"description": "Statistics regarding a specific InfoType.",
"id": "GooglePrivacyDlpV2beta1InfoTypeStatistics",
"properties": {
"count": {
"description": "Number of findings for this info type.",
"format": "int64",
"type": "string"
},
"infoType": {
"$ref": "GooglePrivacyDlpV2beta1InfoType",
"description": "The type of finding this stat is for."
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1InspectConfig": {
"description": "Configuration description of the scanning process.\nWhen used with redactContent only info_types and min_likelihood are currently\nused.",
"id": "GooglePrivacyDlpV2beta1InspectConfig",
"properties": {
"customInfoTypes": {
"description": "Custom info types provided by the user.",
"items": {
"$ref": "GooglePrivacyDlpV2beta1CustomInfoType"
},
"type": "array"
},
"excludeTypes": {
"description": "When true, excludes type information of the findings.",
"type": "boolean"
},
"includeQuote": {
"description": "When true, a contextual quote from the data that triggered a finding is\nincluded in the response; see Finding.quote.",
"type": "boolean"
},
"infoTypeLimits": {
"description": "Configuration of findings limit given for specified info types.",
"items": {
"$ref": "GooglePrivacyDlpV2beta1InfoTypeLimit"
},
"type": "array"
},
"infoTypes": {
"description": "Restricts what info_types to look for. The values must correspond to\nInfoType values returned by ListInfoTypes or found in documentation.\nEmpty info_types runs all enabled detectors.",
"items": {
"$ref": "GooglePrivacyDlpV2beta1InfoType"
},
"type": "array"
},
"maxFindings": {
"description": "Limits the number of findings per content item or long running operation.",
"format": "int32",
"type": "integer"
},
"minLikelihood": {
"description": "Only returns findings equal or above this threshold.",
"enum": [
"LIKELIHOOD_UNSPECIFIED",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Default value; information with all likelihoods is included.",
"Few matching elements.",
"",
"Some matching elements.",
"",
"Many matching elements."
],
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1InspectOperationMetadata": {
"description": "Metadata returned within GetOperation for an inspect request.",
"id": "GooglePrivacyDlpV2beta1InspectOperationMetadata",
"properties": {
"createTime": {
"description": "The time which this request was started.",
"format": "google-datetime",
"type": "string"
},
"infoTypeStats": {
"items": {
"$ref": "GooglePrivacyDlpV2beta1InfoTypeStatistics"
},
"type": "array"
},
"processedBytes": {
"description": "Total size in bytes that were processed.",
"format": "int64",
"type": "string"
},
"requestInspectConfig": {
"$ref": "GooglePrivacyDlpV2beta1InspectConfig",
"description": "The inspect config used to create the Operation."
},
"requestOutputConfig": {
"$ref": "GooglePrivacyDlpV2beta1OutputStorageConfig",
"description": "Optional location to store findings."
},
"requestStorageConfig": {
"$ref": "GooglePrivacyDlpV2beta1StorageConfig",
"description": "The storage config used to create the Operation."
},
"totalEstimatedBytes": {
"description": "Estimate of the number of bytes to process.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1InspectOperationResult": {
"description": "The operational data.",
"id": "GooglePrivacyDlpV2beta1InspectOperationResult",
"properties": {
"name": {
"description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `inspect/results/{id}`.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1KAnonymityConfig": {
"description": "k-anonymity metric, used for analysis of reidentification risk.",
"id": "GooglePrivacyDlpV2beta1KAnonymityConfig",
"properties": {
"entityId": {
"$ref": "GooglePrivacyDlpV2beta1EntityId",
"description": "Optional message indicating that each distinct entity_id should not\ncontribute to the k-anonymity count more than once per equivalence class.\nIf an entity_id appears on several rows with different quasi-identifier\ntuples, it will contribute to each count exactly once.\n\nThis can lead to unexpected results. Consider a table where ID 1 is\nassociated to quasi-identifier \"foo\", ID 2 to \"bar\", and ID 3 to *both*\nquasi-identifiers \"foo\" and \"bar\" (on separate rows), and where this ID\nis used as entity_id. Then, the anonymity value associated to ID 3 will\nbe 2, even if it is the only ID to be associated to both values \"foo\" and\n\"bar\"."
},
"quasiIds": {
"description": "Set of fields to compute k-anonymity over. When multiple fields are\nspecified, they are considered a single composite key. Structs and\nrepeated data types are not supported; however, nested fields are\nsupported so long as they are not structs themselves or nested within\na repeated field.",
"items": {
"$ref": "GooglePrivacyDlpV2beta1FieldId"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass": {
"description": "The set of columns' values that share the same k-anonymity value.",
"id": "GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass",
"properties": {
"equivalenceClassSize": {
"description": "Size of the equivalence class, for example number of rows with the\nabove set of values.",
"format": "int64",
"type": "string"
},
"quasiIdsValues": {
"description": "Set of values defining the equivalence class. One value per\nquasi-identifier column in the original KAnonymity metric message.\nThe order is always the same as the original request.",
"items": {
"$ref": "GooglePrivacyDlpV2beta1Value"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1KAnonymityHistogramBucket": {
"description": "Histogram bucket of equivalence class sizes in the table.",
"id": "GooglePrivacyDlpV2beta1KAnonymityHistogramBucket",
"properties": {
"bucketSize": {
"description": "Total number of records in this bucket.",
"format": "int64",
"type": "string"
},
"bucketValues": {
"description": "Sample of equivalence classes in this bucket. The total number of\nclasses returned per bucket is capped at 20.",
"items": {
"$ref": "GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass"
},
"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"
},
"GooglePrivacyDlpV2beta1KAnonymityResult": {
"description": "Result of the k-anonymity computation.",
"id": "GooglePrivacyDlpV2beta1KAnonymityResult",
"properties": {
"equivalenceClassHistogramBuckets": {
"description": "Histogram of k-anonymity equivalence classes.",
"items": {
"$ref": "GooglePrivacyDlpV2beta1KAnonymityHistogramBucket"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1KMapEstimationConfig": {
"description": "Reidentifiability metric. This corresponds to a risk model similar to what\nis called \"journalist risk\" in the literature, except the attack dataset is\nstatistically modeled instead of being perfectly known. This can be done\nusing publicly available data (like the US Census), or using a custom\nstatistical model (indicated as one or several BigQuery tables), or by\nextrapolating from the distribution of values in the input dataset.",
"id": "GooglePrivacyDlpV2beta1KMapEstimationConfig",
"properties": {
"auxiliaryTables": {
"description": "Several auxiliary tables can be used in the analysis. Each custom_tag\nused to tag a quasi-identifiers column must appear in exactly one column\nof one auxiliary table.",
"items": {
"$ref": "GooglePrivacyDlpV2beta1AuxiliaryTable"
},
"type": "array"
},
"quasiIds": {
"description": "Fields considered to be quasi-identifiers. No two columns can have the\nsame tag. [required]",
"items": {
"$ref": "GooglePrivacyDlpV2beta1TaggedField"
},
"type": "array"
},
"regionCode": {
"description": "ISO 3166-1 alpha-2 region code to use in the statistical modeling.\nRequired if no column is tagged with a region-specific InfoType (like\nUS_ZIP_5) or a region code.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket": {
"description": "A KMapEstimationHistogramBucket message with the following values:\n min_anonymity: 3\n max_anonymity: 5\n frequency: 42\nmeans that there are 42 records whose quasi-identifier values correspond\nto 3, 4 or 5 people in the overlying population. An important particular\ncase is when min_anonymity = max_anonymity = 1: the frequency field then\ncorresponds to the number of uniquely identifiable records.",
"id": "GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket",
"properties": {
"bucketSize": {
"description": "Number of records within these anonymity bounds.",
"format": "int64",
"type": "string"
},
"bucketValues": {
"description": "Sample of quasi-identifier tuple values in this bucket. The total\nnumber of classes returned per bucket is capped at 20.",
"items": {
"$ref": "GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues"
},
"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"
},
"GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues": {
"description": "A tuple of values for the quasi-identifier columns.",
"id": "GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues",
"properties": {
"estimatedAnonymity": {
"description": "The estimated anonymity for these quasi-identifier values.",
"format": "int64",
"type": "string"
},
"quasiIdsValues": {
"description": "The quasi-identifier values.",
"items": {
"$ref": "GooglePrivacyDlpV2beta1Value"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1KMapEstimationResult": {
"description": "Result of the reidentifiability analysis. Note that these results are an\nestimation, not exact values.",
"id": "GooglePrivacyDlpV2beta1KMapEstimationResult",
"properties": {
"kMapEstimationHistogram": {
"description": "The intervals [min_anonymity, max_anonymity] do not overlap. If a value\ndoesn't correspond to any such interval, the associated frequency is\nzero. For example, the following records:\n {min_anonymity: 1, max_anonymity: 1, frequency: 17}\n {min_anonymity: 2, max_anonymity: 3, frequency: 42}\n {min_anonymity: 5, max_anonymity: 10, frequency: 99}\nmean that there are no record with an estimated anonymity of 4, 5, or\nlarger than 10.",
"items": {
"$ref": "GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1KindExpression": {
"description": "A representation of a Datastore kind.",
"id": "GooglePrivacyDlpV2beta1KindExpression",
"properties": {
"name": {
"description": "The name of the kind.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1LDiversityConfig": {
"description": "l-diversity metric, used for analysis of reidentification risk.",
"id": "GooglePrivacyDlpV2beta1LDiversityConfig",
"properties": {
"quasiIds": {
"description": "Set of quasi-identifiers indicating how equivalence classes are\ndefined for the l-diversity computation. When multiple fields are\nspecified, they are considered a single composite key.",
"items": {
"$ref": "GooglePrivacyDlpV2beta1FieldId"
},
"type": "array"
},
"sensitiveAttribute": {
"$ref": "GooglePrivacyDlpV2beta1FieldId",
"description": "Sensitive field for computing the l-value."
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1LDiversityEquivalenceClass": {
"description": "The set of columns' values that share the same l-diversity value.",
"id": "GooglePrivacyDlpV2beta1LDiversityEquivalenceClass",
"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\nclass. The order is always the same as the original request.",
"items": {
"$ref": "GooglePrivacyDlpV2beta1Value"
},
"type": "array"
},
"topSensitiveValues": {
"description": "Estimated frequencies of top sensitive values.",
"items": {
"$ref": "GooglePrivacyDlpV2beta1ValueFrequency"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1LDiversityHistogramBucket": {
"description": "Histogram bucket of sensitive value frequencies in the table.",
"id": "GooglePrivacyDlpV2beta1LDiversityHistogramBucket",
"properties": {
"bucketSize": {
"description": "Total number of records in this bucket.",
"format": "int64",
"type": "string"
},
"bucketValues": {
"description": "Sample of equivalence classes in this bucket. The total number of\nclasses returned per bucket is capped at 20.",
"items": {
"$ref": "GooglePrivacyDlpV2beta1LDiversityEquivalenceClass"
},
"type": "array"
},
"sensitiveValueFrequencyLowerBound": {
"description": "Lower bound on the sensitive value frequencies of the equivalence\nclasses in this bucket.",
"format": "int64",
"type": "string"
},
"sensitiveValueFrequencyUpperBound": {
"description": "Upper bound on the sensitive value frequencies of the equivalence\nclasses in this bucket.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1LDiversityResult": {
"description": "Result of the l-diversity computation.",
"id": "GooglePrivacyDlpV2beta1LDiversityResult",
"properties": {
"sensitiveValueFrequencyHistogramBuckets": {
"description": "Histogram of l-diversity equivalence class sensitive value frequencies.",
"items": {
"$ref": "GooglePrivacyDlpV2beta1LDiversityHistogramBucket"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1NumericalStatsConfig": {
"description": "Compute numerical stats over an individual column, including\nmin, max, and quantiles.",
"id": "GooglePrivacyDlpV2beta1NumericalStatsConfig",
"properties": {
"field": {
"$ref": "GooglePrivacyDlpV2beta1FieldId",
"description": "Field to compute numerical stats on. Supported types are\ninteger, float, date, datetime, timestamp, time."
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1NumericalStatsResult": {
"description": "Result of the numerical stats computation.",
"id": "GooglePrivacyDlpV2beta1NumericalStatsResult",
"properties": {
"maxValue": {
"$ref": "GooglePrivacyDlpV2beta1Value",
"description": "Maximum value appearing in the column."
},
"minValue": {
"$ref": "GooglePrivacyDlpV2beta1Value",
"description": "Minimum value appearing in the column."
},
"quantileValues": {
"description": "List of 99 values that partition the set of field values into 100 equal\nsized buckets.",
"items": {
"$ref": "GooglePrivacyDlpV2beta1Value"
},
"type": "array"
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1OutputStorageConfig": {
"description": "Cloud repository for storing output.",
"id": "GooglePrivacyDlpV2beta1OutputStorageConfig",
"properties": {
"storagePath": {
"$ref": "GooglePrivacyDlpV2beta1CloudStoragePath",
"description": "The path to a Google Cloud Storage location to store output.\nThe bucket must already exist and\nthe Google APIs service account for DLP must have write permission to\nwrite to the given bucket.\nResults are split over multiple csv files with each file name matching\nthe pattern \"[operation_id]_[count].csv\", for example\n`3094877188788974909_1.csv`. The `operation_id` matches the\nidentifier for the Operation, and the `count` is a counter used for\ntracking the number of files written.\n\nThe CSV file(s) contain the following columns regardless of storage type\nscanned:\n- id\n- info_type\n- likelihood\n- byte size of finding\n- quote\n- timestamp\n\nFor Cloud Storage the next columns are:\n\n- file_path\n- start_offset\n\nFor Cloud Datastore the next columns are:\n\n- project_id\n- namespace_id\n- path\n- column_name\n- offset\n\nFor BigQuery the next columns are:\n\n- row_number\n- project_id\n- dataset_id\n- table_id"
},
"table": {
"$ref": "GooglePrivacyDlpV2beta1BigQueryTable",
"description": "Store findings in a new table in the dataset."
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1PartitionId": {
"description": "Datastore partition ID.\nA partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.\n\nA partition ID contains several dimensions:\nproject ID and namespace ID.",
"id": "GooglePrivacyDlpV2beta1PartitionId",
"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"
},
"GooglePrivacyDlpV2beta1PrivacyMetric": {
"description": "Privacy metric to compute for reidentification risk analysis.",
"id": "GooglePrivacyDlpV2beta1PrivacyMetric",
"properties": {
"categoricalStatsConfig": {
"$ref": "GooglePrivacyDlpV2beta1CategoricalStatsConfig"
},
"kAnonymityConfig": {
"$ref": "GooglePrivacyDlpV2beta1KAnonymityConfig"
},
"kMapEstimationConfig": {
"$ref": "GooglePrivacyDlpV2beta1KMapEstimationConfig"
},
"lDiversityConfig": {
"$ref": "GooglePrivacyDlpV2beta1LDiversityConfig"
},
"numericalStatsConfig": {
"$ref": "GooglePrivacyDlpV2beta1NumericalStatsConfig"
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1Projection": {
"description": "A representation of a Datastore property in a projection.",
"id": "GooglePrivacyDlpV2beta1Projection",
"properties": {
"property": {
"$ref": "GooglePrivacyDlpV2beta1PropertyReference",
"description": "The property to project."
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1PropertyReference": {
"description": "A reference to a property relative to the Datastore kind expressions.",
"id": "GooglePrivacyDlpV2beta1PropertyReference",
"properties": {
"name": {
"description": "The name of the property.\nIf name includes \".\"s, it may be interpreted as a property name path.",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1QuasiIdField": {
"description": "A quasi-identifier column has a custom_tag, used to know which column\nin the data corresponds to which column in the statistical model.",
"id": "GooglePrivacyDlpV2beta1QuasiIdField",
"properties": {
"customTag": {
"type": "string"
},
"field": {
"$ref": "GooglePrivacyDlpV2beta1FieldId"
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1RiskAnalysisOperationMetadata": {
"description": "Metadata returned within the\n[`riskAnalysis.operations.get`](/dlp/docs/reference/rest/v2beta1/riskAnalysis.operations/get)\nfor risk analysis.",
"id": "GooglePrivacyDlpV2beta1RiskAnalysisOperationMetadata",
"properties": {
"createTime": {
"description": "The time which this request was started.",
"format": "google-datetime",
"type": "string"
},
"requestedPrivacyMetric": {
"$ref": "GooglePrivacyDlpV2beta1PrivacyMetric",
"description": "Privacy metric to compute."
},
"requestedSourceTable": {
"$ref": "GooglePrivacyDlpV2beta1BigQueryTable",
"description": "Input dataset to compute metrics over."
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1RiskAnalysisOperationResult": {
"description": "Result of a risk analysis\n[`Operation`](/dlp/docs/reference/rest/v2beta1/inspect.operations)\nrequest.",
"id": "GooglePrivacyDlpV2beta1RiskAnalysisOperationResult",
"properties": {
"categoricalStatsResult": {
"$ref": "GooglePrivacyDlpV2beta1CategoricalStatsResult"
},
"kAnonymityResult": {
"$ref": "GooglePrivacyDlpV2beta1KAnonymityResult"
},
"kMapEstimationResult": {
"$ref": "GooglePrivacyDlpV2beta1KMapEstimationResult"
},
"lDiversityResult": {
"$ref": "GooglePrivacyDlpV2beta1LDiversityResult"
},
"numericalStatsResult": {
"$ref": "GooglePrivacyDlpV2beta1NumericalStatsResult"
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1StorageConfig": {
"description": "Shared message indicating Cloud storage type.",
"id": "GooglePrivacyDlpV2beta1StorageConfig",
"properties": {
"bigQueryOptions": {
"$ref": "GooglePrivacyDlpV2beta1BigQueryOptions",
"description": "BigQuery options specification."
},
"cloudStorageOptions": {
"$ref": "GooglePrivacyDlpV2beta1CloudStorageOptions",
"description": "Google Cloud Storage options specification."
},
"datastoreOptions": {
"$ref": "GooglePrivacyDlpV2beta1DatastoreOptions",
"description": "Google Cloud Datastore options specification."
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1SurrogateType": {
"description": "Message for detecting output from deidentification transformations\nsuch as\n[`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2beta1/content/deidentify#CryptoReplaceFfxFpeConfig).\nThese types of transformations are\nthose that perform pseudonymization, thereby producing a \"surrogate\" as\noutput. This should be used in conjunction with a field on the\ntransformation such as `surrogate_info_type`. This custom info type does\nnot support the use of `detection_rules`.",
"id": "GooglePrivacyDlpV2beta1SurrogateType",
"properties": {},
"type": "object"
},
"GooglePrivacyDlpV2beta1TaggedField": {
"description": "A column with a semantic tag attached.",
"id": "GooglePrivacyDlpV2beta1TaggedField",
"properties": {
"customTag": {
"description": "A column can be tagged with a custom tag. In this case, the user must\nindicate an auxiliary table that contains statistical information on\nthe possible values of this column (below).",
"type": "string"
},
"field": {
"$ref": "GooglePrivacyDlpV2beta1FieldId",
"description": "Identifies the column. [required]"
},
"inferred": {
"$ref": "GoogleProtobufEmpty",
"description": "If no semantic tag is indicated, we infer the statistical model from\nthe distribution of values in the input data"
},
"infoType": {
"$ref": "GooglePrivacyDlpV2beta1InfoType",
"description": "A column can be tagged with a InfoType to use the relevant public\ndataset as a statistical model of population, if available. We\ncurrently support US ZIP codes, region codes, ages and genders."
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1Value": {
"description": "Set of primitive values supported by the system.\nNote that for the purposes of inspection or transformation, the number\nof bytes considered to comprise a 'Value' is based on its representation\nas a UTF-8 encoded string. For example, if 'integer_value' is set to\n123456789, the number of bytes would be counted as 9, even though an\nint64 only holds up to 8 bytes of data.",
"id": "GooglePrivacyDlpV2beta1Value",
"properties": {
"booleanValue": {
"type": "boolean"
},
"dateValue": {
"$ref": "GoogleTypeDate"
},
"floatValue": {
"format": "double",
"type": "number"
},
"integerValue": {
"format": "int64",
"type": "string"
},
"stringValue": {
"type": "string"
},
"timeValue": {
"$ref": "GoogleTypeTimeOfDay"
},
"timestampValue": {
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1ValueFrequency": {
"description": "A value of a field, including its frequency.",
"id": "GooglePrivacyDlpV2beta1ValueFrequency",
"properties": {
"count": {
"description": "How many times the value is contained in the field.",
"format": "int64",
"type": "string"
},
"value": {
"$ref": "GooglePrivacyDlpV2beta1Value",
"description": "A value contained in the field in question."
}
},
"type": "object"
},
"GooglePrivacyDlpV2beta1WordList": {
"description": "Message defining a list of words or phrases to search for in the data.",
"id": "GooglePrivacyDlpV2beta1WordList",
"properties": {
"words": {
"description": "Words or phrases defining the dictionary. The dictionary must contain\nat least one phrase and every phrase must contain at least 2 characters\nthat 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\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"id": "GoogleProtobufEmpty",
"properties": {},
"type": "object"
},
"GoogleRpcStatus": {
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"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\nmessage 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\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
"type": "object"
},
"GoogleTypeDate": {
"description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
"id": "GoogleTypeDate",
"properties": {
"day": {
"description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
"format": "int32",
"type": "integer"
},
"month": {
"description": "Month of year. Must be from 1 to 12.",
"format": "int32",
"type": "integer"
},
"year": {
"description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleTypeTimeOfDay": {
"description": "Represents a time of day. The date and time zone are either not significant\nor are specified elsewhere. An API may choose to allow leap seconds. Related\ntypes are google.type.Date and `google.protobuf.Timestamp`.",
"id": "GoogleTypeTimeOfDay",
"properties": {
"hours": {
"description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios like business closing time.",
"format": "int32",
"type": "integer"
},
"minutes": {
"description": "Minutes of hour of day. Must be from 0 to 59.",
"format": "int32",
"type": "integer"
},
"nanos": {
"description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",
"format": "int32",
"type": "integer"
},
"seconds": {
"description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Cloud Data Loss Prevention (DLP) API",
"version": "v2",
"version_module": true
}
Reference in New Issue View Git Blame Copy Permalink