Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3e17f8990db54bec16c48c319072799a14f5a53f / . / docs / dyn / container_v1beta1.projects.locations.html
blob: 430de9ed18a8c907f7ffe2d46c9c39a8537bd094 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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="container_v1beta1.html">Kubernetes Engine API</a> . <a href="container_v1beta1.projects.html">projects</a> . <a href="container_v1beta1.projects.locations.html">locations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="container_v1beta1.projects.locations.clusters.html">clusters()</a></code>
79</p>
80<p class="firstline">Returns the clusters Resource.</p>
81
82<p class="toc_element">
83 <code><a href="container_v1beta1.projects.locations.operations.html">operations()</a></code>
84</p>
85<p class="firstline">Returns the operations Resource.</p>
86
87<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]88 <code><a href="#close">close()</a></code></p>
89<p class="firstline">Close httplib2 connections.</p>
90<p class="toc_element">
91 <code><a href="#getServerConfig">getServerConfig(name, zone=None, projectId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]92<p class="firstline">Returns configuration info about the Google Kubernetes Engine service.</p>
93<p class="toc_element">
94 <code><a href="#list">list(parent, x__xgafv=None)</a></code></p>
95<p class="firstline">Fetches locations that offer Google Kubernetes Engine.</p>
96<h3>Method Details</h3>
97<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]98 <code class="details" id="close">close()</code>
99 <pre>Close httplib2 connections.</pre>
100</div>
101
102<div class="method">
103 <code class="details" id="getServerConfig">getServerConfig(name, zone=None, projectId=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]104 <pre>Returns configuration info about the Google Kubernetes Engine service.
105
106Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]107 name: string, The name (project and location) of the server config to get, specified in the format `projects/*/locations/*`. (required)
108 zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field.
109 projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]110 x__xgafv: string, V1 error format.
111 Allowed values
112 1 - v1 error format
113 2 - v2 error format
114
115Returns:
116 An object of the form:
117
118 { # Kubernetes Engine service configuration.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]119 &quot;validMasterVersions&quot;: [ # List of valid master versions, in descending order.
120 &quot;A String&quot;,
121 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]122 &quot;channels&quot;: [ # List of release channel configurations.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]123 { # ReleaseChannelConfig exposes configuration for a release channel.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]124 &quot;validVersions&quot;: [ # List of valid versions for the channel.
125 &quot;A String&quot;,
126 ],
127 &quot;defaultVersion&quot;: &quot;A String&quot;, # The default version for newly created clusters on the channel.
128 &quot;availableVersions&quot;: [ # Deprecated. This field has been deprecated and replaced with the valid_versions field.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]129 { # Deprecated.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]130 &quot;reason&quot;: &quot;A String&quot;, # Reason for availability.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]131 &quot;version&quot;: &quot;A String&quot;, # Kubernetes version.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]132 },
133 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]134 &quot;channel&quot;: &quot;A String&quot;, # The release channel this configuration applies to.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]135 },
136 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]137 &quot;defaultImageType&quot;: &quot;A String&quot;, # Default image type.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]138 &quot;defaultClusterVersion&quot;: &quot;A String&quot;, # Version of Kubernetes the service deploys by default.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]139 &quot;validNodeVersions&quot;: [ # List of valid node upgrade target versions, in descending order.
140 &quot;A String&quot;,
141 ],
142 &quot;validImageTypes&quot;: [ # List of valid image types.
143 &quot;A String&quot;,
144 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]145 }</pre>
146</div>
147
148<div class="method">
149 <code class="details" id="list">list(parent, x__xgafv=None)</code>
150 <pre>Fetches locations that offer Google Kubernetes Engine.
151
152Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]153 parent: string, Required. Contains the name of the resource requested. Specified in the format `projects/*`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]154 x__xgafv: string, V1 error format.
155 Allowed values
156 1 - v1 error format
157 2 - v2 error format
158
159Returns:
160 An object of the form:
161
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]162 { # ListLocationsResponse returns the list of all GKE locations and their recommendation state.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]163 &quot;locations&quot;: [ # A full list of GKE locations.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]164 { # Location returns the location name, and if the location is recommended for GKE cluster scheduling.
165 &quot;name&quot;: &quot;A String&quot;, # Contains the name of the resource requested. Specified in the format `projects/*/locations/*`.
166 &quot;type&quot;: &quot;A String&quot;, # Contains the type of location this Location is for. Regional or Zonal.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]167 &quot;recommended&quot;: True or False, # Whether the location is recomended for GKE cluster scheduling.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]168 },
169 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]170 &quot;nextPageToken&quot;: &quot;A String&quot;, # Only return ListLocationsResponse that occur after the page_token. This value should be populated from the ListLocationsResponse.next_page_token if that response token was set (which happens when listing more Locations than fit in a single ListLocationsResponse).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]171 }</pre>
172</div>
173
174</body></html>