Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 386cc8b06b57c3d4a564fe0ab0d1e51fc34270a8 / . / docs / dyn / deploymentmanager_v2.manifests.html
blob: 710aeaa23ca07b3c989256d520bb8385718819b8 [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.manifests.html">manifests</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(project, deployment, manifest)</a></code></p>
79<p class="firstline">Gets information about a specific manifest.</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 manifests for 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, manifest)</code>
89 <pre>Gets information about a specific manifest.
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 manifest: string, The name of the manifest for this request. (required)
95
96Returns:
97 An object of the form:
98
99 {
100 "layout": "A String", # [Output Only] The YAML layout for this manifest.
101 "name": "A String", # [Output Only] The name of the manifest.
102 "expandedConfig": "A String", # [Output Only] The fully-expanded configuration file, including any templates and references.
103 "imports": [ # [Output Only] The imported files for this manifest.
104 {
105 "content": "A String", # The contents of the file.
106 "name": "A String", # The name of the file.
107 },
108 ],
109 "insertTime": "A String", # [Output Only] Timestamp when the manifest was created, in RFC3339 text format.
110 "config": { # [Output Only] The YAML configuration for this manifest.
111 "content": "A String", # The contents of the file.
112 },
113 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
114 "selfLink": "A String", # [Output Only] Self link for the manifest.
115 }</pre>
116</div>
117
118<div class="method">
119 <code class="details" id="list">list(project, deployment, maxResults=None, pageToken=None, filter=None)</code>
120 <pre>Lists all manifests for a given deployment.
121
122Args:
123 project: string, The project ID for this request. (required)
124 deployment: string, The name of the deployment for this request. (required)
125 maxResults: integer, Maximum count of results to be returned.
126 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.
127 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.
128
129The 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.
130
131For example, filter=name ne example-instance.
132
133Returns:
134 An object of the form:
135
136 { # A response containing a partial list of manifests and a page token used to build the next request if the request has been truncated.
137 "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
138 "manifests": [ # [Output Only] Manifests contained in this list response.
139 {
140 "layout": "A String", # [Output Only] The YAML layout for this manifest.
141 "name": "A String", # [Output Only] The name of the manifest.
142 "expandedConfig": "A String", # [Output Only] The fully-expanded configuration file, including any templates and references.
143 "imports": [ # [Output Only] The imported files for this manifest.
144 {
145 "content": "A String", # The contents of the file.
146 "name": "A String", # The name of the file.
147 },
148 ],
149 "insertTime": "A String", # [Output Only] Timestamp when the manifest was created, in RFC3339 text format.
150 "config": { # [Output Only] The YAML configuration for this manifest.
151 "content": "A String", # The contents of the file.
152 },
153 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
154 "selfLink": "A String", # [Output Only] Self link for the manifest.
155 },
156 ],
157 }</pre>
158</div>
159
160<div class="method">
161 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
162 <pre>Retrieves the next page of results.
163
164Args:
165 previous_request: The request for the previous page. (required)
166 previous_response: The response from the request for the previous page. (required)
167
168Returns:
169 A request object that you can call 'execute()' on to request the next
170 page. Returns None if there are no more items in the collection.
171 </pre>
172</div>
173
174</body></html>