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.regionNetworkEndpointGroups.html">regionNetworkEndpointGroups</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(project, region, networkEndpointGroup, requestId=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes the specified network endpoint group. Note that the NEG cannot be deleted if it is configured as a backend of a backend service.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(project, region, networkEndpointGroup, x__xgafv=None)</a></code></p> 85<p class="firstline">Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.</p> 86<p class="toc_element"> 87 <code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Creates a network endpoint group in the specified project using the parameters that are included in the request.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Retrieves the list of regional network endpoint groups available to the specified project in the given region.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="close">close()</code> 98 <pre>Close httplib2 connections.</pre> 99</div> 100 101<div class="method"> 102 <code class="details" id="delete">delete(project, region, networkEndpointGroup, requestId=None, x__xgafv=None)</code> 103 <pre>Deletes the specified network endpoint group. Note that the NEG cannot be deleted if it is configured as a backend of a backend service. 104 105Args: 106 project: string, Project ID for this request. (required) 107 region: string, The name of the region where the network endpoint group is located. It should comply with RFC1035. (required) 108 networkEndpointGroup: string, The name of the network endpoint group to delete. It should comply with RFC1035. (required) 109 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). 110 x__xgafv: string, V1 error format. 111 Allowed values 112 1 - v1 error format 113 2 - v2 error format 114 115Returns: 116 An object of the form: 117 118 { # 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. 119 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 120 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 121 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 122 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 123 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 124 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 125 { 126 "code": "A String", # [Output Only] The error type identifier for this error. 127 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 128 "message": "A String", # [Output Only] An optional, human-readable error message. 129 }, 130 ], 131 }, 132 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 133 "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. 134 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 135 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 136 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 137 "name": "A String", # [Output Only] Name of the operation. 138 "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. 139 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 140 "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. 141 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 142 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 143 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 144 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 145 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 146 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 147 "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. 148 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 149 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 150 { 151 "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. 152 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 153 { 154 "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). 155 "value": "A String", # [Output Only] A warning data value corresponding to the key. 156 }, 157 ], 158 "message": "A String", # [Output Only] A human-readable description of the warning code. 159 }, 160 ], 161 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 162}</pre> 163</div> 164 165<div class="method"> 166 <code class="details" id="get">get(project, region, networkEndpointGroup, x__xgafv=None)</code> 167 <pre>Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request. 168 169Args: 170 project: string, Project ID for this request. (required) 171 region: string, The name of the region where the network endpoint group is located. It should comply with RFC1035. (required) 172 networkEndpointGroup: string, The name of the network endpoint group. It should comply with RFC1035. (required) 173 x__xgafv: string, V1 error format. 174 Allowed values 175 1 - v1 error format 176 2 - v2 error format 177 178Returns: 179 An object of the form: 180 181 { # 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. 182 "annotations": { # Metadata defined as annotations on the network endpoint group. 183 "a_key": "A String", 184 }, 185 "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. 186 "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: "default", "my-service". 187 "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. 188 "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: "v1", "v2". 189 }, 190 "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. 191 "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". 192 "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. 193 }, 194 "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. 195 "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". 196 "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". 197 "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. 198 }, 199 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 200 "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. 201 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 202 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 203 "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. 204 "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. 205 "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. 206 "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. 207 "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" 208 "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. 209 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 210 "size": 42, # [Output only] Number of network endpoints in the network endpoint group. 211 "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong. 212 "zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located. 213}</pre> 214</div> 215 216<div class="method"> 217 <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code> 218 <pre>Creates a network endpoint group in the specified project using the parameters that are included in the request. 219 220Args: 221 project: string, Project ID for this request. (required) 222 region: string, The name of the region where you want to create the network endpoint group. It should comply with RFC1035. (required) 223 body: object, The request body. 224 The object takes the form of: 225 226{ # 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. 227 "annotations": { # Metadata defined as annotations on the network endpoint group. 228 "a_key": "A String", 229 }, 230 "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. 231 "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: "default", "my-service". 232 "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. 233 "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: "v1", "v2". 234 }, 235 "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. 236 "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". 237 "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. 238 }, 239 "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. 240 "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". 241 "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". 242 "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. 243 }, 244 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 245 "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. 246 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 247 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 248 "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. 249 "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. 250 "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. 251 "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. 252 "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" 253 "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. 254 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 255 "size": 42, # [Output only] Number of network endpoints in the network endpoint group. 256 "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong. 257 "zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located. 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/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. 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 "name": "A String", # [Output Only] Name of the operation. 289 "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. 290 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 291 "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. 292 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 293 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 294 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 295 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 296 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 297 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 298 "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. 299 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 300 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 301 { 302 "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. 303 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 304 { 305 "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). 306 "value": "A String", # [Output Only] A warning data value corresponding to the key. 307 }, 308 ], 309 "message": "A String", # [Output Only] A human-readable description of the warning code. 310 }, 311 ], 312 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 313}</pre> 314</div> 315 316<div class="method"> 317 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 318 <pre>Retrieves the list of regional network endpoint groups available to the specified project in the given region. 319 320Args: 321 project: string, Project ID for this request. (required) 322 region: string, The name of the region where the network endpoint group is located. It should comply with RFC1035. (required) 323 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) ``` 324 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`) 325 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. 326 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. 327 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 328 x__xgafv: string, V1 error format. 329 Allowed values 330 1 - v1 error format 331 2 - v2 error format 332 333Returns: 334 An object of the form: 335 336 { 337 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 338 "items": [ # A list of NetworkEndpointGroup resources. 339 { # 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. 340 "annotations": { # Metadata defined as annotations on the network endpoint group. 341 "a_key": "A String", 342 }, 343 "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. 344 "service": "A String", # Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: "default", "my-service". 345 "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. 346 "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: "v1", "v2". 347 }, 348 "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. 349 "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". 350 "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. 351 }, 352 "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. 353 "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". 354 "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". 355 "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. 356 }, 357 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 358 "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. 359 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 360 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 361 "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. 362 "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. 363 "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. 364 "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. 365 "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" 366 "region": "A String", # [Output Only] The URL of the region where the network endpoint group is located. 367 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 368 "size": 42, # [Output only] Number of network endpoints in the network endpoint group. 369 "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong. 370 "zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located. 371 }, 372 ], 373 "kind": "compute#networkEndpointGroupList", # [Output Only] The resource type, which is always compute#networkEndpointGroupList for network endpoint group lists. 374 "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. 375 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 376 "warning": { # [Output Only] Informational warning message. 377 "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. 378 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 379 { 380 "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). 381 "value": "A String", # [Output Only] A warning data value corresponding to the key. 382 }, 383 ], 384 "message": "A String", # [Output Only] A human-readable description of the warning code. 385 }, 386}</pre> 387</div> 388 389<div class="method"> 390 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 391 <pre>Retrieves the next page of results. 392 393Args: 394 previous_request: The request for the previous page. (required) 395 previous_response: The response from the request for the previous page. (required) 396 397Returns: 398 A request object that you can call 'execute()' on to request the next 399 page. Returns None if there are no more items in the collection. 400 </pre> 401</div> 402 403</body></html>