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