Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0915761b342e18fdf56f7e1ac174ca736f679ed1 / . / docs / dyn / deploymentmanager_v2beta1.resources.html
blob: 610a6d8f801469def820545960b3b51102d11aee [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.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, pageToken=None, maxResults=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 "errors": [ # [Output Only] A list of any errors that occurred during deployment.
101 "A String",
102 ],
103 "name": "A String", # [Output Only] The name of the resource as it appears in the YAML config.
104 "url": "A String", # [Output Only] The URL of the actual resource.
105 "manifest": "A String", # [Output Only] URL of the manifest representing the current configuration of this resource.
106 "state": "A String", # [Output Only] The state of the resource.
107 "intent": "A String", # [Output Only] The intended state of the resource.
108 "type": "A String", # [Output Only] The type of the resource, for example ?compute.v1.instance?, or ?replicaPools.v1beta2.instanceGroupManager?
109 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
110 }</pre>
111</div>
112
113<div class="method">
114 <code class="details" id="list">list(project, deployment, pageToken=None, maxResults=None)</code>
115 <pre>Lists all resources in a given deployment.
116
117Args:
118 project: string, The project ID for this request. (required)
119 deployment: string, The name of the deployment for this request. (required)
120 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.
121 maxResults: integer, Maximum count of results to be returned. Acceptable values are 0 to 100, inclusive. (Default: 50)
122
123Returns:
124 An object of the form:
125
126 { # A response containing a partial list of resources and a page token used to build the next request if the request has been truncated.
127 "nextPageToken": "A String", # A token used to continue a truncated list request.
128 "resources": [ # Resources contained in this list response.
129 {
130 "errors": [ # [Output Only] A list of any errors that occurred during deployment.
131 "A String",
132 ],
133 "name": "A String", # [Output Only] The name of the resource as it appears in the YAML config.
134 "url": "A String", # [Output Only] The URL of the actual resource.
135 "manifest": "A String", # [Output Only] URL of the manifest representing the current configuration of this resource.
136 "state": "A String", # [Output Only] The state of the resource.
137 "intent": "A String", # [Output Only] The intended state of the resource.
138 "type": "A String", # [Output Only] The type of the resource, for example ?compute.v1.instance?, or ?replicaPools.v1beta2.instanceGroupManager?
139 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
140 },
141 ],
142 }</pre>
143</div>
144
145<div class="method">
146 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
147 <pre>Retrieves the next page of results.
148
149Args:
150 previous_request: The request for the previous page. (required)
151 previous_response: The response from the request for the previous page. (required)
152
153Returns:
154 A request object that you can call 'execute()' on to request the next
155 page. Returns None if there are no more items in the collection.
156 </pre>
157</div>
158
159</body></html>