blob: 1d3e812609e122cb15be6893fca364bc4f114f50 [file] [log] [blame]
yoshi-code-bot466c9a92021-11-22 23:24:31 -08001<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="clouddeploy_v1.html">Google Cloud Deploy API</a> . <a href="clouddeploy_v1.projects.html">projects</a> . <a href="clouddeploy_v1.projects.locations.html">locations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="clouddeploy_v1.projects.locations.deliveryPipelines.html">deliveryPipelines()</a></code>
79</p>
80<p class="firstline">Returns the deliveryPipelines Resource.</p>
81
82<p class="toc_element">
83 <code><a href="clouddeploy_v1.projects.locations.operations.html">operations()</a></code>
84</p>
85<p class="firstline">Returns the operations Resource.</p>
86
87<p class="toc_element">
88 <code><a href="clouddeploy_v1.projects.locations.targets.html">targets()</a></code>
89</p>
90<p class="firstline">Returns the targets Resource.</p>
91
92<p class="toc_element">
93 <code><a href="#close">close()</a></code></p>
94<p class="firstline">Close httplib2 connections.</p>
95<p class="toc_element">
96 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
97<p class="firstline">Gets information about a location.</p>
98<p class="toc_element">
99 <code><a href="#getConfig">getConfig(name, x__xgafv=None)</a></code></p>
100<p class="firstline">Gets the configuration for a location.</p>
101<p class="toc_element">
102 <code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
103<p class="firstline">Lists information about the supported locations for this service.</p>
104<p class="toc_element">
105 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
106<p class="firstline">Retrieves the next page of results.</p>
107<h3>Method Details</h3>
108<div class="method">
109 <code class="details" id="close">close()</code>
110 <pre>Close httplib2 connections.</pre>
111</div>
112
113<div class="method">
114 <code class="details" id="get">get(name, x__xgafv=None)</code>
115 <pre>Gets information about a location.
116
117Args:
118 name: string, Resource name for the location. (required)
119 x__xgafv: string, V1 error format.
120 Allowed values
121 1 - v1 error format
122 2 - v2 error format
123
124Returns:
125 An object of the form:
126
127 { # A resource that represents Google Cloud Platform location.
128 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
129 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
130 &quot;a_key&quot;: &quot;A String&quot;,
131 },
132 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
133 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
134 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
135 },
136 &quot;name&quot;: &quot;A String&quot;, # Resource name for the location, which may vary between implementations. For example: `&quot;projects/example-project/locations/us-east1&quot;`
137}</pre>
138</div>
139
140<div class="method">
141 <code class="details" id="getConfig">getConfig(name, x__xgafv=None)</code>
142 <pre>Gets the configuration for a location.
143
144Args:
145 name: string, Required. Name of requested configuration. (required)
146 x__xgafv: string, V1 error format.
147 Allowed values
148 1 - v1 error format
149 2 - v2 error format
150
151Returns:
152 An object of the form:
153
154 { # Service-wide configuration.
155 &quot;defaultSkaffoldVersion&quot;: &quot;A String&quot;, # Output only. Default Skaffold version that is assigned when a Release is created without specifying a Skaffold version.
156 &quot;name&quot;: &quot;A String&quot;, # Name of the configuration.
157 &quot;supportedVersions&quot;: [ # Output only. All supported versions of Skaffold.
158 { # Details of a supported Skaffold version.
159 &quot;supportEndDate&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`. # Date when this version is expected to no longer be supported.
160 &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.
161 &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.
162 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
163 },
164 &quot;version&quot;: &quot;A String&quot;, # Release version number. For example, &quot;1.20.3&quot;.
165 },
166 ],
167}</pre>
168</div>
169
170<div class="method">
171 <code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
172 <pre>Lists information about the supported locations for this service.
173
174Args:
175 name: string, The resource that owns the locations collection, if applicable. (required)
176 filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like &quot;displayName=tokyo&quot;, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
177 pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
178 pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
179 x__xgafv: string, V1 error format.
180 Allowed values
181 1 - v1 error format
182 2 - v2 error format
183
184Returns:
185 An object of the form:
186
187 { # The response message for Locations.ListLocations.
188 &quot;locations&quot;: [ # A list of locations that matches the specified filter in the request.
189 { # A resource that represents Google Cloud Platform location.
190 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
191 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
192 &quot;a_key&quot;: &quot;A String&quot;,
193 },
194 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
195 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
196 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
197 },
198 &quot;name&quot;: &quot;A String&quot;, # Resource name for the location, which may vary between implementations. For example: `&quot;projects/example-project/locations/us-east1&quot;`
199 },
200 ],
201 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
202}</pre>
203</div>
204
205<div class="method">
206 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
207 <pre>Retrieves the next page of results.
208
209Args:
210 previous_request: The request for the previous page. (required)
211 previous_response: The response from the request for the previous page. (required)
212
213Returns:
214 A request object that you can call &#x27;execute()&#x27; on to request the next
215 page. Returns None if there are no more items in the collection.
216 </pre>
217</div>
218
219</body></html>