| 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 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 75 | <h1><a href="cloudkms_v1.html">Cloud Key Management Service (KMS) API</a> . <a href="cloudkms_v1.projects.html">projects</a> . <a href="cloudkms_v1.projects.locations.html">locations</a></h1> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="cloudkms_v1.projects.locations.keyRings.html">keyRings()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the keyRings Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 83 | <code><a href="#close">close()</a></code></p> |
| 84 | <p class="firstline">Close httplib2 connections.</p> |
| 85 | <p class="toc_element"> |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 86 | <code><a href="#generateRandomBytes">generateRandomBytes(location, body=None, x__xgafv=None)</a></code></p> |
| 87 | <p class="firstline">Generate random bytes using the Cloud KMS randomness source in the provided location.</p> |
| 88 | <p class="toc_element"> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 89 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 90 | <p class="firstline">Gets information about a location.</p> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 91 | <p class="toc_element"> |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 92 | <code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 93 | <p class="firstline">Lists information about the supported locations for this service.</p> |
| 94 | <p class="toc_element"> |
| 95 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 96 | <p class="firstline">Retrieves the next page of results.</p> |
| 97 | <h3>Method Details</h3> |
| 98 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 99 | <code class="details" id="close">close()</code> |
| 100 | <pre>Close httplib2 connections.</pre> |
| 101 | </div> |
| 102 | |
| 103 | <div class="method"> |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 104 | <code class="details" id="generateRandomBytes">generateRandomBytes(location, body=None, x__xgafv=None)</code> |
| 105 | <pre>Generate random bytes using the Cloud KMS randomness source in the provided location. |
| 106 | |
| 107 | Args: |
| 108 | location: string, The project-specific location in which to generate random bytes. For example, "projects/my-project/locations/us-central1". (required) |
| 109 | body: object, The request body. |
| 110 | The object takes the form of: |
| 111 | |
| 112 | { # Request message for KeyManagementService.GenerateRandomBytes. |
| 113 | "lengthBytes": 42, # The length in bytes of the amount of randomness to retrieve. Minimum 8 bytes, maximum 1024 bytes. |
| 114 | "protectionLevel": "A String", # The ProtectionLevel to use when generating the random data. Defaults to SOFTWARE. |
| 115 | } |
| 116 | |
| 117 | x__xgafv: string, V1 error format. |
| 118 | Allowed values |
| 119 | 1 - v1 error format |
| 120 | 2 - v2 error format |
| 121 | |
| 122 | Returns: |
| 123 | An object of the form: |
| 124 | |
| 125 | { # Response message for KeyManagementService.GenerateRandomBytes. |
| 126 | "data": "A String", # The generated data. |
| 127 | "dataCrc32c": "A String", # Integrity verification field. A CRC32C checksum of the returned GenerateRandomBytesResponse.data. An integrity check of GenerateRandomBytesResponse.data can be performed by computing the CRC32C checksum of GenerateRandomBytesResponse.data and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type. |
| 128 | }</pre> |
| 129 | </div> |
| 130 | |
| 131 | <div class="method"> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 132 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 133 | <pre>Gets information about a location. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 134 | |
| 135 | Args: |
| 136 | name: string, Resource name for the location. (required) |
| 137 | x__xgafv: string, V1 error format. |
| 138 | Allowed values |
| 139 | 1 - v1 error format |
| 140 | 2 - v2 error format |
| 141 | |
| 142 | Returns: |
| 143 | An object of the form: |
| 144 | |
| 145 | { # A resource that represents Google Cloud Platform location. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 146 | "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo". |
| 147 | "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} |
| 148 | "a_key": "A String", |
| 149 | }, |
| 150 | "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`. |
| 151 | "metadata": { # Service-specific metadata. For example the available capacity at the given location. |
| 152 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 153 | }, |
| 154 | "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` |
| 155 | }</pre> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 156 | </div> |
| 157 | |
| 158 | <div class="method"> |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 159 | <code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 160 | <pre>Lists information about the supported locations for this service. |
| 161 | |
| 162 | Args: |
| 163 | name: string, The resource that owns the locations collection, if applicable. (required) |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 164 | filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). |
| yoshi-code-bot | 3dd1527 | 2021-04-21 15:07:48 -0700 | [diff] [blame] | 165 | pageSize: integer, The maximum number of results to return. If not set, the service selects a default. |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 166 | pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 167 | x__xgafv: string, V1 error format. |
| 168 | Allowed values |
| 169 | 1 - v1 error format |
| 170 | 2 - v2 error format |
| 171 | |
| 172 | Returns: |
| 173 | An object of the form: |
| 174 | |
| 175 | { # The response message for Locations.ListLocations. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 176 | "locations": [ # A list of locations that matches the specified filter in the request. |
| 177 | { # A resource that represents Google Cloud Platform location. |
| 178 | "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo". |
| 179 | "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} |
| 180 | "a_key": "A String", |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 181 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 182 | "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`. |
| 183 | "metadata": { # Service-specific metadata. For example the available capacity at the given location. |
| 184 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 185 | }, |
| 186 | "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` |
| 187 | }, |
| 188 | ], |
| 189 | "nextPageToken": "A String", # The standard List next-page token. |
| 190 | }</pre> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 191 | </div> |
| 192 | |
| 193 | <div class="method"> |
| 194 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 195 | <pre>Retrieves the next page of results. |
| 196 | |
| 197 | Args: |
| 198 | previous_request: The request for the previous page. (required) |
| 199 | previous_response: The response from the request for the previous page. (required) |
| 200 | |
| 201 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 202 | A request object that you can call 'execute()' on to request the next |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 203 | page. Returns None if there are no more items in the collection. |
| 204 | </pre> |
| 205 | </div> |
| 206 | |
| 207 | </body></html> |