Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / compute_v1.networkEndpointGroups.html
blob: 3fc20f8fa334898436bc4a629391c281a3f353b1 [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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None, includeAllScopes=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]84 <code><a href="#attachNetworkEndpoints">attachNetworkEndpoints(project, zone, networkEndpointGroup, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]90 <code><a href="#detachNetworkEndpoints">detachNetworkEndpoints(project, zone, networkEndpointGroup, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]96 <code><a href="#insert">insert(project, zone, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]102 <code><a href="#listNetworkEndpoints">listNetworkEndpoints(project, zone, networkEndpointGroup, body=None, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]111 <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
113<h3>Method Details</h3>
114<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]115 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None, includeAllScopes=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]123
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]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 `=`, `!=`, `&gt;`, or `&lt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]128
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]129For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]130
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]132
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]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 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]135
136Returns:
137 An object of the form:
138
139 {
140 "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.
141 "kind": "compute#networkEndpointGroupAggregatedList", # [Output Only] The resource type, which is always compute#networkEndpointGroupAggregatedList for aggregated lists of network endpoint groups.
142 "items": { # A list of NetworkEndpointGroupsScopedList resources.
143 "a_key": { # The name of the scope that contains this set of network endpoint groups.
144 "warning": { # [Output Only] An informational warning that replaces the list of network endpoint groups when the list is empty.
145 "message": "A String", # [Output Only] A human-readable description of the warning code.
146 "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.
147 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
148 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
149 {
150 "value": "A String", # [Output Only] A warning data value corresponding to the key.
151 "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).
152 },
153 ],
154 },
155 "networkEndpointGroups": [ # [Output Only] The list of network endpoint groups that are contained in this scope.
156 { # Represents a collection of network endpoints.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]157 #
158 # For more information read Network endpoint groups overview. (== resource_for {$api_version}.networkEndpointGroups ==) Next ID: 21
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]159 "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
160 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
161 "zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located.
162 "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]163 "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]164 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
165 "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong.
166 "size": 42, # [Output only] Number of network endpoints in the network endpoint group.
167 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
168 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
169 "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified.
170 "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.
171 },
172 ],
173 },
174 },
175 "warning": { # [Output Only] Informational warning message.
176 "message": "A String", # [Output Only] A human-readable description of the warning code.
177 "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.
178 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
179 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
180 {
181 "value": "A String", # [Output Only] A warning data value corresponding to the key.
182 "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).
183 },
184 ],
185 },
186 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
187 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
188 }</pre>
189</div>
190
191<div class="method">
192 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
193 <pre>Retrieves the next page of results.
194
195Args:
196 previous_request: The request for the previous page. (required)
197 previous_response: The response from the request for the previous page. (required)
198
199Returns:
200 A request object that you can call 'execute()' on to request the next
201 page. Returns None if there are no more items in the collection.
202 </pre>
203</div>
204
205<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]206 <code class="details" id="attachNetworkEndpoints">attachNetworkEndpoints(project, zone, networkEndpointGroup, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]207 <pre>Attach a list of network endpoints to the specified network endpoint group.
208
209Args:
210 project: string, Project ID for this request. (required)
211 zone: string, The name of the zone where the network endpoint group is located. It should comply with RFC1035. (required)
212 networkEndpointGroup: string, The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]213 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]214 The object takes the form of:
215
216{
217 "networkEndpoints": [ # The list of network endpoints to be attached.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]218 { # The network endpoint. Next ID: 7
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]219 "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.
220 #
221 # The name must be 1-63 characters long, and comply with RFC1035.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]222 "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (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.
223 "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]224 "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.
225 },
226 ],
227 }
228
229 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.
230
231For 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.
232
233The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
234
235Returns:
236 An object of the form:
237
238 { # Represents an Operation resource.
239 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]240 # Google Compute Engine has three Operation resources:
241 #
242 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
243 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]244 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
245 #
246 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]247 # - For global operations, use the `globalOperations` resource.
248 # - For regional operations, use the `regionOperations` resource.
249 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]250 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]251 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]252 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
253 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
254 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]255 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]256 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
257 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]258 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
259 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]260 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]261 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]262 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]263 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]264 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
265 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
266 {
267 "message": "A String", # [Output Only] A human-readable description of the warning code.
268 "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.
269 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
270 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
271 {
272 "value": "A String", # [Output Only] A warning data value corresponding to the key.
273 "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).
274 },
275 ],
276 },
277 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]278 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]279 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]280 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
281 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]282 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
283 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
284 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
285 {
286 "message": "A String", # [Output Only] An optional, human-readable error message.
287 "code": "A String", # [Output Only] The error type identifier for this error.
288 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
289 },
290 ],
291 },
292 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
293 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
294 "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.
295 }</pre>
296</div>
297
298<div class="method">
299 <code class="details" id="delete">delete(project, zone, networkEndpointGroup, requestId=None)</code>
300 <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.
301
302Args:
303 project: string, Project ID for this request. (required)
304 zone: string, The name of the zone where the network endpoint group is located. It should comply with RFC1035. (required)
305 networkEndpointGroup: string, The name of the network endpoint group to delete. It should comply with RFC1035. (required)
306 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.
307
308For 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.
309
310The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
311
312Returns:
313 An object of the form:
314
315 { # Represents an Operation resource.
316 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]317 # Google Compute Engine has three Operation resources:
318 #
319 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
320 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]321 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
322 #
323 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]324 # - For global operations, use the `globalOperations` resource.
325 # - For regional operations, use the `regionOperations` resource.
326 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]327 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]328 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]329 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
330 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
331 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]332 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]333 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
334 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]335 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
336 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]337 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]338 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]339 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]340 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]341 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
342 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
343 {
344 "message": "A String", # [Output Only] A human-readable description of the warning code.
345 "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.
346 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
347 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
348 {
349 "value": "A String", # [Output Only] A warning data value corresponding to the key.
350 "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).
351 },
352 ],
353 },
354 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]355 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]356 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]357 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
358 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]359 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
360 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
361 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
362 {
363 "message": "A String", # [Output Only] An optional, human-readable error message.
364 "code": "A String", # [Output Only] The error type identifier for this error.
365 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
366 },
367 ],
368 },
369 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
370 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
371 "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.
372 }</pre>
373</div>
374
375<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]376 <code class="details" id="detachNetworkEndpoints">detachNetworkEndpoints(project, zone, networkEndpointGroup, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]377 <pre>Detach a list of network endpoints from the specified network endpoint group.
378
379Args:
380 project: string, Project ID for this request. (required)
381 zone: string, The name of the zone where the network endpoint group is located. It should comply with RFC1035. (required)
382 networkEndpointGroup: string, The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]383 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]384 The object takes the form of:
385
386{
387 "networkEndpoints": [ # The list of network endpoints to be detached.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]388 { # The network endpoint. Next ID: 7
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]389 "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.
390 #
391 # The name must be 1-63 characters long, and comply with RFC1035.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]392 "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (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.
393 "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]394 "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.
395 },
396 ],
397 }
398
399 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.
400
401For 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.
402
403The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
404
405Returns:
406 An object of the form:
407
408 { # Represents an Operation resource.
409 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]410 # Google Compute Engine has three Operation resources:
411 #
412 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
413 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]414 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
415 #
416 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]417 # - For global operations, use the `globalOperations` resource.
418 # - For regional operations, use the `regionOperations` resource.
419 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]420 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]421 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]422 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
423 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
424 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]425 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]426 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
427 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]428 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
429 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]430 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]431 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]432 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]433 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]434 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
435 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
436 {
437 "message": "A String", # [Output Only] A human-readable description of the warning code.
438 "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.
439 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
440 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
441 {
442 "value": "A String", # [Output Only] A warning data value corresponding to the key.
443 "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).
444 },
445 ],
446 },
447 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]448 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]449 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]450 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
451 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]452 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
453 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
454 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
455 {
456 "message": "A String", # [Output Only] An optional, human-readable error message.
457 "code": "A String", # [Output Only] The error type identifier for this error.
458 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
459 },
460 ],
461 },
462 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
463 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
464 "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.
465 }</pre>
466</div>
467
468<div class="method">
469 <code class="details" id="get">get(project, zone, networkEndpointGroup)</code>
470 <pre>Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.
471
472Args:
473 project: string, Project ID for this request. (required)
474 zone: string, The name of the zone where the network endpoint group is located. It should comply with RFC1035. (required)
475 networkEndpointGroup: string, The name of the network endpoint group. It should comply with RFC1035. (required)
476
477Returns:
478 An object of the form:
479
480 { # Represents a collection of network endpoints.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]481 #
482 # For more information read Network endpoint groups overview. (== resource_for {$api_version}.networkEndpointGroups ==) Next ID: 21
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]483 "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
484 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
485 "zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located.
486 "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]487 "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]488 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
489 "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong.
490 "size": 42, # [Output only] Number of network endpoints in the network endpoint group.
491 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
492 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
493 "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified.
494 "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.
495 }</pre>
496</div>
497
498<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]499 <code class="details" id="insert">insert(project, zone, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]500 <pre>Creates a network endpoint group in the specified project using the parameters that are included in the request.
501
502Args:
503 project: string, Project ID for this request. (required)
504 zone: string, The name of the zone where you want to create the network endpoint group. It should comply with RFC1035. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]505 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]506 The object takes the form of:
507
508{ # Represents a collection of network endpoints.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]509 #
510 # For more information read Network endpoint groups overview. (== resource_for {$api_version}.networkEndpointGroups ==) Next ID: 21
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]511 "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
512 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
513 "zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located.
514 "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]515 "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]516 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
517 "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong.
518 "size": 42, # [Output only] Number of network endpoints in the network endpoint group.
519 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
520 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
521 "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified.
522 "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.
523 }
524
525 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.
526
527For 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.
528
529The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
530
531Returns:
532 An object of the form:
533
534 { # Represents an Operation resource.
535 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]536 # Google Compute Engine has three Operation resources:
537 #
538 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
539 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]540 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
541 #
542 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]543 # - For global operations, use the `globalOperations` resource.
544 # - For regional operations, use the `regionOperations` resource.
545 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]546 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]547 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]548 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
549 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
550 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]551 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]552 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
553 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]554 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
555 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]556 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]557 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]558 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]559 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]560 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
561 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
562 {
563 "message": "A String", # [Output Only] A human-readable description of the warning code.
564 "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.
565 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
566 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
567 {
568 "value": "A String", # [Output Only] A warning data value corresponding to the key.
569 "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).
570 },
571 ],
572 },
573 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]574 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]575 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]576 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
577 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]578 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
579 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
580 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
581 {
582 "message": "A String", # [Output Only] An optional, human-readable error message.
583 "code": "A String", # [Output Only] The error type identifier for this error.
584 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
585 },
586 ],
587 },
588 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
589 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
590 "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.
591 }</pre>
592</div>
593
594<div class="method">
595 <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
596 <pre>Retrieves the list of network endpoint groups that are located in the specified project and zone.
597
598Args:
599 project: string, Project ID for this request. (required)
600 zone: string, The name of the zone where the network endpoint group is located. It should comply with RFC1035. (required)
601 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
602
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]603You 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]604
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]605Currently, only sorting by `name` or `creationTimestamp desc` is supported.
606 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`)
607 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.
608 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 `=`, `!=`, `&gt;`, or `&lt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]609
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]610For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]611
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]612You 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]613
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]614To 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) ```
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]615
616Returns:
617 An object of the form:
618
619 {
620 "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.
621 "kind": "compute#networkEndpointGroupList", # [Output Only] The resource type, which is always compute#networkEndpointGroupList for network endpoint group lists.
622 "items": [ # A list of NetworkEndpointGroup resources.
623 { # Represents a collection of network endpoints.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]624 #
625 # For more information read Network endpoint groups overview. (== resource_for {$api_version}.networkEndpointGroups ==) Next ID: 21
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]626 "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
627 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
628 "zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located.
629 "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]630 "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]631 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
632 "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong.
633 "size": 42, # [Output only] Number of network endpoints in the network endpoint group.
634 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
635 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
636 "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified.
637 "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.
638 },
639 ],
640 "warning": { # [Output Only] Informational warning message.
641 "message": "A String", # [Output Only] A human-readable description of the warning code.
642 "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.
643 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
644 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
645 {
646 "value": "A String", # [Output Only] A warning data value corresponding to the key.
647 "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).
648 },
649 ],
650 },
651 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
652 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
653 }</pre>
654</div>
655
656<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]657 <code class="details" id="listNetworkEndpoints">listNetworkEndpoints(project, zone, networkEndpointGroup, body=None, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]658 <pre>Lists the network endpoints in the specified network endpoint group.
659
660Args:
661 project: string, Project ID for this request. (required)
662 zone: string, The name of the zone where the network endpoint group is located. It should comply with RFC1035. (required)
663 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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]664 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]665 The object takes the form of:
666
667{
668 "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.
669 }
670
671 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
672
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]673You 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]674
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]675Currently, only sorting by `name` or `creationTimestamp desc` is supported.
676 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`)
677 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.
678 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 `=`, `!=`, `&gt;`, or `&lt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]679
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]680For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]681
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]682You 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]683
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]684To 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) ```
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]685
686Returns:
687 An object of the form:
688
689 {
690 "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.
691 "items": [ # A list of NetworkEndpointWithHealthStatus resources.
692 {
693 "healths": [ # [Output only] The health status of network endpoint;
694 {
695 "forwardingRule": { # URL of the forwarding rule associated with the health state of the network endpoint.
696 "forwardingRule": "A String",
697 },
698 "healthState": "A String", # Health state of the network endpoint determined based on the health checks configured.
699 "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.
700 # - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check
701 # - projects/project-id/global/httpHealthChecks/health-check
702 # - global/httpHealthChecks/health-check
703 "healthCheck": "A String",
704 },
705 "backendService": { # URL of the backend service associated with the health state of the network endpoint.
706 "backendService": "A String",
707 },
708 },
709 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]710 "networkEndpoint": { # The network endpoint. Next ID: 7 # [Output only] The network endpoint;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]711 "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.
712 #
713 # The name must be 1-63 characters long, and comply with RFC1035.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]714 "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (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.
715 "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]716 "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.
717 },
718 },
719 ],
720 "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.
721 "warning": { # [Output Only] Informational warning message.
722 "message": "A String", # [Output Only] A human-readable description of the warning code.
723 "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.
724 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
725 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
726 {
727 "value": "A String", # [Output Only] A warning data value corresponding to the key.
728 "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).
729 },
730 ],
731 },
732 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
733 }</pre>
734</div>
735
736<div class="method">
737 <code class="details" id="listNetworkEndpoints_next">listNetworkEndpoints_next(previous_request, previous_response)</code>
738 <pre>Retrieves the next page of results.
739
740Args:
741 previous_request: The request for the previous page. (required)
742 previous_response: The response from the request for the previous page. (required)
743
744Returns:
745 A request object that you can call 'execute()' on to request the next
746 page. Returns None if there are no more items in the collection.
747 </pre>
748</div>
749
750<div class="method">
751 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
752 <pre>Retrieves the next page of results.
753
754Args:
755 previous_request: The request for the previous page. (required)
756 previous_response: The response from the request for the previous page. (required)
757
758Returns:
759 A request object that you can call 'execute()' on to request the next
760 page. Returns None if there are no more items in the collection.
761 </pre>
762</div>
763
764<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]765 <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]766 <pre>Returns permissions that a caller has on the specified resource.
767
768Args:
769 project: string, Project ID for this request. (required)
770 zone: string, The name of the zone for this request. (required)
771 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]772 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]773 The object takes the form of:
774
775{
776 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
777 "A String",
778 ],
779 }
780
781
782Returns:
783 An object of the form:
784
785 {
786 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
787 "A String",
788 ],
789 }</pre>
790</div>
791
792</body></html>