Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 05f19320b0d5d888db81e84d84582fce6daafe6c / . / docs / dyn / deploymentmanager_v2beta2.resources.html
blob: e98adf252139bb47540246bd7317dac0f5dfb953 [file] [log] [blame]
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[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_v2beta2.html">Google Cloud Deployment Manager API V2</a> . <a href="deploymentmanager_v2beta2.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 "url": "A String", # [Output Only] The URL of the actual resource.
104 "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here.
105 "finalProperties": "A String", # [Output Only] The expanded properties of the resource with reference values expanded. Returned as serialized YAML.
106 "errors": [ # [Output Only] List of all errors encountered while trying to enact update.intent.
107 "A String",
108 ],
109 "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this resource.
110 "state": "A String", # [Output Only] The state of the resource.
111 "intent": "A String", # [Output Only] The intent of the resource, PREVIEW, UPDATE, or CANCEL.
112 "properties": "A String", # [Output Only] The set of updated properties for this resource, before references are expanded. Returned as serialized YAML.
113 },
114 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
115 "insertTime": "A String", # [Output Only] Timestamp when the resource was created or acquired, in RFC3339 text format .
116 "manifest": "A String", # [Output Only] URL of the manifest representing the current configuration of this resource.
117 "type": "A String", # [Output Only] The type of the resource, for example ?compute.v1.instance?, or ?replicaPools.v1beta2.instanceGroupManager?
118 "properties": "A String", # [Output Only] The current properties of the resource before any references have been filled in. Returned as serialized YAML.
119 }</pre>
120</div>
121
122<div class="method">
123 <code class="details" id="list">list(project, deployment, maxResults=None, pageToken=None, filter=None)</code>
124 <pre>Lists all resources in a given deployment.
125
126Args:
127 project: string, The project ID for this request. (required)
128 deployment: string, The name of the deployment for this request. (required)
129 maxResults: integer, Maximum count of results to be returned.
130 pageToken: string, Tag returned by a previous list request when that list was truncated to maxResults. Used to continue a previous list request.
131 filter: string, Filter expression for filtering listed resources.
132
133Returns:
134 An object of the form:
135
136 { # A response containing a partial list of resources and a page token used to build the next request if the request has been truncated.
137 "nextPageToken": "A String", # A token used to continue a truncated list request.
138 "resources": [ # Resources contained in this list response.
139 {
140 "finalProperties": "A String", # [Output Only] The evaluated properties of the resource with references expanded. Returned as serialized YAML.
141 "updateTime": "A String", # [Output Only] Timestamp when the resource was updated, in RFC3339 text format .
142 "name": "A String", # [Output Only] The name of the resource as it appears in the YAML config.
143 "url": "A String", # [Output Only] The URL of the actual resource.
144 "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here.
145 "finalProperties": "A String", # [Output Only] The expanded properties of the resource with reference values expanded. Returned as serialized YAML.
146 "errors": [ # [Output Only] List of all errors encountered while trying to enact update.intent.
147 "A String",
148 ],
149 "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this resource.
150 "state": "A String", # [Output Only] The state of the resource.
151 "intent": "A String", # [Output Only] The intent of the resource, PREVIEW, UPDATE, or CANCEL.
152 "properties": "A String", # [Output Only] The set of updated properties for this resource, before references are expanded. Returned as serialized YAML.
153 },
154 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
155 "insertTime": "A String", # [Output Only] Timestamp when the resource was created or acquired, in RFC3339 text format .
156 "manifest": "A String", # [Output Only] URL of the manifest representing the current configuration of this resource.
157 "type": "A String", # [Output Only] The type of the resource, for example ?compute.v1.instance?, or ?replicaPools.v1beta2.instanceGroupManager?
158 "properties": "A String", # [Output Only] The current properties of the resource before any references have been filled in. Returned as serialized YAML.
159 },
160 ],
161 }</pre>
162</div>
163
164<div class="method">
165 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
166 <pre>Retrieves the next page of results.
167
168Args:
169 previous_request: The request for the previous page. (required)
170 previous_response: The response from the request for the previous page. (required)
171
172Returns:
173 A request object that you can call 'execute()' on to request the next
174 page. Returns None if there are no more items in the collection.
175 </pre>
176</div>
177
178</body></html>