1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.networkEndpointGroups.html">networkEndpointGroups</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#aggregatedList">aggregatedList(project, 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 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 178 "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. 179 "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 180 "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 181 "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 182 "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 183 }, 184 "size": 42, # [Output only] Number of network endpoints in the network endpoint group. 185 "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong. 186 "type": "A String", # Specify the type of this network endpoint group. Only LOAD_BALANCING is valid for now. 187 "zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located. 188 }, 189 ], 190 "warning": { # [Output Only] An informational warning that replaces the list of network endpoint groups when the list is empty. 191 "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. 192 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 193 { 194 "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). 195 "value": "A String", # [Output Only] A warning data value corresponding to the key. 196 }, 197 ], 198 "message": "A String", # [Output Only] A human-readable description of the warning code. 199 }, 200 }, 201 }, 202 "kind": "compute#networkEndpointGroupAggregatedList", # [Output Only] The resource type, which is always compute#networkEndpointGroupAggregatedList for aggregated lists of network endpoint groups. 203 "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. 204 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 205 "unreachables": [ # [Output Only] Unreachable resources. 206 "A String", 207 ], 208 "warning": { # [Output Only] Informational warning message. 209 "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. 210 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 211 { 212 "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). 213 "value": "A String", # [Output Only] A warning data value corresponding to the key. 214 }, 215 ], 216 "message": "A String", # [Output Only] A human-readable description of the warning code. 217 }, 218}</pre> 219</div> 220 221<div class="method"> 222 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 223 <pre>Retrieves the next page of results. 224 225Args: 226 previous_request: The request for the previous page. (required) 227 previous_response: The response from the request for the previous page. (required) 228 229Returns: 230 A request object that you can call 'execute()' on to request the next 231 page. Returns None if there are no more items in the collection. 232 </pre> 233</div> 234 235<div class="method"> 236 <code class="details" id="attachNetworkEndpoints">attachNetworkEndpoints(project, zone, networkEndpointGroup, body=None, requestId=None, x__xgafv=None)</code> 237 <pre>Attach a list of network endpoints to the specified network endpoint group. 238 239Args: 240 project: string, Project ID for this request. (required) 241 zone: string, The name of the zone where the network endpoint group is located. It should comply with RFC1035. (required) 242 networkEndpointGroup: string, The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035. (required) 243 body: object, The request body. 244 The object takes the form of: 245 246{ 247 "networkEndpoints": [ # The list of network endpoints to be attached. 248 { # The network endpoint. 249 "annotations": { # Metadata defined as annotations on the network endpoint. 250 "a_key": "A String", 251 }, 252 "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. 253 "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. 254 "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. 255 "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. 256 }, 257 ], 258} 259 260 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). 261 x__xgafv: string, V1 error format. 262 Allowed values 263 1 - v1 error format 264 2 - v2 error format 265 266Returns: 267 An object of the form: 268 269 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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. 270 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 271 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 272 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 273 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 274 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 275 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 276 { 277 "code": "A String", # [Output Only] The error type identifier for this error. 278 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 279 "message": "A String", # [Output Only] An optional, human-readable error message. 280 }, 281 ], 282 }, 283 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 284 "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. 285 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 286 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 287 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 288 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 289 "a_key": "", # Properties of the object. Contains field @type with type URL. 290 }, 291 "name": "A String", # [Output Only] Name of the operation. 292 "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. 293 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 294 "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. 295 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 296 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 297 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 298 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 299 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 300 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 301 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 302 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 303 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 304 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 305 { 306 "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. 307 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 308 { 309 "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). 310 "value": "A String", # [Output Only] A warning data value corresponding to the key. 311 }, 312 ], 313 "message": "A String", # [Output Only] A human-readable description of the warning code. 314 }, 315 ], 316 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 317}</pre> 318</div> 319 320<div class="method"> 321 <code class="details" id="close">close()</code> 322 <pre>Close httplib2 connections.</pre> 323</div> 324 325<div class="method"> 326 <code class="details" id="delete">delete(project, zone, networkEndpointGroup, requestId=None, x__xgafv=None)</code> 327 <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. 328 329Args: 330 project: string, Project ID for this request. (required) 331 zone: string, The name of the zone where the network endpoint group is located. It should comply with RFC1035. (required) 332 networkEndpointGroup: string, The name of the network endpoint group to delete. It should comply with RFC1035. (required) 333 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). 334 x__xgafv: string, V1 error format. 335 Allowed values 336 1 - v1 error format 337 2 - v2 error format 338 339Returns: 340 An object of the form: 341 342 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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. 343 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 344 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 345 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 346 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 347 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 348 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 349 { 350 "code": "A String", # [Output Only] The error type identifier for this error. 351 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 352 "message": "A String", # [Output Only] An optional, human-readable error message. 353 }, 354 ], 355 }, 356 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 357 "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. 358 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 359 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 360 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 361 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 362 "a_key": "", # Properties of the object. Contains field @type with type URL. 363 }, 364 "name": "A String", # [Output Only] Name of the operation. 365 "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. 366 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 367 "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. 368 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 369 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 370 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 371 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 372 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 373 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 374 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 375 "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. 376 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 377 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 378 { 379 "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. 380 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 381 { 382 "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). 383 "value": "A String", # [Output Only] A warning data value corresponding to the key. 384 }, 385 ], 386 "message": "A String", # [Output Only] A human-readable description of the warning code. 387 }, 388 ], 389 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 390}</pre> 391</div> 392 393<div class="method"> 394 <code class="details" id="detachNetworkEndpoints">detachNetworkEndpoints(project, zone, networkEndpointGroup, body=None, requestId=None, x__xgafv=None)</code> 395 <pre>Detach a list of network endpoints from the specified network endpoint group. 396 397Args: 398 project: string, Project ID for this request. (required) 399 zone: string, The name of the zone where the network endpoint group is located. It should comply with RFC1035. (required) 400 networkEndpointGroup: string, The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035. (required) 401 body: object, The request body. 402 The object takes the form of: 403 404{ 405 "networkEndpoints": [ # The list of network endpoints to be detached. 406 { # The network endpoint. 407 "annotations": { # Metadata defined as annotations on the network endpoint. 408 "a_key": "A String", 409 }, 410 "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. 411 "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. 412 "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. 413 "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. 414 }, 415 ], 416} 417 418 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). 419 x__xgafv: string, V1 error format. 420 Allowed values 421 1 - v1 error format 422 2 - v2 error format 423 424Returns: 425 An object of the form: 426 427 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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. 428 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 429 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 430 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 431 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 432 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 433 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 434 { 435 "code": "A String", # [Output Only] The error type identifier for this error. 436 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 437 "message": "A String", # [Output Only] An optional, human-readable error message. 438 }, 439 ], 440 }, 441 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 442 "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. 443 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 444 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 445 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 446 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 447 "a_key": "", # Properties of the object. Contains field @type with type URL. 448 }, 449 "name": "A String", # [Output Only] Name of the operation. 450 "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. 451 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 452 "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. 453 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 454 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 455 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 456 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 457 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 458 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 459 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 460 "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. 461 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 462 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 463 { 464 "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. 465 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 466 { 467 "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). 468 "value": "A String", # [Output Only] A warning data value corresponding to the key. 469 }, 470 ], 471 "message": "A String", # [Output Only] A human-readable description of the warning code. 472 }, 473 ], 474 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 475}</pre> 476</div> 477 478<div class="method"> 479 <code class="details" id="get">get(project, zone, networkEndpointGroup, x__xgafv=None)</code> 480 <pre>Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request. 481 482Args: 483 project: string, Project ID for this request. (required) 484 zone: string, The name of the zone where the network endpoint group is located. It should comply with RFC1035. (required) 485 networkEndpointGroup: string, The name of the network endpoint group. It should comply with RFC1035. (required) 486 x__xgafv: string, V1 error format. 487 Allowed values 488 1 - v1 error format 489 2 - v2 error format 490 491Returns: 492 An object of the form: 493 494 { # 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. 495 "annotations": { # Metadata defined as annotations on the network endpoint group. 496 "a_key": "A String", 497 }, 498 "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. 499 "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: "default", "my-service". 500 "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. 501 "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: "v1", "v2". 502 }, 503 "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. 504 "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". 505 "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. 506 }, 507 "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. 508 "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". 509 "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". 510 "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. 511 }, 512 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 513 "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. 514 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 515 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 516 "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. 517 "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. 518 "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. [Deprecated] This field is deprecated. 519 "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. 520 "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong. [Deprecated] This field is deprecated. 521 "zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located. [Deprecated] This field is deprecated. 522 }, 523 "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. 524 "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. 525 "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. 526 "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" 527 "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. 528 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 529 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 530 "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. 531 "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 532 "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 533 "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 534 "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 535 }, 536 "size": 42, # [Output only] Number of network endpoints in the network endpoint group. 537 "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong. 538 "type": "A String", # Specify the type of this network endpoint group. Only LOAD_BALANCING is valid for now. 539 "zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located. 540}</pre> 541</div> 542 543<div class="method"> 544 <code class="details" id="insert">insert(project, zone, body=None, requestId=None, x__xgafv=None)</code> 545 <pre>Creates a network endpoint group in the specified project using the parameters that are included in the request. 546 547Args: 548 project: string, Project ID for this request. (required) 549 zone: string, The name of the zone where you want to create the network endpoint group. It should comply with RFC1035. (required) 550 body: object, The request body. 551 The object takes the form of: 552 553{ # 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. 554 "annotations": { # Metadata defined as annotations on the network endpoint group. 555 "a_key": "A String", 556 }, 557 "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. 558 "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: "default", "my-service". 559 "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. 560 "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: "v1", "v2". 561 }, 562 "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. 563 "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". 564 "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. 565 }, 566 "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. 567 "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". 568 "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". 569 "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. 570 }, 571 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 572 "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. 573 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 574 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 575 "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. 576 "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. 577 "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. [Deprecated] This field is deprecated. 578 "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. 579 "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong. [Deprecated] This field is deprecated. 580 "zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located. [Deprecated] This field is deprecated. 581 }, 582 "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. 583 "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. 584 "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. 585 "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" 586 "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. 587 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 588 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 589 "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. 590 "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 591 "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 592 "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 593 "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 594 }, 595 "size": 42, # [Output only] Number of network endpoints in the network endpoint group. 596 "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong. 597 "type": "A String", # Specify the type of this network endpoint group. Only LOAD_BALANCING is valid for now. 598 "zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located. 599} 600 601 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). 602 x__xgafv: string, V1 error format. 603 Allowed values 604 1 - v1 error format 605 2 - v2 error format 606 607Returns: 608 An object of the form: 609 610 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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. 611 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 612 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 613 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 614 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 615 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 616 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 617 { 618 "code": "A String", # [Output Only] The error type identifier for this error. 619 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 620 "message": "A String", # [Output Only] An optional, human-readable error message. 621 }, 622 ], 623 }, 624 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 625 "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. 626 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 627 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 628 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 629 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 630 "a_key": "", # Properties of the object. Contains field @type with type URL. 631 }, 632 "name": "A String", # [Output Only] Name of the operation. 633 "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. 634 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 635 "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. 636 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 637 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 638 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 639 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 640 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 641 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 642 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 643 "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. 644 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 645 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 646 { 647 "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. 648 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 649 { 650 "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). 651 "value": "A String", # [Output Only] A warning data value corresponding to the key. 652 }, 653 ], 654 "message": "A String", # [Output Only] A human-readable description of the warning code. 655 }, 656 ], 657 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 658}</pre> 659</div> 660 661<div class="method"> 662 <code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 663 <pre>Retrieves the list of network endpoint groups that are located in the specified project and zone. 664 665Args: 666 project: string, Project ID for this request. (required) 667 zone: string, The name of the zone where the network endpoint group is located. It should comply with RFC1035. (required) 668 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) ``` 669 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`) 670 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. 671 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. 672 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 673 x__xgafv: string, V1 error format. 674 Allowed values 675 1 - v1 error format 676 2 - v2 error format 677 678Returns: 679 An object of the form: 680 681 { 682 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 683 "items": [ # A list of NetworkEndpointGroup resources. 684 { # 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. 685 "annotations": { # Metadata defined as annotations on the network endpoint group. 686 "a_key": "A String", 687 }, 688 "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. 689 "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: "default", "my-service". 690 "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. 691 "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: "v1", "v2". 692 }, 693 "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. 694 "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". 695 "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. 696 }, 697 "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. 698 "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". 699 "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". 700 "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. 701 }, 702 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 703 "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. 704 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 705 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 706 "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. 707 "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. 708 "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. [Deprecated] This field is deprecated. 709 "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. 710 "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong. [Deprecated] This field is deprecated. 711 "zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located. [Deprecated] This field is deprecated. 712 }, 713 "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. 714 "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. 715 "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. 716 "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" 717 "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. 718 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 719 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 720 "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. 721 "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 722 "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 723 "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 724 "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 725 }, 726 "size": 42, # [Output only] Number of network endpoints in the network endpoint group. 727 "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong. 728 "type": "A String", # Specify the type of this network endpoint group. Only LOAD_BALANCING is valid for now. 729 "zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located. 730 }, 731 ], 732 "kind": "compute#networkEndpointGroupList", # [Output Only] The resource type, which is always compute#networkEndpointGroupList for network endpoint group lists. 733 "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. 734 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 735 "warning": { # [Output Only] Informational warning message. 736 "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. 737 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 738 { 739 "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). 740 "value": "A String", # [Output Only] A warning data value corresponding to the key. 741 }, 742 ], 743 "message": "A String", # [Output Only] A human-readable description of the warning code. 744 }, 745}</pre> 746</div> 747 748<div class="method"> 749 <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> 750 <pre>Lists the network endpoints in the specified network endpoint group. 751 752Args: 753 project: string, Project ID for this request. (required) 754 zone: string, The name of the zone where the network endpoint group is located. It should comply with RFC1035. (required) 755 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) 756 body: object, The request body. 757 The object takes the form of: 758 759{ 760 "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. 761 { 762 "networkEndpoint": { # The network endpoint. 763 "annotations": { # Metadata defined as annotations on the network endpoint. 764 "a_key": "A String", 765 }, 766 "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. 767 "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. 768 "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. 769 "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. 770 }, 771 }, 772 ], 773 "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. 774} 775 776 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) ``` 777 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`) 778 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. 779 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. 780 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 781 x__xgafv: string, V1 error format. 782 Allowed values 783 1 - v1 error format 784 2 - v2 error format 785 786Returns: 787 An object of the form: 788 789 { 790 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 791 "items": [ # A list of NetworkEndpointWithHealthStatus resources. 792 { 793 "healths": [ # [Output only] The health status of network endpoint; 794 { 795 "backendService": { # URL of the backend service associated with the health state of the network endpoint. 796 "backendService": "A String", 797 }, 798 "forwardingRule": { # URL of the forwarding rule associated with the health state of the network endpoint. 799 "forwardingRule": "A String", 800 }, 801 "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. 802 "healthCheck": "A String", 803 }, 804 "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. 805 "healthCheckService": "A String", 806 }, 807 "healthState": "A String", # Health state of the network endpoint determined based on the health checks configured. 808 }, 809 ], 810 "networkEndpoint": { # The network endpoint. # [Output only] The network endpoint; 811 "annotations": { # Metadata defined as annotations on the network endpoint. 812 "a_key": "A String", 813 }, 814 "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. 815 "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. 816 "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. 817 "port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. 818 }, 819 }, 820 ], 821 "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. 822 "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. 823 "warning": { # [Output Only] Informational warning message. 824 "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. 825 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 826 { 827 "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). 828 "value": "A String", # [Output Only] A warning data value corresponding to the key. 829 }, 830 ], 831 "message": "A String", # [Output Only] A human-readable description of the warning code. 832 }, 833}</pre> 834</div> 835 836<div class="method"> 837 <code class="details" id="listNetworkEndpoints_next">listNetworkEndpoints_next(previous_request, previous_response)</code> 838 <pre>Retrieves the next page of results. 839 840Args: 841 previous_request: The request for the previous page. (required) 842 previous_response: The response from the request for the previous page. (required) 843 844Returns: 845 A request object that you can call 'execute()' on to request the next 846 page. Returns None if there are no more items in the collection. 847 </pre> 848</div> 849 850<div class="method"> 851 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 852 <pre>Retrieves the next page of results. 853 854Args: 855 previous_request: The request for the previous page. (required) 856 previous_response: The response from the request for the previous page. (required) 857 858Returns: 859 A request object that you can call 'execute()' on to request the next 860 page. Returns None if there are no more items in the collection. 861 </pre> 862</div> 863 864<div class="method"> 865 <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</code> 866 <pre>Returns permissions that a caller has on the specified resource. 867 868Args: 869 project: string, Project ID for this request. (required) 870 zone: string, The name of the zone for this request. (required) 871 resource: string, Name or id of the resource for this request. (required) 872 body: object, The request body. 873 The object takes the form of: 874 875{ 876 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 877 "A String", 878 ], 879} 880 881 x__xgafv: string, V1 error format. 882 Allowed values 883 1 - v1 error format 884 2 - v2 error format 885 886Returns: 887 An object of the form: 888 889 { 890 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 891 "A String", 892 ], 893}</pre> 894</div> 895 896</body></html>