Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 42818cfca63bf2d3d257ff8859939dcf6839456e / . / docs / dyn / dlp_v2beta1.inspect.results.findings.html
blob: fa160ec54641c58b892b15b3363926c9a5bd4f9a [file] [log] [blame]
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="dlp_v2beta1.html">DLP API</a> . <a href="dlp_v2beta1.inspect.html">inspect</a> . <a href="dlp_v2beta1.inspect.results.html">results</a> . <a href="dlp_v2beta1.inspect.results.findings.html">findings</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]78 <code><a href="#list">list(name, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]79<p class="firstline">Returns list of results for given inspect operation result set id.</p>
80<p class="toc_element">
81 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<h3>Method Details</h3>
84<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]85 <code class="details" id="list">list(name, pageToken=None, x__xgafv=None, pageSize=None)</code>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]86 <pre>Returns list of results for given inspect operation result set id.
87
88Args:
89 name: string, Identifier of the results set returned as metadata of
90the longrunning operation created by a call to CreateInspectOperation.
91Should be in the format of `inspect/results/{id}. (required)
92 pageToken: string, The value returned by the last `ListInspectFindingsResponse`; indicates
93that this is a continuation of a prior `ListInspectFindings` call, and that
94the system should return the next page of data.
95 x__xgafv: string, V1 error format.
96 Allowed values
97 1 - v1 error format
98 2 - v2 error format
99 pageSize: integer, Maximum number of results to return.
100If 0, the implementation will select a reasonable value.
101
102Returns:
103 An object of the form:
104
105 { # Response to the ListInspectFindings request.
106 "nextPageToken": "A String", # If not empty, indicates that there may be more results that match the
107 # request; this value should be passed in a new `ListInspectFindingsRequest`.
108 "result": { # All the findings for a single scanned item. # The results.
109 "findingsTruncated": True or False, # If true, then this item might have more findings than were returned,
110 # and the findings returned are an arbitrary subset of all findings.
111 # The findings list might be truncated because the input items were too
112 # large, or because the server reached the maximum amount of resources
113 # allowed for a single API call. For best results, divide the input into
114 # smaller batches.
115 "findings": [ # List of findings for an item.
116 { # Container structure describing a single finding within a string or image.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]117 "infoType": { # Type of information detected by the API. # The specific type of info the string might be.
118 "name": "A String", # Name of the information type, provided by the API call ListInfoTypes.
119 },
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]120 "location": { # Specifies the location of a finding within its source item. # Location of the info found.
121 "fieldId": { # General identifier of a data field in a storage service. # Field id of the field containing the finding.
122 "columnName": "A String", # Column name describing the field.
123 },
124 "imageBoxes": [ # Location within an image's pixels.
125 { # Bounding box encompassing detected text within an image.
126 "width": 42, # Width of the bounding box in pixels.
127 "top": 42, # Top coordinate of the bounding box. (0,0) is upper left.
128 "left": 42, # Left coordinate of the bounding box. (0,0) is upper left.
129 "height": 42, # Height of the bounding box in pixels.
130 },
131 ],
132 "codepointRange": { # Generic half-open interval [start, end) # Character offsets within a content item, included when content type
133 # is a text. Default charset assumed to be UTF-8.
134 "start": "A String", # Index of the first character of the range (inclusive).
135 "end": "A String", # Index of the last character of the range (exclusive).
136 },
137 "recordKey": { # Message for a unique key indicating a record that contains a finding. # Key of the finding.
138 "cloudStorageKey": { # Record key for a finding in a Cloud Storage file.
139 "startOffset": "A String", # Byte offset of the referenced data in the file.
140 "filePath": "A String", # Path to the file.
141 },
142 "datastoreKey": { # Record key for a finding in Cloud Datastore.
143 "entityKey": { # A unique identifier for a Datastore entity. # Datastore entity key.
144 # If a key's partition ID or any of its path kinds or names are
145 # reserved/read-only, the key is reserved/read-only.
146 # A reserved/read-only key is forbidden in certain documented contexts.
147 "path": [ # The entity path.
148 # An entity path consists of one or more elements composed of a kind and a
149 # string or numerical identifier, which identify entities. The first
150 # element identifies a _root entity_, the second element identifies
151 # a _child_ of the root entity, the third element identifies a child of the
152 # second entity, and so forth. The entities identified by all prefixes of
153 # the path are called the element's _ancestors_.
154 #
155 # A path can never be empty, and a path can have at most 100 elements.
156 { # A (kind, ID/name) pair used to construct a key path.
157 #
158 # If either name or ID is set, the element is complete.
159 # If neither is set, the element is incomplete.
160 "kind": "A String", # The kind of the entity.
161 # A kind matching regex `__.*__` is reserved/read-only.
162 # A kind must not contain more than 1500 bytes when UTF-8 encoded.
163 # Cannot be `""`.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]164 "name": "A String", # The name of the entity.
165 # A name matching regex `__.*__` is reserved/read-only.
166 # A name must not be more than 1500 bytes when UTF-8 encoded.
167 # Cannot be `""`.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]168 "id": "A String", # The auto-allocated ID of the entity.
169 # Never equal to zero. Values less than zero are discouraged and may not
170 # be supported in the future.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]171 },
172 ],
173 "partitionId": { # Datastore partition ID. # Entities are partitioned into subsets, currently identified by a project
174 # ID and namespace ID.
175 # Queries are scoped to a single partition.
176 # A partition ID identifies a grouping of entities. The grouping is always
177 # by project and namespace, however the namespace ID may be empty.
178 #
179 # A partition ID contains several dimensions:
180 # project ID and namespace ID.
181 "projectId": "A String", # The ID of the project to which the entities belong.
182 "databaseId": "A String", # If not empty, the ID of the database to which the entities
183 # belong.
184 "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
185 },
186 },
187 },
188 },
189 "byteRange": { # Generic half-open interval [start, end) # Zero-based byte offsets within a content item.
190 "start": "A String", # Index of the first character of the range (inclusive).
191 "end": "A String", # Index of the last character of the range (exclusive).
192 },
193 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]194 "likelihood": "A String", # Estimate of how likely it is that the info_type is correct.
195 "createTime": "A String", # Timestamp when finding was detected.
196 "quote": "A String", # The specific string that may be potentially sensitive info.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]197 },
198 ],
199 },
200 }</pre>
201</div>
202
203<div class="method">
204 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
205 <pre>Retrieves the next page of results.
206
207Args:
208 previous_request: The request for the previous page. (required)
209 previous_response: The response from the request for the previous page. (required)
210
211Returns:
212 A request object that you can call 'execute()' on to request the next
213 page. Returns None if there are no more items in the collection.
214 </pre>
215</div>
216
217</body></html>