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