Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / compute_v1.networkEndpointGroups.html
blob: e00b743b54d10db2883b207c9e9850875826f8a0 [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="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.networkEndpointGroups.html">networkEndpointGroups</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
79<p class="firstline">Retrieves the list of network endpoint groups and sorts them by zone.</p>
80<p class="toc_element">
81 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<p class="toc_element">
84 <code><a href="#attachNetworkEndpoints">attachNetworkEndpoints(project, zone, networkEndpointGroup, body, requestId=None)</a></code></p>
85<p class="firstline">Attach a list of network endpoints to the specified network endpoint group.</p>
86<p class="toc_element">
87 <code><a href="#delete">delete(project, zone, networkEndpointGroup, requestId=None)</a></code></p>
88<p class="firstline">Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it.</p>
89<p class="toc_element">
90 <code><a href="#detachNetworkEndpoints">detachNetworkEndpoints(project, zone, networkEndpointGroup, body, requestId=None)</a></code></p>
91<p class="firstline">Detach a list of network endpoints from the specified network endpoint group.</p>
92<p class="toc_element">
93 <code><a href="#get">get(project, zone, networkEndpointGroup)</a></code></p>
94<p class="firstline">Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.</p>
95<p class="toc_element">
96 <code><a href="#insert">insert(project, zone, body, requestId=None)</a></code></p>
97<p class="firstline">Creates a network endpoint group in the specified project using the parameters that are included in the request.</p>
98<p class="toc_element">
99 <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
100<p class="firstline">Retrieves the list of network endpoint groups that are located in the specified project and zone.</p>
101<p class="toc_element">
102 <code><a href="#listNetworkEndpoints">listNetworkEndpoints(project, zone, networkEndpointGroup, body, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
103<p class="firstline">Lists the network endpoints in the specified network endpoint group.</p>
104<p class="toc_element">
105 <code><a href="#listNetworkEndpoints_next">listNetworkEndpoints_next(previous_request, previous_response)</a></code></p>
106<p class="firstline">Retrieves the next page of results.</p>
107<p class="toc_element">
108 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
109<p class="firstline">Retrieves the next page of results.</p>
110<p class="toc_element">
111 <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body)</a></code></p>
112<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
113<h3>Method Details</h3>
114<div class="method">
115 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
116 <pre>Retrieves the list of network endpoint groups and sorts them by zone.
117
118Args:
119 project: string, Project ID for this request. (required)
120 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
121
122You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
123
124Currently, only sorting by name or creationTimestamp desc is supported.
125 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
126 pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
127 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
128
129For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
130
131You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
132
133To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).
134
135Returns:
136 An object of the form:
137
138 {
139 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
140 "kind": "compute#networkEndpointGroupAggregatedList", # [Output Only] The resource type, which is always compute#networkEndpointGroupAggregatedList for aggregated lists of network endpoint groups.
141 "items": { # A list of NetworkEndpointGroupsScopedList resources.
142 "a_key": { # The name of the scope that contains this set of network endpoint groups.
143 "warning": { # [Output Only] An informational warning that replaces the list of network endpoint groups when the list is empty.
144 "message": "A String", # [Output Only] A human-readable description of the warning code.
145 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
146 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
147 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
148 {
149 "value": "A String", # [Output Only] A warning data value corresponding to the key.
150 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
151 },
152 ],
153 },
154 "networkEndpointGroups": [ # [Output Only] The list of network endpoint groups that are contained in this scope.
155 { # Represents a collection of network endpoints.
156 "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
157 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
158 "zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located.
159 "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint.
160 "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Currently the only supported value is GCE_VM_IP_PORT.
161 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
162 "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong.
163 "size": 42, # [Output only] Number of network endpoints in the network endpoint group.
164 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
165 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
166 "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified.
167 "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
168 },
169 ],
170 },
171 },
172 "warning": { # [Output Only] Informational warning message.
173 "message": "A String", # [Output Only] A human-readable description of the warning code.
174 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
175 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
176 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
177 {
178 "value": "A String", # [Output Only] A warning data value corresponding to the key.
179 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
180 },
181 ],
182 },
183 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
184 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
185 }</pre>
186</div>
187
188<div class="method">
189 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
190 <pre>Retrieves the next page of results.
191
192Args:
193 previous_request: The request for the previous page. (required)
194 previous_response: The response from the request for the previous page. (required)
195
196Returns:
197 A request object that you can call 'execute()' on to request the next
198 page. Returns None if there are no more items in the collection.
199 </pre>
200</div>
201
202<div class="method">
203 <code class="details" id="attachNetworkEndpoints">attachNetworkEndpoints(project, zone, networkEndpointGroup, body, requestId=None)</code>
204 <pre>Attach a list of network endpoints to the specified network endpoint group.
205
206Args:
207 project: string, Project ID for this request. (required)
208 zone: string, The name of the zone where the network endpoint group is located. It should comply with RFC1035. (required)
209 networkEndpointGroup: string, The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035. (required)
210 body: object, The request body. (required)
211 The object takes the form of:
212
213{
214 "networkEndpoints": [ # The list of network endpoints to be attached.
215 { # The network endpoint.
216 "instance": "A String", # The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group.
217 #
218 # The name must be 1-63 characters long, and comply with RFC1035.
219 "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in GCE (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used.
220 "port": 42, # Optional port number of network endpoint. If not specified and the NetworkEndpointGroup.network_endpoint_type is GCE_IP_PORT, the defaultPort for the network endpoint group will be used.
221 },
222 ],
223 }
224
225 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
226
227For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
228
229The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
230
231Returns:
232 An object of the form:
233
234 { # Represents an Operation resource.
235 #
236 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
237 #
238 # Operations can be global, regional or zonal.
239 # - For global operations, use the globalOperations resource.
240 # - For regional operations, use the regionOperations resource.
241 # - For zonal operations, use the zonalOperations resource.
242 #
243 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
244 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
245 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
246 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
247 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
248 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
249 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
250 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
251 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
252 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
253 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
254 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
255 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
256 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
257 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
258 {
259 "message": "A String", # [Output Only] A human-readable description of the warning code.
260 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
261 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
262 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
263 {
264 "value": "A String", # [Output Only] A warning data value corresponding to the key.
265 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
266 },
267 ],
268 },
269 ],
270 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
271 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
272 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
273 "name": "A String", # [Output Only] Name of the resource.
274 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
275 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
276 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
277 {
278 "message": "A String", # [Output Only] An optional, human-readable error message.
279 "code": "A String", # [Output Only] The error type identifier for this error.
280 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
281 },
282 ],
283 },
284 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
285 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
286 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
287 }</pre>
288</div>
289
290<div class="method">
291 <code class="details" id="delete">delete(project, zone, networkEndpointGroup, requestId=None)</code>
292 <pre>Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it.
293
294Args:
295 project: string, Project ID for this request. (required)
296 zone: string, The name of the zone where the network endpoint group is located. It should comply with RFC1035. (required)
297 networkEndpointGroup: string, The name of the network endpoint group to delete. It should comply with RFC1035. (required)
298 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
299
300For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
301
302The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
303
304Returns:
305 An object of the form:
306
307 { # Represents an Operation resource.
308 #
309 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
310 #
311 # Operations can be global, regional or zonal.
312 # - For global operations, use the globalOperations resource.
313 # - For regional operations, use the regionOperations resource.
314 # - For zonal operations, use the zonalOperations resource.
315 #
316 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
317 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
318 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
319 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
320 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
321 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
322 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
323 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
324 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
325 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
326 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
327 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
328 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
329 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
330 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
331 {
332 "message": "A String", # [Output Only] A human-readable description of the warning code.
333 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
334 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
335 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
336 {
337 "value": "A String", # [Output Only] A warning data value corresponding to the key.
338 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
339 },
340 ],
341 },
342 ],
343 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
344 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
345 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
346 "name": "A String", # [Output Only] Name of the resource.
347 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
348 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
349 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
350 {
351 "message": "A String", # [Output Only] An optional, human-readable error message.
352 "code": "A String", # [Output Only] The error type identifier for this error.
353 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
354 },
355 ],
356 },
357 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
358 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
359 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
360 }</pre>
361</div>
362
363<div class="method">
364 <code class="details" id="detachNetworkEndpoints">detachNetworkEndpoints(project, zone, networkEndpointGroup, body, requestId=None)</code>
365 <pre>Detach a list of network endpoints from the specified network endpoint group.
366
367Args:
368 project: string, Project ID for this request. (required)
369 zone: string, The name of the zone where the network endpoint group is located. It should comply with RFC1035. (required)
370 networkEndpointGroup: string, The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035. (required)
371 body: object, The request body. (required)
372 The object takes the form of:
373
374{
375 "networkEndpoints": [ # The list of network endpoints to be detached.
376 { # The network endpoint.
377 "instance": "A String", # The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group.
378 #
379 # The name must be 1-63 characters long, and comply with RFC1035.
380 "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in GCE (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used.
381 "port": 42, # Optional port number of network endpoint. If not specified and the NetworkEndpointGroup.network_endpoint_type is GCE_IP_PORT, the defaultPort for the network endpoint group will be used.
382 },
383 ],
384 }
385
386 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
387
388For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
389
390The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
391
392Returns:
393 An object of the form:
394
395 { # Represents an Operation resource.
396 #
397 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
398 #
399 # Operations can be global, regional or zonal.
400 # - For global operations, use the globalOperations resource.
401 # - For regional operations, use the regionOperations resource.
402 # - For zonal operations, use the zonalOperations resource.
403 #
404 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
405 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
406 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
407 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
408 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
409 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
410 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
411 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
412 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
413 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
414 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
415 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
416 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
417 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
418 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
419 {
420 "message": "A String", # [Output Only] A human-readable description of the warning code.
421 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
422 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
423 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
424 {
425 "value": "A String", # [Output Only] A warning data value corresponding to the key.
426 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
427 },
428 ],
429 },
430 ],
431 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
432 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
433 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
434 "name": "A String", # [Output Only] Name of the resource.
435 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
436 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
437 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
438 {
439 "message": "A String", # [Output Only] An optional, human-readable error message.
440 "code": "A String", # [Output Only] The error type identifier for this error.
441 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
442 },
443 ],
444 },
445 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
446 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
447 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
448 }</pre>
449</div>
450
451<div class="method">
452 <code class="details" id="get">get(project, zone, networkEndpointGroup)</code>
453 <pre>Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.
454
455Args:
456 project: string, Project ID for this request. (required)
457 zone: string, The name of the zone where the network endpoint group is located. It should comply with RFC1035. (required)
458 networkEndpointGroup: string, The name of the network endpoint group. It should comply with RFC1035. (required)
459
460Returns:
461 An object of the form:
462
463 { # Represents a collection of network endpoints.
464 "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
465 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
466 "zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located.
467 "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint.
468 "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Currently the only supported value is GCE_VM_IP_PORT.
469 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
470 "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong.
471 "size": 42, # [Output only] Number of network endpoints in the network endpoint group.
472 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
473 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
474 "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified.
475 "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
476 }</pre>
477</div>
478
479<div class="method">
480 <code class="details" id="insert">insert(project, zone, body, requestId=None)</code>
481 <pre>Creates a network endpoint group in the specified project using the parameters that are included in the request.
482
483Args:
484 project: string, Project ID for this request. (required)
485 zone: string, The name of the zone where you want to create the network endpoint group. It should comply with RFC1035. (required)
486 body: object, The request body. (required)
487 The object takes the form of:
488
489{ # Represents a collection of network endpoints.
490 "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
491 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
492 "zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located.
493 "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint.
494 "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Currently the only supported value is GCE_VM_IP_PORT.
495 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
496 "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong.
497 "size": 42, # [Output only] Number of network endpoints in the network endpoint group.
498 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
499 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
500 "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified.
501 "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
502 }
503
504 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
505
506For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
507
508The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
509
510Returns:
511 An object of the form:
512
513 { # Represents an Operation resource.
514 #
515 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
516 #
517 # Operations can be global, regional or zonal.
518 # - For global operations, use the globalOperations resource.
519 # - For regional operations, use the regionOperations resource.
520 # - For zonal operations, use the zonalOperations resource.
521 #
522 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
523 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
524 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
525 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
526 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
527 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
528 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
529 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
530 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
531 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
532 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
533 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
534 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
535 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
536 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
537 {
538 "message": "A String", # [Output Only] A human-readable description of the warning code.
539 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
540 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
541 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
542 {
543 "value": "A String", # [Output Only] A warning data value corresponding to the key.
544 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
545 },
546 ],
547 },
548 ],
549 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
550 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
551 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
552 "name": "A String", # [Output Only] Name of the resource.
553 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
554 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
555 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
556 {
557 "message": "A String", # [Output Only] An optional, human-readable error message.
558 "code": "A String", # [Output Only] The error type identifier for this error.
559 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
560 },
561 ],
562 },
563 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
564 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
565 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
566 }</pre>
567</div>
568
569<div class="method">
570 <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
571 <pre>Retrieves the list of network endpoint groups that are located in the specified project and zone.
572
573Args:
574 project: string, Project ID for this request. (required)
575 zone: string, The name of the zone where the network endpoint group is located. It should comply with RFC1035. (required)
576 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
577
578You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
579
580Currently, only sorting by name or creationTimestamp desc is supported.
581 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
582 pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
583 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
584
585For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
586
587You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
588
589To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).
590
591Returns:
592 An object of the form:
593
594 {
595 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
596 "kind": "compute#networkEndpointGroupList", # [Output Only] The resource type, which is always compute#networkEndpointGroupList for network endpoint group lists.
597 "items": [ # A list of NetworkEndpointGroup resources.
598 { # Represents a collection of network endpoints.
599 "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
600 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
601 "zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located.
602 "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint.
603 "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Currently the only supported value is GCE_VM_IP_PORT.
604 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
605 "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong.
606 "size": 42, # [Output only] Number of network endpoints in the network endpoint group.
607 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
608 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
609 "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified.
610 "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
611 },
612 ],
613 "warning": { # [Output Only] Informational warning message.
614 "message": "A String", # [Output Only] A human-readable description of the warning code.
615 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
616 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
617 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
618 {
619 "value": "A String", # [Output Only] A warning data value corresponding to the key.
620 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
621 },
622 ],
623 },
624 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
625 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
626 }</pre>
627</div>
628
629<div class="method">
630 <code class="details" id="listNetworkEndpoints">listNetworkEndpoints(project, zone, networkEndpointGroup, body, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
631 <pre>Lists the network endpoints in the specified network endpoint group.
632
633Args:
634 project: string, Project ID for this request. (required)
635 zone: string, The name of the zone where the network endpoint group is located. It should comply with RFC1035. (required)
636 networkEndpointGroup: string, The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035. (required)
637 body: object, The request body. (required)
638 The object takes the form of:
639
640{
641 "healthStatus": "A String", # Optional query parameter for showing the health status of each network endpoint. Valid options are SKIP or SHOW. If you don't specifiy this parameter, the health status of network endpoints will not be provided.
642 }
643
644 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
645
646You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
647
648Currently, only sorting by name or creationTimestamp desc is supported.
649 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
650 pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
651 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
652
653For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
654
655You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
656
657To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).
658
659Returns:
660 An object of the form:
661
662 {
663 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
664 "items": [ # A list of NetworkEndpointWithHealthStatus resources.
665 {
666 "healths": [ # [Output only] The health status of network endpoint;
667 {
668 "forwardingRule": { # URL of the forwarding rule associated with the health state of the network endpoint.
669 "forwardingRule": "A String",
670 },
671 "healthState": "A String", # Health state of the network endpoint determined based on the health checks configured.
672 "healthCheck": { # A full or valid partial URL to a health check. For example, the following are valid URLs: # URL of the health check associated with the health state of the network endpoint.
673 # - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check
674 # - projects/project-id/global/httpHealthChecks/health-check
675 # - global/httpHealthChecks/health-check
676 "healthCheck": "A String",
677 },
678 "backendService": { # URL of the backend service associated with the health state of the network endpoint.
679 "backendService": "A String",
680 },
681 },
682 ],
683 "networkEndpoint": { # The network endpoint. # [Output only] The network endpoint;
684 "instance": "A String", # The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group.
685 #
686 # The name must be 1-63 characters long, and comply with RFC1035.
687 "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in GCE (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used.
688 "port": 42, # Optional port number of network endpoint. If not specified and the NetworkEndpointGroup.network_endpoint_type is GCE_IP_PORT, the defaultPort for the network endpoint group will be used.
689 },
690 },
691 ],
692 "kind": "compute#networkEndpointGroupsListNetworkEndpoints", # [Output Only] The resource type, which is always compute#networkEndpointGroupsListNetworkEndpoints for the list of network endpoints in the specified network endpoint group.
693 "warning": { # [Output Only] Informational warning message.
694 "message": "A String", # [Output Only] A human-readable description of the warning code.
695 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
696 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
697 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
698 {
699 "value": "A String", # [Output Only] A warning data value corresponding to the key.
700 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
701 },
702 ],
703 },
704 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
705 }</pre>
706</div>
707
708<div class="method">
709 <code class="details" id="listNetworkEndpoints_next">listNetworkEndpoints_next(previous_request, previous_response)</code>
710 <pre>Retrieves the next page of results.
711
712Args:
713 previous_request: The request for the previous page. (required)
714 previous_response: The response from the request for the previous page. (required)
715
716Returns:
717 A request object that you can call 'execute()' on to request the next
718 page. Returns None if there are no more items in the collection.
719 </pre>
720</div>
721
722<div class="method">
723 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
724 <pre>Retrieves the next page of results.
725
726Args:
727 previous_request: The request for the previous page. (required)
728 previous_response: The response from the request for the previous page. (required)
729
730Returns:
731 A request object that you can call 'execute()' on to request the next
732 page. Returns None if there are no more items in the collection.
733 </pre>
734</div>
735
736<div class="method">
737 <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body)</code>
738 <pre>Returns permissions that a caller has on the specified resource.
739
740Args:
741 project: string, Project ID for this request. (required)
742 zone: string, The name of the zone for this request. (required)
743 resource: string, Name or id of the resource for this request. (required)
744 body: object, The request body. (required)
745 The object takes the form of:
746
747{
748 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
749 "A String",
750 ],
751 }
752
753
754Returns:
755 An object of the form:
756
757 {
758 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
759 "A String",
760 ],
761 }</pre>
762</div>
763
764</body></html>