Debian Codegraph @

docs/dyn/compute_alpha.networkProfiles.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.networkProfiles.html">networkProfiles</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#get">get(project, networkProfile, x__xgafv=None)</a></code></p>
82 <p class="firstline">Returns the specified network profile.</p>
83 <p class="toc_element">
84 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Retrieves a list of network profiles available to the specified</p>
86 <p class="toc_element">
87 <code><a href="#list_next">list_next()</a></code></p>
88 <p class="firstline">Retrieves the next page of results.</p>
89 <h3>Method Details</h3>
90 <div class="method">
91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93 </div>
94
95 <div class="method">
96 <code class="details" id="get">get(project, networkProfile, x__xgafv=None)</code>
97 <pre>Returns the specified network profile.
98
99 Args:
100 project: string, Project ID for this request. (required)
101 networkProfile: string, Name of the network profile to return. (required)
102 x__xgafv: string, V1 error format.
103 Allowed values
104 1 - v1 error format
105 2 - v2 error format
106
107 Returns:
108 An object of the form:
109
110 { # NetworkProfile represents a Google managed network profile resource.
111 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
112 # text format.
113 &quot;description&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional description of this resource.
114 &quot;features&quot;: { # Output only. [Output Only] Features supported by the network.
115 &quot;addressPurposes&quot;: [ # Specifies what address purposes are supported. If empty, all address
116 # purposes are supported.
117 &quot;A String&quot;,
118 ],
119 &quot;allowAddressCreation&quot;: &quot;A String&quot;, # Specifies whether address creation is allowed.
120 &quot;allowAliasIpRanges&quot;: &quot;A String&quot;, # Specifies whether alias IP ranges (and secondary address ranges) are
121 # allowed.
122 &quot;allowAutoModeSubnet&quot;: &quot;A String&quot;, # Specifies whether auto mode subnet creation is allowed.
123 &quot;allowClassDFirewalls&quot;: &quot;A String&quot;, # Specifies whether firewalls for Class D address ranges are supported.
124 &quot;allowCloudNat&quot;: &quot;A String&quot;, # Specifies whether cloud NAT creation is allowed.
125 &quot;allowCloudRouter&quot;: &quot;A String&quot;, # Specifies whether cloud router creation is allowed.
126 &quot;allowDefaultNicAttachment&quot;: &quot;A String&quot;, # Specifies whether default NIC attachment is allowed.
127 &quot;allowExternalIpAccess&quot;: &quot;A String&quot;, # Specifies whether VMs are allowed to have external IP access on network
128 # interfaces connected to this VPC.
129 &quot;allowFirewallPolicy&quot;: &quot;A String&quot;, # Specifies whether firewall policy can be attached to the network.
130 &quot;allowInterconnect&quot;: &quot;A String&quot;, # Specifies whether Cloud Interconnect creation is allowed.
131 &quot;allowIpForwarding&quot;: &quot;A String&quot;, # Specifies whether IP forwarding is allowed.
132 &quot;allowLoadBalancing&quot;: &quot;A String&quot;, # Specifies whether cloud load balancing is allowed.
133 &quot;allowMultiNicInSameNetwork&quot;: &quot;A String&quot;, # Specifies whether multi-nic in the same network is allowed.
134 &quot;allowMultiNicInSameSubnetwork&quot;: &quot;A String&quot;, # Specifies whether multi-nic in the same subnetwork is allowed.
135 &quot;allowMulticast&quot;: &quot;A String&quot;, # Specifies whether multicast is allowed.
136 &quot;allowNcc&quot;: &quot;A String&quot;, # Specifies whether NCC is allowed.
137 &quot;allowNetworkMigration&quot;: &quot;A String&quot;, # Specifies whether VM network migration is allowed.
138 &quot;allowPacketMirroring&quot;: &quot;A String&quot;, # Specifies whether Packet Mirroring 1.0 is supported.
139 &quot;allowPrivateGoogleAccess&quot;: &quot;A String&quot;, # Specifies whether private Google access is allowed.
140 &quot;allowPsc&quot;: &quot;A String&quot;, # Specifies whether PSC creation is allowed.
141 &quot;allowSameNetworkUnicast&quot;: &quot;A String&quot;, # Specifies whether unicast within the same network is allowed.
142 &quot;allowStaticRoutes&quot;: &quot;A String&quot;, # Specifies whether static route creation is allowed.
143 &quot;allowSubInterfaces&quot;: &quot;A String&quot;, # Specifies whether sub interfaces are allowed.
144 &quot;allowSubnetworkCreation&quot;: &quot;A String&quot;, # Specifies whether subnetwork creation is allowed.
145 &quot;allowVpcFirewallRules&quot;: &quot;A String&quot;, # Specifies whether VPC firewall rules can be created under the network.
146 &quot;allowVpcPeering&quot;: &quot;A String&quot;, # Specifies whether VPC peering is allowed.
147 &quot;allowVpn&quot;: &quot;A String&quot;, # Specifies whether VPN creation is allowed.
148 &quot;firewallPolicyTypes&quot;: [
149 &quot;A String&quot;,
150 ],
151 &quot;interfaceTypes&quot;: [ # If set, limits the interface types that the network supports. If
152 # empty, all interface types are supported.
153 &quot;A String&quot;,
154 ],
155 &quot;multicast&quot;: &quot;A String&quot;, # Specifies which type of multicast is supported.
156 &quot;predefinedNetworkInternalIpv6Range&quot;: &quot;A String&quot;, # Specifies a predefined internal IPv6 range for the network.
157 &quot;predefinedSubnetworkRanges&quot;: [ # Predefined subnetwork ranges for the network.
158 {
159 &quot;ipv6Range&quot;: &quot;A String&quot;, # The IPv6 range of the predefined subnetwork.
160 &quot;namePrefix&quot;: &quot;A String&quot;, # The naming prefix of the predefined subnetwork.
161 },
162 ],
163 &quot;subnetPurposes&quot;: [ # Specifies which subnetwork purposes are supported.
164 &quot;A String&quot;,
165 ],
166 &quot;subnetStackTypes&quot;: [ # Specifies which subnetwork stack types are supported.
167 &quot;A String&quot;,
168 ],
169 &quot;subnetworkPurposes&quot;: [ # Output only. Specifies which subnetwork purposes are supported.
170 &quot;A String&quot;,
171 ],
172 &quot;subnetworkStackTypes&quot;: [ # Output only. Specifies which subnetwork stack types are supported.
173 &quot;A String&quot;,
174 ],
175 &quot;unicast&quot;: &quot;A String&quot;, # Specifies which type of unicast is supported.
176 },
177 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
178 # defined by the server.
179 &quot;kind&quot;: &quot;compute#networkProfile&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkProfile for network profiles.
180 &quot;location&quot;: { # Output only. [Output Only] Location to which the network is restricted.
181 &quot;name&quot;: &quot;A String&quot;,
182 &quot;scope&quot;: &quot;A String&quot;,
183 },
184 &quot;name&quot;: &quot;A String&quot;, # Output only. [Output Only] Name of the resource.
185 &quot;profileType&quot;: { # Output only. [Output Only] Type of the network profile.
186 &quot;networkType&quot;: &quot;A String&quot;,
187 &quot;rdmaSubtype&quot;: &quot;A String&quot;,
188 &quot;ullSubtype&quot;: &quot;A String&quot;,
189 &quot;vpcSubtype&quot;: &quot;A String&quot;,
190 },
191 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
192 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
193 }</pre>
194 </div>
195
196 <div class="method">
197 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
198 <pre>Retrieves a list of network profiles available to the specified
199 project.
200
201 Args:
202 project: string, Project ID for this request. (required)
203 filter: string, A filter expression that filters resources listed in the response. Most
204 Compute resources support two types of filter expressions:
205 expressions that support regular expressions and expressions that follow
206 API improvement proposal AIP-160.
207 These two types of filter expressions cannot be mixed in one request.
208
209 If you want to use AIP-160, your expression must specify the field name, an
210 operator, and the value that you want to use for filtering. The value
211 must be a string, a number, or a boolean. The operator
212 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
213
214 For example, if you are filtering Compute Engine instances, you can
215 exclude instances named `example-instance` by specifying
216 `name != example-instance`.
217
218 The `:*` comparison can be used to test whether a key has been defined.
219 For example, to find all objects with `owner` label use:
220 ```
221 labels.owner:*
222 ```
223
224 You can also filter nested fields. For example, you could specify
225 `scheduling.automaticRestart = false` to include instances only
226 if they are not scheduled for automatic restarts. You can use filtering
227 on nested fields to filter based onresource labels.
228
229 To filter on multiple expressions, provide each separate expression within
230 parentheses. For example:
231 ```
232 (scheduling.automaticRestart = true)
233 (cpuPlatform = &quot;Intel Skylake&quot;)
234 ```
235 By default, each expression is an `AND` expression. However, you
236 can include `AND` and `OR` expressions explicitly.
237 For example:
238 ```
239 (cpuPlatform = &quot;Intel Skylake&quot;) OR
240 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
241 (scheduling.automaticRestart = true)
242 ```
243
244 If you want to use a regular expression, use the `eq` (equal) or `ne`
245 (not equal) operator against a single un-parenthesized expression with or
246 without quotes or against multiple parenthesized expressions. Examples:
247
248 `fieldname eq unquoted literal`
249 `fieldname eq &#x27;single quoted literal&#x27;`
250 `fieldname eq &quot;double quoted literal&quot;`
251 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
252
253 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
254 The literal value must match the entire field.
255
256 For example, to filter for instances that do not end with name &quot;instance&quot;,
257 you would use `name ne .*instance`.
258
259 You cannot combine constraints on multiple fields using regular
260 expressions.
261 maxResults: integer, The maximum number of results per page that should be returned.
262 If the number of available results is larger than `maxResults`,
263 Compute Engine returns a `nextPageToken` that can be used to get
264 the next page of results in subsequent list requests. Acceptable values are
265 `0` to `500`, inclusive. (Default: `500`)
266 orderBy: string, Sorts list results by a certain order. By default, results
267 are returned in alphanumerical order based on the resource name.
268
269 You can also sort results in descending order based on the creation
270 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
271 results based on the `creationTimestamp` field in
272 reverse chronological order (newest result first). Use this to sort
273 resources like operations so that the newest operation is returned first.
274
275 Currently, only sorting by `name` or
276 `creationTimestamp desc` is supported.
277 pageToken: string, Specifies a page token to use. Set `pageToken` to the
278 `nextPageToken` returned by a previous list request to get
279 the next page of results.
280 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
281 of failure. The default value is false.
282
283 For example, when partial success behavior is enabled, aggregatedList for a
284 single zone scope either returns all resources in the zone or no resources,
285 with an error code.
286 x__xgafv: string, V1 error format.
287 Allowed values
288 1 - v1 error format
289 2 - v2 error format
290
291 Returns:
292 An object of the form:
293
294 { # Contains a list of network profiles.
295 &quot;etag&quot;: &quot;A String&quot;,
296 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
297 &quot;items&quot;: [ # A list of NetworkProfile resources.
298 { # NetworkProfile represents a Google managed network profile resource.
299 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
300 # text format.
301 &quot;description&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional description of this resource.
302 &quot;features&quot;: { # Output only. [Output Only] Features supported by the network.
303 &quot;addressPurposes&quot;: [ # Specifies what address purposes are supported. If empty, all address
304 # purposes are supported.
305 &quot;A String&quot;,
306 ],
307 &quot;allowAddressCreation&quot;: &quot;A String&quot;, # Specifies whether address creation is allowed.
308 &quot;allowAliasIpRanges&quot;: &quot;A String&quot;, # Specifies whether alias IP ranges (and secondary address ranges) are
309 # allowed.
310 &quot;allowAutoModeSubnet&quot;: &quot;A String&quot;, # Specifies whether auto mode subnet creation is allowed.
311 &quot;allowClassDFirewalls&quot;: &quot;A String&quot;, # Specifies whether firewalls for Class D address ranges are supported.
312 &quot;allowCloudNat&quot;: &quot;A String&quot;, # Specifies whether cloud NAT creation is allowed.
313 &quot;allowCloudRouter&quot;: &quot;A String&quot;, # Specifies whether cloud router creation is allowed.
314 &quot;allowDefaultNicAttachment&quot;: &quot;A String&quot;, # Specifies whether default NIC attachment is allowed.
315 &quot;allowExternalIpAccess&quot;: &quot;A String&quot;, # Specifies whether VMs are allowed to have external IP access on network
316 # interfaces connected to this VPC.
317 &quot;allowFirewallPolicy&quot;: &quot;A String&quot;, # Specifies whether firewall policy can be attached to the network.
318 &quot;allowInterconnect&quot;: &quot;A String&quot;, # Specifies whether Cloud Interconnect creation is allowed.
319 &quot;allowIpForwarding&quot;: &quot;A String&quot;, # Specifies whether IP forwarding is allowed.
320 &quot;allowLoadBalancing&quot;: &quot;A String&quot;, # Specifies whether cloud load balancing is allowed.
321 &quot;allowMultiNicInSameNetwork&quot;: &quot;A String&quot;, # Specifies whether multi-nic in the same network is allowed.
322 &quot;allowMultiNicInSameSubnetwork&quot;: &quot;A String&quot;, # Specifies whether multi-nic in the same subnetwork is allowed.
323 &quot;allowMulticast&quot;: &quot;A String&quot;, # Specifies whether multicast is allowed.
324 &quot;allowNcc&quot;: &quot;A String&quot;, # Specifies whether NCC is allowed.
325 &quot;allowNetworkMigration&quot;: &quot;A String&quot;, # Specifies whether VM network migration is allowed.
326 &quot;allowPacketMirroring&quot;: &quot;A String&quot;, # Specifies whether Packet Mirroring 1.0 is supported.
327 &quot;allowPrivateGoogleAccess&quot;: &quot;A String&quot;, # Specifies whether private Google access is allowed.
328 &quot;allowPsc&quot;: &quot;A String&quot;, # Specifies whether PSC creation is allowed.
329 &quot;allowSameNetworkUnicast&quot;: &quot;A String&quot;, # Specifies whether unicast within the same network is allowed.
330 &quot;allowStaticRoutes&quot;: &quot;A String&quot;, # Specifies whether static route creation is allowed.
331 &quot;allowSubInterfaces&quot;: &quot;A String&quot;, # Specifies whether sub interfaces are allowed.
332 &quot;allowSubnetworkCreation&quot;: &quot;A String&quot;, # Specifies whether subnetwork creation is allowed.
333 &quot;allowVpcFirewallRules&quot;: &quot;A String&quot;, # Specifies whether VPC firewall rules can be created under the network.
334 &quot;allowVpcPeering&quot;: &quot;A String&quot;, # Specifies whether VPC peering is allowed.
335 &quot;allowVpn&quot;: &quot;A String&quot;, # Specifies whether VPN creation is allowed.
336 &quot;firewallPolicyTypes&quot;: [
337 &quot;A String&quot;,
338 ],
339 &quot;interfaceTypes&quot;: [ # If set, limits the interface types that the network supports. If
340 # empty, all interface types are supported.
341 &quot;A String&quot;,
342 ],
343 &quot;multicast&quot;: &quot;A String&quot;, # Specifies which type of multicast is supported.
344 &quot;predefinedNetworkInternalIpv6Range&quot;: &quot;A String&quot;, # Specifies a predefined internal IPv6 range for the network.
345 &quot;predefinedSubnetworkRanges&quot;: [ # Predefined subnetwork ranges for the network.
346 {
347 &quot;ipv6Range&quot;: &quot;A String&quot;, # The IPv6 range of the predefined subnetwork.
348 &quot;namePrefix&quot;: &quot;A String&quot;, # The naming prefix of the predefined subnetwork.
349 },
350 ],
351 &quot;subnetPurposes&quot;: [ # Specifies which subnetwork purposes are supported.
352 &quot;A String&quot;,
353 ],
354 &quot;subnetStackTypes&quot;: [ # Specifies which subnetwork stack types are supported.
355 &quot;A String&quot;,
356 ],
357 &quot;subnetworkPurposes&quot;: [ # Output only. Specifies which subnetwork purposes are supported.
358 &quot;A String&quot;,
359 ],
360 &quot;subnetworkStackTypes&quot;: [ # Output only. Specifies which subnetwork stack types are supported.
361 &quot;A String&quot;,
362 ],
363 &quot;unicast&quot;: &quot;A String&quot;, # Specifies which type of unicast is supported.
364 },
365 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
366 # defined by the server.
367 &quot;kind&quot;: &quot;compute#networkProfile&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#networkProfile for network profiles.
368 &quot;location&quot;: { # Output only. [Output Only] Location to which the network is restricted.
369 &quot;name&quot;: &quot;A String&quot;,
370 &quot;scope&quot;: &quot;A String&quot;,
371 },
372 &quot;name&quot;: &quot;A String&quot;, # Output only. [Output Only] Name of the resource.
373 &quot;profileType&quot;: { # Output only. [Output Only] Type of the network profile.
374 &quot;networkType&quot;: &quot;A String&quot;,
375 &quot;rdmaSubtype&quot;: &quot;A String&quot;,
376 &quot;ullSubtype&quot;: &quot;A String&quot;,
377 &quot;vpcSubtype&quot;: &quot;A String&quot;,
378 },
379 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
380 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
381 },
382 ],
383 &quot;kind&quot;: &quot;compute#networkProfileList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#networkProfileList for network profiles.
384 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
385 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value
386 # for
387 # the query parameter pageToken in the next list request.
388 # Subsequent list requests will have their own nextPageToken
389 # to
390 # continue paging through the results.
391 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
392 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
393 # end_interface: MixerListResponseWithEtagBuilder
394 &quot;A String&quot;,
395 ],
396 &quot;warning&quot;: { # [Output Only] Informational warning message.
397 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
398 # Engine returns NO_RESULTS_ON_PAGE if there
399 # are no results in the response.
400 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
401 # value format. For example:
402 #
403 # &quot;data&quot;: [
404 # {
405 # &quot;key&quot;: &quot;scope&quot;,
406 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
407 # }
408 {
409 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
410 # returned. For example, for warnings where there are no results in a list
411 # request for a particular zone, this key might be scope and
412 # the key value might be the zone name. Other examples might be a key
413 # indicating a deprecated resource and a suggested replacement, or a
414 # warning about invalid network settings (for example, if an instance
415 # attempts to perform IP forwarding but is not enabled for IP forwarding).
416 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
417 },
418 ],
419 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
420 },
421 }</pre>
422 </div>
423
424 <div class="method">
425 <code class="details" id="list_next">list_next()</code>
426 <pre>Retrieves the next page of results.
427
428 Args:
429 previous_request: The request for the previous page. (required)
430 previous_response: The response from the request for the previous page. (required)
431
432 Returns:
433 A request object that you can call &#x27;execute()&#x27; on to request the next
434 page. Returns None if there are no more items in the collection.
435 </pre>
436 </div>
437
438 </body></html>