Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b6971b0405ba59d905b84fa5fc8e27e12d29b70c / . / docs / dyn / compute_alpha.instanceGroups.html
blob: 596bb965d0a01a2fd6b3008392788af3604401cf [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]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.instanceGroups.html">instanceGroups</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]78 <code><a href="#addInstances">addInstances(project, zone, instanceGroup, body=None, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]79<p class="firstline">Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.</p>
80<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]81 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]82<p class="firstline">Retrieves the list of instance groups and sorts them by zone.</p>
83<p class="toc_element">
84 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]87 <code><a href="#close">close()</a></code></p>
88<p class="firstline">Close httplib2 connections.</p>
89<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]90 <code><a href="#delete">delete(project, zone, instanceGroup, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]91<p class="firstline">Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.</p>
92<p class="toc_element">
93 <code><a href="#get">get(project, zone, instanceGroup)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94<p class="firstline">Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]96 <code><a href="#insert">insert(project, zone, body=None, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]97<p class="firstline">Creates an instance group in the specified project using the parameters that are included in the request.</p>
98<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]99 <code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]100<p class="firstline">Retrieves the list of zonal instance group resources contained within the specified zone.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]101<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]102 <code><a href="#listInstances">listInstances(project, zone, instanceGroup, body=None, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]103<p class="firstline">Lists the instances in the specified instance group. The orderBy query parameter is not supported.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]104<p class="toc_element">
105 <code><a href="#listInstances_next">listInstances_next(previous_request, previous_response)</a></code></p>
106<p class="firstline">Retrieves the next page of results.</p>
107<p class="toc_element">
108 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
109<p class="firstline">Retrieves the next page of results.</p>
110<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]111 <code><a href="#removeInstances">removeInstances(project, zone, instanceGroup, body=None, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]112<p class="firstline">Removes one or more instances from the specified instance group, but does not delete those instances.</p>
113<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]114 <code><a href="#setNamedPorts">setNamedPorts(project, zone, instanceGroup, body=None, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]115<p class="firstline">Sets the named ports for the specified instance group.</p>
116<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]117 <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]118<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
119<h3>Method Details</h3>
120<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]121 <code class="details" id="addInstances">addInstances(project, zone, instanceGroup, body=None, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]122 <pre>Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.
123
124Args:
125 project: string, Project ID for this request. (required)
126 zone: string, The name of the zone where the instance group is located. (required)
127 instanceGroup: string, The name of the instance group where you are adding instances. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]128 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]129 The object takes the form of:
130
131{
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]132 &quot;instances&quot;: [ # The list of instances to add to the instance group.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]133 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]134 &quot;instance&quot;: &quot;A String&quot;, # The URL for a specific instance.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]135 },
136 ],
137 }
138
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]139 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.
140
141For 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.
142
143The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]144
145Returns:
146 An object of the form:
147
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]148 { # Represents an Operation resource.
149 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]150 # Google Compute Engine has three Operation resources:
151 #
152 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
153 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]154 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
155 #
156 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]157 # - For global operations, use the `globalOperations` resource.
158 # - For regional operations, use the `regionOperations` resource.
159 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]160 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]161 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]162 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
163 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
164 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
165 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
166 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
167 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]168 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]169 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
170 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
171 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]172 },
173 ],
174 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]175 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
176 &quot;httpErrorStatusCode&quot;: 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.
177 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
178 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
179 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
180 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
181 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
182 &quot;progress&quot;: 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.
183 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
184 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
185 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
186 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
187 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
188 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
189 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
190 &quot;targetLink&quot;: &quot;A String&quot;, # [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.
191 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
192 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
193 {
194 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
195 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
196 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
197 {
198 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
199 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
200 },
201 ],
202 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
203 },
204 ],
205 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]206 }</pre>
207</div>
208
209<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]210 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]211 <pre>Retrieves the list of instance groups and sorts them by zone.
212
213Args:
214 project: string, Project ID for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]215 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 `=`, `!=`, `&gt;`, or `&lt;`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]216
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]217For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]218
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]219You 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]220
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]221To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = &quot;Intel Skylake&quot;) ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = &quot;Intel Skylake&quot;) OR (cpuPlatform = &quot;Intel Broadwell&quot;) AND (scheduling.automaticRestart = true) ```
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]222 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]223 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`)
224 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
225
226You can also sort results in descending order based on the creation timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. 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.
227
228Currently, only sorting by `name` or `creationTimestamp desc` is supported.
229 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.
230 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]231
232Returns:
233 An object of the form:
234
235 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]236 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
237 &quot;items&quot;: { # A list of InstanceGroupsScopedList resources.
238 &quot;a_key&quot;: { # The name of the scope that contains this set of instance groups.
239 &quot;instanceGroups&quot;: [ # [Output Only] The list of instance groups that are contained in this scope.
240 { # Represents an Instance Group resource.
241 #
242 # Instance Groups can be used to configure a target for load balancing.
243 #
244 # Instance groups can either be managed or unmanaged.
245 #
246 # To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead.
247 #
248 # Use zonal unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups.
249 #
250 # For more information, read Instance groups.
251 #
252 # (== resource_for {$api_version}.instanceGroups ==) (== resource_for {$api_version}.regionInstanceGroups ==)
253 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
254 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
255 &quot;fingerprint&quot;: &quot;A String&quot;, # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
256 &quot;id&quot;: &quot;A String&quot;, # [Output Only] A unique identifier for this instance group, generated by the server.
257 &quot;kind&quot;: &quot;compute#instanceGroup&quot;, # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
258 &quot;name&quot;: &quot;A String&quot;, # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
259 &quot;namedPorts&quot;: [ # Assigns a name to a port number. For example: {name: &quot;http&quot;, port: 80}
260 #
261 # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: &quot;http&quot;, port: 80},{name: &quot;http&quot;, port: 8080}]
262 #
263 # Named ports apply to all instances in this instance group.
264 { # The named port. For example: .
265 &quot;name&quot;: &quot;A String&quot;, # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
266 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
267 },
268 ],
269 &quot;network&quot;: &quot;A String&quot;, # [Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).
270 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the instance group is located (for regional resources).
271 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] The URL for this instance group. The server generates this URL.
272 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
273 &quot;size&quot;: 42, # [Output Only] The total number of instances in the instance group.
274 &quot;subnetwork&quot;: &quot;A String&quot;, # [Output Only] The URL of the subnetwork to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).
275 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
276 },
277 ],
278 &quot;warning&quot;: { # [Output Only] An informational warning that replaces the list of instance groups when the list is empty.
279 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
280 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
281 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]282 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]283 &quot;key&quot;: &quot;A String&quot;, # [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).
284 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]285 },
286 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]287 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]288 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]289 },
290 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]291 &quot;kind&quot;: &quot;compute#instanceGroupAggregatedList&quot;, # [Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups.
292 &quot;nextPageToken&quot;: &quot;A String&quot;, # [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.
293 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
294 &quot;unreachables&quot;: [ # [Output Only] Unreachable resources.
295 &quot;A String&quot;,
296 ],
297 &quot;warning&quot;: { # [Output Only] Informational warning message.
298 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
299 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
300 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]301 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]302 &quot;key&quot;: &quot;A String&quot;, # [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).
303 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]304 },
305 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]306 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]307 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]308 }</pre>
309</div>
310
311<div class="method">
312 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
313 <pre>Retrieves the next page of results.
314
315Args:
316 previous_request: The request for the previous page. (required)
317 previous_response: The response from the request for the previous page. (required)
318
319Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]320 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]321 page. Returns None if there are no more items in the collection.
322 </pre>
323</div>
324
325<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]326 <code class="details" id="close">close()</code>
327 <pre>Close httplib2 connections.</pre>
328</div>
329
330<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]331 <code class="details" id="delete">delete(project, zone, instanceGroup, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]332 <pre>Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.
333
334Args:
335 project: string, Project ID for this request. (required)
336 zone: string, The name of the zone where the instance group is located. (required)
337 instanceGroup: string, The name of the instance group to delete. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]338 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.
339
340For 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.
341
342The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]343
344Returns:
345 An object of the form:
346
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]347 { # Represents an Operation resource.
348 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]349 # Google Compute Engine has three Operation resources:
350 #
351 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
352 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]353 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
354 #
355 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]356 # - For global operations, use the `globalOperations` resource.
357 # - For regional operations, use the `regionOperations` resource.
358 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]359 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]360 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]361 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
362 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
363 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
364 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
365 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
366 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]367 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]368 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
369 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
370 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]371 },
372 ],
373 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]374 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
375 &quot;httpErrorStatusCode&quot;: 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.
376 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
377 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
378 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
379 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
380 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
381 &quot;progress&quot;: 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.
382 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
383 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
384 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
385 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
386 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
387 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
388 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
389 &quot;targetLink&quot;: &quot;A String&quot;, # [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.
390 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
391 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
392 {
393 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
394 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
395 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
396 {
397 &quot;key&quot;: &quot;A String&quot;, # [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).
398 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
399 },
400 ],
401 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
402 },
403 ],
404 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]405 }</pre>
406</div>
407
408<div class="method">
409 <code class="details" id="get">get(project, zone, instanceGroup)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]410 <pre>Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request.
411
412For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]413
414Args:
415 project: string, Project ID for this request. (required)
416 zone: string, The name of the zone where the instance group is located. (required)
417 instanceGroup: string, The name of the instance group. (required)
418
419Returns:
420 An object of the form:
421
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]422 { # Represents an Instance Group resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]423 #
424 # Instance Groups can be used to configure a target for load balancing.
425 #
426 # Instance groups can either be managed or unmanaged.
427 #
428 # To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead.
429 #
430 # Use zonal unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups.
431 #
432 # For more information, read Instance groups.
433 #
434 # (== resource_for {$api_version}.instanceGroups ==) (== resource_for {$api_version}.regionInstanceGroups ==)
435 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
436 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
437 &quot;fingerprint&quot;: &quot;A String&quot;, # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
438 &quot;id&quot;: &quot;A String&quot;, # [Output Only] A unique identifier for this instance group, generated by the server.
439 &quot;kind&quot;: &quot;compute#instanceGroup&quot;, # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
440 &quot;name&quot;: &quot;A String&quot;, # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
441 &quot;namedPorts&quot;: [ # Assigns a name to a port number. For example: {name: &quot;http&quot;, port: 80}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]442 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]443 # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: &quot;http&quot;, port: 80},{name: &quot;http&quot;, port: 8080}]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]444 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]445 # Named ports apply to all instances in this instance group.
446 { # The named port. For example: .
447 &quot;name&quot;: &quot;A String&quot;, # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
448 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
449 },
450 ],
451 &quot;network&quot;: &quot;A String&quot;, # [Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).
452 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the instance group is located (for regional resources).
453 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] The URL for this instance group. The server generates this URL.
454 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
455 &quot;size&quot;: 42, # [Output Only] The total number of instances in the instance group.
456 &quot;subnetwork&quot;: &quot;A String&quot;, # [Output Only] The URL of the subnetwork to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).
457 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
458 }</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]459</div>
460
461<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]462 <code class="details" id="insert">insert(project, zone, body=None, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]463 <pre>Creates an instance group in the specified project using the parameters that are included in the request.
464
465Args:
466 project: string, Project ID for this request. (required)
467 zone: string, The name of the zone where you want to create the instance group. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]468 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]469 The object takes the form of:
470
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]471{ # Represents an Instance Group resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]472 #
473 # Instance Groups can be used to configure a target for load balancing.
474 #
475 # Instance groups can either be managed or unmanaged.
476 #
477 # To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead.
478 #
479 # Use zonal unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups.
480 #
481 # For more information, read Instance groups.
482 #
483 # (== resource_for {$api_version}.instanceGroups ==) (== resource_for {$api_version}.regionInstanceGroups ==)
484 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
485 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
486 &quot;fingerprint&quot;: &quot;A String&quot;, # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
487 &quot;id&quot;: &quot;A String&quot;, # [Output Only] A unique identifier for this instance group, generated by the server.
488 &quot;kind&quot;: &quot;compute#instanceGroup&quot;, # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
489 &quot;name&quot;: &quot;A String&quot;, # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
490 &quot;namedPorts&quot;: [ # Assigns a name to a port number. For example: {name: &quot;http&quot;, port: 80}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]491 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]492 # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: &quot;http&quot;, port: 80},{name: &quot;http&quot;, port: 8080}]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]493 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]494 # Named ports apply to all instances in this instance group.
495 { # The named port. For example: .
496 &quot;name&quot;: &quot;A String&quot;, # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
497 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
498 },
499 ],
500 &quot;network&quot;: &quot;A String&quot;, # [Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).
501 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the instance group is located (for regional resources).
502 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] The URL for this instance group. The server generates this URL.
503 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
504 &quot;size&quot;: 42, # [Output Only] The total number of instances in the instance group.
505 &quot;subnetwork&quot;: &quot;A String&quot;, # [Output Only] The URL of the subnetwork to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).
506 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
507}
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]508
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]509 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.
510
511For 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.
512
513The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]514
515Returns:
516 An object of the form:
517
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]518 { # Represents an Operation resource.
519 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]520 # Google Compute Engine has three Operation resources:
521 #
522 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
523 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]524 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
525 #
526 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]527 # - For global operations, use the `globalOperations` resource.
528 # - For regional operations, use the `regionOperations` resource.
529 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]530 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]531 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]532 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
533 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
534 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
535 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
536 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
537 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]538 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]539 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
540 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
541 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]542 },
543 ],
544 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]545 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
546 &quot;httpErrorStatusCode&quot;: 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.
547 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
548 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
549 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
550 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
551 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
552 &quot;progress&quot;: 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.
553 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
554 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
555 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
556 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
557 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
558 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
559 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
560 &quot;targetLink&quot;: &quot;A String&quot;, # [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.
561 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
562 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
563 {
564 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
565 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
566 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
567 {
568 &quot;key&quot;: &quot;A String&quot;, # [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).
569 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
570 },
571 ],
572 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
573 },
574 ],
575 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]576 }</pre>
577</div>
578
579<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]580 <code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]581 <pre>Retrieves the list of zonal instance group resources contained within the specified zone.
582
583For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]584
585Args:
586 project: string, Project ID for this request. (required)
587 zone: string, The name of the zone where the instance group is located. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]588 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 `=`, `!=`, `&gt;`, or `&lt;`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]589
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]590For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]591
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]592You 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]593
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]594To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = &quot;Intel Skylake&quot;) ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = &quot;Intel Skylake&quot;) OR (cpuPlatform = &quot;Intel Broadwell&quot;) AND (scheduling.automaticRestart = true) ```
595 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`)
596 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
597
598You can also sort results in descending order based on the creation timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. 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.
599
600Currently, only sorting by `name` or `creationTimestamp desc` is supported.
601 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.
602 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]603
604Returns:
605 An object of the form:
606
607 { # A list of InstanceGroup resources.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]608 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
609 &quot;items&quot;: [ # A list of InstanceGroup resources.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]610 { # Represents an Instance Group resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]611 #
612 # Instance Groups can be used to configure a target for load balancing.
613 #
614 # Instance groups can either be managed or unmanaged.
615 #
616 # To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead.
617 #
618 # Use zonal unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups.
619 #
620 # For more information, read Instance groups.
621 #
622 # (== resource_for {$api_version}.instanceGroups ==) (== resource_for {$api_version}.regionInstanceGroups ==)
623 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
624 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
625 &quot;fingerprint&quot;: &quot;A String&quot;, # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
626 &quot;id&quot;: &quot;A String&quot;, # [Output Only] A unique identifier for this instance group, generated by the server.
627 &quot;kind&quot;: &quot;compute#instanceGroup&quot;, # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
628 &quot;name&quot;: &quot;A String&quot;, # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
629 &quot;namedPorts&quot;: [ # Assigns a name to a port number. For example: {name: &quot;http&quot;, port: 80}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]630 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]631 # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: &quot;http&quot;, port: 80},{name: &quot;http&quot;, port: 8080}]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]632 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]633 # Named ports apply to all instances in this instance group.
634 { # The named port. For example: .
635 &quot;name&quot;: &quot;A String&quot;, # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
636 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
637 },
638 ],
639 &quot;network&quot;: &quot;A String&quot;, # [Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).
640 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the instance group is located (for regional resources).
641 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] The URL for this instance group. The server generates this URL.
642 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
643 &quot;size&quot;: 42, # [Output Only] The total number of instances in the instance group.
644 &quot;subnetwork&quot;: &quot;A String&quot;, # [Output Only] The URL of the subnetwork to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).
645 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
646 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]647 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]648 &quot;kind&quot;: &quot;compute#instanceGroupList&quot;, # [Output Only] The resource type, which is always compute#instanceGroupList for instance group lists.
649 &quot;nextPageToken&quot;: &quot;A String&quot;, # [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.
650 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
651 &quot;warning&quot;: { # [Output Only] Informational warning message.
652 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
653 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
654 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]655 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]656 &quot;key&quot;: &quot;A String&quot;, # [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).
657 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]658 },
659 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]660 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]661 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]662 }</pre>
663</div>
664
665<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]666 <code class="details" id="listInstances">listInstances(project, zone, instanceGroup, body=None, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]667 <pre>Lists the instances in the specified instance group. The orderBy query parameter is not supported.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]668
669Args:
670 project: string, Project ID for this request. (required)
671 zone: string, The name of the zone where the instance group is located. (required)
672 instanceGroup: string, The name of the instance group from which you want to generate a list of included instances. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]673 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]674 The object takes the form of:
675
676{
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]677 &quot;instanceState&quot;: &quot;A String&quot;, # A filter for the state of the instances in the instance group. Valid options are ALL or RUNNING. If you do not specify this parameter the list includes all instances regardless of their state.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]678 }
679
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]680 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 `=`, `!=`, `&gt;`, or `&lt;`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]681
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]682For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]683
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]684You 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]685
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]686To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = &quot;Intel Skylake&quot;) ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = &quot;Intel Skylake&quot;) OR (cpuPlatform = &quot;Intel Broadwell&quot;) AND (scheduling.automaticRestart = true) ```
687 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`)
688 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
689
690You can also sort results in descending order based on the creation timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. 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.
691
692Currently, only sorting by `name` or `creationTimestamp desc` is supported.
693 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.
694 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]695
696Returns:
697 An object of the form:
698
699 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]700 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
701 &quot;items&quot;: [ # A list of InstanceWithNamedPorts resources.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]702 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]703 &quot;instance&quot;: &quot;A String&quot;, # [Output Only] The URL of the instance.
704 &quot;namedPorts&quot;: [ # [Output Only] The named ports that belong to this instance group.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]705 { # The named port. For example: .
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]706 &quot;name&quot;: &quot;A String&quot;, # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
707 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]708 },
709 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]710 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the instance.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]711 },
712 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]713 &quot;kind&quot;: &quot;compute#instanceGroupsListInstances&quot;, # [Output Only] The resource type, which is always compute#instanceGroupsListInstances for the list of instances in the specified instance group.
714 &quot;nextPageToken&quot;: &quot;A String&quot;, # [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.
715 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
716 &quot;warning&quot;: { # [Output Only] Informational warning message.
717 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
718 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
719 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]720 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]721 &quot;key&quot;: &quot;A String&quot;, # [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).
722 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]723 },
724 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]725 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]726 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]727 }</pre>
728</div>
729
730<div class="method">
731 <code class="details" id="listInstances_next">listInstances_next(previous_request, previous_response)</code>
732 <pre>Retrieves the next page of results.
733
734Args:
735 previous_request: The request for the previous page. (required)
736 previous_response: The response from the request for the previous page. (required)
737
738Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]739 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]740 page. Returns None if there are no more items in the collection.
741 </pre>
742</div>
743
744<div class="method">
745 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
746 <pre>Retrieves the next page of results.
747
748Args:
749 previous_request: The request for the previous page. (required)
750 previous_response: The response from the request for the previous page. (required)
751
752Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]753 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]754 page. Returns None if there are no more items in the collection.
755 </pre>
756</div>
757
758<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]759 <code class="details" id="removeInstances">removeInstances(project, zone, instanceGroup, body=None, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]760 <pre>Removes one or more instances from the specified instance group, but does not delete those instances.
761
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]762If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted.
763
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]764Args:
765 project: string, Project ID for this request. (required)
766 zone: string, The name of the zone where the instance group is located. (required)
767 instanceGroup: string, The name of the instance group where the specified instances will be removed. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]768 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]769 The object takes the form of:
770
771{
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]772 &quot;instances&quot;: [ # The list of instances to remove from the instance group.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]773 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]774 &quot;instance&quot;: &quot;A String&quot;, # The URL for a specific instance.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]775 },
776 ],
777 }
778
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]779 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.
780
781For 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.
782
783The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]784
785Returns:
786 An object of the form:
787
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]788 { # Represents an Operation resource.
789 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]790 # Google Compute Engine has three Operation resources:
791 #
792 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
793 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]794 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
795 #
796 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]797 # - For global operations, use the `globalOperations` resource.
798 # - For regional operations, use the `regionOperations` resource.
799 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]800 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]801 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]802 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
803 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
804 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
805 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
806 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
807 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]808 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]809 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
810 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
811 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]812 },
813 ],
814 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]815 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
816 &quot;httpErrorStatusCode&quot;: 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.
817 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
818 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
819 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
820 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
821 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
822 &quot;progress&quot;: 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.
823 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
824 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
825 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
826 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
827 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
828 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
829 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
830 &quot;targetLink&quot;: &quot;A String&quot;, # [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.
831 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
832 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
833 {
834 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
835 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
836 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
837 {
838 &quot;key&quot;: &quot;A String&quot;, # [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).
839 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
840 },
841 ],
842 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
843 },
844 ],
845 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]846 }</pre>
847</div>
848
849<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]850 <code class="details" id="setNamedPorts">setNamedPorts(project, zone, instanceGroup, body=None, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]851 <pre>Sets the named ports for the specified instance group.
852
853Args:
854 project: string, Project ID for this request. (required)
855 zone: string, The name of the zone where the instance group is located. (required)
856 instanceGroup: string, The name of the instance group where the named ports are updated. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]857 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]858 The object takes the form of:
859
860{
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]861 &quot;fingerprint&quot;: &quot;A String&quot;, # The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. A request with an incorrect fingerprint will fail with error 412 conditionNotMet.
862 &quot;namedPorts&quot;: [ # The list of named ports to set for this instance group.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]863 { # The named port. For example: .
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]864 &quot;name&quot;: &quot;A String&quot;, # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
865 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]866 },
867 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]868 }
869
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]870 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.
871
872For 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.
873
874The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]875
876Returns:
877 An object of the form:
878
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]879 { # Represents an Operation resource.
880 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]881 # Google Compute Engine has three Operation resources:
882 #
883 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
884 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]885 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
886 #
887 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]888 # - For global operations, use the `globalOperations` resource.
889 # - For regional operations, use the `regionOperations` resource.
890 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]891 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]892 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]893 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
894 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
895 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
896 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
897 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
898 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]899 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]900 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
901 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
902 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]903 },
904 ],
905 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]906 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
907 &quot;httpErrorStatusCode&quot;: 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.
908 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
909 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
910 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
911 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
912 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
913 &quot;progress&quot;: 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.
914 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
915 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
916 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
917 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
918 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
919 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
920 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
921 &quot;targetLink&quot;: &quot;A String&quot;, # [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.
922 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
923 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
924 {
925 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
926 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
927 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
928 {
929 &quot;key&quot;: &quot;A String&quot;, # [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).
930 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
931 },
932 ],
933 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
934 },
935 ],
936 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]937 }</pre>
938</div>
939
940<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]941 <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]942 <pre>Returns permissions that a caller has on the specified resource.
943
944Args:
945 project: string, Project ID for this request. (required)
946 zone: string, The name of the zone for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]947 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]948 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]949 The object takes the form of:
950
951{
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]952 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
953 &quot;A String&quot;,
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]954 ],
955 }
956
957
958Returns:
959 An object of the form:
960
961 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]962 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
963 &quot;A String&quot;,
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]964 ],
965 }</pre>
966</div>
967
968</body></html>