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