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