forked from GoogleCloudPlatform/python-docs-samples
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtemplates.py
More file actions
229 lines (188 loc) · 8.36 KB
/
templates.py
File metadata and controls
229 lines (188 loc) · 8.36 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# Copyright 2017 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Sample app that sets up Data Loss Prevention API inspect templates."""
from __future__ import print_function
import argparse
import os
import time
# [START dlp_create_template]
def create_inspect_template(project, info_types,
template_id=None, display_name=None,
min_likelihood=None, max_findings=None,
include_quote=None):
"""Creates a Data Loss Prevention API inspect template.
Args:
project: The Google Cloud project id to use as a parent resource.
info_types: A list of strings representing info types to look for.
A full list of info type categories can be fetched from the API.
template_id: The id of the template. If omitted, an id will be randomly
generated.
display_name: The optional display name of the template.
min_likelihood: A string representing the minimum likelihood threshold
that constitutes a match. One of: 'LIKELIHOOD_UNSPECIFIED',
'VERY_UNLIKELY', 'UNLIKELY', 'POSSIBLE', 'LIKELY', 'VERY_LIKELY'.
max_findings: The maximum number of findings to report; 0 = no maximum.
include_quote: Boolean for whether to display a quote of the detected
information in the results.
Returns:
None; the response from the API is printed to the terminal.
"""
# Import the client library
import google.cloud.dlp
# Instantiate a client.
dlp = google.cloud.dlp.DlpServiceClient()
# Prepare info_types by converting the list of strings into a list of
# dictionaries (protos are also accepted).
info_types = [{'name': info_type} for info_type in info_types]
# Construct the configuration dictionary. Keys which are None may
# optionally be omitted entirely.
inspect_config = {
'info_types': info_types,
'min_likelihood': min_likelihood,
'include_quote': include_quote,
'limits': {'max_findings_per_request': max_findings},
}
inspect_template = {
'inspect_config': inspect_config,
'display_name': display_name,
}
# Convert the project id into a full resource id.
parent = dlp.project_path(project)
# Call the API.
response = dlp.create_inspect_template(
parent, inspect_template=inspect_template, template_id=template_id)
print('Successfully created template {}'.format(response.name))
# [END dlp_create_template]
# [START dlp_list_templates]
def list_inspect_templates(project):
"""Lists all Data Loss Prevention API inspect templates.
Args:
project: The Google Cloud project id to use as a parent resource.
Returns:
None; the response from the API is printed to the terminal.
"""
# Import the client library
import google.cloud.dlp
# Instantiate a client.
dlp = google.cloud.dlp.DlpServiceClient()
# Convert the project id into a full resource id.
parent = dlp.project_path(project)
# Call the API.
response = dlp.list_inspect_templates(parent)
# Define a helper function to convert the API's "seconds since the epoch"
# time format into a human-readable string.
def human_readable_time(timestamp):
return str(time.localtime(timestamp.seconds))
for template in response:
print('Template {}:'.format(template.name))
if template.display_name:
print(' Display Name: {}'.format(template.display_name))
print(' Created: {}'.format(
human_readable_time(template.create_time)))
print(' Updated: {}'.format(
human_readable_time(template.update_time)))
config = template.inspect_config
print(' InfoTypes: {}'.format(', '.join(
[it.name for it in config.info_types]
)))
print(' Minimum likelihood: {}'.format(config.min_likelihood))
print(' Include quotes: {}'.format(config.include_quote))
print(' Max findings per request: {}'.format(
config.limits.max_findings_per_request))
# [END dlp_list_templates]
# [START dlp_delete_template]
def delete_inspect_template(project, template_id):
"""Deletes a Data Loss Prevention API template.
Args:
project: The id of the Google Cloud project which owns the template.
template_id: The id of the template to delete.
Returns:
None; the response from the API is printed to the terminal.
"""
# Import the client library
import google.cloud.dlp
# Instantiate a client.
dlp = google.cloud.dlp.DlpServiceClient()
# Convert the project id into a full resource id.
parent = dlp.project_path(project)
# Combine the template id with the parent id.
template_resource = '{}/inspectTemplates/{}'.format(parent, template_id)
# Call the API.
dlp.delete_inspect_template(template_resource)
print('Template {} successfully deleted.'.format(template_resource))
# [END dlp_delete_template]
if __name__ == '__main__':
default_project = os.environ.get('GCLOUD_PROJECT')
parser = argparse.ArgumentParser(description=__doc__)
subparsers = parser.add_subparsers(
dest='action', help='Select which action to perform.')
subparsers.required = True
parser_create = subparsers.add_parser('create', help='Create a template.')
parser_create.add_argument(
'--template_id',
help='The id of the template. If omitted, an id will be randomly '
'generated')
parser_create.add_argument(
'--display_name',
help='The optional display name of the template.')
parser_create.add_argument(
'--project',
help='The Google Cloud project id to use as a parent resource.',
default=default_project)
parser_create.add_argument(
'--info_types', action='append',
help='Strings representing info types to look for. A full list of '
'info categories and types is available from the API. Examples '
'include "FIRST_NAME", "LAST_NAME", "EMAIL_ADDRESS". '
'If unspecified, the three above examples will be used.',
default=['FIRST_NAME', 'LAST_NAME', 'EMAIL_ADDRESS'])
parser_create.add_argument(
'--min_likelihood',
choices=['LIKELIHOOD_UNSPECIFIED', 'VERY_UNLIKELY', 'UNLIKELY',
'POSSIBLE', 'LIKELY', 'VERY_LIKELY'],
help='A string representing the minimum likelihood threshold that '
'constitutes a match.')
parser_create.add_argument(
'--max_findings', type=int,
help='The maximum number of findings to report; 0 = no maximum.')
parser_create.add_argument(
'--include_quote', type=bool,
help='A boolean for whether to display a quote of the detected '
'information in the results.',
default=True)
parser_list = subparsers.add_parser('list', help='List all templates.')
parser_list.add_argument(
'--project',
help='The Google Cloud project id to use as a parent resource.',
default=default_project)
parser_delete = subparsers.add_parser('delete', help='Delete a template.')
parser_delete.add_argument(
'template_id',
help='The id of the template to delete.')
parser_delete.add_argument(
'--project',
help='The Google Cloud project id to use as a parent resource.',
default=default_project)
args = parser.parse_args()
if args.action == 'create':
create_inspect_template(
args.project, args.info_types,
template_id=args.template_id, display_name=args.display_name,
min_likelihood=args.min_likelihood,
max_findings=args.max_findings, include_quote=args.include_quote
)
elif args.action == 'list':
list_inspect_templates(args.project)
elif args.action == 'delete':
delete_inspect_template(args.project, args.template_id)