Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 25fba648ea647b62f2a6edc54ae927c1ed381b45 / . / docs / dyn / deploymentmanager_v2.resources.html
blob: 35a72db00c68b5499cf36d980bf36f83a14976c4 [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -0700[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
75<h1><a href="deploymentmanager_v2.html">Google Cloud Deployment Manager API</a> . <a href="deploymentmanager_v2.resources.html">resources</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]81 <code><a href="#get">get(project, deployment, resource)</a></code></p>
82<p class="firstline">Gets information about a single resource.</p>
83<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]84 <code><a href="#list">list(project, deployment, maxResults=None, pageToken=None, filter=None, orderBy=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]85<p class="firstline">Lists all resources in a given deployment.</p>
86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93</div>
94
95<div class="method">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]96 <code class="details" id="get">get(project, deployment, resource)</code>
97 <pre>Gets information about a single resource.
98
99Args:
100 project: string, The project ID for this request. (required)
101 deployment: string, The name of the deployment for this request. (required)
102 resource: string, The name of the resource for this request. (required)
103
104Returns:
105 An object of the form:
106
107 {
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]108 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of the resource, for example `compute.v1.instance`, or `cloudfunctions.v1beta1.function`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]109 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of the resource as it appears in the YAML config.
110 &quot;id&quot;: &quot;A String&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]111 &quot;warnings&quot;: [ # Output only. If warning messages are generated during processing of this resource, this field will be populated.
112 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]113 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
114 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]115 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]116 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
117 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]118 },
119 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]120 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]121 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]122 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]123 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]124 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update timestamp in RFC3339 text format.
125 &quot;properties&quot;: &quot;A String&quot;, # Output only. The current properties of the resource before any references have been filled in. Returned as serialized YAML.
126 &quot;accessControl&quot;: { # The access controls set on the resource. # The Access Control Policy set on this resource.
127 &quot;gcpIamPolicy&quot;: &quot;A String&quot;, # The GCP IAM Policy to set on the resource.
128 },
129 &quot;url&quot;: &quot;A String&quot;, # Output only. The URL of the actual resource.
130 &quot;update&quot;: { # Output only. If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here.
131 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the resource.
132 &quot;manifest&quot;: &quot;A String&quot;, # Output only. URL of the manifest representing the update configuration of this resource.
133 &quot;accessControl&quot;: { # The access controls set on the resource. # The Access Control Policy to set on this resource after updating the resource itself.
134 &quot;gcpIamPolicy&quot;: &quot;A String&quot;, # The GCP IAM Policy to set on the resource.
135 },
136 &quot;finalProperties&quot;: &quot;A String&quot;, # Output only. The expanded properties of the resource with reference values expanded. Returned as serialized YAML.
137 &quot;warnings&quot;: [ # Output only. If warning messages are generated during processing of this resource, this field will be populated.
138 {
139 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
140 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
141 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
142 {
143 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
144 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
145 },
146 ],
147 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
148 },
149 ],
150 &quot;error&quot;: { # Output only. If errors are generated during update of the resource, this field will be populated.
151 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
152 {
153 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
154 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
155 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
156 },
157 ],
158 },
159 &quot;properties&quot;: &quot;A String&quot;, # Output only. The set of updated properties for this resource, before references are expanded. Returned as serialized YAML.
160 &quot;intent&quot;: &quot;A String&quot;, # Output only. The intent of the resource: `PREVIEW`, `UPDATE`, or `CANCEL`.
161 },
162 &quot;insertTime&quot;: &quot;A String&quot;, # Output only. Creation timestamp in RFC3339 text format.
163 &quot;manifest&quot;: &quot;A String&quot;, # Output only. URL of the manifest representing the current configuration of this resource.
164 &quot;finalProperties&quot;: &quot;A String&quot;, # Output only. The evaluated properties of the resource with references expanded. Returned as serialized YAML.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]165 }</pre>
166</div>
167
168<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]169 <code class="details" id="list">list(project, deployment, maxResults=None, pageToken=None, filter=None, orderBy=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]170 <pre>Lists all resources in a given deployment.
171
172Args:
173 project: string, The project ID for this request. (required)
174 deployment: string, The name of the deployment for this request. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]175 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
176 pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]177 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `&gt;`, or `&lt;`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]178
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]179For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]180
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]181You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]182
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]183To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = &quot;Intel Skylake&quot;) ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = &quot;Intel Skylake&quot;) OR (cpuPlatform = &quot;Intel Broadwell&quot;) AND (scheduling.automaticRestart = true) ```
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]184 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
185
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]186You can also sort results in descending order based on the creation timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]187
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]188Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]189
190Returns:
191 An object of the form:
192
193 { # A response containing a partial list of resources and a page token used to build the next request if the request has been truncated.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]194 &quot;resources&quot;: [ # Resources contained in this list response.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]195 {
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]196 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of the resource, for example `compute.v1.instance`, or `cloudfunctions.v1beta1.function`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]197 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of the resource as it appears in the YAML config.
198 &quot;id&quot;: &quot;A String&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]199 &quot;warnings&quot;: [ # Output only. If warning messages are generated during processing of this resource, this field will be populated.
200 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]201 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
202 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]203 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]204 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
205 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]206 },
207 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]208 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]209 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]210 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]211 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]212 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update timestamp in RFC3339 text format.
213 &quot;properties&quot;: &quot;A String&quot;, # Output only. The current properties of the resource before any references have been filled in. Returned as serialized YAML.
214 &quot;accessControl&quot;: { # The access controls set on the resource. # The Access Control Policy set on this resource.
215 &quot;gcpIamPolicy&quot;: &quot;A String&quot;, # The GCP IAM Policy to set on the resource.
216 },
217 &quot;url&quot;: &quot;A String&quot;, # Output only. The URL of the actual resource.
218 &quot;update&quot;: { # Output only. If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here.
219 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the resource.
220 &quot;manifest&quot;: &quot;A String&quot;, # Output only. URL of the manifest representing the update configuration of this resource.
221 &quot;accessControl&quot;: { # The access controls set on the resource. # The Access Control Policy to set on this resource after updating the resource itself.
222 &quot;gcpIamPolicy&quot;: &quot;A String&quot;, # The GCP IAM Policy to set on the resource.
223 },
224 &quot;finalProperties&quot;: &quot;A String&quot;, # Output only. The expanded properties of the resource with reference values expanded. Returned as serialized YAML.
225 &quot;warnings&quot;: [ # Output only. If warning messages are generated during processing of this resource, this field will be populated.
226 {
227 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
228 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
229 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
230 {
231 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
232 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
233 },
234 ],
235 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
236 },
237 ],
238 &quot;error&quot;: { # Output only. If errors are generated during update of the resource, this field will be populated.
239 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
240 {
241 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
242 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
243 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
244 },
245 ],
246 },
247 &quot;properties&quot;: &quot;A String&quot;, # Output only. The set of updated properties for this resource, before references are expanded. Returned as serialized YAML.
248 &quot;intent&quot;: &quot;A String&quot;, # Output only. The intent of the resource: `PREVIEW`, `UPDATE`, or `CANCEL`.
249 },
250 &quot;insertTime&quot;: &quot;A String&quot;, # Output only. Creation timestamp in RFC3339 text format.
251 &quot;manifest&quot;: &quot;A String&quot;, # Output only. URL of the manifest representing the current configuration of this resource.
252 &quot;finalProperties&quot;: &quot;A String&quot;, # Output only. The evaluated properties of the resource with references expanded. Returned as serialized YAML.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]253 },
254 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]255 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token used to continue a truncated list request.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]256 }</pre>
257</div>
258
259<div class="method">
260 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
261 <pre>Retrieves the next page of results.
262
263Args:
264 previous_request: The request for the previous page. (required)
265 previous_response: The response from the request for the previous page. (required)
266
267Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]268 A request object that you can call &#x27;execute()&#x27; on to request the next
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]269 page. Returns None if there are no more items in the collection.
270 </pre>
271</div>
272
273</body></html>