blob: 0956a3e7c001822943886696094b0e578a5dfa73 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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
75<h1><a href="composer_v1.html">Cloud Composer API</a> . <a href="composer_v1.projects.html">projects</a> . <a href="composer_v1.projects.locations.html">locations</a> . <a href="composer_v1.projects.locations.imageVersions.html">imageVersions</a></h1>
76<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">
yoshi-code-botb6dc1b92021-03-02 11:49:08 -080081 <code><a href="#list">list(parent, includePastReleases=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070082<p class="firstline">List ImageVersions for provided location.</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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070088 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90</div>
91
92<div class="method">
yoshi-code-botb6dc1b92021-03-02 11:49:08 -080093 <code class="details" id="list">list(parent, includePastReleases=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070094 <pre>List ImageVersions for provided location.
95
96Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070097 parent: string, List ImageVersions in the given project and location, in the form: &quot;projects/{projectId}/locations/{locationId}&quot; (required)
yoshi-code-botb6dc1b92021-03-02 11:49:08 -080098 includePastReleases: boolean, Whether or not image versions from old releases should be included.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -080099 pageSize: integer, The maximum number of image_versions to return.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800100 pageToken: string, The next_page_token value returned from a previous List request, if any.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700101 x__xgafv: string, V1 error format.
102 Allowed values
103 1 - v1 error format
104 2 - v2 error format
105
106Returns:
107 An object of the form:
108
109 { # The ImageVersions in a project and location.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800110 &quot;imageVersions&quot;: [ # The list of supported ImageVersions in a location.
111 { # ImageVersion information
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800112 &quot;creationDisabled&quot;: True or False, # Whether it is impossible to create an environment with the image version.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800113 &quot;imageVersionId&quot;: &quot;A String&quot;, # The string identifier of the ImageVersion, in the form: &quot;composer-x.y.z-airflow-a.b(.c)&quot;
114 &quot;isDefault&quot;: True or False, # Whether this is the default ImageVersion used by Composer during environment creation if no input ImageVersion is specified.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800115 &quot;releaseDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date of the version release.
116 &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
117 &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
118 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
119 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800120 &quot;supportedPythonVersions&quot;: [ # supported python versions
121 &quot;A String&quot;,
122 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800123 &quot;upgradeDisabled&quot;: True or False, # Whether it is impossible to upgrade an environment running with the image version.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800124 },
125 ],
126 &quot;nextPageToken&quot;: &quot;A String&quot;, # The page token used to query for the next page if one exists.
127}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700128</div>
129
130<div class="method">
131 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
132 <pre>Retrieves the next page of results.
133
134Args:
135 previous_request: The request for the previous page. (required)
136 previous_response: The response from the request for the previous page. (required)
137
138Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700139 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700140 page. Returns None if there are no more items in the collection.
141 </pre>
142</div>
143
144</body></html>