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.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 | |
| 100 | Args: |
| 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 | |
| 113 | Returns: |
| 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 | |
| 132 | Args: |
| 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. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 138 | "outputConfig": { # Cloud repository for storing output. # Optional location to store findings. The bucket must already exist and |
| 139 | # the Google APIs service account for DLP must have write permission to |
| 140 | # write to the given bucket. |
| 141 | # <p>Results are split over multiple csv files with each file name matching |
| 142 | # the pattern "[operation_id]_[count].csv", for example |
| 143 | # `3094877188788974909_1.csv`. The `operation_id` matches the |
| 144 | # identifier for the Operation, and the `count` is a counter used for |
| 145 | # tracking the number of files written. <p>The CSV file(s) contain the |
| 146 | # following columns regardless of storage type scanned: <li>id <li>info_type |
| 147 | # <li>likelihood <li>byte size of finding <li>quote <li>time_stamp<br/> |
| 148 | # <p>For Cloud Storage the next columns are: <li>file_path |
| 149 | # <li>start_offset<br/> |
| 150 | # <p>For Cloud Datastore the next columns are: <li>project_id |
| 151 | # <li>namespace_id <li>path <li>column_name <li>offset |
| 152 | "storagePath": { # A location in Cloud Storage. # The path to a Google Cloud Storage location to store output. |
| 153 | "path": "A String", # The url, in the format of `gs://bucket/<path>`. |
| 154 | }, |
| 155 | }, |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 156 | "inspectConfig": { # Configuration description of the scanning process. # Configuration for the inspector. |
| 157 | # When used with redactContent only info_types and min_likelihood are currently |
| 158 | # used. |
| 159 | "minLikelihood": "A String", # Only return findings equal or above this threshold. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 160 | "includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding is |
| 161 | # included in the response; see Finding.quote. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 162 | "excludeTypes": True or False, # When true, exclude type information of the findings. |
| 163 | "infoTypes": [ # Restrict what info_types to look for. The values must correspond to |
| 164 | # InfoType values returned by ListInfoTypes or found in documentation. |
| 165 | # Empty info_types runs all enabled detectors. |
| 166 | { # Type of information detected by the API. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 167 | "name": "A String", # Name of the information type. For built-in info types, this is provided by |
| 168 | # the API call ListInfoTypes. For user-defined info types, this is |
| 169 | # provided by the user. All user-defined info types must have unique names, |
| 170 | # and cannot conflict with built-in info type names. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 171 | }, |
| 172 | ], |
| 173 | "maxFindings": 42, # Limit the number of findings per content item. |
| 174 | }, |
| 175 | "storageConfig": { # Shared message indicating Cloud storage type. # Specification of the data set to process. |
| 176 | "datastoreOptions": { # Options defining a data set within Google Cloud Datastore. # Google Cloud Datastore options specification. |
| 177 | "kind": { # A representation of a Datastore kind. # The kind to process. |
| 178 | "name": "A String", # The name of the kind. |
| 179 | }, |
| 180 | "projection": [ # Properties to scan. If none are specified, all properties will be scanned |
| 181 | # by default. |
| 182 | { # A representation of a Datastore property in a projection. |
| 183 | "property": { # A reference to a property relative to the Datastore kind expressions. # The property to project. |
| 184 | "name": "A String", # The name of the property. |
| 185 | # If name includes "."s, it may be interpreted as a property name path. |
| 186 | }, |
| 187 | }, |
| 188 | ], |
| 189 | "partitionId": { # Datastore partition ID. # A partition ID identifies a grouping of entities. The grouping is always |
| 190 | # by project and namespace, however the namespace ID may be empty. |
| 191 | # A partition ID identifies a grouping of entities. The grouping is always |
| 192 | # by project and namespace, however the namespace ID may be empty. |
| 193 | # |
| 194 | # A partition ID contains several dimensions: |
| 195 | # project ID and namespace ID. |
| 196 | "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] | 197 | "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. |
| 198 | }, |
| 199 | }, |
| 200 | "cloudStorageOptions": { # Options defining a file or a set of files (path ending with *) within # Google Cloud Storage options specification. |
| 201 | # a Google Cloud Storage bucket. |
| 202 | "fileSet": { # Set of files to scan. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 203 | "url": "A String", # The url, in the format `gs://<bucket>/<path>`. Trailing wildcard in the |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 204 | # path is allowed. |
| 205 | }, |
| 206 | }, |
| 207 | }, |
| 208 | } |
| 209 | |
| 210 | x__xgafv: string, V1 error format. |
| 211 | Allowed values |
| 212 | 1 - v1 error format |
| 213 | 2 - v2 error format |
| 214 | |
| 215 | Returns: |
| 216 | An object of the form: |
| 217 | |
| 218 | { # This resource represents a long-running operation that is the result of a |
| 219 | # network API call. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 220 | "metadata": { # This field will contain an `InspectOperationMetadata` object. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 221 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 222 | }, |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 223 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 224 | # If true, the operation is completed, and either `error` or `response` is |
| 225 | # available. |
| 226 | "response": { # This field will contain an `InspectOperationResult` object. |
| 227 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 228 | }, |
| 229 | "name": "A String", # The server-assigned name, The `name` should have the format of `inspect/operations/<identifier>`. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 230 | "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. |
| 231 | # programming environments, including REST APIs and RPC APIs. It is used by |
| 232 | # [gRPC](https://github.com/grpc). The error model is designed to be: |
| 233 | # |
| 234 | # - Simple to use and understand for most users |
| 235 | # - Flexible enough to meet unexpected needs |
| 236 | # |
| 237 | # # Overview |
| 238 | # |
| 239 | # The `Status` message contains three pieces of data: error code, error message, |
| 240 | # and error details. The error code should be an enum value of |
| 241 | # google.rpc.Code, but it may accept additional error codes if needed. The |
| 242 | # error message should be a developer-facing English message that helps |
| 243 | # developers *understand* and *resolve* the error. If a localized user-facing |
| 244 | # error message is needed, put the localized message in the error details or |
| 245 | # localize it in the client. The optional error details may contain arbitrary |
| 246 | # information about the error. There is a predefined set of error detail types |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 247 | # in the package `google.rpc` that can be used for common error conditions. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 248 | # |
| 249 | # # Language mapping |
| 250 | # |
| 251 | # The `Status` message is the logical representation of the error model, but it |
| 252 | # is not necessarily the actual wire format. When the `Status` message is |
| 253 | # exposed in different client libraries and different wire protocols, it can be |
| 254 | # mapped differently. For example, it will likely be mapped to some exceptions |
| 255 | # in Java, but more likely mapped to some error codes in C. |
| 256 | # |
| 257 | # # Other uses |
| 258 | # |
| 259 | # The error model and the `Status` message can be used in a variety of |
| 260 | # environments, either with or without APIs, to provide a |
| 261 | # consistent developer experience across different environments. |
| 262 | # |
| 263 | # Example uses of this error model include: |
| 264 | # |
| 265 | # - Partial errors. If a service needs to return partial errors to the client, |
| 266 | # it may embed the `Status` in the normal response to indicate the partial |
| 267 | # errors. |
| 268 | # |
| 269 | # - Workflow errors. A typical workflow has multiple steps. Each step may |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 270 | # have a `Status` message for error reporting. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 271 | # |
| 272 | # - Batch operations. If a client uses batch request and batch response, the |
| 273 | # `Status` message should be used directly inside batch response, one for |
| 274 | # each error sub-response. |
| 275 | # |
| 276 | # - Asynchronous operations. If an API call embeds asynchronous operation |
| 277 | # results in its response, the status of those operations should be |
| 278 | # represented directly using the `Status` message. |
| 279 | # |
| 280 | # - Logging. If some API errors are stored in logs, the message `Status` could |
| 281 | # be used directly after any stripping needed for security/privacy reasons. |
| 282 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 283 | # user-facing error message should be localized and sent in the |
| 284 | # google.rpc.Status.details field, or localized by the client. |
| 285 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 286 | "details": [ # A list of messages that carry the error details. There will be a |
| 287 | # common set of message types for APIs to use. |
| 288 | { |
| 289 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 290 | }, |
| 291 | ], |
| 292 | }, |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 293 | }</pre> |
| 294 | </div> |
| 295 | |
| 296 | <div class="method"> |
| 297 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 298 | <pre>This method is not supported and the server returns `UNIMPLEMENTED`. |
| 299 | |
| 300 | Args: |
| 301 | name: string, The name of the operation resource to be deleted. (required) |
| 302 | x__xgafv: string, V1 error format. |
| 303 | Allowed values |
| 304 | 1 - v1 error format |
| 305 | 2 - v2 error format |
| 306 | |
| 307 | Returns: |
| 308 | An object of the form: |
| 309 | |
| 310 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 311 | # empty messages in your APIs. A typical example is to use it as the request |
| 312 | # or the response type of an API method. For instance: |
| 313 | # |
| 314 | # service Foo { |
| 315 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 316 | # } |
| 317 | # |
| 318 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 319 | }</pre> |
| 320 | </div> |
| 321 | |
| 322 | <div class="method"> |
| 323 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 324 | <pre>Gets the latest state of a long-running operation. Clients can use this |
| 325 | method to poll the operation result at intervals as recommended by the API |
| 326 | service. |
| 327 | |
| 328 | Args: |
| 329 | name: string, The name of the operation resource. (required) |
| 330 | x__xgafv: string, V1 error format. |
| 331 | Allowed values |
| 332 | 1 - v1 error format |
| 333 | 2 - v2 error format |
| 334 | |
| 335 | Returns: |
| 336 | An object of the form: |
| 337 | |
| 338 | { # This resource represents a long-running operation that is the result of a |
| 339 | # network API call. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 340 | "metadata": { # This field will contain an `InspectOperationMetadata` object. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 341 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 342 | }, |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 343 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 344 | # If true, the operation is completed, and either `error` or `response` is |
| 345 | # available. |
| 346 | "response": { # This field will contain an `InspectOperationResult` object. |
| 347 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 348 | }, |
| 349 | "name": "A String", # The server-assigned name, The `name` should have the format of `inspect/operations/<identifier>`. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 350 | "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. |
| 351 | # programming environments, including REST APIs and RPC APIs. It is used by |
| 352 | # [gRPC](https://github.com/grpc). The error model is designed to be: |
| 353 | # |
| 354 | # - Simple to use and understand for most users |
| 355 | # - Flexible enough to meet unexpected needs |
| 356 | # |
| 357 | # # Overview |
| 358 | # |
| 359 | # The `Status` message contains three pieces of data: error code, error message, |
| 360 | # and error details. The error code should be an enum value of |
| 361 | # google.rpc.Code, but it may accept additional error codes if needed. The |
| 362 | # error message should be a developer-facing English message that helps |
| 363 | # developers *understand* and *resolve* the error. If a localized user-facing |
| 364 | # error message is needed, put the localized message in the error details or |
| 365 | # localize it in the client. The optional error details may contain arbitrary |
| 366 | # information about the error. There is a predefined set of error detail types |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 367 | # in the package `google.rpc` that can be used for common error conditions. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 368 | # |
| 369 | # # Language mapping |
| 370 | # |
| 371 | # The `Status` message is the logical representation of the error model, but it |
| 372 | # is not necessarily the actual wire format. When the `Status` message is |
| 373 | # exposed in different client libraries and different wire protocols, it can be |
| 374 | # mapped differently. For example, it will likely be mapped to some exceptions |
| 375 | # in Java, but more likely mapped to some error codes in C. |
| 376 | # |
| 377 | # # Other uses |
| 378 | # |
| 379 | # The error model and the `Status` message can be used in a variety of |
| 380 | # environments, either with or without APIs, to provide a |
| 381 | # consistent developer experience across different environments. |
| 382 | # |
| 383 | # Example uses of this error model include: |
| 384 | # |
| 385 | # - Partial errors. If a service needs to return partial errors to the client, |
| 386 | # it may embed the `Status` in the normal response to indicate the partial |
| 387 | # errors. |
| 388 | # |
| 389 | # - Workflow errors. A typical workflow has multiple steps. Each step may |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 390 | # have a `Status` message for error reporting. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 391 | # |
| 392 | # - Batch operations. If a client uses batch request and batch response, the |
| 393 | # `Status` message should be used directly inside batch response, one for |
| 394 | # each error sub-response. |
| 395 | # |
| 396 | # - Asynchronous operations. If an API call embeds asynchronous operation |
| 397 | # results in its response, the status of those operations should be |
| 398 | # represented directly using the `Status` message. |
| 399 | # |
| 400 | # - Logging. If some API errors are stored in logs, the message `Status` could |
| 401 | # be used directly after any stripping needed for security/privacy reasons. |
| 402 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 403 | # user-facing error message should be localized and sent in the |
| 404 | # google.rpc.Status.details field, or localized by the client. |
| 405 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 406 | "details": [ # A list of messages that carry the error details. There will be a |
| 407 | # common set of message types for APIs to use. |
| 408 | { |
| 409 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 410 | }, |
| 411 | ], |
| 412 | }, |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 413 | }</pre> |
| 414 | </div> |
| 415 | |
| 416 | <div class="method"> |
| 417 | <code class="details" id="list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code> |
| 418 | <pre>Lists operations that match the specified filter in the request. If the |
| 419 | server doesn't support this method, it returns `UNIMPLEMENTED`. |
| 420 | |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 421 | NOTE: the `name` binding allows API services to override the binding |
| 422 | to use different resource name schemes, such as `users/*/operations`. To |
| 423 | override the binding, API services can add a binding such as |
| 424 | `"/v1/{name=users/*}/operations"` to their service configuration. |
| 425 | For backwards compatibility, the default name includes the operations |
| 426 | collection id, however overriding users must ensure the name binding |
| 427 | is the parent resource, without the operations collection id. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 428 | |
| 429 | Args: |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 430 | name: string, The name of the operation's parent resource. (required) |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 431 | pageSize: integer, The list page size. The max allowed value is 256 and default is 100. |
| 432 | filter: string, This parameter supports filtering by done, ie done=true or done=false. |
| 433 | pageToken: string, The list page token. |
| 434 | x__xgafv: string, V1 error format. |
| 435 | Allowed values |
| 436 | 1 - v1 error format |
| 437 | 2 - v2 error format |
| 438 | |
| 439 | Returns: |
| 440 | An object of the form: |
| 441 | |
| 442 | { # The response message for Operations.ListOperations. |
Thomas Coffee | 2f24537 | 2017-03-27 10:39:26 -0700 | [diff] [blame] | 443 | "nextPageToken": "A String", # The standard List next-page token. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 444 | "operations": [ # A list of operations that matches the specified filter in the request. |
| 445 | { # This resource represents a long-running operation that is the result of a |
| 446 | # network API call. |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 447 | "metadata": { # This field will contain an `InspectOperationMetadata` object. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 448 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 449 | }, |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 450 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 451 | # If true, the operation is completed, and either `error` or `response` is |
| 452 | # available. |
| 453 | "response": { # This field will contain an `InspectOperationResult` object. |
| 454 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 455 | }, |
| 456 | "name": "A String", # The server-assigned name, The `name` should have the format of `inspect/operations/<identifier>`. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 457 | "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. |
| 458 | # programming environments, including REST APIs and RPC APIs. It is used by |
| 459 | # [gRPC](https://github.com/grpc). The error model is designed to be: |
| 460 | # |
| 461 | # - Simple to use and understand for most users |
| 462 | # - Flexible enough to meet unexpected needs |
| 463 | # |
| 464 | # # Overview |
| 465 | # |
| 466 | # The `Status` message contains three pieces of data: error code, error message, |
| 467 | # and error details. The error code should be an enum value of |
| 468 | # google.rpc.Code, but it may accept additional error codes if needed. The |
| 469 | # error message should be a developer-facing English message that helps |
| 470 | # developers *understand* and *resolve* the error. If a localized user-facing |
| 471 | # error message is needed, put the localized message in the error details or |
| 472 | # localize it in the client. The optional error details may contain arbitrary |
| 473 | # information about the error. There is a predefined set of error detail types |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 474 | # in the package `google.rpc` that can be used for common error conditions. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 475 | # |
| 476 | # # Language mapping |
| 477 | # |
| 478 | # The `Status` message is the logical representation of the error model, but it |
| 479 | # is not necessarily the actual wire format. When the `Status` message is |
| 480 | # exposed in different client libraries and different wire protocols, it can be |
| 481 | # mapped differently. For example, it will likely be mapped to some exceptions |
| 482 | # in Java, but more likely mapped to some error codes in C. |
| 483 | # |
| 484 | # # Other uses |
| 485 | # |
| 486 | # The error model and the `Status` message can be used in a variety of |
| 487 | # environments, either with or without APIs, to provide a |
| 488 | # consistent developer experience across different environments. |
| 489 | # |
| 490 | # Example uses of this error model include: |
| 491 | # |
| 492 | # - Partial errors. If a service needs to return partial errors to the client, |
| 493 | # it may embed the `Status` in the normal response to indicate the partial |
| 494 | # errors. |
| 495 | # |
| 496 | # - Workflow errors. A typical workflow has multiple steps. Each step may |
Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 497 | # have a `Status` message for error reporting. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 498 | # |
| 499 | # - Batch operations. If a client uses batch request and batch response, the |
| 500 | # `Status` message should be used directly inside batch response, one for |
| 501 | # each error sub-response. |
| 502 | # |
| 503 | # - Asynchronous operations. If an API call embeds asynchronous operation |
| 504 | # results in its response, the status of those operations should be |
| 505 | # represented directly using the `Status` message. |
| 506 | # |
| 507 | # - Logging. If some API errors are stored in logs, the message `Status` could |
| 508 | # be used directly after any stripping needed for security/privacy reasons. |
| 509 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 510 | # user-facing error message should be localized and sent in the |
| 511 | # google.rpc.Status.details field, or localized by the client. |
| 512 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 513 | "details": [ # A list of messages that carry the error details. There will be a |
| 514 | # common set of message types for APIs to use. |
| 515 | { |
| 516 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 517 | }, |
| 518 | ], |
| 519 | }, |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 520 | }, |
| 521 | ], |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 522 | }</pre> |
| 523 | </div> |
| 524 | |
| 525 | <div class="method"> |
| 526 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 527 | <pre>Retrieves the next page of results. |
| 528 | |
| 529 | Args: |
| 530 | previous_request: The request for the previous page. (required) |
| 531 | previous_response: The response from the request for the previous page. (required) |
| 532 | |
| 533 | Returns: |
| 534 | A request object that you can call 'execute()' on to request the next |
| 535 | page. Returns None if there are no more items in the collection. |
| 536 | </pre> |
| 537 | </div> |
| 538 | |
| 539 | </body></html> |