Debian Codegraph @

docs/dyn/cloudkms_v1.projects.locations.html

raw
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">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.ekmConfig.html">ekmConfig()</a></code>
79 </p>
80 <p class="firstline">Returns the ekmConfig Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="cloudkms_v1.projects.locations.ekmConnections.html">ekmConnections()</a></code>
84 </p>
85 <p class="firstline">Returns the ekmConnections Resource.</p>
86
87 <p class="toc_element">
88 <code><a href="cloudkms_v1.projects.locations.keyHandles.html">keyHandles()</a></code>
89 </p>
90 <p class="firstline">Returns the keyHandles Resource.</p>
91
92 <p class="toc_element">
93 <code><a href="cloudkms_v1.projects.locations.keyRings.html">keyRings()</a></code>
94 </p>
95 <p class="firstline">Returns the keyRings Resource.</p>
96
97 <p class="toc_element">
98 <code><a href="cloudkms_v1.projects.locations.operations.html">operations()</a></code>
99 </p>
100 <p class="firstline">Returns the operations Resource.</p>
101
102 <p class="toc_element">
103 <code><a href="cloudkms_v1.projects.locations.retiredResources.html">retiredResources()</a></code>
104 </p>
105 <p class="firstline">Returns the retiredResources Resource.</p>
106
107 <p class="toc_element">
108 <code><a href="cloudkms_v1.projects.locations.singleTenantHsmInstances.html">singleTenantHsmInstances()</a></code>
109 </p>
110 <p class="firstline">Returns the singleTenantHsmInstances Resource.</p>
111
112 <p class="toc_element">
113 <code><a href="#close">close()</a></code></p>
114 <p class="firstline">Close httplib2 connections.</p>
115 <p class="toc_element">
116 <code><a href="#generateRandomBytes">generateRandomBytes(location, body=None, x__xgafv=None)</a></code></p>
117 <p class="firstline">Generate random bytes using the Cloud KMS randomness source in the provided location.</p>
118 <p class="toc_element">
119 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
120 <p class="firstline">Gets information about a location.</p>
121 <p class="toc_element">
122 <code><a href="#getEkmConfig">getEkmConfig(name, x__xgafv=None)</a></code></p>
123 <p class="firstline">Returns the EkmConfig singleton resource for a given project and location.</p>
124 <p class="toc_element">
125 <code><a href="#list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
126 <p class="firstline">Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.</p>
127 <p class="toc_element">
128 <code><a href="#list_next">list_next()</a></code></p>
129 <p class="firstline">Retrieves the next page of results.</p>
130 <p class="toc_element">
131 <code><a href="#updateEkmConfig">updateEkmConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
132 <p class="firstline">Updates the EkmConfig singleton resource for a given project and location.</p>
133 <h3>Method Details</h3>
134 <div class="method">
135 <code class="details" id="close">close()</code>
136 <pre>Close httplib2 connections.</pre>
137 </div>
138
139 <div class="method">
140 <code class="details" id="generateRandomBytes">generateRandomBytes(location, body=None, x__xgafv=None)</code>
141 <pre>Generate random bytes using the Cloud KMS randomness source in the provided location.
142
143 Args:
144 location: string, The project-specific location in which to generate random bytes. For example, &quot;projects/my-project/locations/us-central1&quot;. (required)
145 body: object, The request body.
146 The object takes the form of:
147
148 { # Request message for KeyManagementService.GenerateRandomBytes.
149 &quot;lengthBytes&quot;: 42, # The length in bytes of the amount of randomness to retrieve. Minimum 8 bytes, maximum 1024 bytes.
150 &quot;protectionLevel&quot;: &quot;A String&quot;, # The ProtectionLevel to use when generating the random data. Currently, only HSM protection level is supported.
151 }
152
153 x__xgafv: string, V1 error format.
154 Allowed values
155 1 - v1 error format
156 2 - v2 error format
157
158 Returns:
159 An object of the form:
160
161 { # Response message for KeyManagementService.GenerateRandomBytes.
162 &quot;data&quot;: &quot;A String&quot;, # The generated data.
163 &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.
164 }</pre>
165 </div>
166
167 <div class="method">
168 <code class="details" id="get">get(name, x__xgafv=None)</code>
169 <pre>Gets information about a location.
170
171 Args:
172 name: string, Resource name for the location. (required)
173 x__xgafv: string, V1 error format.
174 Allowed values
175 1 - v1 error format
176 2 - v2 error format
177
178 Returns:
179 An object of the form:
180
181 { # A resource that represents a Google Cloud location.
182 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
183 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
184 &quot;a_key&quot;: &quot;A String&quot;,
185 },
186 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
187 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
188 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
189 },
190 &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;`
191 }</pre>
192 </div>
193
194 <div class="method">
195 <code class="details" id="getEkmConfig">getEkmConfig(name, x__xgafv=None)</code>
196 <pre>Returns the EkmConfig singleton resource for a given project and location.
197
198 Args:
199 name: string, Required. The name of the EkmConfig to get. (required)
200 x__xgafv: string, V1 error format.
201 Allowed values
202 1 - v1 error format
203 2 - v2 error format
204
205 Returns:
206 An object of the form:
207
208 { # An EkmConfig is a singleton resource that represents configuration parameters that apply to all CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC in a given project and location.
209 &quot;defaultEkmConnection&quot;: &quot;A String&quot;, # Optional. Resource name of the default EkmConnection. Setting this field to the empty string removes the default.
210 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for the EkmConfig in the format `projects/*/locations/*/ekmConfig`.
211 }</pre>
212 </div>
213
214 <div class="method">
215 <code class="details" id="list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
216 <pre>Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
217
218 Args:
219 name: string, The resource that owns the locations collection, if applicable. (required)
220 extraLocationTypes: string, Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
221 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).
222 pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
223 pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
224 x__xgafv: string, V1 error format.
225 Allowed values
226 1 - v1 error format
227 2 - v2 error format
228
229 Returns:
230 An object of the form:
231
232 { # The response message for Locations.ListLocations.
233 &quot;locations&quot;: [ # A list of locations that matches the specified filter in the request.
234 { # A resource that represents a Google Cloud location.
235 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
236 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
237 &quot;a_key&quot;: &quot;A String&quot;,
238 },
239 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
240 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
241 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
242 },
243 &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;`
244 },
245 ],
246 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
247 }</pre>
248 </div>
249
250 <div class="method">
251 <code class="details" id="list_next">list_next()</code>
252 <pre>Retrieves the next page of results.
253
254 Args:
255 previous_request: The request for the previous page. (required)
256 previous_response: The response from the request for the previous page. (required)
257
258 Returns:
259 A request object that you can call &#x27;execute()&#x27; on to request the next
260 page. Returns None if there are no more items in the collection.
261 </pre>
262 </div>
263
264 <div class="method">
265 <code class="details" id="updateEkmConfig">updateEkmConfig(name, body=None, updateMask=None, x__xgafv=None)</code>
266 <pre>Updates the EkmConfig singleton resource for a given project and location.
267
268 Args:
269 name: string, Output only. The resource name for the EkmConfig in the format `projects/*/locations/*/ekmConfig`. (required)
270 body: object, The request body.
271 The object takes the form of:
272
273 { # An EkmConfig is a singleton resource that represents configuration parameters that apply to all CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC in a given project and location.
274 &quot;defaultEkmConnection&quot;: &quot;A String&quot;, # Optional. Resource name of the default EkmConnection. Setting this field to the empty string removes the default.
275 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for the EkmConfig in the format `projects/*/locations/*/ekmConfig`.
276 }
277
278 updateMask: string, Required. List of fields to be updated in this request.
279 x__xgafv: string, V1 error format.
280 Allowed values
281 1 - v1 error format
282 2 - v2 error format
283
284 Returns:
285 An object of the form:
286
287 { # An EkmConfig is a singleton resource that represents configuration parameters that apply to all CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC in a given project and location.
288 &quot;defaultEkmConnection&quot;: &quot;A String&quot;, # Optional. Resource name of the default EkmConnection. Setting this field to the empty string removes the default.
289 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name for the EkmConfig in the format `projects/*/locations/*/ekmConfig`.
290 }</pre>
291 </div>
292
293 </body></html>