• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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_v1.html">Kubernetes Engine API</a> . <a href="container_v1.projects.html">projects</a> . <a href="container_v1.projects.aggregated.html">aggregated</a> . <a href="container_v1.projects.aggregated.usableSubnetworks.html">usableSubnetworks</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</a></code></p>
79<p class="firstline">Lists subnetworks that are usable for creating clusters in a project.</p>
80<p class="toc_element">
81  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<h3>Method Details</h3>
84<div class="method">
85    <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code>
86  <pre>Lists subnetworks that are usable for creating clusters in a project.
87
88Args:
89  parent: string, The parent project where subnetworks are usable.
90Specified in the format 'projects/*'. (required)
91  pageToken: string, Specifies a page token to use. Set this to the nextPageToken returned by
92previous list requests to get the next page of results.
93  x__xgafv: string, V1 error format.
94    Allowed values
95      1 - v1 error format
96      2 - v2 error format
97  pageSize: integer, The max number of results per page that should be returned. If the number
98of available results is larger than `page_size`, a `next_page_token` is
99returned which can be used to get the next page of results in subsequent
100requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
101  filter: string, Filtering currently only supports equality on the networkProjectId and must
102be in the form: "networkProjectId=[PROJECTID]", where `networkProjectId`
103is the project which owns the listed subnetworks. This defaults to the
104parent project ID.
105
106Returns:
107  An object of the form:
108
109    { # ListUsableSubnetworksResponse is the response of
110      # ListUsableSubnetworksRequest.
111    "nextPageToken": "A String", # This token allows you to get the next page of results for list requests.
112        # If the number of results is larger than `page_size`, use the
113        # `next_page_token` as a value for the query parameter `page_token` in the
114        # next request. The value will become empty when there are no more pages.
115    "subnetworks": [ # A list of usable subnetworks in the specified network project.
116      { # UsableSubnetwork resource returns the subnetwork name, its associated network
117          # and the primary CIDR range.
118        "secondaryIpRanges": [ # Secondary IP ranges.
119          { # Secondary IP range of a usable subnetwork.
120            "status": "A String", # This field is to determine the status of the secondary range programmably.
121            "ipCidrRange": "A String", # The range of IP addresses belonging to this subnetwork secondary range.
122            "rangeName": "A String", # The name associated with this subnetwork secondary range, used when adding
123                # an alias IP range to a VM instance.
124          },
125        ],
126        "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork.
127        "subnetwork": "A String", # Subnetwork Name.
128            # Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
129        "statusMessage": "A String", # A human readable status message representing the reasons for cases where
130            # the caller cannot use the secondary ranges under the subnet. For example if
131            # the secondary_ip_ranges is empty due to a permission issue, an insufficient
132            # permission message will be given by status_message.
133        "network": "A String", # Network Name.
134            # Example: projects/my-project/global/networks/my-network
135      },
136    ],
137  }</pre>
138</div>
139
140<div class="method">
141    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
142  <pre>Retrieves the next page of results.
143
144Args:
145  previous_request: The request for the previous page. (required)
146  previous_response: The response from the request for the previous page. (required)
147
148Returns:
149  A request object that you can call 'execute()' on to request the next
150  page. Returns None if there are no more items in the collection.
151    </pre>
152</div>
153
154</body></html>