Debian Codegraph @

docs/dyn/config_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="config_v1.html">Infrastructure Manager API</a> . <a href="config_v1.projects.html">projects</a> . <a href="config_v1.projects.locations.html">locations</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="config_v1.projects.locations.deploymentGroups.html">deploymentGroups()</a></code>
79 </p>
80 <p class="firstline">Returns the deploymentGroups Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="config_v1.projects.locations.deployments.html">deployments()</a></code>
84 </p>
85 <p class="firstline">Returns the deployments Resource.</p>
86
87 <p class="toc_element">
88 <code><a href="config_v1.projects.locations.operations.html">operations()</a></code>
89 </p>
90 <p class="firstline">Returns the operations Resource.</p>
91
92 <p class="toc_element">
93 <code><a href="config_v1.projects.locations.previews.html">previews()</a></code>
94 </p>
95 <p class="firstline">Returns the previews Resource.</p>
96
97 <p class="toc_element">
98 <code><a href="config_v1.projects.locations.terraformVersions.html">terraformVersions()</a></code>
99 </p>
100 <p class="firstline">Returns the terraformVersions Resource.</p>
101
102 <p class="toc_element">
103 <code><a href="#close">close()</a></code></p>
104 <p class="firstline">Close httplib2 connections.</p>
105 <p class="toc_element">
106 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
107 <p class="firstline">Gets information about a location.</p>
108 <p class="toc_element">
109 <code><a href="#getAutoMigrationConfig">getAutoMigrationConfig(name, x__xgafv=None)</a></code></p>
110 <p class="firstline">Get the AutoMigrationConfig for a given project and location.</p>
111 <p class="toc_element">
112 <code><a href="#list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
113 <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>
114 <p class="toc_element">
115 <code><a href="#list_next">list_next()</a></code></p>
116 <p class="firstline">Retrieves the next page of results.</p>
117 <p class="toc_element">
118 <code><a href="#updateAutoMigrationConfig">updateAutoMigrationConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
119 <p class="firstline">Updates the AutoMigrationConfig for a given project and location.</p>
120 <h3>Method Details</h3>
121 <div class="method">
122 <code class="details" id="close">close()</code>
123 <pre>Close httplib2 connections.</pre>
124 </div>
125
126 <div class="method">
127 <code class="details" id="get">get(name, x__xgafv=None)</code>
128 <pre>Gets information about a location.
129
130 Args:
131 name: string, Resource name for the location. (required)
132 x__xgafv: string, V1 error format.
133 Allowed values
134 1 - v1 error format
135 2 - v2 error format
136
137 Returns:
138 An object of the form:
139
140 { # A resource that represents a Google Cloud location.
141 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
142 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
143 &quot;a_key&quot;: &quot;A String&quot;,
144 },
145 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
146 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
147 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
148 },
149 &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;`
150 }</pre>
151 </div>
152
153 <div class="method">
154 <code class="details" id="getAutoMigrationConfig">getAutoMigrationConfig(name, x__xgafv=None)</code>
155 <pre>Get the AutoMigrationConfig for a given project and location.
156
157 Args:
158 name: string, Required. The name of the AutoMigrationConfig. Format: &#x27;projects/{project_id}/locations/{location}/AutoMigrationConfig&#x27;. (required)
159 x__xgafv: string, V1 error format.
160 Allowed values
161 1 - v1 error format
162 2 - v2 error format
163
164 Returns:
165 An object of the form:
166
167 { # AutoMigrationConfig contains the automigration configuration for a project.
168 &quot;autoMigrationEnabled&quot;: True or False, # Optional. Whether the auto migration is enabled for the project.
169 &quot;name&quot;: &quot;A String&quot;, # Identifier. The name of the AutoMigrationConfig. Format: &#x27;projects/{project_id}/locations/{location}/AutoMigrationConfig&#x27;.
170 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time the AutoMigrationConfig was last updated.
171 }</pre>
172 </div>
173
174 <div class="method">
175 <code class="details" id="list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
176 <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.
177
178 Args:
179 name: string, The resource that owns the locations collection, if applicable. (required)
180 extraLocationTypes: string, Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
181 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).
182 pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
183 pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
184 x__xgafv: string, V1 error format.
185 Allowed values
186 1 - v1 error format
187 2 - v2 error format
188
189 Returns:
190 An object of the form:
191
192 { # The response message for Locations.ListLocations.
193 &quot;locations&quot;: [ # A list of locations that matches the specified filter in the request.
194 { # A resource that represents a Google Cloud location.
195 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
196 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
197 &quot;a_key&quot;: &quot;A String&quot;,
198 },
199 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
200 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
201 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
202 },
203 &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;`
204 },
205 ],
206 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
207 }</pre>
208 </div>
209
210 <div class="method">
211 <code class="details" id="list_next">list_next()</code>
212 <pre>Retrieves the next page of results.
213
214 Args:
215 previous_request: The request for the previous page. (required)
216 previous_response: The response from the request for the previous page. (required)
217
218 Returns:
219 A request object that you can call &#x27;execute()&#x27; on to request the next
220 page. Returns None if there are no more items in the collection.
221 </pre>
222 </div>
223
224 <div class="method">
225 <code class="details" id="updateAutoMigrationConfig">updateAutoMigrationConfig(name, body=None, updateMask=None, x__xgafv=None)</code>
226 <pre>Updates the AutoMigrationConfig for a given project and location.
227
228 Args:
229 name: string, Identifier. The name of the AutoMigrationConfig. Format: &#x27;projects/{project_id}/locations/{location}/AutoMigrationConfig&#x27;. (required)
230 body: object, The request body.
231 The object takes the form of:
232
233 { # AutoMigrationConfig contains the automigration configuration for a project.
234 &quot;autoMigrationEnabled&quot;: True or False, # Optional. Whether the auto migration is enabled for the project.
235 &quot;name&quot;: &quot;A String&quot;, # Identifier. The name of the AutoMigrationConfig. Format: &#x27;projects/{project_id}/locations/{location}/AutoMigrationConfig&#x27;.
236 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time the AutoMigrationConfig was last updated.
237 }
238
239 updateMask: string, Optional. The update mask applies to the resource. See google.protobuf.FieldMask.
240 x__xgafv: string, V1 error format.
241 Allowed values
242 1 - v1 error format
243 2 - v2 error format
244
245 Returns:
246 An object of the form:
247
248 { # This resource represents a long-running operation that is the result of a network API call.
249 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
250 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
251 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
252 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
253 {
254 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
255 },
256 ],
257 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
258 },
259 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
260 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
261 },
262 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
263 &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
264 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
265 },
266 }</pre>
267 </div>
268
269 </body></html>