Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / cc94ec86e652769e9d3d5cb6d6491efb8d76dd21 / . / docs / dyn / compute_beta.regionInstanceGroups.html
blob: 3f79a0248efc8142cd10e9019125ea865bd22b93 [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.regionInstanceGroups.html">regionInstanceGroups</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]81 <code><a href="#get">get(project, region, instanceGroup)</a></code></p>
82<p class="firstline">Returns the specified instance group resource.</p>
83<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]84 <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]85<p class="firstline">Retrieves the list of instance group resources contained within the specified region.</p>
86<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]87 <code><a href="#listInstances">listInstances(project, region, instanceGroup, body=None, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]88<p class="firstline">Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. The orderBy query parameter is not supported.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]89<p class="toc_element">
90 <code><a href="#listInstances_next">listInstances_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]96 <code><a href="#setNamedPorts">setNamedPorts(project, region, instanceGroup, body=None, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]97<p class="firstline">Sets the named ports for the specified regional instance group.</p>
98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]99 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]100<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
101<h3>Method Details</h3>
102<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]103 <code class="details" id="close">close()</code>
104 <pre>Close httplib2 connections.</pre>
105</div>
106
107<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]108 <code class="details" id="get">get(project, region, instanceGroup)</code>
109 <pre>Returns the specified instance group resource.
110
111Args:
112 project: string, Project ID for this request. (required)
113 region: string, Name of the region scoping this request. (required)
114 instanceGroup: string, Name of the instance group resource to return. (required)
115
116Returns:
117 An object of the form:
118
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]119 { # Represents an Instance Group resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]120 #
121 # Instance Groups can be used to configure a target for load balancing.
122 #
123 # Instance groups can either be managed or unmanaged.
124 #
125 # To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead.
126 #
127 # 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.
128 #
129 # For more information, read Instance groups.
130 #
131 # (== resource_for {$api_version}.instanceGroups ==) (== resource_for {$api_version}.regionInstanceGroups ==)
132 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
133 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
134 &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.
135 &quot;id&quot;: &quot;A String&quot;, # [Output Only] A unique identifier for this instance group, generated by the server.
136 &quot;kind&quot;: &quot;compute#instanceGroup&quot;, # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
137 &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.
138 &quot;namedPorts&quot;: [ # Assigns a name to a port number. For example: {name: &quot;http&quot;, port: 80}
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]139 #
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]140 # 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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]141 #
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]142 # Named ports apply to all instances in this instance group.
143 { # The named port. For example: .
144 &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.
145 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
146 },
147 ],
148 &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).
149 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the instance group is located (for regional resources).
150 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] The URL for this instance group. The server generates this URL.
151 &quot;size&quot;: 42, # [Output Only] The total number of instances in the instance group.
152 &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).
153 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
154}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]155</div>
156
157<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]158 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]159 <pre>Retrieves the list of instance group resources contained within the specified region.
160
161Args:
162 project: string, Project ID for this request. (required)
163 region: string, Name of the region scoping this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]164 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `&gt;`, or `&lt;`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]165
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]166For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]167
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]168You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]169
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]170To 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) ```
171 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`)
172 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
173
174You 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.
175
176Currently, only sorting by `name` or `creationTimestamp desc` is supported.
177 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]178 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]179
180Returns:
181 An object of the form:
182
183 { # Contains a list of InstanceGroup resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]184 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
185 &quot;items&quot;: [ # A list of InstanceGroup resources.
186 { # Represents an Instance Group resource.
187 #
188 # Instance Groups can be used to configure a target for load balancing.
189 #
190 # Instance groups can either be managed or unmanaged.
191 #
192 # To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead.
193 #
194 # 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.
195 #
196 # For more information, read Instance groups.
197 #
198 # (== resource_for {$api_version}.instanceGroups ==) (== resource_for {$api_version}.regionInstanceGroups ==)
199 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
200 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
201 &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.
202 &quot;id&quot;: &quot;A String&quot;, # [Output Only] A unique identifier for this instance group, generated by the server.
203 &quot;kind&quot;: &quot;compute#instanceGroup&quot;, # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
204 &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.
205 &quot;namedPorts&quot;: [ # Assigns a name to a port number. For example: {name: &quot;http&quot;, port: 80}
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]206 #
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]207 # 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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]208 #
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]209 # Named ports apply to all instances in this instance group.
210 { # The named port. For example: .
211 &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.
212 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]213 },
214 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]215 &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).
216 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the instance group is located (for regional resources).
217 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] The URL for this instance group. The server generates this URL.
218 &quot;size&quot;: 42, # [Output Only] The total number of instances in the instance group.
219 &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).
220 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]221 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]222 ],
223 &quot;kind&quot;: &quot;compute#regionInstanceGroupList&quot;, # The resource type.
224 &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.
225 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
226 &quot;warning&quot;: { # [Output Only] Informational warning message.
227 &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.
228 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
229 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
230 {
231 &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).
232 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
233 },
234 ],
235 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
236 },
237}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]238</div>
239
240<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]241 <code class="details" id="listInstances">listInstances(project, region, instanceGroup, body=None, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]242 <pre>Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. The orderBy query parameter is not supported.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]243
244Args:
245 project: string, Project ID for this request. (required)
246 region: string, Name of the region scoping this request. (required)
247 instanceGroup: string, Name of the regional instance group for which we want to list the instances. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]248 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]249 The object takes the form of:
250
251{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]252 &quot;instanceState&quot;: &quot;A String&quot;, # Instances in which state should be returned. Valid options are: &#x27;ALL&#x27;, &#x27;RUNNING&#x27;. By default, it lists all instances.
253 &quot;portName&quot;: &quot;A String&quot;, # Name of port user is interested in. It is optional. If it is set, only information about this ports will be returned. If it is not set, all the named ports will be returned. Always lists all instances.
254}
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]255
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]256 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `&gt;`, or `&lt;`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]257
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]258For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]259
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]260You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]261
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]262To 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) ```
263 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`)
264 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
265
266You 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.
267
268Currently, only sorting by `name` or `creationTimestamp desc` is supported.
269 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]270 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]271
272Returns:
273 An object of the form:
274
275 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]276 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
277 &quot;items&quot;: [ # A list of InstanceWithNamedPorts resources.
278 {
279 &quot;instance&quot;: &quot;A String&quot;, # [Output Only] The URL of the instance.
280 &quot;namedPorts&quot;: [ # [Output Only] The named ports that belong to this instance group.
281 { # The named port. For example: .
282 &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.
283 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]284 },
285 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]286 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]287 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]288 ],
289 &quot;kind&quot;: &quot;compute#regionInstanceGroupsListInstances&quot;, # The resource type.
290 &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.
291 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
292 &quot;warning&quot;: { # [Output Only] Informational warning message.
293 &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.
294 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
295 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
296 {
297 &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).
298 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
299 },
300 ],
301 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
302 },
303}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]304</div>
305
306<div class="method">
307 <code class="details" id="listInstances_next">listInstances_next(previous_request, previous_response)</code>
308 <pre>Retrieves the next page of results.
309
310Args:
311 previous_request: The request for the previous page. (required)
312 previous_response: The response from the request for the previous page. (required)
313
314Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]315 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]316 page. Returns None if there are no more items in the collection.
317 </pre>
318</div>
319
320<div class="method">
321 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
322 <pre>Retrieves the next page of results.
323
324Args:
325 previous_request: The request for the previous page. (required)
326 previous_response: The response from the request for the previous page. (required)
327
328Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]329 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]330 page. Returns None if there are no more items in the collection.
331 </pre>
332</div>
333
334<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]335 <code class="details" id="setNamedPorts">setNamedPorts(project, region, instanceGroup, body=None, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]336 <pre>Sets the named ports for the specified regional instance group.
337
338Args:
339 project: string, Project ID for this request. (required)
340 region: string, Name of the region scoping this request. (required)
341 instanceGroup: string, The name of the regional instance group where the named ports are updated. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]342 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]343 The object takes the form of:
344
345{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]346 &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.
347 &quot;namedPorts&quot;: [ # The list of named ports to set for this instance group.
348 { # The named port. For example: .
349 &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.
350 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
351 },
352 ],
353}
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]354
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]355 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.
356
357For 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.
358
359The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]360
361Returns:
362 An object of the form:
363
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]364 { # Represents an Operation resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]365 #
366 # Google Compute Engine has three Operation resources:
367 #
368 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
369 #
370 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
371 #
372 # Operations can be global, regional or zonal.
373 # - For global operations, use the `globalOperations` resource.
374 # - For regional operations, use the `regionOperations` resource.
375 # - For zonal operations, use the `zonalOperations` resource.
376 #
377 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
378 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
379 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
380 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
381 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
382 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
383 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]384 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]385 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
386 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
387 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]388 },
389 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]390 },
391 &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`.
392 &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.
393 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
394 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
395 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
396 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
397 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
398 &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.
399 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
400 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
401 &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.
402 &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`.
403 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
404 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
405 &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.
406 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
407 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
408 {
409 &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.
410 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
411 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
412 {
413 &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).
414 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
415 },
416 ],
417 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
418 },
419 ],
420 &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.
421}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]422</div>
423
424<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]425 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]426 <pre>Returns permissions that a caller has on the specified resource.
427
428Args:
429 project: string, Project ID for this request. (required)
430 region: string, The name of the region for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]431 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]432 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]433 The object takes the form of:
434
435{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]436 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
437 &quot;A String&quot;,
438 ],
439}
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]440
441
442Returns:
443 An object of the form:
444
445 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]446 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
447 &quot;A String&quot;,
448 ],
449}</pre>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]450</div>
451
452</body></html>