blob: 819e470d3c2407a2db97ee2ec90a9ecb2ba23dc2 [file] [log] [blame]
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001<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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070075<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 Cheemalapatic30d2b52017-03-13 12:12:03 -040076<h2>Instance Methods</h2>
77<p class="toc_element">
yoshi-code-bot85954412021-12-06 23:26:37 -080078 <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">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040083 <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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070088 <code><a href="#close">close()</a></code></p>
89<p class="firstline">Close httplib2 connections.</p>
90<p class="toc_element">
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -070091 <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">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040094 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070095<p class="firstline">Gets information about a location.</p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040096<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -080097 <code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040098<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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700104 <code class="details" id="close">close()</code>
105 <pre>Close httplib2 connections.</pre>
106</div>
107
108<div class="method">
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700109 <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, &quot;projects/my-project/locations/us-central1&quot;. (required)
114 body: object, The request body.
115 The object takes the form of:
116
117{ # Request message for KeyManagementService.GenerateRandomBytes.
118 &quot;lengthBytes&quot;: 42, # The length in bytes of the amount of randomness to retrieve. Minimum 8 bytes, maximum 1024 bytes.
119 &quot;protectionLevel&quot;: &quot;A String&quot;, # 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 &quot;data&quot;: &quot;A String&quot;, # The generated data.
132 &quot;dataCrc32c&quot;: &quot;A String&quot;, # 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">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400137 <code class="details" id="get">get(name, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700138 <pre>Gets information about a location.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400139
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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800151 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
152 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
153 &quot;a_key&quot;: &quot;A String&quot;,
154 },
155 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
156 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
157 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
158 },
159 &quot;name&quot;: &quot;A String&quot;, # Resource name for the location, which may vary between implementations. For example: `&quot;projects/example-project/locations/us-east1&quot;`
160}</pre>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400161</div>
162
163<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800164 <code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400165 <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)
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700169 filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like &quot;displayName=tokyo&quot;, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
yoshi-code-bot3dd15272021-04-21 15:07:48 -0700170 pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700171 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 Cheemalapatic30d2b52017-03-13 12:12:03 -0400172 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800181 &quot;locations&quot;: [ # A list of locations that matches the specified filter in the request.
182 { # A resource that represents Google Cloud Platform location.
183 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
184 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
185 &quot;a_key&quot;: &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400186 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800187 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
188 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
189 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
190 },
191 &quot;name&quot;: &quot;A String&quot;, # Resource name for the location, which may vary between implementations. For example: `&quot;projects/example-project/locations/us-east1&quot;`
192 },
193 ],
194 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
195}</pre>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400196</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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700207 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400208 page. Returns None if there are no more items in the collection.
209 </pre>
210</div>
211
212</body></html>