• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5  margin: 0;
6  padding: 0;
7  border: 0;
8  font-weight: inherit;
9  font-style: inherit;
10  font-size: 100%;
11  font-family: inherit;
12  vertical-align: baseline;
13}
14
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50  border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54  margin-top: 0.5em;
55}
56
57.firstline {
58  margin-left: 2 em;
59}
60
61.method  {
62  margin-top: 1em;
63  border: solid 1px #CCC;
64  padding: 1em;
65  background: #EEE;
66}
67
68.details {
69  font-weight: bold;
70  font-size: 14px;
71}
72
73</style>
74
75<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.globalNetworkEndpointGroups.html">globalNetworkEndpointGroups</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#attachNetworkEndpoints">attachNetworkEndpoints(project, networkEndpointGroup, body, requestId=None)</a></code></p>
79<p class="firstline">Attach a network endpoint to the specified network endpoint group.</p>
80<p class="toc_element">
81  <code><a href="#delete">delete(project, networkEndpointGroup, requestId=None)</a></code></p>
82<p class="firstline">Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it.</p>
83<p class="toc_element">
84  <code><a href="#detachNetworkEndpoints">detachNetworkEndpoints(project, networkEndpointGroup, body, requestId=None)</a></code></p>
85<p class="firstline">Detach the network endpoint from the specified network endpoint group.</p>
86<p class="toc_element">
87  <code><a href="#get">get(project, networkEndpointGroup)</a></code></p>
88<p class="firstline">Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.</p>
89<p class="toc_element">
90  <code><a href="#insert">insert(project, body, requestId=None)</a></code></p>
91<p class="firstline">Creates a network endpoint group in the specified project using the parameters that are included in the request.</p>
92<p class="toc_element">
93  <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
94<p class="firstline">Retrieves the list of network endpoint groups that are located in the specified project.</p>
95<p class="toc_element">
96  <code><a href="#listNetworkEndpoints">listNetworkEndpoints(project, networkEndpointGroup, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
97<p class="firstline">Lists the network endpoints in the specified network endpoint group.</p>
98<p class="toc_element">
99  <code><a href="#listNetworkEndpoints_next">listNetworkEndpoints_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<p class="toc_element">
102  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
103<p class="firstline">Retrieves the next page of results.</p>
104<h3>Method Details</h3>
105<div class="method">
106    <code class="details" id="attachNetworkEndpoints">attachNetworkEndpoints(project, networkEndpointGroup, body, requestId=None)</code>
107  <pre>Attach a network endpoint to the specified network endpoint group.
108
109Args:
110  project: string, Project ID for this request. (required)
111  networkEndpointGroup: string, The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035. (required)
112  body: object, The request body. (required)
113    The object takes the form of:
114
115{
116    "networkEndpoints": [ # The list of network endpoints to be attached.
117      { # The network endpoint.
118        "port": 42, # Optional port number of network endpoint. If not specified and the NetworkEndpointGroup.network_endpoint_type is GCE_IP_PORT, the defaultPort for the network endpoint group will be used.
119        "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.
120            #
121            # The name must be 1-63 characters long, and comply with RFC1035.
122        "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in GCE (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used.
123        "annotations": { # Metadata defined as annotations on the network endpoint.
124          "a_key": "A String",
125        },
126        "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.
127      },
128    ],
129  }
130
131  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.
132
133For 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.
134
135The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
136
137Returns:
138  An object of the form:
139
140    { # Represents an Operation resource.
141      #
142      # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
143      #
144      # Operations can be global, regional or zonal.
145      # - For global operations, use the globalOperations resource.
146      # - For regional operations, use the regionOperations resource.
147      # - For zonal operations, use the zonalOperations resource.
148      #
149      # For more information, read  Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
150    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
151    "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
152    "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
153    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
154    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
155    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
156    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
157    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
158    "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.
159    "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.
160    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
161    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
162    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
163    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
164      {
165        "message": "A String", # [Output Only] A human-readable description of the warning code.
166        "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.
167        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
168            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
169          {
170            "value": "A String", # [Output Only] A warning data value corresponding to the key.
171            "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).
172          },
173        ],
174      },
175    ],
176    "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
177    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
178    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
179    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
180    "name": "A String", # [Output Only] Name of the resource.
181    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
182    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
183      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
184        {
185          "message": "A String", # [Output Only] An optional, human-readable error message.
186          "code": "A String", # [Output Only] The error type identifier for this error.
187          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
188        },
189      ],
190    },
191    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
192    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
193    "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.
194  }</pre>
195</div>
196
197<div class="method">
198    <code class="details" id="delete">delete(project, networkEndpointGroup, requestId=None)</code>
199  <pre>Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it.
200
201Args:
202  project: string, Project ID for this request. (required)
203  networkEndpointGroup: string, The name of the network endpoint group to delete. It should comply with RFC1035. (required)
204  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.
205
206For 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.
207
208The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
209
210Returns:
211  An object of the form:
212
213    { # Represents an Operation resource.
214      #
215      # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
216      #
217      # Operations can be global, regional or zonal.
218      # - For global operations, use the globalOperations resource.
219      # - For regional operations, use the regionOperations resource.
220      # - For zonal operations, use the zonalOperations resource.
221      #
222      # For more information, read  Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
223    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
224    "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
225    "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
226    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
227    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
228    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
229    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
230    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
231    "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.
232    "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.
233    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
234    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
235    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
236    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
237      {
238        "message": "A String", # [Output Only] A human-readable description of the warning code.
239        "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.
240        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
241            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
242          {
243            "value": "A String", # [Output Only] A warning data value corresponding to the key.
244            "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).
245          },
246        ],
247      },
248    ],
249    "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
250    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
251    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
252    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
253    "name": "A String", # [Output Only] Name of the resource.
254    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
255    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
256      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
257        {
258          "message": "A String", # [Output Only] An optional, human-readable error message.
259          "code": "A String", # [Output Only] The error type identifier for this error.
260          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
261        },
262      ],
263    },
264    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
265    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
266    "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.
267  }</pre>
268</div>
269
270<div class="method">
271    <code class="details" id="detachNetworkEndpoints">detachNetworkEndpoints(project, networkEndpointGroup, body, requestId=None)</code>
272  <pre>Detach the network endpoint from the specified network endpoint group.
273
274Args:
275  project: string, Project ID for this request. (required)
276  networkEndpointGroup: string, The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035. (required)
277  body: object, The request body. (required)
278    The object takes the form of:
279
280{
281    "networkEndpoints": [ # The list of network endpoints to be detached.
282      { # The network endpoint.
283        "port": 42, # Optional port number of network endpoint. If not specified and the NetworkEndpointGroup.network_endpoint_type is GCE_IP_PORT, the defaultPort for the network endpoint group will be used.
284        "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.
285            #
286            # The name must be 1-63 characters long, and comply with RFC1035.
287        "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in GCE (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used.
288        "annotations": { # Metadata defined as annotations on the network endpoint.
289          "a_key": "A String",
290        },
291        "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.
292      },
293    ],
294  }
295
296  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.
297
298For 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.
299
300The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
301
302Returns:
303  An object of the form:
304
305    { # Represents an Operation resource.
306      #
307      # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
308      #
309      # Operations can be global, regional or zonal.
310      # - For global operations, use the globalOperations resource.
311      # - For regional operations, use the regionOperations resource.
312      # - For zonal operations, use the zonalOperations resource.
313      #
314      # For more information, read  Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
315    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
316    "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
317    "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
318    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
319    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
320    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
321    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
322    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
323    "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.
324    "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.
325    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
326    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
327    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
328    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
329      {
330        "message": "A String", # [Output Only] A human-readable description of the warning code.
331        "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.
332        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
333            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
334          {
335            "value": "A String", # [Output Only] A warning data value corresponding to the key.
336            "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).
337          },
338        ],
339      },
340    ],
341    "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
342    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
343    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
344    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
345    "name": "A String", # [Output Only] Name of the resource.
346    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
347    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
348      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
349        {
350          "message": "A String", # [Output Only] An optional, human-readable error message.
351          "code": "A String", # [Output Only] The error type identifier for this error.
352          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
353        },
354      ],
355    },
356    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
357    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
358    "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.
359  }</pre>
360</div>
361
362<div class="method">
363    <code class="details" id="get">get(project, networkEndpointGroup)</code>
364  <pre>Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.
365
366Args:
367  project: string, Project ID for this request. (required)
368  networkEndpointGroup: string, The name of the network endpoint group. It should comply with RFC1035. (required)
369
370Returns:
371  An object of the form:
372
373    { # Represents a collection of network endpoints.
374      "size": 42, # [Output only] Number of network endpoints in the network endpoint group.
375      "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
376      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
377      "zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located.
378      "type": "A String", # Specify the type of this network endpoint group. Only LOAD_BALANCING is valid for now.
379      "annotations": { # Metadata defined as annotations on the network endpoint group.
380        "a_key": "A String",
381      },
382      "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint.
383      "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Currently the only supported value is GCE_VM_IP_PORT.
384      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
385      "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified.
386      "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong.
387      "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
388      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
389      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
390      "loadBalancer": { # Load balancing specific fields for network endpoint group. # This field is only valid when the network endpoint group is used for load balancing. [Deprecated] This field is deprecated.
391        "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. [Deprecated] This field is deprecated.
392        "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong. [Deprecated] This field is deprecated.
393        "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. [Deprecated] This field is deprecated.
394        "zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located. [Deprecated] This field is deprecated.
395      },
396      "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.
397    }</pre>
398</div>
399
400<div class="method">
401    <code class="details" id="insert">insert(project, body, requestId=None)</code>
402  <pre>Creates a network endpoint group in the specified project using the parameters that are included in the request.
403
404Args:
405  project: string, Project ID for this request. (required)
406  body: object, The request body. (required)
407    The object takes the form of:
408
409{ # Represents a collection of network endpoints.
410    "size": 42, # [Output only] Number of network endpoints in the network endpoint group.
411    "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
412    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
413    "zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located.
414    "type": "A String", # Specify the type of this network endpoint group. Only LOAD_BALANCING is valid for now.
415    "annotations": { # Metadata defined as annotations on the network endpoint group.
416      "a_key": "A String",
417    },
418    "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint.
419    "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Currently the only supported value is GCE_VM_IP_PORT.
420    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
421    "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified.
422    "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong.
423    "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
424    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
425    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
426    "loadBalancer": { # Load balancing specific fields for network endpoint group. # This field is only valid when the network endpoint group is used for load balancing. [Deprecated] This field is deprecated.
427      "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. [Deprecated] This field is deprecated.
428      "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong. [Deprecated] This field is deprecated.
429      "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. [Deprecated] This field is deprecated.
430      "zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located. [Deprecated] This field is deprecated.
431    },
432    "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.
433  }
434
435  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.
436
437For 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.
438
439The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
440
441Returns:
442  An object of the form:
443
444    { # Represents an Operation resource.
445      #
446      # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
447      #
448      # Operations can be global, regional or zonal.
449      # - For global operations, use the globalOperations resource.
450      # - For regional operations, use the regionOperations resource.
451      # - For zonal operations, use the zonalOperations resource.
452      #
453      # For more information, read  Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
454    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
455    "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
456    "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
457    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
458    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
459    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
460    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
461    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
462    "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.
463    "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.
464    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
465    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
466    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
467    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
468      {
469        "message": "A String", # [Output Only] A human-readable description of the warning code.
470        "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.
471        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
472            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
473          {
474            "value": "A String", # [Output Only] A warning data value corresponding to the key.
475            "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).
476          },
477        ],
478      },
479    ],
480    "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
481    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
482    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
483    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
484    "name": "A String", # [Output Only] Name of the resource.
485    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
486    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
487      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
488        {
489          "message": "A String", # [Output Only] An optional, human-readable error message.
490          "code": "A String", # [Output Only] The error type identifier for this error.
491          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
492        },
493      ],
494    },
495    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
496    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
497    "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.
498  }</pre>
499</div>
500
501<div class="method">
502    <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
503  <pre>Retrieves the list of network endpoint groups that are located in the specified project.
504
505Args:
506  project: string, Project ID for this request. (required)
507  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
508
509You 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.
510
511Currently, only sorting by name or creationTimestamp desc is supported.
512  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)
513  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.
514  filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
515
516For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
517
518You 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.
519
520To 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).
521
522Returns:
523  An object of the form:
524
525    {
526    "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.
527    "kind": "compute#networkEndpointGroupList", # [Output Only] The resource type, which is always compute#networkEndpointGroupList for network endpoint group lists.
528    "items": [ # A list of NetworkEndpointGroup resources.
529      { # Represents a collection of network endpoints.
530          "size": 42, # [Output only] Number of network endpoints in the network endpoint group.
531          "kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.
532          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
533          "zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located.
534          "type": "A String", # Specify the type of this network endpoint group. Only LOAD_BALANCING is valid for now.
535          "annotations": { # Metadata defined as annotations on the network endpoint group.
536            "a_key": "A String",
537          },
538          "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint.
539          "networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Currently the only supported value is GCE_VM_IP_PORT.
540          "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
541          "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified.
542          "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong.
543          "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
544          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
545          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
546          "loadBalancer": { # Load balancing specific fields for network endpoint group. # This field is only valid when the network endpoint group is used for load balancing. [Deprecated] This field is deprecated.
547            "defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. [Deprecated] This field is deprecated.
548            "subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong. [Deprecated] This field is deprecated.
549            "network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. [Deprecated] This field is deprecated.
550            "zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located. [Deprecated] This field is deprecated.
551          },
552          "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.
553        },
554    ],
555    "warning": { # [Output Only] Informational warning message.
556      "message": "A String", # [Output Only] A human-readable description of the warning code.
557      "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.
558      "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
559          # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
560        {
561          "value": "A String", # [Output Only] A warning data value corresponding to the key.
562          "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).
563        },
564      ],
565    },
566    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
567    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
568  }</pre>
569</div>
570
571<div class="method">
572    <code class="details" id="listNetworkEndpoints">listNetworkEndpoints(project, networkEndpointGroup, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
573  <pre>Lists the network endpoints in the specified network endpoint group.
574
575Args:
576  project: string, Project ID for this request. (required)
577  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)
578  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
579
580You 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.
581
582Currently, only sorting by name or creationTimestamp desc is supported.
583  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)
584  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.
585  filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
586
587For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
588
589You 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.
590
591To 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).
592
593Returns:
594  An object of the form:
595
596    {
597    "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.
598    "items": [ # A list of NetworkEndpointWithHealthStatus resources.
599      {
600        "healths": [ # [Output only] The health status of network endpoint;
601          {
602            "forwardingRule": { # URL of the forwarding rule associated with the health state of the network endpoint.
603              "forwardingRule": "A String",
604            },
605            "healthState": "A String", # Health state of the network endpoint determined based on the health checks configured.
606            "healthCheck": { # A full or valid partial URL to a health check. For example, the following are valid URLs: # URL of the health check associated with the health state of the network endpoint.
607                # - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check
608                # - projects/project-id/global/httpHealthChecks/health-check
609                # - global/httpHealthChecks/health-check
610              "healthCheck": "A String",
611            },
612            "healthCheckService": { # A full or valid partial URL to a health check service. For example, the following are valid URLs: # URL of the health check service associated with the health state of the network endpoint.
613                # - https://www.googleapis.com/compute/beta/projects/project-id/regions/us-west1/healthCheckServices/health-check-service
614                # - projects/project-id/regions/us-west1/healthCheckServices/health-check-service
615                # - regions/us-west1/healthCheckServices/health-check-service
616              "healthCheckService": "A String",
617            },
618            "backendService": { # URL of the backend service associated with the health state of the network endpoint.
619              "backendService": "A String",
620            },
621          },
622        ],
623        "networkEndpoint": { # The network endpoint. # [Output only] The network endpoint;
624          "port": 42, # Optional port number of network endpoint. If not specified and the NetworkEndpointGroup.network_endpoint_type is GCE_IP_PORT, the defaultPort for the network endpoint group will be used.
625          "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.
626              #
627              # The name must be 1-63 characters long, and comply with RFC1035.
628          "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in GCE (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used.
629          "annotations": { # Metadata defined as annotations on the network endpoint.
630            "a_key": "A String",
631          },
632          "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.
633        },
634      },
635    ],
636    "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.
637    "warning": { # [Output Only] Informational warning message.
638      "message": "A String", # [Output Only] A human-readable description of the warning code.
639      "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.
640      "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
641          # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
642        {
643          "value": "A String", # [Output Only] A warning data value corresponding to the key.
644          "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).
645        },
646      ],
647    },
648    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
649  }</pre>
650</div>
651
652<div class="method">
653    <code class="details" id="listNetworkEndpoints_next">listNetworkEndpoints_next(previous_request, previous_response)</code>
654  <pre>Retrieves the next page of results.
655
656Args:
657  previous_request: The request for the previous page. (required)
658  previous_response: The response from the request for the previous page. (required)
659
660Returns:
661  A request object that you can call 'execute()' on to request the next
662  page. Returns None if there are no more items in the collection.
663    </pre>
664</div>
665
666<div class="method">
667    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
668  <pre>Retrieves the next page of results.
669
670Args:
671  previous_request: The request for the previous page. (required)
672  previous_response: The response from the request for the previous page. (required)
673
674Returns:
675  A request object that you can call 'execute()' on to request the next
676  page. Returns None if there are no more items in the collection.
677    </pre>
678</div>
679
680</body></html>