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