Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 650209194f8080f37a5f20846931790f4c70ed46 / . / docs / dyn / cloudkms_v1.projects.locations.html
blob: 05506cb817c090e48c38b535533ae9dd0b4d2333 [file] [log] [blame]
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]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
Bu Sun Kim715bd7f2019-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 Cheemalapatic30d2b52017-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">
83 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]84<p class="firstline">Gets information about a location.</p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]85<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]86 <code><a href="#list">list(name, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]87<p class="firstline">Lists information about the supported locations for this service.</p>
88<p class="toc_element">
89 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
90<p class="firstline">Retrieves the next page of results.</p>
91<h3>Method Details</h3>
92<div class="method">
93 <code class="details" id="get">get(name, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94 <pre>Gets information about a location.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]95
96Args:
97 name: string, Resource name for the location. (required)
98 x__xgafv: string, V1 error format.
99 Allowed values
100 1 - v1 error format
101 2 - v2 error format
102
103Returns:
104 An object of the form:
105
106 { # A resource that represents Google Cloud Platform location.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]107 &quot;name&quot;: &quot;A String&quot;, # Resource name for the location, which may vary between implementations.
108 # For example: `&quot;projects/example-project/locations/us-east1&quot;`
109 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
110 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name.
111 # For example, &quot;Tokyo&quot;.
112 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]113 # location.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]114 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
115 },
116 &quot;labels&quot;: { # Cross-service attributes for the location. For example
117 #
118 # {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
119 &quot;a_key&quot;: &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]120 },
121 }</pre>
122</div>
123
124<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]125 <code class="details" id="list">list(name, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]126 <pre>Lists information about the supported locations for this service.
127
128Args:
129 name: string, The resource that owns the locations collection, if applicable. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]130 filter: string, The standard list filter.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]131 pageToken: string, The standard list page token.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]132 pageSize: integer, The standard list page size.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]133 x__xgafv: string, V1 error format.
134 Allowed values
135 1 - v1 error format
136 2 - v2 error format
137
138Returns:
139 An object of the form:
140
141 { # The response message for Locations.ListLocations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]142 &quot;locations&quot;: [ # A list of locations that matches the specified filter in the request.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]143 { # A resource that represents Google Cloud Platform location.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]144 &quot;name&quot;: &quot;A String&quot;, # Resource name for the location, which may vary between implementations.
145 # For example: `&quot;projects/example-project/locations/us-east1&quot;`
146 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
147 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name.
148 # For example, &quot;Tokyo&quot;.
149 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]150 # location.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]151 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
152 },
153 &quot;labels&quot;: { # Cross-service attributes for the location. For example
154 #
155 # {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
156 &quot;a_key&quot;: &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]157 },
158 },
159 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]160 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]161 }</pre>
162</div>
163
164<div class="method">
165 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
166 <pre>Retrieves the next page of results.
167
168Args:
169 previous_request: The request for the previous page. (required)
170 previous_response: The response from the request for the previous page. (required)
171
172Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]173 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]174 page. Returns None if there are no more items in the collection.
175 </pre>
176</div>
177
178</body></html>