Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a36e3b130d609dfdc5b3ac0a70ff1b014c4bc75f / . / docs / dyn / compute_alpha.nodeGroups.html
blob: d4647d16780b3301365f13f4fa056585d2436e13 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.nodeGroups.html">nodeGroups</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]78 <code><a href="#addNodes">addNodes(project, zone, nodeGroup, body=None, requestId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Adds specified number of nodes to the node group.</p>
80<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]81 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group.</p>
83<p class="toc_element">
84 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]87 <code><a href="#close">close()</a></code></p>
88<p class="firstline">Close httplib2 connections.</p>
89<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]90 <code><a href="#delete">delete(project, zone, nodeGroup, requestId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91<p class="firstline">Deletes the specified NodeGroup resource.</p>
92<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]93 <code><a href="#deleteNodes">deleteNodes(project, zone, nodeGroup, body=None, requestId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94<p class="firstline">Deletes specified nodes from the node group.</p>
95<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]96 <code><a href="#get">get(project, zone, nodeGroup, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97<p class="firstline">Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the "nodes" field should not be used. Use nodeGroups.listNodes instead.</p>
98<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]99 <code><a href="#getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]100<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p>
101<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]102 <code><a href="#insert">insert(project, zone, initialNodeCount, body=None, requestId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103<p class="firstline">Creates a NodeGroup resource in the specified project using the data included in the request.</p>
104<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]105 <code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106<p class="firstline">Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group.</p>
107<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]108 <code><a href="#listNodes">listNodes(project, zone, nodeGroup, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]109<p class="firstline">Lists nodes in the node group.</p>
110<p class="toc_element">
111 <code><a href="#listNodes_next">listNodes_next(previous_request, previous_response)</a></code></p>
112<p class="firstline">Retrieves the next page of results.</p>
113<p class="toc_element">
114 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
115<p class="firstline">Retrieves the next page of results.</p>
116<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]117 <code><a href="#patch">patch(project, zone, nodeGroup, body=None, requestId=None, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]118<p class="firstline">Updates the specified node group.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]119<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]120 <code><a href="#setIamPolicy">setIamPolicy(project, zone, resource, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]121<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>
122<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]123 <code><a href="#setNodeTemplate">setNodeTemplate(project, zone, nodeGroup, body=None, requestId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]124<p class="firstline">Updates the node template of the node group.</p>
125<p class="toc_element">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]126 <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]127<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
128<h3>Method Details</h3>
129<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]130 <code class="details" id="addNodes">addNodes(project, zone, nodeGroup, body=None, requestId=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]131 <pre>Adds specified number of nodes to the node group.
132
133Args:
134 project: string, Project ID for this request. (required)
135 zone: string, The name of the zone for this request. (required)
136 nodeGroup: string, Name of the NodeGroup resource. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]137 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]138 The object takes the form of:
139
140{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]141 &quot;additionalNodeCount&quot;: 42, # Count of additional nodes to be added to the node group.
142}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]143
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]144 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
145 x__xgafv: string, V1 error format.
146 Allowed values
147 1 - v1 error format
148 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]149
150Returns:
151 An object of the form:
152
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]153 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]154 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
155 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
156 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
157 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
158 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
159 &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]160 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]161 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
162 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
163 &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]164 },
165 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]166 },
167 &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`.
168 &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.
169 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
170 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
171 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
172 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]173 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]174 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
175 &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.
176 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
177 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
178 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
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.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]188 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]189 {
190 &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).
191 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
192 },
193 ],
194 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
195 },
196 ],
197 &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.
198}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]199</div>
200
201<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]202 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]203 <pre>Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group.
204
205Args:
206 project: string, Project ID for this request. (required)
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]207 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;`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = &quot;Intel Skylake&quot;) ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = &quot;Intel Skylake&quot;) OR (cpuPlatform = &quot;Intel Broadwell&quot;) AND (scheduling.automaticRestart = true) ```
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]208 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]209 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]210 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]211 pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]212 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]213 x__xgafv: string, V1 error format.
214 Allowed values
215 1 - v1 error format
216 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]217
218Returns:
219 An object of the form:
220
221 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]222 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
223 &quot;items&quot;: { # A list of NodeGroupsScopedList resources.
224 &quot;a_key&quot;: { # [Output Only] Name of the scope containing this set of node groups.
225 &quot;nodeGroups&quot;: [ # [Output Only] A list of node groups contained in this scope.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]226 { # Represent a sole-tenant Node Group resource. A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]227 &quot;autoscalingPolicy&quot;: { # Specifies how autoscaling should behave.
228 &quot;maxNodes&quot;: 42, # The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100.
229 &quot;minNodes&quot;: 42, # The minimum number of nodes that the group should have.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]230 &quot;mode&quot;: &quot;A String&quot;, # The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For more information, see Autoscaler modes.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]231 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]232 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
233 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
234 &quot;fingerprint&quot;: &quot;A String&quot;,
235 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
236 &quot;kind&quot;: &quot;compute#nodeGroup&quot;, # [Output Only] The type of the resource. Always compute#nodeGroup for node group.
237 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]238 &quot;maintenancePolicy&quot;: &quot;A String&quot;, # Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]239 &quot;maintenanceWindow&quot;: { # Time window specified for daily maintenance operations. GCE&#x27;s internal maintenance will be performed within this window.
240 &quot;duration&quot;: &quot;A String&quot;, # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]241 &quot;maintenanceDuration&quot;: { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like &quot;day&quot; or &quot;month&quot;. Range is approximately 10,000 years. # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.
242 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
243 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
244 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]245 &quot;startTime&quot;: &quot;A String&quot;, # Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.
246 },
247 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
248 &quot;nodeTemplate&quot;: &quot;A String&quot;, # URL of the node template to create the node group from.
249 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
250 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
yoshi-code-bot73a0aa32021-05-25 00:30:03 -0700[diff] [blame]251 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Share-settings for the node group
252 &quot;projects&quot;: [ # A List of Project names to specify consumer projects for this shared-reservation. This is only valid when share_type&#x27;s value is SPECIFIC_PROJECTS.
253 &quot;A String&quot;,
254 ],
255 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
256 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]257 &quot;size&quot;: 42, # [Output Only] The total number of nodes in the node group.
258 &quot;status&quot;: &quot;A String&quot;,
259 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The name of the zone where the node group resides, such as us-central1-a.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]260 },
261 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]262 &quot;warning&quot;: { # [Output Only] An informational warning that appears when the nodeGroup list is empty.
263 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]264 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]265 {
266 &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).
267 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
268 },
269 ],
270 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
271 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]272 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]273 },
274 &quot;kind&quot;: &quot;compute#nodeGroupAggregatedList&quot;, # [Output Only] Type of resource.Always compute#nodeGroupAggregatedList for aggregated lists of node groups.
275 &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.
276 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
277 &quot;unreachables&quot;: [ # [Output Only] Unreachable resources.
278 &quot;A String&quot;,
279 ],
280 &quot;warning&quot;: { # [Output Only] Informational warning message.
281 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]282 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]283 {
284 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
285 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
286 },
287 ],
288 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
289 },
290}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]291</div>
292
293<div class="method">
294 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
295 <pre>Retrieves the next page of results.
296
297Args:
298 previous_request: The request for the previous page. (required)
299 previous_response: The response from the request for the previous page. (required)
300
301Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]302 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]303 page. Returns None if there are no more items in the collection.
304 </pre>
305</div>
306
307<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]308 <code class="details" id="close">close()</code>
309 <pre>Close httplib2 connections.</pre>
310</div>
311
312<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]313 <code class="details" id="delete">delete(project, zone, nodeGroup, requestId=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]314 <pre>Deletes the specified NodeGroup resource.
315
316Args:
317 project: string, Project ID for this request. (required)
318 zone: string, The name of the zone for this request. (required)
319 nodeGroup: string, Name of the NodeGroup resource to delete. (required)
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]320 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
321 x__xgafv: string, V1 error format.
322 Allowed values
323 1 - v1 error format
324 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]325
326Returns:
327 An object of the form:
328
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]329 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]330 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
331 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
332 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
333 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
334 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
335 &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]336 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]337 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
338 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
339 &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]340 },
341 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]342 },
343 &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`.
344 &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.
345 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
346 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
347 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
348 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]349 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]350 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
351 &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.
352 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
353 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
354 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
355 &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.
356 &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`.
357 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
358 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
359 &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.
360 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
361 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
362 {
363 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]364 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]365 {
366 &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).
367 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
368 },
369 ],
370 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
371 },
372 ],
373 &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.
374}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]375</div>
376
377<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]378 <code class="details" id="deleteNodes">deleteNodes(project, zone, nodeGroup, body=None, requestId=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]379 <pre>Deletes specified nodes from the node group.
380
381Args:
382 project: string, Project ID for this request. (required)
383 zone: string, The name of the zone for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]384 nodeGroup: string, Name of the NodeGroup resource whose nodes will be deleted. (required)
385 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]386 The object takes the form of:
387
388{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]389 &quot;nodes&quot;: [ # Names of the nodes to delete.
390 &quot;A String&quot;,
391 ],
392}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]393
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]394 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
395 x__xgafv: string, V1 error format.
396 Allowed values
397 1 - v1 error format
398 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]399
400Returns:
401 An object of the form:
402
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]403 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]404 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
405 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
406 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
407 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
408 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
409 &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]410 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]411 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
412 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
413 &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]414 },
415 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]416 },
417 &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`.
418 &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.
419 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
420 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
421 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
422 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]423 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]424 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
425 &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.
426 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
427 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
428 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
429 &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.
430 &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`.
431 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
432 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
433 &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.
434 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
435 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
436 {
437 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]438 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]439 {
440 &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).
441 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
442 },
443 ],
444 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
445 },
446 ],
447 &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.
448}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]449</div>
450
451<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]452 <code class="details" id="get">get(project, zone, nodeGroup, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]453 <pre>Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the &quot;nodes&quot; field should not be used. Use nodeGroups.listNodes instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]454
455Args:
456 project: string, Project ID for this request. (required)
457 zone: string, The name of the zone for this request. (required)
458 nodeGroup: string, Name of the node group to return. (required)
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]459 x__xgafv: string, V1 error format.
460 Allowed values
461 1 - v1 error format
462 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]463
464Returns:
465 An object of the form:
466
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]467 { # Represent a sole-tenant Node Group resource. A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]468 &quot;autoscalingPolicy&quot;: { # Specifies how autoscaling should behave.
469 &quot;maxNodes&quot;: 42, # The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100.
470 &quot;minNodes&quot;: 42, # The minimum number of nodes that the group should have.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]471 &quot;mode&quot;: &quot;A String&quot;, # The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For more information, see Autoscaler modes.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]472 },
473 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
474 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
475 &quot;fingerprint&quot;: &quot;A String&quot;,
476 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
477 &quot;kind&quot;: &quot;compute#nodeGroup&quot;, # [Output Only] The type of the resource. Always compute#nodeGroup for node group.
478 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]479 &quot;maintenancePolicy&quot;: &quot;A String&quot;, # Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]480 &quot;maintenanceWindow&quot;: { # Time window specified for daily maintenance operations. GCE&#x27;s internal maintenance will be performed within this window.
481 &quot;duration&quot;: &quot;A String&quot;, # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]482 &quot;maintenanceDuration&quot;: { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like &quot;day&quot; or &quot;month&quot;. Range is approximately 10,000 years. # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.
483 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
484 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
485 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]486 &quot;startTime&quot;: &quot;A String&quot;, # Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.
487 },
488 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
489 &quot;nodeTemplate&quot;: &quot;A String&quot;, # URL of the node template to create the node group from.
490 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
491 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
yoshi-code-bot73a0aa32021-05-25 00:30:03 -0700[diff] [blame]492 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Share-settings for the node group
493 &quot;projects&quot;: [ # A List of Project names to specify consumer projects for this shared-reservation. This is only valid when share_type&#x27;s value is SPECIFIC_PROJECTS.
494 &quot;A String&quot;,
495 ],
496 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
497 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]498 &quot;size&quot;: 42, # [Output Only] The total number of nodes in the node group.
499 &quot;status&quot;: &quot;A String&quot;,
500 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The name of the zone where the node group resides, such as us-central1-a.
501}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]502</div>
503
504<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]505 <code class="details" id="getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]506 <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.
507
508Args:
509 project: string, Project ID for this request. (required)
510 zone: string, The name of the zone for this request. (required)
511 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]512 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]513 x__xgafv: string, V1 error format.
514 Allowed values
515 1 - v1 error format
516 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]517
518Returns:
519 An object of the form:
520
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]521 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:mike@example.com&quot;, &quot;group:admins@example.com&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:eve@example.com&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]522 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]523 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { &quot;audit_configs&quot;: [ { &quot;service&quot;: &quot;allServices&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; }, { &quot;log_type&quot;: &quot;ADMIN_READ&quot; } ] }, { &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot; }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot;, &quot;exempted_members&quot;: [ &quot;user:aliya@example.com&quot; ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]524 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]525 { # Provides the configuration for logging a type of permissions. Example: { &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; } ] } This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting jose@example.com from DATA_READ logging.
526 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]527 &quot;A String&quot;,
528 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]529 &quot;ignoreChildExemptions&quot;: True or False, # This is deprecated and has no effect. Do not use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]530 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]531 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]532 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]533 &quot;exemptedMembers&quot;: [ # This is deprecated and has no effect. Do not use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]534 &quot;A String&quot;,
535 ],
536 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
537 },
538 ],
539 &quot;bindings&quot;: [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
540 { # Associates `members` with a `role`.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]541 &quot;bindingId&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
542 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]543 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
544 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
545 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
546 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]547 },
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]548 &quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]549 &quot;A String&quot;,
550 ],
551 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
552 },
553 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]554 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
555 &quot;iamOwned&quot;: True or False, # This is deprecated and has no effect. Do not use.
556 &quot;rules&quot;: [ # This is deprecated and has no effect. Do not use.
557 { # This is deprecated and has no effect. Do not use.
558 &quot;action&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
559 &quot;conditions&quot;: [ # This is deprecated and has no effect. Do not use.
560 { # This is deprecated and has no effect. Do not use.
561 &quot;iam&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
562 &quot;op&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
563 &quot;svc&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
564 &quot;sys&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
565 &quot;values&quot;: [ # This is deprecated and has no effect. Do not use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]566 &quot;A String&quot;,
567 ],
568 },
569 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]570 &quot;description&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
571 &quot;ins&quot;: [ # This is deprecated and has no effect. Do not use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]572 &quot;A String&quot;,
573 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]574 &quot;logConfigs&quot;: [ # This is deprecated and has no effect. Do not use.
575 { # This is deprecated and has no effect. Do not use.
576 &quot;cloudAudit&quot;: { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
577 &quot;authorizationLoggingOptions&quot;: { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
578 &quot;permissionType&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]579 },
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]580 &quot;logName&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]581 },
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]582 &quot;counter&quot;: { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
583 &quot;customFields&quot;: [ # This is deprecated and has no effect. Do not use.
584 { # This is deprecated and has no effect. Do not use.
585 &quot;name&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
586 &quot;value&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]587 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]588 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]589 &quot;field&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
590 &quot;metric&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]591 },
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]592 &quot;dataAccess&quot;: { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
593 &quot;logMode&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]594 },
595 },
596 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]597 &quot;notIns&quot;: [ # This is deprecated and has no effect. Do not use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]598 &quot;A String&quot;,
599 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]600 &quot;permissions&quot;: [ # This is deprecated and has no effect. Do not use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]601 &quot;A String&quot;,
602 ],
603 },
604 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]605 &quot;version&quot;: 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]606}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]607</div>
608
609<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]610 <code class="details" id="insert">insert(project, zone, initialNodeCount, body=None, requestId=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]611 <pre>Creates a NodeGroup resource in the specified project using the data included in the request.
612
613Args:
614 project: string, Project ID for this request. (required)
615 zone: string, The name of the zone for this request. (required)
616 initialNodeCount: integer, Initial count of nodes in the node group. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]617 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]618 The object takes the form of:
619
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]620{ # Represent a sole-tenant Node Group resource. A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]621 &quot;autoscalingPolicy&quot;: { # Specifies how autoscaling should behave.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]622 &quot;maxNodes&quot;: 42, # The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]623 &quot;minNodes&quot;: 42, # The minimum number of nodes that the group should have.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]624 &quot;mode&quot;: &quot;A String&quot;, # The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For more information, see Autoscaler modes.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]625 },
626 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
627 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
628 &quot;fingerprint&quot;: &quot;A String&quot;,
629 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
630 &quot;kind&quot;: &quot;compute#nodeGroup&quot;, # [Output Only] The type of the resource. Always compute#nodeGroup for node group.
631 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]632 &quot;maintenancePolicy&quot;: &quot;A String&quot;, # Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]633 &quot;maintenanceWindow&quot;: { # Time window specified for daily maintenance operations. GCE&#x27;s internal maintenance will be performed within this window.
634 &quot;duration&quot;: &quot;A String&quot;, # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]635 &quot;maintenanceDuration&quot;: { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like &quot;day&quot; or &quot;month&quot;. Range is approximately 10,000 years. # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.
636 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
637 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
638 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]639 &quot;startTime&quot;: &quot;A String&quot;, # Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.
640 },
641 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]642 &quot;nodeTemplate&quot;: &quot;A String&quot;, # URL of the node template to create the node group from.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]643 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
644 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
yoshi-code-bot73a0aa32021-05-25 00:30:03 -0700[diff] [blame]645 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Share-settings for the node group
646 &quot;projects&quot;: [ # A List of Project names to specify consumer projects for this shared-reservation. This is only valid when share_type&#x27;s value is SPECIFIC_PROJECTS.
647 &quot;A String&quot;,
648 ],
649 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
650 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]651 &quot;size&quot;: 42, # [Output Only] The total number of nodes in the node group.
652 &quot;status&quot;: &quot;A String&quot;,
653 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The name of the zone where the node group resides, such as us-central1-a.
654}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]655
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]656 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
657 x__xgafv: string, V1 error format.
658 Allowed values
659 1 - v1 error format
660 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]661
662Returns:
663 An object of the form:
664
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]665 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]666 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
667 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
668 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
669 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
670 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
671 &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]672 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]673 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
674 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
675 &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]676 },
677 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]678 },
679 &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`.
680 &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.
681 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
682 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
683 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
684 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]685 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]686 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
687 &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.
688 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
689 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
690 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
691 &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.
692 &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`.
693 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
694 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
695 &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.
696 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
697 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
698 {
699 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]700 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]701 {
702 &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).
703 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
704 },
705 ],
706 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
707 },
708 ],
709 &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.
710}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]711</div>
712
713<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]714 <code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]715 <pre>Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group.
716
717Args:
718 project: string, Project ID for this request. (required)
719 zone: string, The name of the zone for this request. (required)
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]720 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;`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = &quot;Intel Skylake&quot;) ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = &quot;Intel Skylake&quot;) OR (cpuPlatform = &quot;Intel Broadwell&quot;) AND (scheduling.automaticRestart = true) ```
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]721 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]722 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]723 pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]724 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]725 x__xgafv: string, V1 error format.
726 Allowed values
727 1 - v1 error format
728 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]729
730Returns:
731 An object of the form:
732
733 { # Contains a list of nodeGroups.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]734 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
735 &quot;items&quot;: [ # A list of NodeGroup resources.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]736 { # Represent a sole-tenant Node Group resource. A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]737 &quot;autoscalingPolicy&quot;: { # Specifies how autoscaling should behave.
738 &quot;maxNodes&quot;: 42, # The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100.
739 &quot;minNodes&quot;: 42, # The minimum number of nodes that the group should have.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]740 &quot;mode&quot;: &quot;A String&quot;, # The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For more information, see Autoscaler modes.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]741 },
742 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
743 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
744 &quot;fingerprint&quot;: &quot;A String&quot;,
745 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
746 &quot;kind&quot;: &quot;compute#nodeGroup&quot;, # [Output Only] The type of the resource. Always compute#nodeGroup for node group.
747 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]748 &quot;maintenancePolicy&quot;: &quot;A String&quot;, # Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]749 &quot;maintenanceWindow&quot;: { # Time window specified for daily maintenance operations. GCE&#x27;s internal maintenance will be performed within this window.
750 &quot;duration&quot;: &quot;A String&quot;, # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]751 &quot;maintenanceDuration&quot;: { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like &quot;day&quot; or &quot;month&quot;. Range is approximately 10,000 years. # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.
752 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
753 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
754 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]755 &quot;startTime&quot;: &quot;A String&quot;, # Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.
756 },
757 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
758 &quot;nodeTemplate&quot;: &quot;A String&quot;, # URL of the node template to create the node group from.
759 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
760 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
yoshi-code-bot73a0aa32021-05-25 00:30:03 -0700[diff] [blame]761 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Share-settings for the node group
762 &quot;projects&quot;: [ # A List of Project names to specify consumer projects for this shared-reservation. This is only valid when share_type&#x27;s value is SPECIFIC_PROJECTS.
763 &quot;A String&quot;,
764 ],
765 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
766 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]767 &quot;size&quot;: 42, # [Output Only] The total number of nodes in the node group.
768 &quot;status&quot;: &quot;A String&quot;,
769 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The name of the zone where the node group resides, such as us-central1-a.
770 },
771 ],
772 &quot;kind&quot;: &quot;compute#nodeGroupList&quot;, # [Output Only] Type of resource.Always compute#nodeGroupList for lists of node groups.
773 &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.
774 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
775 &quot;warning&quot;: { # [Output Only] Informational warning message.
776 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]777 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]778 {
779 &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).
780 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]781 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]782 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]783 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
784 },
785}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]786</div>
787
788<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]789 <code class="details" id="listNodes">listNodes(project, zone, nodeGroup, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]790 <pre>Lists nodes in the node group.
791
792Args:
793 project: string, Project ID for this request. (required)
794 zone: string, The name of the zone for this request. (required)
795 nodeGroup: string, Name of the NodeGroup resource whose nodes you want to list. (required)
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]796 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;`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = &quot;Intel Skylake&quot;) ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = &quot;Intel Skylake&quot;) OR (cpuPlatform = &quot;Intel Broadwell&quot;) AND (scheduling.automaticRestart = true) ```
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]797 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]798 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]799 pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]800 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]801 x__xgafv: string, V1 error format.
802 Allowed values
803 1 - v1 error format
804 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]805
806Returns:
807 An object of the form:
808
809 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]810 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
811 &quot;items&quot;: [ # A list of Node resources.
812 {
813 &quot;accelerators&quot;: [ # Accelerators for this node.
814 { # A specification of the type and number of accelerator cards attached to the instance.
815 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
816 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]817 },
818 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]819 &quot;cpuOvercommitType&quot;: &quot;A String&quot;, # CPU overcommit.
820 &quot;disks&quot;: [ # Local disk configurations.
821 {
822 &quot;diskCount&quot;: 42, # Specifies the number of such disks.
823 &quot;diskSizeGb&quot;: 42, # Specifies the size of the disk in base-2 GB.
824 &quot;diskType&quot;: &quot;A String&quot;, # Specifies the desired disk type on the node. This disk type must be a local storage type (e.g.: local-ssd). Note that for nodeTemplates, this should be the name of the disk type and not its URL.
825 },
826 ],
827 &quot;instances&quot;: [ # Instances scheduled on this node.
828 &quot;A String&quot;,
829 ],
830 &quot;name&quot;: &quot;A String&quot;, # The name of the node.
831 &quot;nodeType&quot;: &quot;A String&quot;, # The type of this node.
832 &quot;satisfiesPzs&quot;: True or False, # [Output Only] Reserved for future use.
833 &quot;serverBinding&quot;: { # Binding properties for the physical server.
834 &quot;type&quot;: &quot;A String&quot;,
835 },
836 &quot;serverId&quot;: &quot;A String&quot;, # Server ID associated with this node.
837 &quot;status&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]838 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]839 ],
840 &quot;kind&quot;: &quot;compute#nodeGroupsListNodes&quot;, # [Output Only] The resource type, which is always compute.nodeGroupsListNodes for the list of nodes in the specified node group.
841 &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.
842 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
843 &quot;warning&quot;: { # [Output Only] Informational warning message.
844 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]845 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]846 {
847 &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).
848 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
849 },
850 ],
851 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
852 },
853}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]854</div>
855
856<div class="method">
857 <code class="details" id="listNodes_next">listNodes_next(previous_request, previous_response)</code>
858 <pre>Retrieves the next page of results.
859
860Args:
861 previous_request: The request for the previous page. (required)
862 previous_response: The response from the request for the previous page. (required)
863
864Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]865 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]866 page. Returns None if there are no more items in the collection.
867 </pre>
868</div>
869
870<div class="method">
871 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
872 <pre>Retrieves the next page of results.
873
874Args:
875 previous_request: The request for the previous page. (required)
876 previous_response: The response from the request for the previous page. (required)
877
878Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]879 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]880 page. Returns None if there are no more items in the collection.
881 </pre>
882</div>
883
884<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]885 <code class="details" id="patch">patch(project, zone, nodeGroup, body=None, requestId=None, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]886 <pre>Updates the specified node group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]887
888Args:
889 project: string, Project ID for this request. (required)
890 zone: string, The name of the zone for this request. (required)
891 nodeGroup: string, Name of the NodeGroup resource to update. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]892 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]893 The object takes the form of:
894
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]895{ # Represent a sole-tenant Node Group resource. A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]896 &quot;autoscalingPolicy&quot;: { # Specifies how autoscaling should behave.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]897 &quot;maxNodes&quot;: 42, # The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]898 &quot;minNodes&quot;: 42, # The minimum number of nodes that the group should have.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]899 &quot;mode&quot;: &quot;A String&quot;, # The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For more information, see Autoscaler modes.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]900 },
901 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
902 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
903 &quot;fingerprint&quot;: &quot;A String&quot;,
904 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
905 &quot;kind&quot;: &quot;compute#nodeGroup&quot;, # [Output Only] The type of the resource. Always compute#nodeGroup for node group.
906 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]907 &quot;maintenancePolicy&quot;: &quot;A String&quot;, # Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]908 &quot;maintenanceWindow&quot;: { # Time window specified for daily maintenance operations. GCE&#x27;s internal maintenance will be performed within this window.
909 &quot;duration&quot;: &quot;A String&quot;, # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]910 &quot;maintenanceDuration&quot;: { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like &quot;day&quot; or &quot;month&quot;. Range is approximately 10,000 years. # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.
911 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
912 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
913 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]914 &quot;startTime&quot;: &quot;A String&quot;, # Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.
915 },
916 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]917 &quot;nodeTemplate&quot;: &quot;A String&quot;, # URL of the node template to create the node group from.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]918 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
919 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
yoshi-code-bot73a0aa32021-05-25 00:30:03 -0700[diff] [blame]920 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Share-settings for the node group
921 &quot;projects&quot;: [ # A List of Project names to specify consumer projects for this shared-reservation. This is only valid when share_type&#x27;s value is SPECIFIC_PROJECTS.
922 &quot;A String&quot;,
923 ],
924 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
925 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]926 &quot;size&quot;: 42, # [Output Only] The total number of nodes in the node group.
927 &quot;status&quot;: &quot;A String&quot;,
928 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The name of the zone where the node group resides, such as us-central1-a.
929}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]930
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]931 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
932 x__xgafv: string, V1 error format.
933 Allowed values
934 1 - v1 error format
935 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]936
937Returns:
938 An object of the form:
939
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]940 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]941 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
942 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
943 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
944 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
945 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
946 &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]947 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]948 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
949 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
950 &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]951 },
952 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]953 },
954 &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`.
955 &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.
956 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
957 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
958 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
959 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]960 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]961 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
962 &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.
963 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
964 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
965 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
966 &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.
967 &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`.
968 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
969 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
970 &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.
971 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
972 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
973 {
974 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]975 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]976 {
977 &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).
978 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
979 },
980 ],
981 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
982 },
983 ],
984 &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.
985}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]986</div>
987
988<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]989 <code class="details" id="setIamPolicy">setIamPolicy(project, zone, resource, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]990 <pre>Sets the access control policy on the specified resource. Replaces any existing policy.
991
992Args:
993 project: string, Project ID for this request. (required)
994 zone: string, The name of the zone for this request. (required)
995 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]996 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]997 The object takes the form of:
998
999{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1000 &quot;bindings&quot;: [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use &#x27;policy&#x27; to specify bindings.
1001 { # Associates `members` with a `role`.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1002 &quot;bindingId&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1003 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1004 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
1005 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
1006 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
1007 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
1008 },
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1009 &quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1010 &quot;A String&quot;,
1011 ],
1012 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1013 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1014 ],
1015 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format. Deprecated. Use &#x27;policy&#x27; to specify the etag.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1016 &quot;policy&quot;: { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:mike@example.com&quot;, &quot;group:admins@example.com&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:eve@example.com&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the &#x27;resource&#x27;. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1017 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1018 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { &quot;audit_configs&quot;: [ { &quot;service&quot;: &quot;allServices&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; }, { &quot;log_type&quot;: &quot;ADMIN_READ&quot; } ] }, { &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot; }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot;, &quot;exempted_members&quot;: [ &quot;user:aliya@example.com&quot; ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1019 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1020 { # Provides the configuration for logging a type of permissions. Example: { &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; } ] } This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting jose@example.com from DATA_READ logging.
1021 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1022 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1023 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1024 &quot;ignoreChildExemptions&quot;: True or False, # This is deprecated and has no effect. Do not use.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1025 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1026 },
1027 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1028 &quot;exemptedMembers&quot;: [ # This is deprecated and has no effect. Do not use.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1029 &quot;A String&quot;,
1030 ],
1031 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1032 },
1033 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1034 &quot;bindings&quot;: [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1035 { # Associates `members` with a `role`.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1036 &quot;bindingId&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1037 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1038 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
1039 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
1040 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
1041 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
1042 },
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1043 &quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1044 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1045 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1046 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1047 },
1048 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1049 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
1050 &quot;iamOwned&quot;: True or False, # This is deprecated and has no effect. Do not use.
1051 &quot;rules&quot;: [ # This is deprecated and has no effect. Do not use.
1052 { # This is deprecated and has no effect. Do not use.
1053 &quot;action&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1054 &quot;conditions&quot;: [ # This is deprecated and has no effect. Do not use.
1055 { # This is deprecated and has no effect. Do not use.
1056 &quot;iam&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1057 &quot;op&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1058 &quot;svc&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1059 &quot;sys&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1060 &quot;values&quot;: [ # This is deprecated and has no effect. Do not use.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1061 &quot;A String&quot;,
1062 ],
1063 },
1064 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1065 &quot;description&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1066 &quot;ins&quot;: [ # This is deprecated and has no effect. Do not use.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1067 &quot;A String&quot;,
1068 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1069 &quot;logConfigs&quot;: [ # This is deprecated and has no effect. Do not use.
1070 { # This is deprecated and has no effect. Do not use.
1071 &quot;cloudAudit&quot;: { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
1072 &quot;authorizationLoggingOptions&quot;: { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
1073 &quot;permissionType&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1074 },
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1075 &quot;logName&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1076 },
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1077 &quot;counter&quot;: { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
1078 &quot;customFields&quot;: [ # This is deprecated and has no effect. Do not use.
1079 { # This is deprecated and has no effect. Do not use.
1080 &quot;name&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1081 &quot;value&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1082 },
1083 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1084 &quot;field&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1085 &quot;metric&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1086 },
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1087 &quot;dataAccess&quot;: { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
1088 &quot;logMode&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1089 },
1090 },
1091 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1092 &quot;notIns&quot;: [ # This is deprecated and has no effect. Do not use.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1093 &quot;A String&quot;,
1094 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1095 &quot;permissions&quot;: [ # This is deprecated and has no effect. Do not use.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1096 &quot;A String&quot;,
1097 ],
1098 },
1099 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1100 &quot;version&quot;: 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1101 },
1102}
1103
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1104 x__xgafv: string, V1 error format.
1105 Allowed values
1106 1 - v1 error format
1107 2 - v2 error format
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1108
1109Returns:
1110 An object of the form:
1111
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1112 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:mike@example.com&quot;, &quot;group:admins@example.com&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:eve@example.com&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1113 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1114 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { &quot;audit_configs&quot;: [ { &quot;service&quot;: &quot;allServices&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; }, { &quot;log_type&quot;: &quot;ADMIN_READ&quot; } ] }, { &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot; }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot;, &quot;exempted_members&quot;: [ &quot;user:aliya@example.com&quot; ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1115 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1116 { # Provides the configuration for logging a type of permissions. Example: { &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; } ] } This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting jose@example.com from DATA_READ logging.
1117 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1118 &quot;A String&quot;,
1119 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1120 &quot;ignoreChildExemptions&quot;: True or False, # This is deprecated and has no effect. Do not use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1121 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
1122 },
1123 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1124 &quot;exemptedMembers&quot;: [ # This is deprecated and has no effect. Do not use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1125 &quot;A String&quot;,
1126 ],
1127 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
1128 },
1129 ],
1130 &quot;bindings&quot;: [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
1131 { # Associates `members` with a `role`.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1132 &quot;bindingId&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1133 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1134 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
1135 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
1136 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
1137 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
1138 },
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1139 &quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1140 &quot;A String&quot;,
1141 ],
1142 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1143 },
1144 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1145 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
1146 &quot;iamOwned&quot;: True or False, # This is deprecated and has no effect. Do not use.
1147 &quot;rules&quot;: [ # This is deprecated and has no effect. Do not use.
1148 { # This is deprecated and has no effect. Do not use.
1149 &quot;action&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1150 &quot;conditions&quot;: [ # This is deprecated and has no effect. Do not use.
1151 { # This is deprecated and has no effect. Do not use.
1152 &quot;iam&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1153 &quot;op&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1154 &quot;svc&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1155 &quot;sys&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1156 &quot;values&quot;: [ # This is deprecated and has no effect. Do not use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1157 &quot;A String&quot;,
1158 ],
1159 },
1160 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1161 &quot;description&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1162 &quot;ins&quot;: [ # This is deprecated and has no effect. Do not use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1163 &quot;A String&quot;,
1164 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1165 &quot;logConfigs&quot;: [ # This is deprecated and has no effect. Do not use.
1166 { # This is deprecated and has no effect. Do not use.
1167 &quot;cloudAudit&quot;: { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
1168 &quot;authorizationLoggingOptions&quot;: { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
1169 &quot;permissionType&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1170 },
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1171 &quot;logName&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1172 },
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1173 &quot;counter&quot;: { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
1174 &quot;customFields&quot;: [ # This is deprecated and has no effect. Do not use.
1175 { # This is deprecated and has no effect. Do not use.
1176 &quot;name&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1177 &quot;value&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1178 },
1179 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1180 &quot;field&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1181 &quot;metric&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1182 },
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1183 &quot;dataAccess&quot;: { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
1184 &quot;logMode&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1185 },
1186 },
1187 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1188 &quot;notIns&quot;: [ # This is deprecated and has no effect. Do not use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1189 &quot;A String&quot;,
1190 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1191 &quot;permissions&quot;: [ # This is deprecated and has no effect. Do not use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1192 &quot;A String&quot;,
1193 ],
1194 },
1195 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1196 &quot;version&quot;: 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1197}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1198</div>
1199
1200<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1201 <code class="details" id="setNodeTemplate">setNodeTemplate(project, zone, nodeGroup, body=None, requestId=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1202 <pre>Updates the node template of the node group.
1203
1204Args:
1205 project: string, Project ID for this request. (required)
1206 zone: string, The name of the zone for this request. (required)
1207 nodeGroup: string, Name of the NodeGroup resource to update. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1208 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1209 The object takes the form of:
1210
1211{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1212 &quot;nodeTemplate&quot;: &quot;A String&quot;, # Full or partial URL of the node template resource to be updated for this node group.
1213}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1214
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1215 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
1216 x__xgafv: string, V1 error format.
1217 Allowed values
1218 1 - v1 error format
1219 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1220
1221Returns:
1222 An object of the form:
1223
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1224 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1225 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
1226 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1227 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
1228 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1229 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1230 &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]1231 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1232 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1233 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
1234 &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]1235 },
1236 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1237 },
1238 &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`.
1239 &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.
1240 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
1241 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1242 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
1243 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1244 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1245 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
1246 &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.
1247 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
1248 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1249 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
1250 &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.
1251 &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`.
1252 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
1253 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1254 &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.
1255 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
1256 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1257 {
1258 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1259 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example: &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1260 {
1261 &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).
1262 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1263 },
1264 ],
1265 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1266 },
1267 ],
1268 &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.
1269}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1270</div>
1271
1272<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1273 <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1274 <pre>Returns permissions that a caller has on the specified resource.
1275
1276Args:
1277 project: string, Project ID for this request. (required)
1278 zone: string, The name of the zone for this request. (required)
1279 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1280 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1281 The object takes the form of:
1282
1283{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1284 &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.
1285 &quot;A String&quot;,
1286 ],
1287}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1288
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1289 x__xgafv: string, V1 error format.
1290 Allowed values
1291 1 - v1 error format
1292 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1293
1294Returns:
1295 An object of the form:
1296
1297 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1298 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
1299 &quot;A String&quot;,
1300 ],
1301}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1302</div>
1303
1304</body></html>