Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 96afc04eaae89dcaae4aaf7a63d5dcbf4b1e7d57 / . / docs / dyn / compute_alpha.nodeGroups.html
blob: c133a46f834ed967efd0ad63625da1d00be55b34 [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-bot96afc042021-08-24 00:22:31 -0700[diff] [blame^]226 { # Represents 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
yoshi-code-bot96afc042021-08-24 00:22:31 -0700[diff] [blame^]252 &quot;folderMap&quot;: { # A map of folder id and folder config to specify consumer projects for this shared-reservation. This is only valid when share_type&#x27;s value is DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS.
253 &quot;a_key&quot;: { # Config for each folder in the share settings.
254 &quot;folderId&quot;: &quot;A String&quot;, # The folder ID, should be same as the key of this folder config in the parent map.
255 },
256 },
yoshi-code-bot73a0aa32021-05-25 00:30:03 -0700[diff] [blame]257 &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.
258 &quot;A String&quot;,
259 ],
260 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
261 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]262 &quot;size&quot;: 42, # [Output Only] The total number of nodes in the node group.
263 &quot;status&quot;: &quot;A String&quot;,
264 &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]265 },
266 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]267 &quot;warning&quot;: { # [Output Only] An informational warning that appears when the nodeGroup list is empty.
268 &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]269 &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]270 {
271 &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).
272 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
273 },
274 ],
275 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
276 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]277 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]278 },
279 &quot;kind&quot;: &quot;compute#nodeGroupAggregatedList&quot;, # [Output Only] Type of resource.Always compute#nodeGroupAggregatedList for aggregated lists of node groups.
280 &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.
281 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
282 &quot;unreachables&quot;: [ # [Output Only] Unreachable resources.
283 &quot;A String&quot;,
284 ],
285 &quot;warning&quot;: { # [Output Only] Informational warning message.
286 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]287 &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]288 {
289 &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).
290 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
291 },
292 ],
293 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
294 },
295}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]296</div>
297
298<div class="method">
299 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
300 <pre>Retrieves the next page of results.
301
302Args:
303 previous_request: The request for the previous page. (required)
304 previous_response: The response from the request for the previous page. (required)
305
306Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]307 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]308 page. Returns None if there are no more items in the collection.
309 </pre>
310</div>
311
312<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]313 <code class="details" id="close">close()</code>
314 <pre>Close httplib2 connections.</pre>
315</div>
316
317<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]318 <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]319 <pre>Deletes the specified NodeGroup resource.
320
321Args:
322 project: string, Project ID for this request. (required)
323 zone: string, The name of the zone for this request. (required)
324 nodeGroup: string, Name of the NodeGroup resource to delete. (required)
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]325 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).
326 x__xgafv: string, V1 error format.
327 Allowed values
328 1 - v1 error format
329 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]330
331Returns:
332 An object of the form:
333
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]334 { # 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]335 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
336 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
337 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
338 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
339 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
340 &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]341 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]342 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
343 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
344 &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]345 },
346 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]347 },
348 &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`.
349 &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.
350 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
351 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
352 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
353 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]354 &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]355 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
356 &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.
357 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
358 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
359 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
360 &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.
361 &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`.
362 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
363 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
364 &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.
365 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
366 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
367 {
368 &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]369 &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]370 {
371 &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).
372 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
373 },
374 ],
375 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
376 },
377 ],
378 &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.
379}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]380</div>
381
382<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]383 <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]384 <pre>Deletes specified nodes from the node group.
385
386Args:
387 project: string, Project ID for this request. (required)
388 zone: string, The name of the zone for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]389 nodeGroup: string, Name of the NodeGroup resource whose nodes will be deleted. (required)
390 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]391 The object takes the form of:
392
393{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]394 &quot;nodes&quot;: [ # Names of the nodes to delete.
395 &quot;A String&quot;,
396 ],
397}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]398
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]399 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).
400 x__xgafv: string, V1 error format.
401 Allowed values
402 1 - v1 error format
403 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]404
405Returns:
406 An object of the form:
407
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]408 { # 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]409 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
410 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
411 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
412 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
413 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
414 &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]415 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]416 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
417 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
418 &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]419 },
420 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]421 },
422 &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`.
423 &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.
424 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
425 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
426 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
427 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]428 &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]429 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
430 &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.
431 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
432 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
433 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
434 &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.
435 &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`.
436 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
437 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
438 &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.
439 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
440 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
441 {
442 &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]443 &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]444 {
445 &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).
446 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
447 },
448 ],
449 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
450 },
451 ],
452 &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.
453}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]454</div>
455
456<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]457 <code class="details" id="get">get(project, zone, nodeGroup, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]458 <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]459
460Args:
461 project: string, Project ID for this request. (required)
462 zone: string, The name of the zone for this request. (required)
463 nodeGroup: string, Name of the node group to return. (required)
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]464 x__xgafv: string, V1 error format.
465 Allowed values
466 1 - v1 error format
467 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]468
469Returns:
470 An object of the form:
471
yoshi-code-bot96afc042021-08-24 00:22:31 -0700[diff] [blame^]472 { # Represents 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]473 &quot;autoscalingPolicy&quot;: { # Specifies how autoscaling should behave.
474 &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.
475 &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]476 &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]477 },
478 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
479 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
480 &quot;fingerprint&quot;: &quot;A String&quot;,
481 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
482 &quot;kind&quot;: &quot;compute#nodeGroup&quot;, # [Output Only] The type of the resource. Always compute#nodeGroup for node group.
483 &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]484 &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]485 &quot;maintenanceWindow&quot;: { # Time window specified for daily maintenance operations. GCE&#x27;s internal maintenance will be performed within this window.
486 &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]487 &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.
488 &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.
489 &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
490 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]491 &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.
492 },
493 &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.
494 &quot;nodeTemplate&quot;: &quot;A String&quot;, # URL of the node template to create the node group from.
495 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
496 &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]497 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Share-settings for the node group
yoshi-code-bot96afc042021-08-24 00:22:31 -0700[diff] [blame^]498 &quot;folderMap&quot;: { # A map of folder id and folder config to specify consumer projects for this shared-reservation. This is only valid when share_type&#x27;s value is DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS.
499 &quot;a_key&quot;: { # Config for each folder in the share settings.
500 &quot;folderId&quot;: &quot;A String&quot;, # The folder ID, should be same as the key of this folder config in the parent map.
501 },
502 },
yoshi-code-bot73a0aa32021-05-25 00:30:03 -0700[diff] [blame]503 &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.
504 &quot;A String&quot;,
505 ],
506 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
507 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]508 &quot;size&quot;: 42, # [Output Only] The total number of nodes in the node group.
509 &quot;status&quot;: &quot;A String&quot;,
510 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The name of the zone where the node group resides, such as us-central1-a.
511}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]512</div>
513
514<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]515 <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]516 <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.
517
518Args:
519 project: string, Project ID for this request. (required)
520 zone: string, The name of the zone for this request. (required)
521 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]522 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]523 x__xgafv: string, V1 error format.
524 Allowed values
525 1 - v1 error format
526 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]527
528Returns:
529 An object of the form:
530
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]531 { # 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]532 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]533 { # 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]534 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]535 { # 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.
536 &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]537 &quot;A String&quot;,
538 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]539 &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]540 &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]541 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]542 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]543 &quot;exemptedMembers&quot;: [ # This is deprecated and has no effect. Do not use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]544 &quot;A String&quot;,
545 ],
546 &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.
547 },
548 ],
549 &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.
550 { # Associates `members` with a `role`.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]551 &quot;bindingId&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
552 &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]553 &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.
554 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
555 &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.
556 &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]557 },
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]558 &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]559 &quot;A String&quot;,
560 ],
561 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
562 },
563 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]564 &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.
565 &quot;iamOwned&quot;: True or False, # This is deprecated and has no effect. Do not use.
566 &quot;rules&quot;: [ # This is deprecated and has no effect. Do not use.
567 { # This is deprecated and has no effect. Do not use.
568 &quot;action&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
569 &quot;conditions&quot;: [ # This is deprecated and has no effect. Do not use.
570 { # This is deprecated and has no effect. Do not use.
571 &quot;iam&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
572 &quot;op&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
573 &quot;svc&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
574 &quot;sys&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
575 &quot;values&quot;: [ # This is deprecated and has no effect. Do not use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]576 &quot;A String&quot;,
577 ],
578 },
579 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]580 &quot;description&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
581 &quot;ins&quot;: [ # This is deprecated and has no effect. Do not use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]582 &quot;A String&quot;,
583 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]584 &quot;logConfigs&quot;: [ # This is deprecated and has no effect. Do not use.
585 { # This is deprecated and has no effect. Do not use.
586 &quot;cloudAudit&quot;: { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
587 &quot;authorizationLoggingOptions&quot;: { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
588 &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]589 },
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]590 &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]591 },
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]592 &quot;counter&quot;: { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
593 &quot;customFields&quot;: [ # This is deprecated and has no effect. Do not use.
594 { # This is deprecated and has no effect. Do not use.
595 &quot;name&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
596 &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]597 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]598 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]599 &quot;field&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
600 &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]601 },
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]602 &quot;dataAccess&quot;: { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
603 &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]604 },
605 },
606 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]607 &quot;notIns&quot;: [ # This is deprecated and has no effect. Do not use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]608 &quot;A String&quot;,
609 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]610 &quot;permissions&quot;: [ # This is deprecated and has no effect. Do not use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]611 &quot;A String&quot;,
612 ],
613 },
614 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]615 &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]616}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]617</div>
618
619<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]620 <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]621 <pre>Creates a NodeGroup resource in the specified project using the data included in the request.
622
623Args:
624 project: string, Project ID for this request. (required)
625 zone: string, The name of the zone for this request. (required)
626 initialNodeCount: integer, Initial count of nodes in the node group. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]627 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]628 The object takes the form of:
629
yoshi-code-bot96afc042021-08-24 00:22:31 -0700[diff] [blame^]630{ # Represents 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]631 &quot;autoscalingPolicy&quot;: { # Specifies how autoscaling should behave.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]632 &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]633 &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]634 &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]635 },
636 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
637 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
638 &quot;fingerprint&quot;: &quot;A String&quot;,
639 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
640 &quot;kind&quot;: &quot;compute#nodeGroup&quot;, # [Output Only] The type of the resource. Always compute#nodeGroup for node group.
641 &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]642 &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]643 &quot;maintenanceWindow&quot;: { # Time window specified for daily maintenance operations. GCE&#x27;s internal maintenance will be performed within this window.
644 &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]645 &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.
646 &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.
647 &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
648 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]649 &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.
650 },
651 &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]652 &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]653 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
654 &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]655 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Share-settings for the node group
yoshi-code-bot96afc042021-08-24 00:22:31 -0700[diff] [blame^]656 &quot;folderMap&quot;: { # A map of folder id and folder config to specify consumer projects for this shared-reservation. This is only valid when share_type&#x27;s value is DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS.
657 &quot;a_key&quot;: { # Config for each folder in the share settings.
658 &quot;folderId&quot;: &quot;A String&quot;, # The folder ID, should be same as the key of this folder config in the parent map.
659 },
660 },
yoshi-code-bot73a0aa32021-05-25 00:30:03 -0700[diff] [blame]661 &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.
662 &quot;A String&quot;,
663 ],
664 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
665 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]666 &quot;size&quot;: 42, # [Output Only] The total number of nodes in the node group.
667 &quot;status&quot;: &quot;A String&quot;,
668 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The name of the zone where the node group resides, such as us-central1-a.
669}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]670
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]671 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).
672 x__xgafv: string, V1 error format.
673 Allowed values
674 1 - v1 error format
675 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]676
677Returns:
678 An object of the form:
679
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]680 { # 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]681 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
682 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
683 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
684 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
685 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
686 &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]687 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]688 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
689 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
690 &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]691 },
692 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]693 },
694 &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`.
695 &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.
696 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
697 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
698 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
699 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]700 &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]701 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
702 &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.
703 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
704 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
705 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
706 &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.
707 &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`.
708 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
709 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
710 &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.
711 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
712 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
713 {
714 &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]715 &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]716 {
717 &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).
718 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
719 },
720 ],
721 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
722 },
723 ],
724 &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.
725}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]726</div>
727
728<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]729 <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]730 <pre>Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group.
731
732Args:
733 project: string, Project ID for this request. (required)
734 zone: string, The name of the zone for this request. (required)
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]735 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]736 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]737 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]738 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]739 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]740 x__xgafv: string, V1 error format.
741 Allowed values
742 1 - v1 error format
743 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]744
745Returns:
746 An object of the form:
747
748 { # Contains a list of nodeGroups.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]749 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
750 &quot;items&quot;: [ # A list of NodeGroup resources.
yoshi-code-bot96afc042021-08-24 00:22:31 -0700[diff] [blame^]751 { # Represents 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]752 &quot;autoscalingPolicy&quot;: { # Specifies how autoscaling should behave.
753 &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.
754 &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]755 &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]756 },
757 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
758 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
759 &quot;fingerprint&quot;: &quot;A String&quot;,
760 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
761 &quot;kind&quot;: &quot;compute#nodeGroup&quot;, # [Output Only] The type of the resource. Always compute#nodeGroup for node group.
762 &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]763 &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]764 &quot;maintenanceWindow&quot;: { # Time window specified for daily maintenance operations. GCE&#x27;s internal maintenance will be performed within this window.
765 &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]766 &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.
767 &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.
768 &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
769 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]770 &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.
771 },
772 &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.
773 &quot;nodeTemplate&quot;: &quot;A String&quot;, # URL of the node template to create the node group from.
774 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
775 &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]776 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Share-settings for the node group
yoshi-code-bot96afc042021-08-24 00:22:31 -0700[diff] [blame^]777 &quot;folderMap&quot;: { # A map of folder id and folder config to specify consumer projects for this shared-reservation. This is only valid when share_type&#x27;s value is DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS.
778 &quot;a_key&quot;: { # Config for each folder in the share settings.
779 &quot;folderId&quot;: &quot;A String&quot;, # The folder ID, should be same as the key of this folder config in the parent map.
780 },
781 },
yoshi-code-bot73a0aa32021-05-25 00:30:03 -0700[diff] [blame]782 &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.
783 &quot;A String&quot;,
784 ],
785 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
786 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]787 &quot;size&quot;: 42, # [Output Only] The total number of nodes in the node group.
788 &quot;status&quot;: &quot;A String&quot;,
789 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The name of the zone where the node group resides, such as us-central1-a.
790 },
791 ],
792 &quot;kind&quot;: &quot;compute#nodeGroupList&quot;, # [Output Only] Type of resource.Always compute#nodeGroupList for lists of node groups.
793 &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.
794 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
795 &quot;warning&quot;: { # [Output Only] Informational warning message.
796 &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]797 &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]798 {
799 &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).
800 &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]801 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]802 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]803 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
804 },
805}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]806</div>
807
808<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]809 <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]810 <pre>Lists nodes in the node group.
811
812Args:
813 project: string, Project ID for this request. (required)
814 zone: string, The name of the zone for this request. (required)
815 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]816 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]817 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]818 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]819 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]820 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]821 x__xgafv: string, V1 error format.
822 Allowed values
823 1 - v1 error format
824 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]825
826Returns:
827 An object of the form:
828
829 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]830 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
831 &quot;items&quot;: [ # A list of Node resources.
832 {
833 &quot;accelerators&quot;: [ # Accelerators for this node.
834 { # A specification of the type and number of accelerator cards attached to the instance.
835 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
836 &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]837 },
838 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]839 &quot;cpuOvercommitType&quot;: &quot;A String&quot;, # CPU overcommit.
840 &quot;disks&quot;: [ # Local disk configurations.
841 {
842 &quot;diskCount&quot;: 42, # Specifies the number of such disks.
843 &quot;diskSizeGb&quot;: 42, # Specifies the size of the disk in base-2 GB.
844 &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.
845 },
846 ],
847 &quot;instances&quot;: [ # Instances scheduled on this node.
848 &quot;A String&quot;,
849 ],
850 &quot;name&quot;: &quot;A String&quot;, # The name of the node.
851 &quot;nodeType&quot;: &quot;A String&quot;, # The type of this node.
852 &quot;satisfiesPzs&quot;: True or False, # [Output Only] Reserved for future use.
853 &quot;serverBinding&quot;: { # Binding properties for the physical server.
854 &quot;type&quot;: &quot;A String&quot;,
855 },
856 &quot;serverId&quot;: &quot;A String&quot;, # Server ID associated with this node.
857 &quot;status&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]858 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]859 ],
860 &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.
861 &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.
862 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
863 &quot;warning&quot;: { # [Output Only] Informational warning message.
864 &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]865 &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]866 {
867 &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).
868 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
869 },
870 ],
871 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
872 },
873}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]874</div>
875
876<div class="method">
877 <code class="details" id="listNodes_next">listNodes_next(previous_request, previous_response)</code>
878 <pre>Retrieves the next page of results.
879
880Args:
881 previous_request: The request for the previous page. (required)
882 previous_response: The response from the request for the previous page. (required)
883
884Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]885 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]886 page. Returns None if there are no more items in the collection.
887 </pre>
888</div>
889
890<div class="method">
891 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
892 <pre>Retrieves the next page of results.
893
894Args:
895 previous_request: The request for the previous page. (required)
896 previous_response: The response from the request for the previous page. (required)
897
898Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]899 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]900 page. Returns None if there are no more items in the collection.
901 </pre>
902</div>
903
904<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]905 <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]906 <pre>Updates the specified node group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]907
908Args:
909 project: string, Project ID for this request. (required)
910 zone: string, The name of the zone for this request. (required)
911 nodeGroup: string, Name of the NodeGroup resource to update. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]912 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]913 The object takes the form of:
914
yoshi-code-bot96afc042021-08-24 00:22:31 -0700[diff] [blame^]915{ # Represents 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]916 &quot;autoscalingPolicy&quot;: { # Specifies how autoscaling should behave.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]917 &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]918 &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]919 &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]920 },
921 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
922 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
923 &quot;fingerprint&quot;: &quot;A String&quot;,
924 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
925 &quot;kind&quot;: &quot;compute#nodeGroup&quot;, # [Output Only] The type of the resource. Always compute#nodeGroup for node group.
926 &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]927 &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]928 &quot;maintenanceWindow&quot;: { # Time window specified for daily maintenance operations. GCE&#x27;s internal maintenance will be performed within this window.
929 &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]930 &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.
931 &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.
932 &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
933 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]934 &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.
935 },
936 &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]937 &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]938 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
939 &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]940 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Share-settings for the node group
yoshi-code-bot96afc042021-08-24 00:22:31 -0700[diff] [blame^]941 &quot;folderMap&quot;: { # A map of folder id and folder config to specify consumer projects for this shared-reservation. This is only valid when share_type&#x27;s value is DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS.
942 &quot;a_key&quot;: { # Config for each folder in the share settings.
943 &quot;folderId&quot;: &quot;A String&quot;, # The folder ID, should be same as the key of this folder config in the parent map.
944 },
945 },
yoshi-code-bot73a0aa32021-05-25 00:30:03 -0700[diff] [blame]946 &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.
947 &quot;A String&quot;,
948 ],
949 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
950 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]951 &quot;size&quot;: 42, # [Output Only] The total number of nodes in the node group.
952 &quot;status&quot;: &quot;A String&quot;,
953 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The name of the zone where the node group resides, such as us-central1-a.
954}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]955
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]956 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).
957 x__xgafv: string, V1 error format.
958 Allowed values
959 1 - v1 error format
960 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]961
962Returns:
963 An object of the form:
964
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]965 { # 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]966 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
967 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
968 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
969 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
970 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
971 &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]972 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]973 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
974 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
975 &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]976 },
977 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]978 },
979 &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`.
980 &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.
981 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
982 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
983 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
984 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]985 &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]986 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
987 &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.
988 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
989 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
990 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
991 &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.
992 &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`.
993 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
994 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
995 &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.
996 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
997 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
998 {
999 &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]1000 &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]1001 {
1002 &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).
1003 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1004 },
1005 ],
1006 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1007 },
1008 ],
1009 &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.
1010}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1011</div>
1012
1013<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1014 <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]1015 <pre>Sets the access control policy on the specified resource. Replaces any existing policy.
1016
1017Args:
1018 project: string, Project ID for this request. (required)
1019 zone: string, The name of the zone for this request. (required)
1020 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1021 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1022 The object takes the form of:
1023
1024{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1025 &quot;bindings&quot;: [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use &#x27;policy&#x27; to specify bindings.
1026 { # Associates `members` with a `role`.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1027 &quot;bindingId&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1028 &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]1029 &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.
1030 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
1031 &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.
1032 &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.
1033 },
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1034 &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]1035 &quot;A String&quot;,
1036 ],
1037 &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]1038 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1039 ],
1040 &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]1041 &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]1042 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1043 { # 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]1044 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1045 { # 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.
1046 &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]1047 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1048 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1049 &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]1050 &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]1051 },
1052 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1053 &quot;exemptedMembers&quot;: [ # This is deprecated and has no effect. Do not use.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1054 &quot;A String&quot;,
1055 ],
1056 &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]1057 },
1058 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1059 &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]1060 { # Associates `members` with a `role`.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1061 &quot;bindingId&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1062 &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]1063 &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.
1064 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
1065 &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.
1066 &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.
1067 },
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1068 &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]1069 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1070 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1071 &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]1072 },
1073 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1074 &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.
1075 &quot;iamOwned&quot;: True or False, # This is deprecated and has no effect. Do not use.
1076 &quot;rules&quot;: [ # This is deprecated and has no effect. Do not use.
1077 { # This is deprecated and has no effect. Do not use.
1078 &quot;action&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1079 &quot;conditions&quot;: [ # This is deprecated and has no effect. Do not use.
1080 { # This is deprecated and has no effect. Do not use.
1081 &quot;iam&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1082 &quot;op&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1083 &quot;svc&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1084 &quot;sys&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1085 &quot;values&quot;: [ # This is deprecated and has no effect. Do not use.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1086 &quot;A String&quot;,
1087 ],
1088 },
1089 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1090 &quot;description&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1091 &quot;ins&quot;: [ # This is deprecated and has no effect. Do not use.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1092 &quot;A String&quot;,
1093 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1094 &quot;logConfigs&quot;: [ # This is deprecated and has no effect. Do not use.
1095 { # This is deprecated and has no effect. Do not use.
1096 &quot;cloudAudit&quot;: { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
1097 &quot;authorizationLoggingOptions&quot;: { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
1098 &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]1099 },
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1100 &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]1101 },
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1102 &quot;counter&quot;: { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
1103 &quot;customFields&quot;: [ # This is deprecated and has no effect. Do not use.
1104 { # This is deprecated and has no effect. Do not use.
1105 &quot;name&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1106 &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]1107 },
1108 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1109 &quot;field&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1110 &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]1111 },
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1112 &quot;dataAccess&quot;: { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
1113 &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]1114 },
1115 },
1116 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1117 &quot;notIns&quot;: [ # This is deprecated and has no effect. Do not use.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1118 &quot;A String&quot;,
1119 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1120 &quot;permissions&quot;: [ # This is deprecated and has no effect. Do not use.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1121 &quot;A String&quot;,
1122 ],
1123 },
1124 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1125 &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]1126 },
1127}
1128
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1129 x__xgafv: string, V1 error format.
1130 Allowed values
1131 1 - v1 error format
1132 2 - v2 error format
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1133
1134Returns:
1135 An object of the form:
1136
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1137 { # 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]1138 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1139 { # 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]1140 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1141 { # 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.
1142 &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]1143 &quot;A String&quot;,
1144 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1145 &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]1146 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
1147 },
1148 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1149 &quot;exemptedMembers&quot;: [ # This is deprecated and has no effect. Do not use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1150 &quot;A String&quot;,
1151 ],
1152 &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.
1153 },
1154 ],
1155 &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.
1156 { # Associates `members` with a `role`.
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1157 &quot;bindingId&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1158 &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]1159 &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.
1160 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
1161 &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.
1162 &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.
1163 },
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1164 &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]1165 &quot;A String&quot;,
1166 ],
1167 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1168 },
1169 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1170 &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.
1171 &quot;iamOwned&quot;: True or False, # This is deprecated and has no effect. Do not use.
1172 &quot;rules&quot;: [ # This is deprecated and has no effect. Do not use.
1173 { # This is deprecated and has no effect. Do not use.
1174 &quot;action&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1175 &quot;conditions&quot;: [ # This is deprecated and has no effect. Do not use.
1176 { # This is deprecated and has no effect. Do not use.
1177 &quot;iam&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1178 &quot;op&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1179 &quot;svc&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1180 &quot;sys&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1181 &quot;values&quot;: [ # This is deprecated and has no effect. Do not use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1182 &quot;A String&quot;,
1183 ],
1184 },
1185 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1186 &quot;description&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1187 &quot;ins&quot;: [ # This is deprecated and has no effect. Do not use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1188 &quot;A String&quot;,
1189 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1190 &quot;logConfigs&quot;: [ # This is deprecated and has no effect. Do not use.
1191 { # This is deprecated and has no effect. Do not use.
1192 &quot;cloudAudit&quot;: { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
1193 &quot;authorizationLoggingOptions&quot;: { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
1194 &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]1195 },
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1196 &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]1197 },
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1198 &quot;counter&quot;: { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
1199 &quot;customFields&quot;: [ # This is deprecated and has no effect. Do not use.
1200 { # This is deprecated and has no effect. Do not use.
1201 &quot;name&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1202 &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]1203 },
1204 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1205 &quot;field&quot;: &quot;A String&quot;, # This is deprecated and has no effect. Do not use.
1206 &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]1207 },
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1208 &quot;dataAccess&quot;: { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.
1209 &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]1210 },
1211 },
1212 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1213 &quot;notIns&quot;: [ # This is deprecated and has no effect. Do not use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1214 &quot;A String&quot;,
1215 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1216 &quot;permissions&quot;: [ # This is deprecated and has no effect. Do not use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1217 &quot;A String&quot;,
1218 ],
1219 },
1220 ],
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1221 &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]1222}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1223</div>
1224
1225<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1226 <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]1227 <pre>Updates the node template of the node group.
1228
1229Args:
1230 project: string, Project ID for this request. (required)
1231 zone: string, The name of the zone for this request. (required)
1232 nodeGroup: string, Name of the NodeGroup resource to update. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1233 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1234 The object takes the form of:
1235
1236{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1237 &quot;nodeTemplate&quot;: &quot;A String&quot;, # Full or partial URL of the node template resource to be updated for this node group.
1238}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1239
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1240 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).
1241 x__xgafv: string, V1 error format.
1242 Allowed values
1243 1 - v1 error format
1244 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1245
1246Returns:
1247 An object of the form:
1248
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1249 { # 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]1250 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
1251 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1252 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
1253 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1254 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1255 &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]1256 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1257 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1258 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
1259 &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]1260 },
1261 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1262 },
1263 &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`.
1264 &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.
1265 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
1266 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1267 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
1268 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]1269 &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]1270 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
1271 &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.
1272 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
1273 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1274 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
1275 &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.
1276 &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`.
1277 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
1278 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1279 &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.
1280 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
1281 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1282 {
1283 &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]1284 &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]1285 {
1286 &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).
1287 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1288 },
1289 ],
1290 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1291 },
1292 ],
1293 &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.
1294}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1295</div>
1296
1297<div class="method">
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1298 <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]1299 <pre>Returns permissions that a caller has on the specified resource.
1300
1301Args:
1302 project: string, Project ID for this request. (required)
1303 zone: string, The name of the zone for this request. (required)
1304 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1305 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1306 The object takes the form of:
1307
1308{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1309 &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.
1310 &quot;A String&quot;,
1311 ],
1312}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1313
yoshi-code-bot36591372021-06-16 00:22:06 -0700[diff] [blame]1314 x__xgafv: string, V1 error format.
1315 Allowed values
1316 1 - v1 error format
1317 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1318
1319Returns:
1320 An object of the form:
1321
1322 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]1323 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
1324 &quot;A String&quot;,
1325 ],
1326}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1327</div>
1328
1329</body></html>