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