Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 650209194f8080f37a5f20846931790f4c70ed46 / . / docs / dyn / deploymentmanager_alpha.manifests.html
blob: db5c3e0790a71403aed25afafeeecc42ca7161ae [file] [log] [blame]
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[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_alpha.html">Google Cloud Deployment Manager Alpha API</a> . <a href="deploymentmanager_alpha.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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]81 <code><a href="#list">list(project, deployment, filter=None, maxResults=None, orderBy=None, pageToken=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]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 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]100 &quot;config&quot;: { # Output only. The YAML configuration for this manifest.
101 &quot;content&quot;: &quot;A String&quot;, # The contents of the file.
102 },
103 &quot;expandedConfig&quot;: &quot;A String&quot;, # Output only. The fully-expanded configuration file, including any templates and references.
104 &quot;id&quot;: &quot;A String&quot;,
105 &quot;imports&quot;: [ # Output only. The imported files for this manifest.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]106 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]107 &quot;content&quot;: &quot;A String&quot;, # The contents of the file.
108 &quot;name&quot;: &quot;A String&quot;, # The name of the file.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]109 },
110 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]111 &quot;insertTime&quot;: &quot;A String&quot;, # Output only. Creation timestamp in RFC3339 text format.
112 &quot;layout&quot;: &quot;A String&quot;, # Output only. The YAML layout for this manifest.
113 &quot;name&quot;: &quot;A String&quot;, # Output only.
114 #
115 # The name of the manifest.
116 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. Self link for the manifest.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]117 }</pre>
118</div>
119
120<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]121 <code class="details" id="list">list(project, deployment, filter=None, maxResults=None, orderBy=None, pageToken=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]122 <pre>Lists all manifests for a given deployment.
123
124Args:
125 project: string, The project ID for this request. (required)
126 deployment: string, The name of the deployment for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]127 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;.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]128
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]129For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]130
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]131You 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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]132
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]133To 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).
134 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)
135 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
136
137You 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.
138
139Currently, only sorting by name or creationTimestamp desc is supported.
140 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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]141
142Returns:
143 An object of the form:
144
145 { # A response containing a partial list of manifests and a page token used to build the next request if the request has been truncated.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]146 &quot;manifests&quot;: [ # Output only. Manifests contained in this list response.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]147 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]148 &quot;config&quot;: { # Output only. The YAML configuration for this manifest.
149 &quot;content&quot;: &quot;A String&quot;, # The contents of the file.
150 },
151 &quot;expandedConfig&quot;: &quot;A String&quot;, # Output only. The fully-expanded configuration file, including any templates and references.
152 &quot;id&quot;: &quot;A String&quot;,
153 &quot;imports&quot;: [ # Output only. The imported files for this manifest.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]154 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]155 &quot;content&quot;: &quot;A String&quot;, # The contents of the file.
156 &quot;name&quot;: &quot;A String&quot;, # The name of the file.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]157 },
158 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]159 &quot;insertTime&quot;: &quot;A String&quot;, # Output only. Creation timestamp in RFC3339 text format.
160 &quot;layout&quot;: &quot;A String&quot;, # Output only. The YAML layout for this manifest.
161 &quot;name&quot;: &quot;A String&quot;, # Output only.
162 #
163 # The name of the manifest.
164 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. Self link for the manifest.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]165 },
166 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]167 &quot;nextPageToken&quot;: &quot;A String&quot;, # Output only. A token used to continue a truncated list request.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]168 }</pre>
169</div>
170
171<div class="method">
172 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
173 <pre>Retrieves the next page of results.
174
175Args:
176 previous_request: The request for the previous page. (required)
177 previous_response: The response from the request for the previous page. (required)
178
179Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]180 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]181 page. Returns None if there are no more items in the collection.
182 </pre>
183</div>
184
185</body></html>