blob: ecc2b2ca6c94f04fc29d4c3489b90d8b894472fa [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001<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">
yoshi-code-bot36591372021-06-16 00:22:06 -070078 <code><a href="#addInstances">addInstances(project, zone, instanceGroup, body=None, requestId=None, x__xgafv=None)</a></code></p>
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>
Sai Cheemalapatidf613972016-10-21 13:59:49 -070080<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -070081 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -070082<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 -070087 <code><a href="#close">close()</a></code></p>
88<p class="firstline">Close httplib2 connections.</p>
89<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -070090 <code><a href="#delete">delete(project, zone, instanceGroup, requestId=None, x__xgafv=None)</a></code></p>
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>
Sai Cheemalapatidf613972016-10-21 13:59:49 -070092<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -070093 <code><a href="#get">get(project, zone, instanceGroup, x__xgafv=None)</a></code></p>
94<p class="firstline">Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -070095<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -070096 <code><a href="#insert">insert(project, zone, body=None, requestId=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -070097<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">
yoshi-code-bot36591372021-06-16 00:22:06 -070099 <code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
100<p class="firstline">Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700101<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -0700102 <code><a href="#listInstances">listInstances(project, zone, instanceGroup, body=None, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700103<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 -0700104<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">
yoshi-code-bot36591372021-06-16 00:22:06 -0700111 <code><a href="#removeInstances">removeInstances(project, zone, instanceGroup, body=None, requestId=None, x__xgafv=None)</a></code></p>
112<p class="firstline">Removes one or more instances from the specified instance group, but does not delete those instances. If 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.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700113<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -0700114 <code><a href="#setNamedPorts">setNamedPorts(project, zone, instanceGroup, body=None, requestId=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700115<p class="firstline">Sets the named ports for the specified instance group.</p>
116<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -0700117 <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700118<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
119<h3>Method Details</h3>
120<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700121 <code class="details" id="addInstances">addInstances(project, zone, instanceGroup, body=None, requestId=None, x__xgafv=None)</code>
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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700123
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 -0700128 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700129 The object takes the form of:
130
131{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800132 &quot;instances&quot;: [ # The list of instances to add to the instance group.
133 {
yoshi-code-bot36591372021-06-16 00:22:06 -0700134 &quot;instance&quot;: &quot;A String&quot;, # The URL for a specific instance. @required compute.instancegroups.addInstances/removeInstances
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800135 },
136 ],
137}
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700138
yoshi-code-bot36591372021-06-16 00:22:06 -0700139 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
140 x__xgafv: string, V1 error format.
141 Allowed values
142 1 - v1 error format
143 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700144
145Returns:
146 An object of the form:
147
yoshi-code-bot36591372021-06-16 00:22:06 -0700148 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800149 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
150 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
151 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
152 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
153 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
154 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700155 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800156 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
157 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
158 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700159 },
160 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800161 },
162 &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`.
163 &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.
164 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
165 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
166 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bot85954412021-12-06 23:26:37 -0800167 &quot;metadata&quot;: { # [Output Only] Service-specific metadata attached to this operation.
168 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
169 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800170 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800171 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800172 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
173 &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.
174 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
175 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
176 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
177 &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.
178 &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`.
179 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
180 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
181 &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.
182 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
183 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
184 {
185 &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.
yoshi-code-bot36591372021-06-16 00:22:06 -0700186 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800187 {
188 &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).
189 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
190 },
191 ],
192 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
193 },
194 ],
195 &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.
196}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700197</div>
198
199<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700200 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700201 <pre>Retrieves the list of instance groups and sorts them by zone.
202
203Args:
204 project: string, Project ID for this request. (required)
yoshi-code-bot85954412021-12-06 23:26:37 -0800205 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = &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 -0700206 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 -0700207 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`)
yoshi-code-bot36591372021-06-16 00:22:06 -0700208 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=&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. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Bu Sun Kim65020912020-05-20 12:08:20 -0700209 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.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800210 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
yoshi-code-bot36591372021-06-16 00:22:06 -0700211 x__xgafv: string, V1 error format.
212 Allowed values
213 1 - v1 error format
214 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700215
216Returns:
217 An object of the form:
218
219 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800220 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
221 &quot;items&quot;: { # A list of InstanceGroupsScopedList resources.
222 &quot;a_key&quot;: { # The name of the scope that contains this set of instance groups.
223 &quot;instanceGroups&quot;: [ # [Output Only] The list of instance groups that are contained in this scope.
yoshi-code-bot36591372021-06-16 00:22:06 -0700224 { # Represents an Instance Group resource. Instance Groups can be used to configure a target for load balancing. Instance groups can either be managed or unmanaged. To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead. 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. For more information, read Instance groups.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800225 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
226 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
227 &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.
228 &quot;id&quot;: &quot;A String&quot;, # [Output Only] A unique identifier for this instance group, generated by the server.
229 &quot;kind&quot;: &quot;compute#instanceGroup&quot;, # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
230 &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.
yoshi-code-bot36591372021-06-16 00:22:06 -0700231 &quot;namedPorts&quot;: [ # Assigns a name to a port number. For example: {name: &quot;http&quot;, port: 80} 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}] Named ports apply to all instances in this instance group.
232 { # The named port. For example: &lt;&quot;http&quot;, 80&gt;.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800233 &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.
234 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700235 },
236 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800237 &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).
238 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the instance group is located (for regional resources).
239 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] The URL for this instance group. The server generates this URL.
240 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
241 &quot;size&quot;: 42, # [Output Only] The total number of instances in the instance group.
242 &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).
243 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700244 },
245 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800246 &quot;warning&quot;: { # [Output Only] An informational warning that replaces the list of instance groups when the list is empty.
247 &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.
yoshi-code-bot36591372021-06-16 00:22:06 -0700248 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800249 {
250 &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).
251 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
252 },
253 ],
254 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
255 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700256 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800257 },
258 &quot;kind&quot;: &quot;compute#instanceGroupAggregatedList&quot;, # [Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups.
259 &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.
260 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
261 &quot;unreachables&quot;: [ # [Output Only] Unreachable resources.
262 &quot;A String&quot;,
263 ],
264 &quot;warning&quot;: { # [Output Only] Informational warning message.
265 &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.
yoshi-code-bot36591372021-06-16 00:22:06 -0700266 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800267 {
268 &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).
269 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
270 },
271 ],
272 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
273 },
274}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700275</div>
276
277<div class="method">
278 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
279 <pre>Retrieves the next page of results.
280
281Args:
282 previous_request: The request for the previous page. (required)
283 previous_response: The response from the request for the previous page. (required)
284
285Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700286 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700287 page. Returns None if there are no more items in the collection.
288 </pre>
289</div>
290
291<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700292 <code class="details" id="close">close()</code>
293 <pre>Close httplib2 connections.</pre>
294</div>
295
296<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700297 <code class="details" id="delete">delete(project, zone, instanceGroup, requestId=None, x__xgafv=None)</code>
298 <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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700299
300Args:
301 project: string, Project ID for this request. (required)
302 zone: string, The name of the zone where the instance group is located. (required)
303 instanceGroup: string, The name of the instance group to delete. (required)
yoshi-code-bot36591372021-06-16 00:22:06 -0700304 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
305 x__xgafv: string, V1 error format.
306 Allowed values
307 1 - v1 error format
308 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700309
310Returns:
311 An object of the form:
312
yoshi-code-bot36591372021-06-16 00:22:06 -0700313 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800314 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
315 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
316 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
317 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
318 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
319 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700320 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800321 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
322 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
323 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700324 },
325 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800326 },
327 &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`.
328 &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.
329 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
330 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
331 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bot85954412021-12-06 23:26:37 -0800332 &quot;metadata&quot;: { # [Output Only] Service-specific metadata attached to this operation.
333 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
334 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800335 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800336 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800337 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
338 &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.
339 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
340 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
341 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
342 &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.
343 &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`.
344 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
345 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
346 &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.
347 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
348 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
349 {
350 &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.
yoshi-code-bot36591372021-06-16 00:22:06 -0700351 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800352 {
353 &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).
354 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
355 },
356 ],
357 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
358 },
359 ],
360 &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.
361}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700362</div>
363
364<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700365 <code class="details" id="get">get(project, zone, instanceGroup, x__xgafv=None)</code>
366 <pre>Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700367
368Args:
369 project: string, Project ID for this request. (required)
370 zone: string, The name of the zone where the instance group is located. (required)
371 instanceGroup: string, The name of the instance group. (required)
yoshi-code-bot36591372021-06-16 00:22:06 -0700372 x__xgafv: string, V1 error format.
373 Allowed values
374 1 - v1 error format
375 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700376
377Returns:
378 An object of the form:
379
yoshi-code-bot36591372021-06-16 00:22:06 -0700380 { # Represents an Instance Group resource. Instance Groups can be used to configure a target for load balancing. Instance groups can either be managed or unmanaged. To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead. 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. For more information, read Instance groups.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800381 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
382 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
383 &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.
384 &quot;id&quot;: &quot;A String&quot;, # [Output Only] A unique identifier for this instance group, generated by the server.
385 &quot;kind&quot;: &quot;compute#instanceGroup&quot;, # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
386 &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.
yoshi-code-bot36591372021-06-16 00:22:06 -0700387 &quot;namedPorts&quot;: [ # Assigns a name to a port number. For example: {name: &quot;http&quot;, port: 80} 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}] Named ports apply to all instances in this instance group.
388 { # The named port. For example: &lt;&quot;http&quot;, 80&gt;.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800389 &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.
390 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
391 },
392 ],
393 &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).
394 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the instance group is located (for regional resources).
395 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] The URL for this instance group. The server generates this URL.
396 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
397 &quot;size&quot;: 42, # [Output Only] The total number of instances in the instance group.
398 &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).
399 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
400}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700401</div>
402
403<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700404 <code class="details" id="insert">insert(project, zone, body=None, requestId=None, x__xgafv=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700405 <pre>Creates an instance group in the specified project using the parameters that are included in the request.
406
407Args:
408 project: string, Project ID for this request. (required)
409 zone: string, The name of the zone where you want to create the instance group. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700410 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700411 The object takes the form of:
412
yoshi-code-bot36591372021-06-16 00:22:06 -0700413{ # Represents an Instance Group resource. Instance Groups can be used to configure a target for load balancing. Instance groups can either be managed or unmanaged. To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead. 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. For more information, read Instance groups.
Bu Sun Kim65020912020-05-20 12:08:20 -0700414 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
415 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
416 &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.
417 &quot;id&quot;: &quot;A String&quot;, # [Output Only] A unique identifier for this instance group, generated by the server.
418 &quot;kind&quot;: &quot;compute#instanceGroup&quot;, # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
419 &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.
yoshi-code-bot36591372021-06-16 00:22:06 -0700420 &quot;namedPorts&quot;: [ # Assigns a name to a port number. For example: {name: &quot;http&quot;, port: 80} 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}] Named ports apply to all instances in this instance group.
421 { # The named port. For example: &lt;&quot;http&quot;, 80&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700422 &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.
423 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
424 },
425 ],
426 &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).
427 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the instance group is located (for regional resources).
428 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] The URL for this instance group. The server generates this URL.
429 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
430 &quot;size&quot;: 42, # [Output Only] The total number of instances in the instance group.
431 &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).
432 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
433}
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700434
yoshi-code-bot36591372021-06-16 00:22:06 -0700435 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
436 x__xgafv: string, V1 error format.
437 Allowed values
438 1 - v1 error format
439 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700440
441Returns:
442 An object of the form:
443
yoshi-code-bot36591372021-06-16 00:22:06 -0700444 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800445 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
446 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
447 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
448 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
449 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
450 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700451 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800452 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
453 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
454 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700455 },
456 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800457 },
458 &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`.
459 &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.
460 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
461 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
462 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bot85954412021-12-06 23:26:37 -0800463 &quot;metadata&quot;: { # [Output Only] Service-specific metadata attached to this operation.
464 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
465 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800466 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800467 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800468 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
469 &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.
470 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
471 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
472 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
473 &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.
474 &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`.
475 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
476 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
477 &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.
478 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
479 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
480 {
481 &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.
yoshi-code-bot36591372021-06-16 00:22:06 -0700482 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800483 {
484 &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).
485 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
486 },
487 ],
488 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
489 },
490 ],
491 &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.
492}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700493</div>
494
495<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700496 <code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
497 <pre>Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700498
499Args:
500 project: string, Project ID for this request. (required)
501 zone: string, The name of the zone where the instance group is located. (required)
yoshi-code-bot85954412021-12-06 23:26:37 -0800502 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = &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) ```
Bu Sun Kim65020912020-05-20 12:08:20 -0700503 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`)
yoshi-code-bot36591372021-06-16 00:22:06 -0700504 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=&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. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Bu Sun Kim65020912020-05-20 12:08:20 -0700505 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.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800506 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
yoshi-code-bot36591372021-06-16 00:22:06 -0700507 x__xgafv: string, V1 error format.
508 Allowed values
509 1 - v1 error format
510 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700511
512Returns:
513 An object of the form:
514
515 { # A list of InstanceGroup resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800516 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
517 &quot;items&quot;: [ # A list of InstanceGroup resources.
yoshi-code-bot36591372021-06-16 00:22:06 -0700518 { # Represents an Instance Group resource. Instance Groups can be used to configure a target for load balancing. Instance groups can either be managed or unmanaged. To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead. 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. For more information, read Instance groups.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800519 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
520 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
521 &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.
522 &quot;id&quot;: &quot;A String&quot;, # [Output Only] A unique identifier for this instance group, generated by the server.
523 &quot;kind&quot;: &quot;compute#instanceGroup&quot;, # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
524 &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.
yoshi-code-bot36591372021-06-16 00:22:06 -0700525 &quot;namedPorts&quot;: [ # Assigns a name to a port number. For example: {name: &quot;http&quot;, port: 80} 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}] Named ports apply to all instances in this instance group.
526 { # The named port. For example: &lt;&quot;http&quot;, 80&gt;.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800527 &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.
528 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700529 },
530 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800531 &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).
532 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the instance group is located (for regional resources).
533 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] The URL for this instance group. The server generates this URL.
534 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
535 &quot;size&quot;: 42, # [Output Only] The total number of instances in the instance group.
536 &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).
537 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700538 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800539 ],
540 &quot;kind&quot;: &quot;compute#instanceGroupList&quot;, # [Output Only] The resource type, which is always compute#instanceGroupList for instance group lists.
541 &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.
542 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
543 &quot;warning&quot;: { # [Output Only] Informational warning message.
544 &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.
yoshi-code-bot36591372021-06-16 00:22:06 -0700545 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800546 {
547 &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).
548 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
549 },
550 ],
551 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
552 },
553}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700554</div>
555
556<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700557 <code class="details" id="listInstances">listInstances(project, zone, instanceGroup, body=None, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700558 <pre>Lists the instances in the specified instance group. The orderBy query parameter is not supported.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700559
560Args:
561 project: string, Project ID for this request. (required)
562 zone: string, The name of the zone where the instance group is located. (required)
563 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 -0700564 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700565 The object takes the form of:
566
567{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800568 &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.
569}
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700570
yoshi-code-bot85954412021-12-06 23:26:37 -0800571 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = &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) ```
Bu Sun Kim65020912020-05-20 12:08:20 -0700572 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`)
yoshi-code-bot36591372021-06-16 00:22:06 -0700573 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=&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. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Bu Sun Kim65020912020-05-20 12:08:20 -0700574 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.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800575 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
yoshi-code-bot36591372021-06-16 00:22:06 -0700576 x__xgafv: string, V1 error format.
577 Allowed values
578 1 - v1 error format
579 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700580
581Returns:
582 An object of the form:
583
584 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800585 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
586 &quot;items&quot;: [ # A list of InstanceWithNamedPorts resources.
587 {
588 &quot;instance&quot;: &quot;A String&quot;, # [Output Only] The URL of the instance.
589 &quot;namedPorts&quot;: [ # [Output Only] The named ports that belong to this instance group.
yoshi-code-bot36591372021-06-16 00:22:06 -0700590 { # The named port. For example: &lt;&quot;http&quot;, 80&gt;.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800591 &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.
592 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700593 },
594 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800595 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700596 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800597 ],
598 &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.
599 &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.
600 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
601 &quot;warning&quot;: { # [Output Only] Informational warning message.
602 &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.
yoshi-code-bot36591372021-06-16 00:22:06 -0700603 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800604 {
605 &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).
606 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
607 },
608 ],
609 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
610 },
611}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700612</div>
613
614<div class="method">
615 <code class="details" id="listInstances_next">listInstances_next(previous_request, previous_response)</code>
616 <pre>Retrieves the next page of results.
617
618Args:
619 previous_request: The request for the previous page. (required)
620 previous_response: The response from the request for the previous page. (required)
621
622Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700623 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700624 page. Returns None if there are no more items in the collection.
625 </pre>
626</div>
627
628<div class="method">
629 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
630 <pre>Retrieves the next page of results.
631
632Args:
633 previous_request: The request for the previous page. (required)
634 previous_response: The response from the request for the previous page. (required)
635
636Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700637 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700638 page. Returns None if there are no more items in the collection.
639 </pre>
640</div>
641
642<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700643 <code class="details" id="removeInstances">removeInstances(project, zone, instanceGroup, body=None, requestId=None, x__xgafv=None)</code>
644 <pre>Removes one or more instances from the specified instance group, but does not delete those instances. If 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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400645
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700646Args:
647 project: string, Project ID for this request. (required)
648 zone: string, The name of the zone where the instance group is located. (required)
649 instanceGroup: string, The name of the instance group where the specified instances will be removed. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700650 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700651 The object takes the form of:
652
653{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800654 &quot;instances&quot;: [ # The list of instances to remove from the instance group.
655 {
yoshi-code-bot36591372021-06-16 00:22:06 -0700656 &quot;instance&quot;: &quot;A String&quot;, # The URL for a specific instance. @required compute.instancegroups.addInstances/removeInstances
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800657 },
658 ],
659}
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700660
yoshi-code-bot36591372021-06-16 00:22:06 -0700661 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
662 x__xgafv: string, V1 error format.
663 Allowed values
664 1 - v1 error format
665 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700666
667Returns:
668 An object of the form:
669
yoshi-code-bot36591372021-06-16 00:22:06 -0700670 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800671 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
672 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
673 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
674 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
675 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
676 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700677 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800678 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
679 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
680 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700681 },
682 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800683 },
684 &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`.
685 &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.
686 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
687 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
688 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bot85954412021-12-06 23:26:37 -0800689 &quot;metadata&quot;: { # [Output Only] Service-specific metadata attached to this operation.
690 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
691 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800692 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800693 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800694 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
695 &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.
696 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
697 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
698 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
699 &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.
700 &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`.
701 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
702 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
703 &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.
704 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
705 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
706 {
707 &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.
yoshi-code-bot36591372021-06-16 00:22:06 -0700708 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800709 {
710 &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).
711 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
712 },
713 ],
714 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
715 },
716 ],
717 &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.
718}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700719</div>
720
721<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700722 <code class="details" id="setNamedPorts">setNamedPorts(project, zone, instanceGroup, body=None, requestId=None, x__xgafv=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700723 <pre>Sets the named ports for the specified instance group.
724
725Args:
726 project: string, Project ID for this request. (required)
727 zone: string, The name of the zone where the instance group is located. (required)
728 instanceGroup: string, The name of the instance group where the named ports are updated. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700729 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700730 The object takes the form of:
731
732{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800733 &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.
734 &quot;namedPorts&quot;: [ # The list of named ports to set for this instance group.
yoshi-code-bot36591372021-06-16 00:22:06 -0700735 { # The named port. For example: &lt;&quot;http&quot;, 80&gt;.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800736 &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.
737 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
738 },
739 ],
740}
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700741
yoshi-code-bot36591372021-06-16 00:22:06 -0700742 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
743 x__xgafv: string, V1 error format.
744 Allowed values
745 1 - v1 error format
746 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700747
748Returns:
749 An object of the form:
750
yoshi-code-bot36591372021-06-16 00:22:06 -0700751 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800752 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
753 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
754 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
755 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
756 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
757 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700758 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800759 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
760 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
761 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700762 },
763 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800764 },
765 &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`.
766 &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.
767 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
768 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
769 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bot85954412021-12-06 23:26:37 -0800770 &quot;metadata&quot;: { # [Output Only] Service-specific metadata attached to this operation.
771 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
772 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800773 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800774 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800775 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
776 &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.
777 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
778 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
779 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
780 &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.
781 &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`.
782 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
783 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
784 &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.
785 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
786 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
787 {
788 &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.
yoshi-code-bot36591372021-06-16 00:22:06 -0700789 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800790 {
791 &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).
792 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
793 },
794 ],
795 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
796 },
797 ],
798 &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.
799}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700800</div>
801
802<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700803 <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700804 <pre>Returns permissions that a caller has on the specified resource.
805
806Args:
807 project: string, Project ID for this request. (required)
808 zone: string, The name of the zone for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700809 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700810 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700811 The object takes the form of:
812
813{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800814 &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.
815 &quot;A String&quot;,
816 ],
817}
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700818
yoshi-code-bot36591372021-06-16 00:22:06 -0700819 x__xgafv: string, V1 error format.
820 Allowed values
821 1 - v1 error format
822 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700823
824Returns:
825 An object of the form:
826
827 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800828 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
829 &quot;A String&quot;,
830 ],
831}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700832</div>
833
834</body></html>