blob: abedb81fdc8464fd35ee4394a0e2b3d0329365ad [file] [log] [blame]
Sai Cheemalapatie833b792017-03-24 15:06:46 -07001<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
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070075<h1><a href="deploymentmanager_v2beta.html">Cloud Deployment Manager V2 API</a> . <a href="deploymentmanager_v2beta.manifests.html">manifests</a></h1>
Sai Cheemalapatie833b792017-03-24 15:06:46 -070076<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070081 <code><a href="#get">get(project, deployment, manifest, x__xgafv=None)</a></code></p>
Sai Cheemalapatie833b792017-03-24 15:06:46 -070082<p class="firstline">Gets information about a specific manifest.</p>
83<p class="toc_element">
yoshi-code-botb6dc1b92021-03-02 11:49:08 -080084 <code><a href="#list">list(project, deployment, filter=None, maxResults=None, orderBy=None, pageToken=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatie833b792017-03-24 15:06:46 -070085<p class="firstline">Lists all manifests for a given deployment.</p>
86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070091 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93</div>
94
95<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070096 <code class="details" id="get">get(project, deployment, manifest, x__xgafv=None)</code>
Sai Cheemalapatie833b792017-03-24 15:06:46 -070097 <pre>Gets information about a specific manifest.
98
99Args:
100 project: string, The project ID for this request. (required)
101 deployment: string, The name of the deployment for this request. (required)
102 manifest: string, The name of the manifest for this request. (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700103 x__xgafv: string, V1 error format.
104 Allowed values
105 1 - v1 error format
106 2 - v2 error format
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700107
108Returns:
109 An object of the form:
110
111 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800112 &quot;config&quot;: { # Output only. The YAML configuration for this manifest.
113 &quot;content&quot;: &quot;A String&quot;, # The contents of the file.
114 },
115 &quot;expandedConfig&quot;: &quot;A String&quot;, # Output only. The fully-expanded configuration file, including any templates and references.
116 &quot;id&quot;: &quot;A String&quot;,
117 &quot;imports&quot;: [ # Output only. The imported files for this manifest.
118 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700119 &quot;content&quot;: &quot;A String&quot;, # The contents of the file.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800120 &quot;name&quot;: &quot;A String&quot;, # The name of the file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700121 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800122 ],
123 &quot;insertTime&quot;: &quot;A String&quot;, # Output only. Creation timestamp in RFC3339 text format.
124 &quot;layout&quot;: &quot;A String&quot;, # Output only. The YAML layout for this manifest.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800125 &quot;manifestSizeBytes&quot;: &quot;A String&quot;, # Output only. The computed size of the fully expanded manifest.
126 &quot;manifestSizeLimitBytes&quot;: &quot;A String&quot;, # Output only. The size limit for expanded manifests in the project.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800127 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of the manifest.
128 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. Self link for the manifest.
129}</pre>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700130</div>
131
132<div class="method">
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800133 <code class="details" id="list">list(project, deployment, filter=None, maxResults=None, orderBy=None, pageToken=None, x__xgafv=None)</code>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700134 <pre>Lists all manifests for a given deployment.
135
136Args:
137 project: string, The project ID for this request. (required)
138 deployment: string, The name of the deployment for this request. (required)
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800139 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `&gt;`, or `&lt;`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = &quot;Intel Skylake&quot;) ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = &quot;Intel Skylake&quot;) OR (cpuPlatform = &quot;Intel Broadwell&quot;) AND (scheduling.automaticRestart = true) ```
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800140 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
141 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
142 pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700143 x__xgafv: string, V1 error format.
144 Allowed values
145 1 - v1 error format
146 2 - v2 error format
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700147
148Returns:
149 An object of the form:
150
151 { # A response containing a partial list of manifests and a page token used to build the next request if the request has been truncated.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800152 &quot;manifests&quot;: [ # Output only. Manifests contained in this list response.
153 {
154 &quot;config&quot;: { # Output only. The YAML configuration for this manifest.
155 &quot;content&quot;: &quot;A String&quot;, # The contents of the file.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700156 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800157 &quot;expandedConfig&quot;: &quot;A String&quot;, # Output only. The fully-expanded configuration file, including any templates and references.
158 &quot;id&quot;: &quot;A String&quot;,
159 &quot;imports&quot;: [ # Output only. The imported files for this manifest.
160 {
161 &quot;content&quot;: &quot;A String&quot;, # The contents of the file.
162 &quot;name&quot;: &quot;A String&quot;, # The name of the file.
163 },
164 ],
165 &quot;insertTime&quot;: &quot;A String&quot;, # Output only. Creation timestamp in RFC3339 text format.
166 &quot;layout&quot;: &quot;A String&quot;, # Output only. The YAML layout for this manifest.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800167 &quot;manifestSizeBytes&quot;: &quot;A String&quot;, # Output only. The computed size of the fully expanded manifest.
168 &quot;manifestSizeLimitBytes&quot;: &quot;A String&quot;, # Output only. The size limit for expanded manifests in the project.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800169 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of the manifest.
170 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. Self link for the manifest.
171 },
172 ],
173 &quot;nextPageToken&quot;: &quot;A String&quot;, # Output only. A token used to continue a truncated list request.
174}</pre>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700175</div>
176
177<div class="method">
178 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
179 <pre>Retrieves the next page of results.
180
181Args:
182 previous_request: The request for the previous page. (required)
183 previous_response: The response from the request for the previous page. (required)
184
185Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700186 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700187 page. Returns None if there are no more items in the collection.
188 </pre>
189</div>
190
191</body></html>