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="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> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="cloudkms_v1.projects.locations.ekmConnections.html">ekmConnections()</a></code> 79</p> 80<p class="firstline">Returns the ekmConnections Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="cloudkms_v1.projects.locations.keyRings.html">keyRings()</a></code> 84</p> 85<p class="firstline">Returns the keyRings Resource.</p> 86 87<p class="toc_element"> 88 <code><a href="#close">close()</a></code></p> 89<p class="firstline">Close httplib2 connections.</p> 90<p class="toc_element"> 91 <code><a href="#generateRandomBytes">generateRandomBytes(location, body=None, x__xgafv=None)</a></code></p> 92<p class="firstline">Generate random bytes using the Cloud KMS randomness source in the provided location.</p> 93<p class="toc_element"> 94 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 95<p class="firstline">Gets information about a location.</p> 96<p class="toc_element"> 97 <code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 98<p class="firstline">Lists information about the supported locations for this service.</p> 99<p class="toc_element"> 100 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 101<p class="firstline">Retrieves the next page of results.</p> 102<h3>Method Details</h3> 103<div class="method"> 104 <code class="details" id="close">close()</code> 105 <pre>Close httplib2 connections.</pre> 106</div> 107 108<div class="method"> 109 <code class="details" id="generateRandomBytes">generateRandomBytes(location, body=None, x__xgafv=None)</code> 110 <pre>Generate random bytes using the Cloud KMS randomness source in the provided location. 111 112Args: 113 location: string, The project-specific location in which to generate random bytes. For example, "projects/my-project/locations/us-central1". (required) 114 body: object, The request body. 115 The object takes the form of: 116 117{ # Request message for KeyManagementService.GenerateRandomBytes. 118 "lengthBytes": 42, # The length in bytes of the amount of randomness to retrieve. Minimum 8 bytes, maximum 1024 bytes. 119 "protectionLevel": "A String", # The ProtectionLevel to use when generating the random data. Defaults to SOFTWARE. 120} 121 122 x__xgafv: string, V1 error format. 123 Allowed values 124 1 - v1 error format 125 2 - v2 error format 126 127Returns: 128 An object of the form: 129 130 { # Response message for KeyManagementService.GenerateRandomBytes. 131 "data": "A String", # The generated data. 132 "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. 133}</pre> 134</div> 135 136<div class="method"> 137 <code class="details" id="get">get(name, x__xgafv=None)</code> 138 <pre>Gets information about a location. 139 140Args: 141 name: string, Resource name for the location. (required) 142 x__xgafv: string, V1 error format. 143 Allowed values 144 1 - v1 error format 145 2 - v2 error format 146 147Returns: 148 An object of the form: 149 150 { # A resource that represents Google Cloud Platform location. 151 "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo". 152 "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} 153 "a_key": "A String", 154 }, 155 "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`. 156 "metadata": { # Service-specific metadata. For example the available capacity at the given location. 157 "a_key": "", # Properties of the object. Contains field @type with type URL. 158 }, 159 "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` 160}</pre> 161</div> 162 163<div class="method"> 164 <code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 165 <pre>Lists information about the supported locations for this service. 166 167Args: 168 name: string, The resource that owns the locations collection, if applicable. (required) 169 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). 170 pageSize: integer, The maximum number of results to return. If not set, the service selects a default. 171 pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. 172 x__xgafv: string, V1 error format. 173 Allowed values 174 1 - v1 error format 175 2 - v2 error format 176 177Returns: 178 An object of the form: 179 180 { # The response message for Locations.ListLocations. 181 "locations": [ # A list of locations that matches the specified filter in the request. 182 { # A resource that represents Google Cloud Platform location. 183 "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo". 184 "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} 185 "a_key": "A String", 186 }, 187 "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`. 188 "metadata": { # Service-specific metadata. For example the available capacity at the given location. 189 "a_key": "", # Properties of the object. Contains field @type with type URL. 190 }, 191 "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` 192 }, 193 ], 194 "nextPageToken": "A String", # The standard List next-page token. 195}</pre> 196</div> 197 198<div class="method"> 199 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 200 <pre>Retrieves the next page of results. 201 202Args: 203 previous_request: The request for the previous page. (required) 204 previous_response: The response from the request for the previous page. (required) 205 206Returns: 207 A request object that you can call 'execute()' on to request the next 208 page. Returns None if there are no more items in the collection. 209 </pre> 210</div> 211 212</body></html>