Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0915761b342e18fdf56f7e1ac174ca736f679ed1 / . / docs / dyn / deploymentmanager_v2beta1.deployments.html
blob: 2dfdbb68c49caada3ec273ad4e592cc097c47d7d [file] [log] [blame]
Craig Citroe633be12015-03-02 13:40:36 -0800[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_v2beta1.html">Google Cloud Deployment Manager API V2</a> . <a href="deploymentmanager_v2beta1.deployments.html">deployments</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(project, deployment)</a></code></p>
79<p class="firstline">Deletes a deployment and all of the resources in the deployment.</p>
80<p class="toc_element">
81 <code><a href="#get">get(project, deployment)</a></code></p>
82<p class="firstline">Gets information about a specific deployment.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(project, body)</a></code></p>
85<p class="firstline">Creates a deployment and all of the resources described by the deployment manifest.</p>
86<p class="toc_element">
87 <code><a href="#list">list(project, pageToken=None, maxResults=None)</a></code></p>
88<p class="firstline">Lists all deployments for a given project.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="delete">delete(project, deployment)</code>
95 <pre>Deletes a deployment and all of the resources in the deployment.
96
97Args:
98 project: string, The project ID for this request. (required)
99 deployment: string, The name of the deployment for this request. (required)
100
101Returns:
102 An object of the form:
103
104 { # An operation resource, used to manage asynchronous API requests.
105 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
106 "name": "A String", # [Output Only] Name of the operation.
107 "warnings": [ # [Output Only] If warning messages generated during processing of this operation, this field will be populated.
108 {
109 "message": "A String", # Optional human-readable details for this warning.
110 "code": "", # The warning type identifier for this warning.
111 "data": [ # Metadata for this warning in 'key: value' format.
112 {
113 "value": "A String", # A warning data value corresponding to the key.
114 "key": "A String", # A key for the warning data.
115 },
116 ],
117 },
118 ],
119 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
120 "httpErrorStatusCode": 42, # [Output Only] If operation fails, the HTTP error status code returned, e.g. 404.
121 "user": "A String", # [Output Only] User who requested the operation, for example "user@example.com"
122 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
123 "errors": [ # The array of errors encountered while processing this operation.
124 {
125 "message": "A String", # An optional, human-readable error message.
126 "code": "A String", # The error type identifier for this error.
127 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
128 },
129 ],
130 },
131 "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
132 "operationType": "A String", # [Output Only] Type of the operation. Examples include "insert", or "delete"
133 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
134 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
135 "httpErrorMessage": "A String", # [Output Only] If operation fails, the HTTP error message returned, e.g. NOT FOUND.
136 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
137 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 format.
138 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
139 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
140 "selfLink": "A String", # [Output Only] Self link for the manifest.
141 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
142 }</pre>
143</div>
144
145<div class="method">
146 <code class="details" id="get">get(project, deployment)</code>
147 <pre>Gets information about a specific deployment.
148
149Args:
150 project: string, The project ID for this request. (required)
151 deployment: string, The name of the deployment for this request. (required)
152
153Returns:
154 An object of the form:
155
156 {
157 "targetConfig": "A String", # [Input Only] The YAML configuration to use in processing this deployment.
158 #
159 # When you create a deployment, the server creates a new manifest with the given YAML configuration and sets the `manifest` property to the URL of the manifest resource.
160 "manifest": "A String", # [Output Only] URL of the manifest representing the full configuration of this deployment.
161 "description": "A String", # An optional user-provided description of the deployment.
162 "name": "A String", # The name of the deployment, which must be unique within the project.
163 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
164 }</pre>
165</div>
166
167<div class="method">
168 <code class="details" id="insert">insert(project, body)</code>
169 <pre>Creates a deployment and all of the resources described by the deployment manifest.
170
171Args:
172 project: string, The project ID for this request. (required)
173 body: object, The request body. (required)
174 The object takes the form of:
175
176{
177 "targetConfig": "A String", # [Input Only] The YAML configuration to use in processing this deployment.
178 #
179 # When you create a deployment, the server creates a new manifest with the given YAML configuration and sets the `manifest` property to the URL of the manifest resource.
180 "manifest": "A String", # [Output Only] URL of the manifest representing the full configuration of this deployment.
181 "description": "A String", # An optional user-provided description of the deployment.
182 "name": "A String", # The name of the deployment, which must be unique within the project.
183 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
184 }
185
186
187Returns:
188 An object of the form:
189
190 { # An operation resource, used to manage asynchronous API requests.
191 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
192 "name": "A String", # [Output Only] Name of the operation.
193 "warnings": [ # [Output Only] If warning messages generated during processing of this operation, this field will be populated.
194 {
195 "message": "A String", # Optional human-readable details for this warning.
196 "code": "", # The warning type identifier for this warning.
197 "data": [ # Metadata for this warning in 'key: value' format.
198 {
199 "value": "A String", # A warning data value corresponding to the key.
200 "key": "A String", # A key for the warning data.
201 },
202 ],
203 },
204 ],
205 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
206 "httpErrorStatusCode": 42, # [Output Only] If operation fails, the HTTP error status code returned, e.g. 404.
207 "user": "A String", # [Output Only] User who requested the operation, for example "user@example.com"
208 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
209 "errors": [ # The array of errors encountered while processing this operation.
210 {
211 "message": "A String", # An optional, human-readable error message.
212 "code": "A String", # The error type identifier for this error.
213 "location": "A String", # Indicates the field in the request which caused the error. This property is optional.
214 },
215 ],
216 },
217 "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
218 "operationType": "A String", # [Output Only] Type of the operation. Examples include "insert", or "delete"
219 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
220 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
221 "httpErrorMessage": "A String", # [Output Only] If operation fails, the HTTP error message returned, e.g. NOT FOUND.
222 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
223 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 format.
224 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
225 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
226 "selfLink": "A String", # [Output Only] Self link for the manifest.
227 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
228 }</pre>
229</div>
230
231<div class="method">
232 <code class="details" id="list">list(project, pageToken=None, maxResults=None)</code>
233 <pre>Lists all deployments for a given project.
234
235Args:
236 project: string, The project ID for this request. (required)
237 pageToken: string, Specifies a nextPageToken returned by a previous list request. This token can be used to request the next page of results from a previous list request.
238 maxResults: integer, Maximum count of results to be returned. Acceptable values are 0 to 100, inclusive. (Default: 50)
239
240Returns:
241 An object of the form:
242
243 { # A response containing a partial list of deployments and a page token used to build the next request if the request has been truncated.
244 "nextPageToken": "A String", # A token used to continue a truncated list request.
245 "deployments": [ # The deployments contained in this response.
246 {
247 "targetConfig": "A String", # [Input Only] The YAML configuration to use in processing this deployment.
248 #
249 # When you create a deployment, the server creates a new manifest with the given YAML configuration and sets the `manifest` property to the URL of the manifest resource.
250 "manifest": "A String", # [Output Only] URL of the manifest representing the full configuration of this deployment.
251 "description": "A String", # An optional user-provided description of the deployment.
252 "name": "A String", # The name of the deployment, which must be unique within the project.
253 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
254 },
255 ],
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:
268 A request object that you can call 'execute()' on to request the next
269 page. Returns None if there are no more items in the collection.
270 </pre>
271</div>
272
273</body></html>