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