Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0669410c6b2c48884ae31671b9d710a9ff6346c6 / . / docs / dyn / deploymentmanager_v2.resources.html
blob: 968a37f09bb173d0748c0379190f56a0418fb50a [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">
78 <code><a href="#get">get(project, deployment, resource)</a></code></p>
79<p class="firstline">Gets information about a single resource.</p>
80<p class="toc_element">
81 <code><a href="#list">list(project, deployment, maxResults=None, pageToken=None, filter=None)</a></code></p>
82<p class="firstline">Lists all resources in a given deployment.</p>
83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="get">get(project, deployment, resource)</code>
89 <pre>Gets information about a single resource.
90
91Args:
92 project: string, The project ID for this request. (required)
93 deployment: string, The name of the deployment for this request. (required)
94 resource: string, The name of the resource for this request. (required)
95
96Returns:
97 An object of the form:
98
99 {
100 "finalProperties": "A String", # [Output Only] The evaluated properties of the resource with references expanded. Returned as serialized YAML.
101 "updateTime": "A String", # [Output Only] Timestamp when the resource was updated, in RFC3339 text format .
102 "name": "A String", # [Output Only] The name of the resource as it appears in the YAML config.
103 "warnings": [ # [Output Only] If warning messages are generated during processing of this resource, this field will be populated.
104 {
105 "message": "A String", # [Output Only] Optional human-readable details for this warning.
106 "code": "A String", # [Output Only] The warning type identifier for this warning.
107 "data": [ # [Output Only] Metadata for this warning in key: value format.
108 {
109 "value": "A String", # [Output Only] A warning data value corresponding to the key.
110 "key": "A String", # [Output Only] A key for the warning data.
111 },
112 ],
113 },
114 ],
115 "url": "A String", # [Output Only] The URL of the actual resource.
116 "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here.
117 "finalProperties": "A String", # [Output Only] The expanded properties of the resource with reference values expanded. Returned as serialized YAML.
118 "warnings": [ # [Output Only] If warning messages are generated during processing of this resource, this field will be populated.
119 {
120 "message": "A String", # [Output Only] Optional human-readable details for this warning.
121 "code": "A String", # [Output Only] The warning type identifier for this warning.
122 "data": [ # [Output Only] Metadata for this warning in key: value format.
123 {
124 "value": "A String", # [Output Only] A warning data value corresponding to the key.
125 "key": "A String", # [Output Only] A key for the warning data.
126 },
127 ],
128 },
129 ],
130 "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this resource.
131 "state": "A String", # [Output Only] The state of the resource.
132 "intent": "A String", # [Output Only] The intent of the resource: PREVIEW, UPDATE, or CANCEL.
133 "error": { # [Output Only] If errors are generated during update of the resource, this field will be populated.
134 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
135 {
136 "message": "A String", # [Output Only] An optional, human-readable error message.
137 "code": "A String", # [Output Only] The error type identifier for this error.
138 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
139 },
140 ],
141 },
142 "properties": "A String", # [Output Only] The set of updated properties for this resource, before references are expanded. Returned as serialized YAML.
143 },
144 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
145 "insertTime": "A String", # [Output Only] Timestamp when the resource was created or acquired, in RFC3339 text format .
146 "manifest": "A String", # [Output Only] URL of the manifest representing the current configuration of this resource.
147 "type": "A String", # [Output Only] The type of the resource, for example compute.v1.instance, or replicaPools.v1beta2.instanceGroupManager.
148 "properties": "A String", # [Output Only] The current properties of the resource before any references have been filled in. Returned as serialized YAML.
149 }</pre>
150</div>
151
152<div class="method">
153 <code class="details" id="list">list(project, deployment, maxResults=None, pageToken=None, filter=None)</code>
154 <pre>Lists all resources in a given deployment.
155
156Args:
157 project: string, The project ID for this request. (required)
158 deployment: string, The name of the deployment for this request. (required)
159 maxResults: integer, Maximum count of results to be returned.
160 pageToken: string, Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.
161 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.
162
163The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
164
165For example, filter=name ne example-instance.
166
167Returns:
168 An object of the form:
169
170 { # A response containing a partial list of resources and a page token used to build the next request if the request has been truncated.
171 "nextPageToken": "A String", # A token used to continue a truncated list request.
172 "resources": [ # Resources contained in this list response.
173 {
174 "finalProperties": "A String", # [Output Only] The evaluated properties of the resource with references expanded. Returned as serialized YAML.
175 "updateTime": "A String", # [Output Only] Timestamp when the resource was updated, in RFC3339 text format .
176 "name": "A String", # [Output Only] The name of the resource as it appears in the YAML config.
177 "warnings": [ # [Output Only] If warning messages are generated during processing of this resource, this field will be populated.
178 {
179 "message": "A String", # [Output Only] Optional human-readable details for this warning.
180 "code": "A String", # [Output Only] The warning type identifier for this warning.
181 "data": [ # [Output Only] Metadata for this warning in key: value format.
182 {
183 "value": "A String", # [Output Only] A warning data value corresponding to the key.
184 "key": "A String", # [Output Only] A key for the warning data.
185 },
186 ],
187 },
188 ],
189 "url": "A String", # [Output Only] The URL of the actual resource.
190 "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here.
191 "finalProperties": "A String", # [Output Only] The expanded properties of the resource with reference values expanded. Returned as serialized YAML.
192 "warnings": [ # [Output Only] If warning messages are generated during processing of this resource, this field will be populated.
193 {
194 "message": "A String", # [Output Only] Optional human-readable details for this warning.
195 "code": "A String", # [Output Only] The warning type identifier for this warning.
196 "data": [ # [Output Only] Metadata for this warning in key: value format.
197 {
198 "value": "A String", # [Output Only] A warning data value corresponding to the key.
199 "key": "A String", # [Output Only] A key for the warning data.
200 },
201 ],
202 },
203 ],
204 "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this resource.
205 "state": "A String", # [Output Only] The state of the resource.
206 "intent": "A String", # [Output Only] The intent of the resource: PREVIEW, UPDATE, or CANCEL.
207 "error": { # [Output Only] If errors are generated during update of the resource, this field will be populated.
208 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
209 {
210 "message": "A String", # [Output Only] An optional, human-readable error message.
211 "code": "A String", # [Output Only] The error type identifier for this error.
212 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
213 },
214 ],
215 },
216 "properties": "A String", # [Output Only] The set of updated properties for this resource, before references are expanded. Returned as serialized YAML.
217 },
218 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
219 "insertTime": "A String", # [Output Only] Timestamp when the resource was created or acquired, in RFC3339 text format .
220 "manifest": "A String", # [Output Only] URL of the manifest representing the current configuration of this resource.
221 "type": "A String", # [Output Only] The type of the resource, for example compute.v1.instance, or replicaPools.v1beta2.instanceGroupManager.
222 "properties": "A String", # [Output Only] The current properties of the resource before any references have been filled in. Returned as serialized YAML.
223 },
224 ],
225 }</pre>
226</div>
227
228<div class="method">
229 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
230 <pre>Retrieves the next page of results.
231
232Args:
233 previous_request: The request for the previous page. (required)
234 previous_response: The response from the request for the previous page. (required)
235
236Returns:
237 A request object that you can call 'execute()' on to request the next
238 page. Returns None if there are no more items in the collection.
239 </pre>
240</div>
241
242</body></html>