Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b6971b0405ba59d905b84fa5fc8e27e12d29b70c / . / docs / dyn / deploymentmanager_v2.resources.html
blob: 7617c021577279f7c0ad4648cf44f0c1dcecb88a [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
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]75<h1><a href="deploymentmanager_v2.html">Cloud Deployment Manager V2 API</a> . <a href="deploymentmanager_v2.resources.html">resources</a></h1>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]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">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]81 <code><a href="#get">get(project, deployment, resource, x__xgafv=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]82<p class="firstline">Gets information about a single resource.</p>
83<p class="toc_element">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]84 <code><a href="#list">list(project, deployment, filter=None, pageToken=None, returnPartialSuccess=None, orderBy=None, maxResults=None, x__xgafv=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">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]96 <code class="details" id="get">get(project, deployment, resource, x__xgafv=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]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)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]103 x__xgafv: string, V1 error format.
104 Allowed values
105 1 - v1 error format
106 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]107
108Returns:
109 An object of the form:
110
111 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]112 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]113 &quot;id&quot;: &quot;A String&quot;,
114 &quot;accessControl&quot;: { # The access controls set on the resource. # The Access Control Policy set on this resource.
115 &quot;gcpIamPolicy&quot;: &quot;A String&quot;, # The GCP IAM Policy to set on the resource.
116 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]117 &quot;finalProperties&quot;: &quot;A String&quot;, # Output only. The evaluated properties of the resource with references expanded. Returned as serialized YAML.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]118 &quot;warnings&quot;: [ # Output only. If warning messages are generated during processing of this resource, this field will be populated.
119 {
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]120 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
121 {
122 &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).
123 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
124 },
125 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]126 &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.
127 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]128 },
129 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]130 &quot;manifest&quot;: &quot;A String&quot;, # Output only. URL of the manifest representing the current configuration of this resource.
131 &quot;insertTime&quot;: &quot;A String&quot;, # Output only. Creation timestamp in RFC3339 text format.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]132 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of the resource, for example `compute.v1.instance`, or `cloudfunctions.v1beta1.function`.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]133 &quot;update&quot;: { # Output only. If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]134 &quot;error&quot;: { # Output only. If errors are generated during update of the resource, this field will be populated.
135 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
136 {
137 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
138 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
139 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
140 },
141 ],
142 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]143 &quot;intent&quot;: &quot;A String&quot;, # Output only. The intent of the resource: `PREVIEW`, `UPDATE`, or `CANCEL`.
144 &quot;manifest&quot;: &quot;A String&quot;, # Output only. URL of the manifest representing the update configuration of this resource.
145 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the resource.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]146 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]147 &quot;accessControl&quot;: { # The access controls set on the resource. # The Access Control Policy to set on this resource after updating the resource itself.
148 &quot;gcpIamPolicy&quot;: &quot;A String&quot;, # The GCP IAM Policy to set on the resource.
149 },
150 &quot;warnings&quot;: [ # Output only. If warning messages are generated during processing of this resource, this field will be populated.
151 {
152 &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.
153 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
154 {
155 &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).
156 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
157 },
158 ],
159 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
160 },
161 ],
162 &quot;finalProperties&quot;: &quot;A String&quot;, # Output only. The expanded properties of the resource with reference values expanded. Returned as serialized YAML.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]163 },
164 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of the resource as it appears in the YAML config.
165 &quot;url&quot;: &quot;A String&quot;, # Output only. The URL of the actual resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]166 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update timestamp in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]167 }</pre>
168</div>
169
170<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]171 <code class="details" id="list">list(project, deployment, filter=None, pageToken=None, returnPartialSuccess=None, orderBy=None, maxResults=None, x__xgafv=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]172 <pre>Lists all resources in a given deployment.
173
174Args:
175 project: string, The project ID for this request. (required)
176 deployment: string, The name of the deployment for this request. (required)
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[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;`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. You 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. To 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) ```
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]178 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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]179 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
180 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
181 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`)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]182 x__xgafv: string, V1 error format.
183 Allowed values
184 1 - v1 error format
185 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]186
187Returns:
188 An object of the form:
189
190 { # A response containing a partial list of resources and a page token used to build the next request if the request has been truncated.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]191 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token used to continue a truncated list request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]192 &quot;resources&quot;: [ # Resources contained in this list response.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]193 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]194 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]195 &quot;id&quot;: &quot;A String&quot;,
196 &quot;accessControl&quot;: { # The access controls set on the resource. # The Access Control Policy set on this resource.
197 &quot;gcpIamPolicy&quot;: &quot;A String&quot;, # The GCP IAM Policy to set on the resource.
198 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]199 &quot;finalProperties&quot;: &quot;A String&quot;, # Output only. The evaluated properties of the resource with references expanded. Returned as serialized YAML.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]200 &quot;warnings&quot;: [ # Output only. If warning messages are generated during processing of this resource, this field will be populated.
201 {
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]202 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
203 {
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.
206 },
207 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[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.
209 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]210 },
211 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]212 &quot;manifest&quot;: &quot;A String&quot;, # Output only. URL of the manifest representing the current configuration of this resource.
213 &quot;insertTime&quot;: &quot;A String&quot;, # Output only. Creation timestamp in RFC3339 text format.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]214 &quot;type&quot;: &quot;A String&quot;, # Output only. The type of the resource, for example `compute.v1.instance`, or `cloudfunctions.v1beta1.function`.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]215 &quot;update&quot;: { # Output only. If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]216 &quot;error&quot;: { # Output only. If errors are generated during update of the resource, this field will be populated.
217 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
218 {
219 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
220 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
221 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
222 },
223 ],
224 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]225 &quot;intent&quot;: &quot;A String&quot;, # Output only. The intent of the resource: `PREVIEW`, `UPDATE`, or `CANCEL`.
226 &quot;manifest&quot;: &quot;A String&quot;, # Output only. URL of the manifest representing the update configuration of this resource.
227 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the resource.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]228 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]229 &quot;accessControl&quot;: { # The access controls set on the resource. # The Access Control Policy to set on this resource after updating the resource itself.
230 &quot;gcpIamPolicy&quot;: &quot;A String&quot;, # The GCP IAM Policy to set on the resource.
231 },
232 &quot;warnings&quot;: [ # Output only. If warning messages are generated during processing of this resource, this field will be populated.
233 {
234 &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.
235 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
236 {
237 &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).
238 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
239 },
240 ],
241 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
242 },
243 ],
244 &quot;finalProperties&quot;: &quot;A String&quot;, # Output only. The expanded properties of the resource with reference values expanded. Returned as serialized YAML.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]245 },
246 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of the resource as it appears in the YAML config.
247 &quot;url&quot;: &quot;A String&quot;, # Output only. The URL of the actual resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]248 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update timestamp in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]249 },
250 ],
251 }</pre>
252</div>
253
254<div class="method">
255 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
256 <pre>Retrieves the next page of results.
257
258Args:
259 previous_request: The request for the previous page. (required)
260 previous_response: The response from the request for the previous page. (required)
261
262Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]263 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]264 page. Returns None if there are no more items in the collection.
265 </pre>
266</div>
267
268</body></html>