| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [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="cloudkms_v1.html">Google Cloud Key Management Service (KMS) API</a> . <a href="cloudkms_v1.projects.html">projects</a> . <a href="cloudkms_v1.projects.locations.html">locations</a> . <a href="cloudkms_v1.projects.locations.keyRings.html">keyRings</a> . <a href="cloudkms_v1.projects.locations.keyRings.cryptoKeys.html">cryptoKeys</a> . <a href="cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html">cryptoKeyVersions</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#create">create(parent=None, body, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Create a new CryptoKeyVersion in a CryptoKey.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#destroy">destroy(name, body, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Schedule a CryptoKeyVersion for destruction.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Returns metadata for a given CryptoKeyVersion.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p> |
| 88 | <p class="firstline">Lists CryptoKeyVersions.</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 91 | <p class="firstline">Retrieves the next page of results.</p> |
| 92 | <p class="toc_element"> |
| 93 | <code><a href="#patch">patch(name=None, body, updateMask=None, x__xgafv=None)</a></code></p> |
| 94 | <p class="firstline">Update a CryptoKeyVersion's metadata.</p> |
| 95 | <p class="toc_element"> |
| 96 | <code><a href="#restore">restore(name, body, x__xgafv=None)</a></code></p> |
| 97 | <p class="firstline">Restore a CryptoKeyVersion in the</p> |
| 98 | <h3>Method Details</h3> |
| 99 | <div class="method"> |
| 100 | <code class="details" id="create">create(parent=None, body, x__xgafv=None)</code> |
| 101 | <pre>Create a new CryptoKeyVersion in a CryptoKey. |
| 102 | |
| 103 | The server will assign the next sequential id. If unset, |
| 104 | state will be set to |
| 105 | ENABLED. |
| 106 | |
| 107 | Args: |
| 108 | parent: string, Required. The name of the CryptoKey associated with |
| 109 | the CryptoKeyVersions. (required) |
| 110 | body: object, The request body. (required) |
| 111 | The object takes the form of: |
| 112 | |
| 113 | { # A CryptoKeyVersion represents an individual cryptographic key, and the |
| 114 | # associated key material. |
| 115 | # |
| 116 | # It can be used for cryptographic operations either directly, or via its |
| 117 | # parent CryptoKey, in which case the server will choose the appropriate |
| 118 | # version for the operation. |
| 119 | "state": "A String", # The current state of the CryptoKeyVersion. |
| 120 | "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created. |
| 121 | "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format |
| 122 | # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. |
| 123 | "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled |
| 124 | # for destruction. Only present if state is |
| 125 | # DESTROY_SCHEDULED. |
| 126 | "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was |
| 127 | # destroyed. Only present if state is |
| 128 | # DESTROYED. |
| 129 | } |
| 130 | |
| 131 | x__xgafv: string, V1 error format. |
| 132 | Allowed values |
| 133 | 1 - v1 error format |
| 134 | 2 - v2 error format |
| 135 | |
| 136 | Returns: |
| 137 | An object of the form: |
| 138 | |
| 139 | { # A CryptoKeyVersion represents an individual cryptographic key, and the |
| 140 | # associated key material. |
| 141 | # |
| 142 | # It can be used for cryptographic operations either directly, or via its |
| 143 | # parent CryptoKey, in which case the server will choose the appropriate |
| 144 | # version for the operation. |
| 145 | "state": "A String", # The current state of the CryptoKeyVersion. |
| 146 | "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created. |
| 147 | "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format |
| 148 | # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. |
| 149 | "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled |
| 150 | # for destruction. Only present if state is |
| 151 | # DESTROY_SCHEDULED. |
| 152 | "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was |
| 153 | # destroyed. Only present if state is |
| 154 | # DESTROYED. |
| 155 | }</pre> |
| 156 | </div> |
| 157 | |
| 158 | <div class="method"> |
| 159 | <code class="details" id="destroy">destroy(name, body, x__xgafv=None)</code> |
| 160 | <pre>Schedule a CryptoKeyVersion for destruction. |
| 161 | |
| 162 | Upon calling this method, CryptoKeyVersion.state will be set to |
| 163 | DESTROY_SCHEDULED |
| 164 | and destroy_time will be set to a time 24 |
| 165 | hours in the future, at which point the state |
| 166 | will be changed to |
| 167 | DESTROYED, and the key |
| 168 | material will be irrevocably destroyed. |
| 169 | |
| 170 | Before the destroy_time is reached, |
| 171 | RestoreCryptoKeyVersion may be called to reverse the process. |
| 172 | |
| 173 | Args: |
| 174 | name: string, The resource name of the CryptoKeyVersion to destroy. (required) |
| 175 | body: object, The request body. (required) |
| 176 | The object takes the form of: |
| 177 | |
| 178 | { # Request message for KeyManagementService.DestroyCryptoKeyVersion. |
| 179 | } |
| 180 | |
| 181 | x__xgafv: string, V1 error format. |
| 182 | Allowed values |
| 183 | 1 - v1 error format |
| 184 | 2 - v2 error format |
| 185 | |
| 186 | Returns: |
| 187 | An object of the form: |
| 188 | |
| 189 | { # A CryptoKeyVersion represents an individual cryptographic key, and the |
| 190 | # associated key material. |
| 191 | # |
| 192 | # It can be used for cryptographic operations either directly, or via its |
| 193 | # parent CryptoKey, in which case the server will choose the appropriate |
| 194 | # version for the operation. |
| 195 | "state": "A String", # The current state of the CryptoKeyVersion. |
| 196 | "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created. |
| 197 | "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format |
| 198 | # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. |
| 199 | "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled |
| 200 | # for destruction. Only present if state is |
| 201 | # DESTROY_SCHEDULED. |
| 202 | "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was |
| 203 | # destroyed. Only present if state is |
| 204 | # DESTROYED. |
| 205 | }</pre> |
| 206 | </div> |
| 207 | |
| 208 | <div class="method"> |
| 209 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 210 | <pre>Returns metadata for a given CryptoKeyVersion. |
| 211 | |
| 212 | Args: |
| 213 | name: string, The name of the CryptoKeyVersion to get. (required) |
| 214 | x__xgafv: string, V1 error format. |
| 215 | Allowed values |
| 216 | 1 - v1 error format |
| 217 | 2 - v2 error format |
| 218 | |
| 219 | Returns: |
| 220 | An object of the form: |
| 221 | |
| 222 | { # A CryptoKeyVersion represents an individual cryptographic key, and the |
| 223 | # associated key material. |
| 224 | # |
| 225 | # It can be used for cryptographic operations either directly, or via its |
| 226 | # parent CryptoKey, in which case the server will choose the appropriate |
| 227 | # version for the operation. |
| 228 | "state": "A String", # The current state of the CryptoKeyVersion. |
| 229 | "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created. |
| 230 | "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format |
| 231 | # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. |
| 232 | "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled |
| 233 | # for destruction. Only present if state is |
| 234 | # DESTROY_SCHEDULED. |
| 235 | "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was |
| 236 | # destroyed. Only present if state is |
| 237 | # DESTROYED. |
| 238 | }</pre> |
| 239 | </div> |
| 240 | |
| 241 | <div class="method"> |
| 242 | <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code> |
| 243 | <pre>Lists CryptoKeyVersions. |
| 244 | |
| 245 | Args: |
| 246 | parent: string, Required. The resource name of the CryptoKey to list, in the format |
| 247 | `projects/*/locations/*/keyRings/*/cryptoKeys/*`. (required) |
| 248 | pageToken: string, Optional pagination token, returned earlier via |
| 249 | ListCryptoKeyVersionsResponse.next_page_token. |
| 250 | x__xgafv: string, V1 error format. |
| 251 | Allowed values |
| 252 | 1 - v1 error format |
| 253 | 2 - v2 error format |
| 254 | pageSize: integer, Optional limit on the number of CryptoKeyVersions to |
| 255 | include in the response. Further CryptoKeyVersions can |
| 256 | subsequently be obtained by including the |
| 257 | ListCryptoKeyVersionsResponse.next_page_token in a subsequent request. |
| 258 | If unspecified, the server will pick an appropriate default. |
| 259 | |
| 260 | Returns: |
| 261 | An object of the form: |
| 262 | |
| 263 | { # Response message for KeyManagementService.ListCryptoKeyVersions. |
| 264 | "nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in |
| 265 | # ListCryptoKeyVersionsRequest.page_token to retrieve the next page of |
| 266 | # results. |
| 267 | "totalSize": 42, # The total number of CryptoKeyVersions that matched the |
| 268 | # query. |
| 269 | "cryptoKeyVersions": [ # The list of CryptoKeyVersions. |
| 270 | { # A CryptoKeyVersion represents an individual cryptographic key, and the |
| 271 | # associated key material. |
| 272 | # |
| 273 | # It can be used for cryptographic operations either directly, or via its |
| 274 | # parent CryptoKey, in which case the server will choose the appropriate |
| 275 | # version for the operation. |
| 276 | "state": "A String", # The current state of the CryptoKeyVersion. |
| 277 | "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created. |
| 278 | "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format |
| 279 | # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. |
| 280 | "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled |
| 281 | # for destruction. Only present if state is |
| 282 | # DESTROY_SCHEDULED. |
| 283 | "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was |
| 284 | # destroyed. Only present if state is |
| 285 | # DESTROYED. |
| 286 | }, |
| 287 | ], |
| 288 | }</pre> |
| 289 | </div> |
| 290 | |
| 291 | <div class="method"> |
| 292 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 293 | <pre>Retrieves the next page of results. |
| 294 | |
| 295 | Args: |
| 296 | previous_request: The request for the previous page. (required) |
| 297 | previous_response: The response from the request for the previous page. (required) |
| 298 | |
| 299 | Returns: |
| 300 | A request object that you can call 'execute()' on to request the next |
| 301 | page. Returns None if there are no more items in the collection. |
| 302 | </pre> |
| 303 | </div> |
| 304 | |
| 305 | <div class="method"> |
| 306 | <code class="details" id="patch">patch(name=None, body, updateMask=None, x__xgafv=None)</code> |
| 307 | <pre>Update a CryptoKeyVersion's metadata. |
| 308 | |
| 309 | state may be changed between |
| 310 | ENABLED and |
| 311 | DISABLED using this |
| 312 | method. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to |
| 313 | move between other states. |
| 314 | |
| 315 | Args: |
| 316 | name: string, Output only. The resource name for this CryptoKeyVersion in the format |
| 317 | `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. (required) |
| 318 | body: object, The request body. (required) |
| 319 | The object takes the form of: |
| 320 | |
| 321 | { # A CryptoKeyVersion represents an individual cryptographic key, and the |
| 322 | # associated key material. |
| 323 | # |
| 324 | # It can be used for cryptographic operations either directly, or via its |
| 325 | # parent CryptoKey, in which case the server will choose the appropriate |
| 326 | # version for the operation. |
| 327 | "state": "A String", # The current state of the CryptoKeyVersion. |
| 328 | "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created. |
| 329 | "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format |
| 330 | # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. |
| 331 | "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled |
| 332 | # for destruction. Only present if state is |
| 333 | # DESTROY_SCHEDULED. |
| 334 | "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was |
| 335 | # destroyed. Only present if state is |
| 336 | # DESTROYED. |
| 337 | } |
| 338 | |
| 339 | updateMask: string, Required list of fields to be updated in this request. |
| 340 | x__xgafv: string, V1 error format. |
| 341 | Allowed values |
| 342 | 1 - v1 error format |
| 343 | 2 - v2 error format |
| 344 | |
| 345 | Returns: |
| 346 | An object of the form: |
| 347 | |
| 348 | { # A CryptoKeyVersion represents an individual cryptographic key, and the |
| 349 | # associated key material. |
| 350 | # |
| 351 | # It can be used for cryptographic operations either directly, or via its |
| 352 | # parent CryptoKey, in which case the server will choose the appropriate |
| 353 | # version for the operation. |
| 354 | "state": "A String", # The current state of the CryptoKeyVersion. |
| 355 | "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created. |
| 356 | "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format |
| 357 | # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. |
| 358 | "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled |
| 359 | # for destruction. Only present if state is |
| 360 | # DESTROY_SCHEDULED. |
| 361 | "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was |
| 362 | # destroyed. Only present if state is |
| 363 | # DESTROYED. |
| 364 | }</pre> |
| 365 | </div> |
| 366 | |
| 367 | <div class="method"> |
| 368 | <code class="details" id="restore">restore(name, body, x__xgafv=None)</code> |
| 369 | <pre>Restore a CryptoKeyVersion in the |
| 370 | DESTROY_SCHEDULED, |
| 371 | state. |
| 372 | |
| 373 | Upon restoration of the CryptoKeyVersion, state |
| 374 | will be set to DISABLED, |
| 375 | and destroy_time will be cleared. |
| 376 | |
| 377 | Args: |
| 378 | name: string, The resource name of the CryptoKeyVersion to restore. (required) |
| 379 | body: object, The request body. (required) |
| 380 | The object takes the form of: |
| 381 | |
| 382 | { # Request message for KeyManagementService.RestoreCryptoKeyVersion. |
| 383 | } |
| 384 | |
| 385 | x__xgafv: string, V1 error format. |
| 386 | Allowed values |
| 387 | 1 - v1 error format |
| 388 | 2 - v2 error format |
| 389 | |
| 390 | Returns: |
| 391 | An object of the form: |
| 392 | |
| 393 | { # A CryptoKeyVersion represents an individual cryptographic key, and the |
| 394 | # associated key material. |
| 395 | # |
| 396 | # It can be used for cryptographic operations either directly, or via its |
| 397 | # parent CryptoKey, in which case the server will choose the appropriate |
| 398 | # version for the operation. |
| 399 | "state": "A String", # The current state of the CryptoKeyVersion. |
| 400 | "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created. |
| 401 | "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format |
| 402 | # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. |
| 403 | "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled |
| 404 | # for destruction. Only present if state is |
| 405 | # DESTROY_SCHEDULED. |
| 406 | "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was |
| 407 | # destroyed. Only present if state is |
| 408 | # DESTROYED. |
| 409 | }</pre> |
| 410 | </div> |
| 411 | |
| 412 | </body></html> |