Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 2f245374da9c895dbd8bb0423e98707d51b53414 / . / docs / dyn / dlp_v2beta1.inspect.operations.html
blob: 3921a915e9ac1cc2e9ef94df387c8b278756ebc5 [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.operations.html">operations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#cancel">cancel(name, body, x__xgafv=None)</a></code></p>
79<p class="firstline">Cancels an operation. Use the get method to check whether the cancellation succeeded or whether the operation completed despite cancellation.</p>
80<p class="toc_element">
81 <code><a href="#create">create(body, x__xgafv=None)</a></code></p>
82<p class="firstline">Schedule a job scanning content in a Google Cloud Platform data repository.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
85<p class="firstline">This method is not supported and the server returns `UNIMPLEMENTED`.</p>
86<p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88<p class="firstline">Gets the latest state of a long-running operation. Clients can use this</p>
89<p class="toc_element">
90 <code><a href="#list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
91<p class="firstline">Lists operations that match the specified filter in the request. If the</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="cancel">cancel(name, body, x__xgafv=None)</code>
98 <pre>Cancels an operation. Use the get method to check whether the cancellation succeeded or whether the operation completed despite cancellation.
99
100Args:
101 name: string, The name of the operation resource to be cancelled. (required)
102 body: object, The request body. (required)
103 The object takes the form of:
104
105{ # The request message for Operations.CancelOperation.
106 }
107
108 x__xgafv: string, V1 error format.
109 Allowed values
110 1 - v1 error format
111 2 - v2 error format
112
113Returns:
114 An object of the form:
115
116 { # A generic empty message that you can re-use to avoid defining duplicated
117 # empty messages in your APIs. A typical example is to use it as the request
118 # or the response type of an API method. For instance:
119 #
120 # service Foo {
121 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
122 # }
123 #
124 # The JSON representation for `Empty` is empty JSON object `{}`.
125 }</pre>
126</div>
127
128<div class="method">
129 <code class="details" id="create">create(body, x__xgafv=None)</code>
130 <pre>Schedule a job scanning content in a Google Cloud Platform data repository.
131
132Args:
133 body: object, The request body. (required)
134 The object takes the form of:
135
136{ # Request for scheduling a scan of a data subset from a Google Platform data
137 # repository.
138 "inspectConfig": { # Configuration description of the scanning process. # Configuration for the inspector.
139 # When used with redactContent only info_types and min_likelihood are currently
140 # used.
141 "minLikelihood": "A String", # Only return findings equal or above this threshold.
142 "includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding will
143 # be included in the response; see Finding.quote.
144 "excludeTypes": True or False, # When true, exclude type information of the findings.
145 "infoTypes": [ # Restrict what info_types to look for. The values must correspond to
146 # InfoType values returned by ListInfoTypes or found in documentation.
147 # Empty info_types runs all enabled detectors.
148 { # Type of information detected by the API.
149 "name": "A String", # Name of the information type, provided by the API call ListInfoTypes.
150 },
151 ],
152 "maxFindings": 42, # Limit the number of findings per content item.
153 },
154 "storageConfig": { # Shared message indicating Cloud storage type. # Specification of the data set to process.
155 "datastoreOptions": { # Options defining a data set within Google Cloud Datastore. # Google Cloud Datastore options specification.
156 "kind": { # A representation of a Datastore kind. # The kind to process.
157 "name": "A String", # The name of the kind.
158 },
159 "projection": [ # Properties to scan. If none are specified, all properties will be scanned
160 # by default.
161 { # A representation of a Datastore property in a projection.
162 "property": { # A reference to a property relative to the Datastore kind expressions. # The property to project.
163 "name": "A String", # The name of the property.
164 # If name includes "."s, it may be interpreted as a property name path.
165 },
166 },
167 ],
168 "partitionId": { # Datastore partition ID. # A partition ID identifies a grouping of entities. The grouping is always
169 # by project and namespace, however the namespace ID may be empty.
170 # A partition ID identifies a grouping of entities. The grouping is always
171 # by project and namespace, however the namespace ID may be empty.
172 #
173 # A partition ID contains several dimensions:
174 # project ID and namespace ID.
175 "projectId": "A String", # The ID of the project to which the entities belong.
176 "databaseId": "A String", # If not empty, the ID of the database to which the entities
177 # belong.
178 "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
179 },
180 },
181 "cloudStorageOptions": { # Options defining a file or a set of files (path ending with *) within # Google Cloud Storage options specification.
182 # a Google Cloud Storage bucket.
183 "fileSet": { # Set of files to scan.
184 "url": "A String", # The url, in the format gs://<bucket>/<path>. Trailing wildcard in the
185 # path is allowed.
186 },
187 },
188 },
189 }
190
191 x__xgafv: string, V1 error format.
192 Allowed values
193 1 - v1 error format
194 2 - v2 error format
195
196Returns:
197 An object of the form:
198
199 { # This resource represents a long-running operation that is the result of a
200 # network API call.
201 "metadata": { # This field will contain an `InspectOperationMetdata` object.
202 "a_key": "", # Properties of the object. Contains field @type with type URL.
203 },
204 "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
205 # programming environments, including REST APIs and RPC APIs. It is used by
206 # [gRPC](https://github.com/grpc). The error model is designed to be:
207 #
208 # - Simple to use and understand for most users
209 # - Flexible enough to meet unexpected needs
210 #
211 # # Overview
212 #
213 # The `Status` message contains three pieces of data: error code, error message,
214 # and error details. The error code should be an enum value of
215 # google.rpc.Code, but it may accept additional error codes if needed. The
216 # error message should be a developer-facing English message that helps
217 # developers *understand* and *resolve* the error. If a localized user-facing
218 # error message is needed, put the localized message in the error details or
219 # localize it in the client. The optional error details may contain arbitrary
220 # information about the error. There is a predefined set of error detail types
221 # in the package `google.rpc` which can be used for common error conditions.
222 #
223 # # Language mapping
224 #
225 # The `Status` message is the logical representation of the error model, but it
226 # is not necessarily the actual wire format. When the `Status` message is
227 # exposed in different client libraries and different wire protocols, it can be
228 # mapped differently. For example, it will likely be mapped to some exceptions
229 # in Java, but more likely mapped to some error codes in C.
230 #
231 # # Other uses
232 #
233 # The error model and the `Status` message can be used in a variety of
234 # environments, either with or without APIs, to provide a
235 # consistent developer experience across different environments.
236 #
237 # Example uses of this error model include:
238 #
239 # - Partial errors. If a service needs to return partial errors to the client,
240 # it may embed the `Status` in the normal response to indicate the partial
241 # errors.
242 #
243 # - Workflow errors. A typical workflow has multiple steps. Each step may
244 # have a `Status` message for error reporting purpose.
245 #
246 # - Batch operations. If a client uses batch request and batch response, the
247 # `Status` message should be used directly inside batch response, one for
248 # each error sub-response.
249 #
250 # - Asynchronous operations. If an API call embeds asynchronous operation
251 # results in its response, the status of those operations should be
252 # represented directly using the `Status` message.
253 #
254 # - Logging. If some API errors are stored in logs, the message `Status` could
255 # be used directly after any stripping needed for security/privacy reasons.
256 "message": "A String", # A developer-facing error message, which should be in English. Any
257 # user-facing error message should be localized and sent in the
258 # google.rpc.Status.details field, or localized by the client.
259 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
260 "details": [ # A list of messages that carry the error details. There will be a
261 # common set of message types for APIs to use.
262 {
263 "a_key": "", # Properties of the object. Contains field @type with type URL.
264 },
265 ],
266 },
267 "done": True or False, # If the value is `false`, it means the operation is still in progress.
268 # If true, the operation is completed, and either `error` or `response` is
269 # available.
270 "response": { # This field will contain an `InspectOperationResult` object.
271 "a_key": "", # Properties of the object. Contains field @type with type URL.
272 },
273 "name": "A String", # The server-assigned name, The `name` should have the format of `inspect/operations/<identifier>`.
274 }</pre>
275</div>
276
277<div class="method">
278 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
279 <pre>This method is not supported and the server returns `UNIMPLEMENTED`.
280
281Args:
282 name: string, The name of the operation resource to be deleted. (required)
283 x__xgafv: string, V1 error format.
284 Allowed values
285 1 - v1 error format
286 2 - v2 error format
287
288Returns:
289 An object of the form:
290
291 { # A generic empty message that you can re-use to avoid defining duplicated
292 # empty messages in your APIs. A typical example is to use it as the request
293 # or the response type of an API method. For instance:
294 #
295 # service Foo {
296 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
297 # }
298 #
299 # The JSON representation for `Empty` is empty JSON object `{}`.
300 }</pre>
301</div>
302
303<div class="method">
304 <code class="details" id="get">get(name, x__xgafv=None)</code>
305 <pre>Gets the latest state of a long-running operation. Clients can use this
306method to poll the operation result at intervals as recommended by the API
307service.
308
309Args:
310 name: string, The name of the operation resource. (required)
311 x__xgafv: string, V1 error format.
312 Allowed values
313 1 - v1 error format
314 2 - v2 error format
315
316Returns:
317 An object of the form:
318
319 { # This resource represents a long-running operation that is the result of a
320 # network API call.
321 "metadata": { # This field will contain an `InspectOperationMetdata` object.
322 "a_key": "", # Properties of the object. Contains field @type with type URL.
323 },
324 "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
325 # programming environments, including REST APIs and RPC APIs. It is used by
326 # [gRPC](https://github.com/grpc). The error model is designed to be:
327 #
328 # - Simple to use and understand for most users
329 # - Flexible enough to meet unexpected needs
330 #
331 # # Overview
332 #
333 # The `Status` message contains three pieces of data: error code, error message,
334 # and error details. The error code should be an enum value of
335 # google.rpc.Code, but it may accept additional error codes if needed. The
336 # error message should be a developer-facing English message that helps
337 # developers *understand* and *resolve* the error. If a localized user-facing
338 # error message is needed, put the localized message in the error details or
339 # localize it in the client. The optional error details may contain arbitrary
340 # information about the error. There is a predefined set of error detail types
341 # in the package `google.rpc` which can be used for common error conditions.
342 #
343 # # Language mapping
344 #
345 # The `Status` message is the logical representation of the error model, but it
346 # is not necessarily the actual wire format. When the `Status` message is
347 # exposed in different client libraries and different wire protocols, it can be
348 # mapped differently. For example, it will likely be mapped to some exceptions
349 # in Java, but more likely mapped to some error codes in C.
350 #
351 # # Other uses
352 #
353 # The error model and the `Status` message can be used in a variety of
354 # environments, either with or without APIs, to provide a
355 # consistent developer experience across different environments.
356 #
357 # Example uses of this error model include:
358 #
359 # - Partial errors. If a service needs to return partial errors to the client,
360 # it may embed the `Status` in the normal response to indicate the partial
361 # errors.
362 #
363 # - Workflow errors. A typical workflow has multiple steps. Each step may
364 # have a `Status` message for error reporting purpose.
365 #
366 # - Batch operations. If a client uses batch request and batch response, the
367 # `Status` message should be used directly inside batch response, one for
368 # each error sub-response.
369 #
370 # - Asynchronous operations. If an API call embeds asynchronous operation
371 # results in its response, the status of those operations should be
372 # represented directly using the `Status` message.
373 #
374 # - Logging. If some API errors are stored in logs, the message `Status` could
375 # be used directly after any stripping needed for security/privacy reasons.
376 "message": "A String", # A developer-facing error message, which should be in English. Any
377 # user-facing error message should be localized and sent in the
378 # google.rpc.Status.details field, or localized by the client.
379 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
380 "details": [ # A list of messages that carry the error details. There will be a
381 # common set of message types for APIs to use.
382 {
383 "a_key": "", # Properties of the object. Contains field @type with type URL.
384 },
385 ],
386 },
387 "done": True or False, # If the value is `false`, it means the operation is still in progress.
388 # If true, the operation is completed, and either `error` or `response` is
389 # available.
390 "response": { # This field will contain an `InspectOperationResult` object.
391 "a_key": "", # Properties of the object. Contains field @type with type URL.
392 },
393 "name": "A String", # The server-assigned name, The `name` should have the format of `inspect/operations/<identifier>`.
394 }</pre>
395</div>
396
397<div class="method">
398 <code class="details" id="list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
399 <pre>Lists operations that match the specified filter in the request. If the
400server doesn't support this method, it returns `UNIMPLEMENTED`.
401
402NOTE: the `name` binding below allows API services to override the binding
403to use different resource name schemes, such as `users/*/operations`.
404
405Args:
406 name: string, The name of the operation collection. (required)
407 pageSize: integer, The list page size. The max allowed value is 256 and default is 100.
408 filter: string, This parameter supports filtering by done, ie done=true or done=false.
409 pageToken: string, The list page token.
410 x__xgafv: string, V1 error format.
411 Allowed values
412 1 - v1 error format
413 2 - v2 error format
414
415Returns:
416 An object of the form:
417
418 { # The response message for Operations.ListOperations.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]419 "nextPageToken": "A String", # The standard List next-page token.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]420 "operations": [ # A list of operations that matches the specified filter in the request.
421 { # This resource represents a long-running operation that is the result of a
422 # network API call.
423 "metadata": { # This field will contain an `InspectOperationMetdata` object.
424 "a_key": "", # Properties of the object. Contains field @type with type URL.
425 },
426 "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
427 # programming environments, including REST APIs and RPC APIs. It is used by
428 # [gRPC](https://github.com/grpc). The error model is designed to be:
429 #
430 # - Simple to use and understand for most users
431 # - Flexible enough to meet unexpected needs
432 #
433 # # Overview
434 #
435 # The `Status` message contains three pieces of data: error code, error message,
436 # and error details. The error code should be an enum value of
437 # google.rpc.Code, but it may accept additional error codes if needed. The
438 # error message should be a developer-facing English message that helps
439 # developers *understand* and *resolve* the error. If a localized user-facing
440 # error message is needed, put the localized message in the error details or
441 # localize it in the client. The optional error details may contain arbitrary
442 # information about the error. There is a predefined set of error detail types
443 # in the package `google.rpc` which can be used for common error conditions.
444 #
445 # # Language mapping
446 #
447 # The `Status` message is the logical representation of the error model, but it
448 # is not necessarily the actual wire format. When the `Status` message is
449 # exposed in different client libraries and different wire protocols, it can be
450 # mapped differently. For example, it will likely be mapped to some exceptions
451 # in Java, but more likely mapped to some error codes in C.
452 #
453 # # Other uses
454 #
455 # The error model and the `Status` message can be used in a variety of
456 # environments, either with or without APIs, to provide a
457 # consistent developer experience across different environments.
458 #
459 # Example uses of this error model include:
460 #
461 # - Partial errors. If a service needs to return partial errors to the client,
462 # it may embed the `Status` in the normal response to indicate the partial
463 # errors.
464 #
465 # - Workflow errors. A typical workflow has multiple steps. Each step may
466 # have a `Status` message for error reporting purpose.
467 #
468 # - Batch operations. If a client uses batch request and batch response, the
469 # `Status` message should be used directly inside batch response, one for
470 # each error sub-response.
471 #
472 # - Asynchronous operations. If an API call embeds asynchronous operation
473 # results in its response, the status of those operations should be
474 # represented directly using the `Status` message.
475 #
476 # - Logging. If some API errors are stored in logs, the message `Status` could
477 # be used directly after any stripping needed for security/privacy reasons.
478 "message": "A String", # A developer-facing error message, which should be in English. Any
479 # user-facing error message should be localized and sent in the
480 # google.rpc.Status.details field, or localized by the client.
481 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
482 "details": [ # A list of messages that carry the error details. There will be a
483 # common set of message types for APIs to use.
484 {
485 "a_key": "", # Properties of the object. Contains field @type with type URL.
486 },
487 ],
488 },
489 "done": True or False, # If the value is `false`, it means the operation is still in progress.
490 # If true, the operation is completed, and either `error` or `response` is
491 # available.
492 "response": { # This field will contain an `InspectOperationResult` object.
493 "a_key": "", # Properties of the object. Contains field @type with type URL.
494 },
495 "name": "A String", # The server-assigned name, The `name` should have the format of `inspect/operations/<identifier>`.
496 },
497 ],
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]498 }</pre>
499</div>
500
501<div class="method">
502 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
503 <pre>Retrieves the next page of results.
504
505Args:
506 previous_request: The request for the previous page. (required)
507 previous_response: The response from the request for the previous page. (required)
508
509Returns:
510 A request object that you can call 'execute()' on to request the next
511 page. Returns None if there are no more items in the collection.
512 </pre>
513</div>
514
515</body></html>