Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / compute_beta.regionInstanceGroups.html
blob: 2648e105d9980574bc09efea681b4823eebb76c7 [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">
78 <code><a href="#get">get(project, region, instanceGroup)</a></code></p>
79<p class="firstline">Returns the specified instance group resource.</p>
80<p class="toc_element">
81 <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
82<p class="firstline">Retrieves the list of instance group resources contained within the specified region.</p>
83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]84 <code><a href="#listInstances">listInstances(project, region, instanceGroup, body=None, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]85<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.</p>
86<p class="toc_element">
87 <code><a href="#listInstances_next">listInstances_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]93 <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]94<p class="firstline">Sets the named ports for the specified regional instance group.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]96 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]97<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="get">get(project, region, instanceGroup)</code>
101 <pre>Returns the specified instance group resource.
102
103Args:
104 project: string, Project ID for this request. (required)
105 region: string, Name of the region scoping this request. (required)
106 instanceGroup: string, Name of the instance group resource to return. (required)
107
108Returns:
109 An object of the form:
110
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]111 { # Represents an Instance Group resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]113 # Instance Groups can be used to configure a target for load balancing.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]114 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]115 # Instance groups can either be managed or unmanaged.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]116 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]117 # To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead.
118 #
119 # 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.
120 #
121 # For more information, read Instance groups.
122 #
123 # (== resource_for {$api_version}.instanceGroups ==) (== resource_for {$api_version}.regionInstanceGroups ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]124 "size": 42, # [Output Only] The total number of instances in the instance group.
125 "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
126 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
127 "zone": "A String", # [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]128 "region": "A String", # [Output Only] The URL of the region where the instance group is located (for regional resources).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]129 "network": "A String", # [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).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]130 "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]131 "subnetwork": "A String", # [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).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]132 "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
133 #
134 # 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: "http", port: 80},{name: "http", port: 8080}]
135 #
136 # Named ports apply to all instances in this instance group.
137 { # The named port. For example: .
138 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
139 "port": 42, # The port number, which can be a value between 1 and 65535.
140 },
141 ],
142 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
143 "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
144 "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
145 "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
146 }</pre>
147</div>
148
149<div class="method">
150 <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
151 <pre>Retrieves the list of instance group resources contained within the specified region.
152
153Args:
154 project: string, Project ID for this request. (required)
155 region: string, Name of the region scoping this request. (required)
156 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
157
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]158You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]159
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]160Currently, only sorting by `name` or `creationTimestamp desc` is supported.
161 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`)
162 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.
163 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]164
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]165For 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]166
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]167You 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]168
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]169To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]170
171Returns:
172 An object of the form:
173
174 { # Contains a list of InstanceGroup resources.
175 "nextPageToken": "A String", # [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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]176 "kind": "compute#regionInstanceGroupList", # The resource type.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]177 "items": [ # A list of InstanceGroup resources.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]178 { # Represents an Instance Group resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]179 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]180 # Instance Groups can be used to configure a target for load balancing.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]181 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]182 # Instance groups can either be managed or unmanaged.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]183 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]184 # To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead.
185 #
186 # 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.
187 #
188 # For more information, read Instance groups.
189 #
190 # (== resource_for {$api_version}.instanceGroups ==) (== resource_for {$api_version}.regionInstanceGroups ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]191 "size": 42, # [Output Only] The total number of instances in the instance group.
192 "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
193 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
194 "zone": "A String", # [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]195 "region": "A String", # [Output Only] The URL of the region where the instance group is located (for regional resources).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]196 "network": "A String", # [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).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]197 "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]198 "subnetwork": "A String", # [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).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]199 "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
200 #
201 # 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: "http", port: 80},{name: "http", port: 8080}]
202 #
203 # Named ports apply to all instances in this instance group.
204 { # The named port. For example: .
205 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
206 "port": 42, # The port number, which can be a value between 1 and 65535.
207 },
208 ],
209 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
210 "id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
211 "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
212 "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
213 },
214 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]215 "warning": { # [Output Only] Informational warning message.
216 "message": "A String", # [Output Only] A human-readable description of the warning code.
217 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
218 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
219 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
220 {
221 "value": "A String", # [Output Only] A warning data value corresponding to the key.
222 "key": "A String", # [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).
223 },
224 ],
225 },
226 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
227 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]228 }</pre>
229</div>
230
231<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]232 <code class="details" id="listInstances">listInstances(project, region, instanceGroup, body=None, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]233 <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.
234
235Args:
236 project: string, Project ID for this request. (required)
237 region: string, Name of the region scoping this request. (required)
238 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^]239 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]240 The object takes the form of:
241
242{
243 "portName": "A String", # 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.
244 "instanceState": "A String", # Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default, it lists all instances.
245 }
246
247 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
248
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]249You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]250
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]251Currently, only sorting by `name` or `creationTimestamp desc` is supported.
252 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`)
253 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.
254 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]255
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]256For 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]257
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]258You 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]259
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]260To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]261
262Returns:
263 An object of the form:
264
265 {
266 "nextPageToken": "A String", # [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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]267 "kind": "compute#regionInstanceGroupsListInstances", # The resource type.
268 "items": [ # A list of InstanceWithNamedPorts resources.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]269 {
270 "status": "A String", # [Output Only] The status of the instance.
271 "instance": "A String", # [Output Only] The URL of the instance.
272 "namedPorts": [ # [Output Only] The named ports that belong to this instance group.
273 { # The named port. For example: .
274 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
275 "port": 42, # The port number, which can be a value between 1 and 65535.
276 },
277 ],
278 },
279 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]280 "warning": { # [Output Only] Informational warning message.
281 "message": "A String", # [Output Only] A human-readable description of the warning code.
282 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
283 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
284 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
285 {
286 "value": "A String", # [Output Only] A warning data value corresponding to the key.
287 "key": "A String", # [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).
288 },
289 ],
290 },
291 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
292 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]293 }</pre>
294</div>
295
296<div class="method">
297 <code class="details" id="listInstances_next">listInstances_next(previous_request, previous_response)</code>
298 <pre>Retrieves the next page of results.
299
300Args:
301 previous_request: The request for the previous page. (required)
302 previous_response: The response from the request for the previous page. (required)
303
304Returns:
305 A request object that you can call 'execute()' on to request the next
306 page. Returns None if there are no more items in the collection.
307 </pre>
308</div>
309
310<div class="method">
311 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
312 <pre>Retrieves the next page of results.
313
314Args:
315 previous_request: The request for the previous page. (required)
316 previous_response: The response from the request for the previous page. (required)
317
318Returns:
319 A request object that you can call 'execute()' on to request the next
320 page. Returns None if there are no more items in the collection.
321 </pre>
322</div>
323
324<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]325 <code class="details" id="setNamedPorts">setNamedPorts(project, region, instanceGroup, body=None, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]326 <pre>Sets the named ports for the specified regional instance group.
327
328Args:
329 project: string, Project ID for this request. (required)
330 region: string, Name of the region scoping this request. (required)
331 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^]332 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]333 The object takes the form of:
334
335{
336 "namedPorts": [ # The list of named ports to set for this instance group.
337 { # The named port. For example: .
338 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
339 "port": 42, # The port number, which can be a value between 1 and 65535.
340 },
341 ],
342 "fingerprint": "A String", # 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.
343 }
344
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]345 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.
346
347For 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.
348
349The 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]350
351Returns:
352 An object of the form:
353
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]354 { # Represents an Operation resource.
355 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]356 # Google Compute Engine has three Operation resources:
357 #
358 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
359 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]360 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
361 #
362 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]363 # - For global operations, use the `globalOperations` resource.
364 # - For regional operations, use the `regionOperations` resource.
365 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]366 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]367 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]368 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]369 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]370 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]371 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]372 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]373 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]374 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
375 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]376 "progress": 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]377 "httpErrorStatusCode": 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]378 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]379 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]380 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
381 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
382 {
383 "message": "A String", # [Output Only] A human-readable description of the warning code.
384 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
385 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
386 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
387 {
388 "value": "A String", # [Output Only] A warning data value corresponding to the key.
389 "key": "A String", # [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).
390 },
391 ],
392 },
393 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]394 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]395 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]396 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
397 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]398 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]399 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
400 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
401 {
402 "message": "A String", # [Output Only] An optional, human-readable error message.
403 "code": "A String", # [Output Only] The error type identifier for this error.
404 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
405 },
406 ],
407 },
408 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
409 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]410 "targetLink": "A String", # [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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]411 }</pre>
412</div>
413
414<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]415 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]416 <pre>Returns permissions that a caller has on the specified resource.
417
418Args:
419 project: string, Project ID for this request. (required)
420 region: string, The name of the region for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]421 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]422 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]423 The object takes the form of:
424
425{
426 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
427 "A String",
428 ],
429 }
430
431
432Returns:
433 An object of the form:
434
435 {
436 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
437 "A String",
438 ],
439 }</pre>
440</div>
441
442</body></html>