1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.nodeGroups.html">nodeGroups</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#addNodes">addNodes(project, zone, nodeGroup, body=None, requestId=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Adds specified number of nodes to the node group.</p> 80<p class="toc_element"> 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> 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"> 87 <code><a href="#close">close()</a></code></p> 88<p class="firstline">Close httplib2 connections.</p> 89<p class="toc_element"> 90 <code><a href="#delete">delete(project, zone, nodeGroup, requestId=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Deletes the specified NodeGroup resource.</p> 92<p class="toc_element"> 93 <code><a href="#deleteNodes">deleteNodes(project, zone, nodeGroup, body=None, requestId=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Deletes specified nodes from the node group.</p> 95<p class="toc_element"> 96 <code><a href="#get">get(project, zone, nodeGroup, x__xgafv=None)</a></code></p> 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"> 99 <code><a href="#getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p> 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"> 102 <code><a href="#insert">insert(project, zone, initialNodeCount, body=None, requestId=None, x__xgafv=None)</a></code></p> 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"> 105 <code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 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"> 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> 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"> 117 <code><a href="#patch">patch(project, zone, nodeGroup, body=None, requestId=None, x__xgafv=None)</a></code></p> 118<p class="firstline">Updates the specified node group.</p> 119<p class="toc_element"> 120 <code><a href="#setIamPolicy">setIamPolicy(project, zone, resource, body=None, x__xgafv=None)</a></code></p> 121<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p> 122<p class="toc_element"> 123 <code><a href="#setNodeTemplate">setNodeTemplate(project, zone, nodeGroup, body=None, requestId=None, x__xgafv=None)</a></code></p> 124<p class="firstline">Updates the node template of the node group.</p> 125<p class="toc_element"> 126 <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</a></code></p> 127<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 128<h3>Method Details</h3> 129<div class="method"> 130 <code class="details" id="addNodes">addNodes(project, zone, nodeGroup, body=None, requestId=None, x__xgafv=None)</code> 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) 137 body: object, The request body. 138 The object takes the form of: 139 140{ 141 "additionalNodeCount": 42, # Count of additional nodes to be added to the node group. 142} 143 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 149 150Returns: 151 An object of the form: 152 153 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 154 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 155 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 156 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 157 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 158 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 159 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 160 { 161 "code": "A String", # [Output Only] The error type identifier for this error. 162 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 163 "message": "A String", # [Output Only] An optional, human-readable error message. 164 }, 165 ], 166 }, 167 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 168 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. 169 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 170 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 171 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 172 "name": "A String", # [Output Only] Name of the operation. 173 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 174 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 175 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 176 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 177 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 178 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 179 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 180 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 181 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 182 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 183 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 184 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 185 { 186 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 187 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 188 { 189 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 190 "value": "A String", # [Output Only] A warning data value corresponding to the key. 191 }, 192 ], 193 "message": "A String", # [Output Only] A human-readable description of the warning code. 194 }, 195 ], 196 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 197}</pre> 198</div> 199 200<div class="method"> 201 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 202 <pre>Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. 203 204Args: 205 project: string, Project ID for this request. (required) 206 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` 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 = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` 207 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. 208 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`) 209 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="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. 210 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. 211 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 212 x__xgafv: string, V1 error format. 213 Allowed values 214 1 - v1 error format 215 2 - v2 error format 216 217Returns: 218 An object of the form: 219 220 { 221 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 222 "items": { # A list of NodeGroupsScopedList resources. 223 "a_key": { # [Output Only] Name of the scope containing this set of node groups. 224 "nodeGroups": [ # [Output Only] A list of node groups contained in this scope. 225 { # 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. 226 "autoscalingPolicy": { # Specifies how autoscaling should behave. 227 "maxNodes": 42, # The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100. 228 "minNodes": 42, # The minimum number of nodes that the group should have. 229 "mode": "A String", # The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For more information, see Autoscaler modes. 230 }, 231 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 232 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 233 "fingerprint": "A String", 234 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 235 "kind": "compute#nodeGroup", # [Output Only] The type of the resource. Always compute#nodeGroup for node group. 236 "locationHint": "A String", # 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. 237 "maintenancePolicy": "A String", # 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. 238 "maintenanceWindow": { # Time window specified for daily maintenance operations. GCE's internal maintenance will be performed within this window. 239 "maintenanceDuration": { # 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 "day" or "month". 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. 240 "nanos": 42, # Span of time that'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. 241 "seconds": "A String", # 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 242 }, 243 "startTime": "A String", # 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. 244 }, 245 "name": "A String", # 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. 246 "nodeTemplate": "A String", # URL of the node template to create the node group from. 247 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 248 "size": 42, # [Output Only] The total number of nodes in the node group. 249 "status": "A String", 250 "zone": "A String", # [Output Only] The name of the zone where the node group resides, such as us-central1-a. 251 }, 252 ], 253 "warning": { # [Output Only] An informational warning that appears when the nodeGroup list is empty. 254 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 255 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 256 { 257 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 258 "value": "A String", # [Output Only] A warning data value corresponding to the key. 259 }, 260 ], 261 "message": "A String", # [Output Only] A human-readable description of the warning code. 262 }, 263 }, 264 }, 265 "kind": "compute#nodeGroupAggregatedList", # [Output Only] Type of resource.Always compute#nodeGroupAggregatedList for aggregated lists of node groups. 266 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. 267 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 268 "unreachables": [ # [Output Only] Unreachable resources. 269 "A String", 270 ], 271 "warning": { # [Output Only] Informational warning message. 272 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 273 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 274 { 275 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 276 "value": "A String", # [Output Only] A warning data value corresponding to the key. 277 }, 278 ], 279 "message": "A String", # [Output Only] A human-readable description of the warning code. 280 }, 281}</pre> 282</div> 283 284<div class="method"> 285 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 286 <pre>Retrieves the next page of results. 287 288Args: 289 previous_request: The request for the previous page. (required) 290 previous_response: The response from the request for the previous page. (required) 291 292Returns: 293 A request object that you can call 'execute()' on to request the next 294 page. Returns None if there are no more items in the collection. 295 </pre> 296</div> 297 298<div class="method"> 299 <code class="details" id="close">close()</code> 300 <pre>Close httplib2 connections.</pre> 301</div> 302 303<div class="method"> 304 <code class="details" id="delete">delete(project, zone, nodeGroup, requestId=None, x__xgafv=None)</code> 305 <pre>Deletes the specified NodeGroup resource. 306 307Args: 308 project: string, Project ID for this request. (required) 309 zone: string, The name of the zone for this request. (required) 310 nodeGroup: string, Name of the NodeGroup resource to delete. (required) 311 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). 312 x__xgafv: string, V1 error format. 313 Allowed values 314 1 - v1 error format 315 2 - v2 error format 316 317Returns: 318 An object of the form: 319 320 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 321 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 322 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 323 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 324 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 325 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 326 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 327 { 328 "code": "A String", # [Output Only] The error type identifier for this error. 329 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 330 "message": "A String", # [Output Only] An optional, human-readable error message. 331 }, 332 ], 333 }, 334 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 335 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. 336 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 337 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 338 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 339 "name": "A String", # [Output Only] Name of the operation. 340 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 341 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 342 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 343 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 344 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 345 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 346 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 347 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 348 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 349 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 350 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 351 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 352 { 353 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 354 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 355 { 356 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 357 "value": "A String", # [Output Only] A warning data value corresponding to the key. 358 }, 359 ], 360 "message": "A String", # [Output Only] A human-readable description of the warning code. 361 }, 362 ], 363 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 364}</pre> 365</div> 366 367<div class="method"> 368 <code class="details" id="deleteNodes">deleteNodes(project, zone, nodeGroup, body=None, requestId=None, x__xgafv=None)</code> 369 <pre>Deletes specified nodes from the node group. 370 371Args: 372 project: string, Project ID for this request. (required) 373 zone: string, The name of the zone for this request. (required) 374 nodeGroup: string, Name of the NodeGroup resource whose nodes will be deleted. (required) 375 body: object, The request body. 376 The object takes the form of: 377 378{ 379 "nodes": [ # Names of the nodes to delete. 380 "A String", 381 ], 382} 383 384 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). 385 x__xgafv: string, V1 error format. 386 Allowed values 387 1 - v1 error format 388 2 - v2 error format 389 390Returns: 391 An object of the form: 392 393 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 394 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 395 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 396 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 397 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 398 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 399 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 400 { 401 "code": "A String", # [Output Only] The error type identifier for this error. 402 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 403 "message": "A String", # [Output Only] An optional, human-readable error message. 404 }, 405 ], 406 }, 407 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 408 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. 409 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 410 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 411 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 412 "name": "A String", # [Output Only] Name of the operation. 413 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 414 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 415 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 416 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 417 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 418 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 419 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 420 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 421 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 422 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 423 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 424 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 425 { 426 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 427 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 428 { 429 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 430 "value": "A String", # [Output Only] A warning data value corresponding to the key. 431 }, 432 ], 433 "message": "A String", # [Output Only] A human-readable description of the warning code. 434 }, 435 ], 436 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 437}</pre> 438</div> 439 440<div class="method"> 441 <code class="details" id="get">get(project, zone, nodeGroup, x__xgafv=None)</code> 442 <pre>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. 443 444Args: 445 project: string, Project ID for this request. (required) 446 zone: string, The name of the zone for this request. (required) 447 nodeGroup: string, Name of the node group to return. (required) 448 x__xgafv: string, V1 error format. 449 Allowed values 450 1 - v1 error format 451 2 - v2 error format 452 453Returns: 454 An object of the form: 455 456 { # 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. 457 "autoscalingPolicy": { # Specifies how autoscaling should behave. 458 "maxNodes": 42, # The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100. 459 "minNodes": 42, # The minimum number of nodes that the group should have. 460 "mode": "A String", # The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For more information, see Autoscaler modes. 461 }, 462 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 463 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 464 "fingerprint": "A String", 465 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 466 "kind": "compute#nodeGroup", # [Output Only] The type of the resource. Always compute#nodeGroup for node group. 467 "locationHint": "A String", # 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. 468 "maintenancePolicy": "A String", # 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. 469 "maintenanceWindow": { # Time window specified for daily maintenance operations. GCE's internal maintenance will be performed within this window. 470 "maintenanceDuration": { # 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 "day" or "month". 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. 471 "nanos": 42, # Span of time that'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. 472 "seconds": "A String", # 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 473 }, 474 "startTime": "A String", # 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. 475 }, 476 "name": "A String", # 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. 477 "nodeTemplate": "A String", # URL of the node template to create the node group from. 478 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 479 "size": 42, # [Output Only] The total number of nodes in the node group. 480 "status": "A String", 481 "zone": "A String", # [Output Only] The name of the zone where the node group resides, such as us-central1-a. 482}</pre> 483</div> 484 485<div class="method"> 486 <code class="details" id="getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code> 487 <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists. 488 489Args: 490 project: string, Project ID for this request. (required) 491 zone: string, The name of the zone for this request. (required) 492 resource: string, Name or id of the resource for this request. (required) 493 optionsRequestedPolicyVersion: integer, Requested IAM Policy version. 494 x__xgafv: string, V1 error format. 495 Allowed values 496 1 - v1 error format 497 2 - v2 error format 498 499Returns: 500 An object of the form: 501 502 { # 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`, or principals, to a single `role`. Principals 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:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). 503 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 504 { # 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: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 505 "auditLogConfigs": [ # The configuration for logging of each type of permission. 506 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 507 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 508 "A String", 509 ], 510 "ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use. 511 "logType": "A String", # The log type that this config enables. 512 }, 513 ], 514 "exemptedMembers": [ # This is deprecated and has no effect. Do not use. 515 "A String", 516 ], 517 "service": "A String", # 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. 518 }, 519 ], 520 "bindings": [ # Associates a list of `members`, or principals, with 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 principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 521 { # Associates `members`, or principals, with a `role`. 522 "bindingId": "A String", # This is deprecated and has no effect. Do not use. 523 "condition": { # 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: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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 principals 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). 524 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 525 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 526 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 527 "title": "A String", # 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. 528 }, 529 "members": [ # Specifies the principals 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, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?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, `[email protected]?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, `[email protected]?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`. 530 "A String", 531 ], 532 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 533 }, 534 ], 535 "etag": "A String", # `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. 536 "rules": [ # This is deprecated and has no effect. Do not use. 537 { # This is deprecated and has no effect. Do not use. 538 "action": "A String", # This is deprecated and has no effect. Do not use. 539 "conditions": [ # This is deprecated and has no effect. Do not use. 540 { # This is deprecated and has no effect. Do not use. 541 "iam": "A String", # This is deprecated and has no effect. Do not use. 542 "op": "A String", # This is deprecated and has no effect. Do not use. 543 "svc": "A String", # This is deprecated and has no effect. Do not use. 544 "sys": "A String", # This is deprecated and has no effect. Do not use. 545 "values": [ # This is deprecated and has no effect. Do not use. 546 "A String", 547 ], 548 }, 549 ], 550 "description": "A String", # This is deprecated and has no effect. Do not use. 551 "ins": [ # This is deprecated and has no effect. Do not use. 552 "A String", 553 ], 554 "logConfigs": [ # This is deprecated and has no effect. Do not use. 555 { # This is deprecated and has no effect. Do not use. 556 "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 557 "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 558 "permissionType": "A String", # This is deprecated and has no effect. Do not use. 559 }, 560 "logName": "A String", # This is deprecated and has no effect. Do not use. 561 }, 562 "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 563 "customFields": [ # This is deprecated and has no effect. Do not use. 564 { # This is deprecated and has no effect. Do not use. 565 "name": "A String", # This is deprecated and has no effect. Do not use. 566 "value": "A String", # This is deprecated and has no effect. Do not use. 567 }, 568 ], 569 "field": "A String", # This is deprecated and has no effect. Do not use. 570 "metric": "A String", # This is deprecated and has no effect. Do not use. 571 }, 572 "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 573 "logMode": "A String", # This is deprecated and has no effect. Do not use. 574 }, 575 }, 576 ], 577 "notIns": [ # This is deprecated and has no effect. Do not use. 578 "A String", 579 ], 580 "permissions": [ # This is deprecated and has no effect. Do not use. 581 "A String", 582 ], 583 }, 584 ], 585 "version": 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). 586}</pre> 587</div> 588 589<div class="method"> 590 <code class="details" id="insert">insert(project, zone, initialNodeCount, body=None, requestId=None, x__xgafv=None)</code> 591 <pre>Creates a NodeGroup resource in the specified project using the data included in the request. 592 593Args: 594 project: string, Project ID for this request. (required) 595 zone: string, The name of the zone for this request. (required) 596 initialNodeCount: integer, Initial count of nodes in the node group. (required) 597 body: object, The request body. 598 The object takes the form of: 599 600{ # 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. 601 "autoscalingPolicy": { # Specifies how autoscaling should behave. 602 "maxNodes": 42, # The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100. 603 "minNodes": 42, # The minimum number of nodes that the group should have. 604 "mode": "A String", # The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For more information, see Autoscaler modes. 605 }, 606 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 607 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 608 "fingerprint": "A String", 609 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 610 "kind": "compute#nodeGroup", # [Output Only] The type of the resource. Always compute#nodeGroup for node group. 611 "locationHint": "A String", # 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. 612 "maintenancePolicy": "A String", # 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. 613 "maintenanceWindow": { # Time window specified for daily maintenance operations. GCE's internal maintenance will be performed within this window. 614 "maintenanceDuration": { # 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 "day" or "month". 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. 615 "nanos": 42, # Span of time that'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. 616 "seconds": "A String", # 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 617 }, 618 "startTime": "A String", # 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. 619 }, 620 "name": "A String", # 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. 621 "nodeTemplate": "A String", # URL of the node template to create the node group from. 622 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 623 "size": 42, # [Output Only] The total number of nodes in the node group. 624 "status": "A String", 625 "zone": "A String", # [Output Only] The name of the zone where the node group resides, such as us-central1-a. 626} 627 628 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). 629 x__xgafv: string, V1 error format. 630 Allowed values 631 1 - v1 error format 632 2 - v2 error format 633 634Returns: 635 An object of the form: 636 637 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 638 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 639 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 640 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 641 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 642 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 643 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 644 { 645 "code": "A String", # [Output Only] The error type identifier for this error. 646 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 647 "message": "A String", # [Output Only] An optional, human-readable error message. 648 }, 649 ], 650 }, 651 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 652 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. 653 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 654 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 655 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 656 "name": "A String", # [Output Only] Name of the operation. 657 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 658 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 659 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 660 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 661 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 662 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 663 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 664 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 665 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 666 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 667 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 668 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 669 { 670 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 671 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 672 { 673 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 674 "value": "A String", # [Output Only] A warning data value corresponding to the key. 675 }, 676 ], 677 "message": "A String", # [Output Only] A human-readable description of the warning code. 678 }, 679 ], 680 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 681}</pre> 682</div> 683 684<div class="method"> 685 <code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 686 <pre>Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group. 687 688Args: 689 project: string, Project ID for this request. (required) 690 zone: string, The name of the zone for this request. (required) 691 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` 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 = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` 692 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`) 693 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="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. 694 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. 695 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 696 x__xgafv: string, V1 error format. 697 Allowed values 698 1 - v1 error format 699 2 - v2 error format 700 701Returns: 702 An object of the form: 703 704 { # Contains a list of nodeGroups. 705 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 706 "items": [ # A list of NodeGroup resources. 707 { # 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. 708 "autoscalingPolicy": { # Specifies how autoscaling should behave. 709 "maxNodes": 42, # The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100. 710 "minNodes": 42, # The minimum number of nodes that the group should have. 711 "mode": "A String", # The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For more information, see Autoscaler modes. 712 }, 713 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 714 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 715 "fingerprint": "A String", 716 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 717 "kind": "compute#nodeGroup", # [Output Only] The type of the resource. Always compute#nodeGroup for node group. 718 "locationHint": "A String", # 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. 719 "maintenancePolicy": "A String", # 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. 720 "maintenanceWindow": { # Time window specified for daily maintenance operations. GCE's internal maintenance will be performed within this window. 721 "maintenanceDuration": { # 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 "day" or "month". 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. 722 "nanos": 42, # Span of time that'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. 723 "seconds": "A String", # 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 724 }, 725 "startTime": "A String", # 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. 726 }, 727 "name": "A String", # 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. 728 "nodeTemplate": "A String", # URL of the node template to create the node group from. 729 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 730 "size": 42, # [Output Only] The total number of nodes in the node group. 731 "status": "A String", 732 "zone": "A String", # [Output Only] The name of the zone where the node group resides, such as us-central1-a. 733 }, 734 ], 735 "kind": "compute#nodeGroupList", # [Output Only] Type of resource.Always compute#nodeGroupList for lists of node groups. 736 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. 737 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 738 "warning": { # [Output Only] Informational warning message. 739 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 740 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 741 { 742 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 743 "value": "A String", # [Output Only] A warning data value corresponding to the key. 744 }, 745 ], 746 "message": "A String", # [Output Only] A human-readable description of the warning code. 747 }, 748}</pre> 749</div> 750 751<div class="method"> 752 <code class="details" id="listNodes">listNodes(project, zone, nodeGroup, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 753 <pre>Lists nodes in the node group. 754 755Args: 756 project: string, Project ID for this request. (required) 757 zone: string, The name of the zone for this request. (required) 758 nodeGroup: string, Name of the NodeGroup resource whose nodes you want to list. (required) 759 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` 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 = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` 760 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`) 761 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="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. 762 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. 763 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 764 x__xgafv: string, V1 error format. 765 Allowed values 766 1 - v1 error format 767 2 - v2 error format 768 769Returns: 770 An object of the form: 771 772 { 773 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 774 "items": [ # A list of Node resources. 775 { 776 "accelerators": [ # Accelerators for this node. 777 { # A specification of the type and number of accelerator cards attached to the instance. 778 "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. 779 "acceleratorType": "A String", # 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. 780 }, 781 ], 782 "cpuOvercommitType": "A String", # CPU overcommit. 783 "disks": [ # Local disk configurations. 784 { 785 "diskCount": 42, # Specifies the number of such disks. 786 "diskSizeGb": 42, # Specifies the size of the disk in base-2 GB. 787 "diskType": "A String", # 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. 788 }, 789 ], 790 "instances": [ # Instances scheduled on this node. 791 "A String", 792 ], 793 "name": "A String", # The name of the node. 794 "nodeType": "A String", # The type of this node. 795 "satisfiesPzs": True or False, # [Output Only] Reserved for future use. 796 "serverBinding": { # Binding properties for the physical server. 797 "type": "A String", 798 }, 799 "serverId": "A String", # Server ID associated with this node. 800 "status": "A String", 801 }, 802 ], 803 "kind": "compute#nodeGroupsListNodes", # [Output Only] The resource type, which is always compute.nodeGroupsListNodes for the list of nodes in the specified node group. 804 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. 805 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 806 "warning": { # [Output Only] Informational warning message. 807 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 808 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 809 { 810 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 811 "value": "A String", # [Output Only] A warning data value corresponding to the key. 812 }, 813 ], 814 "message": "A String", # [Output Only] A human-readable description of the warning code. 815 }, 816}</pre> 817</div> 818 819<div class="method"> 820 <code class="details" id="listNodes_next">listNodes_next(previous_request, previous_response)</code> 821 <pre>Retrieves the next page of results. 822 823Args: 824 previous_request: The request for the previous page. (required) 825 previous_response: The response from the request for the previous page. (required) 826 827Returns: 828 A request object that you can call 'execute()' on to request the next 829 page. Returns None if there are no more items in the collection. 830 </pre> 831</div> 832 833<div class="method"> 834 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 835 <pre>Retrieves the next page of results. 836 837Args: 838 previous_request: The request for the previous page. (required) 839 previous_response: The response from the request for the previous page. (required) 840 841Returns: 842 A request object that you can call 'execute()' on to request the next 843 page. Returns None if there are no more items in the collection. 844 </pre> 845</div> 846 847<div class="method"> 848 <code class="details" id="patch">patch(project, zone, nodeGroup, body=None, requestId=None, x__xgafv=None)</code> 849 <pre>Updates the specified node group. 850 851Args: 852 project: string, Project ID for this request. (required) 853 zone: string, The name of the zone for this request. (required) 854 nodeGroup: string, Name of the NodeGroup resource to update. (required) 855 body: object, The request body. 856 The object takes the form of: 857 858{ # 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. 859 "autoscalingPolicy": { # Specifies how autoscaling should behave. 860 "maxNodes": 42, # The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100. 861 "minNodes": 42, # The minimum number of nodes that the group should have. 862 "mode": "A String", # The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For more information, see Autoscaler modes. 863 }, 864 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 865 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 866 "fingerprint": "A String", 867 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 868 "kind": "compute#nodeGroup", # [Output Only] The type of the resource. Always compute#nodeGroup for node group. 869 "locationHint": "A String", # 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. 870 "maintenancePolicy": "A String", # 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. 871 "maintenanceWindow": { # Time window specified for daily maintenance operations. GCE's internal maintenance will be performed within this window. 872 "maintenanceDuration": { # 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 "day" or "month". 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. 873 "nanos": 42, # Span of time that'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. 874 "seconds": "A String", # 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 875 }, 876 "startTime": "A String", # 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. 877 }, 878 "name": "A String", # 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. 879 "nodeTemplate": "A String", # URL of the node template to create the node group from. 880 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 881 "size": 42, # [Output Only] The total number of nodes in the node group. 882 "status": "A String", 883 "zone": "A String", # [Output Only] The name of the zone where the node group resides, such as us-central1-a. 884} 885 886 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). 887 x__xgafv: string, V1 error format. 888 Allowed values 889 1 - v1 error format 890 2 - v2 error format 891 892Returns: 893 An object of the form: 894 895 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 896 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 897 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 898 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 899 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 900 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 901 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 902 { 903 "code": "A String", # [Output Only] The error type identifier for this error. 904 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 905 "message": "A String", # [Output Only] An optional, human-readable error message. 906 }, 907 ], 908 }, 909 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 910 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. 911 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 912 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 913 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 914 "name": "A String", # [Output Only] Name of the operation. 915 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 916 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 917 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 918 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 919 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 920 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 921 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 922 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 923 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 924 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 925 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 926 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 927 { 928 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 929 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 930 { 931 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 932 "value": "A String", # [Output Only] A warning data value corresponding to the key. 933 }, 934 ], 935 "message": "A String", # [Output Only] A human-readable description of the warning code. 936 }, 937 ], 938 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 939}</pre> 940</div> 941 942<div class="method"> 943 <code class="details" id="setIamPolicy">setIamPolicy(project, zone, resource, body=None, x__xgafv=None)</code> 944 <pre>Sets the access control policy on the specified resource. Replaces any existing policy. 945 946Args: 947 project: string, Project ID for this request. (required) 948 zone: string, The name of the zone for this request. (required) 949 resource: string, Name or id of the resource for this request. (required) 950 body: object, The request body. 951 The object takes the form of: 952 953{ 954 "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. 955 { # Associates `members`, or principals, with a `role`. 956 "bindingId": "A String", # This is deprecated and has no effect. Do not use. 957 "condition": { # 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: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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 principals 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). 958 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 959 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 960 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 961 "title": "A String", # 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. 962 }, 963 "members": [ # Specifies the principals 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, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?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, `[email protected]?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, `[email protected]?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`. 964 "A String", 965 ], 966 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 967 }, 968 ], 969 "etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. 970 "policy": { # 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`, or principals, to a single `role`. Principals 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:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') 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 'resource'. 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. 971 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 972 { # 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: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 973 "auditLogConfigs": [ # The configuration for logging of each type of permission. 974 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 975 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 976 "A String", 977 ], 978 "ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use. 979 "logType": "A String", # The log type that this config enables. 980 }, 981 ], 982 "exemptedMembers": [ # This is deprecated and has no effect. Do not use. 983 "A String", 984 ], 985 "service": "A String", # 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. 986 }, 987 ], 988 "bindings": [ # Associates a list of `members`, or principals, with 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 principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 989 { # Associates `members`, or principals, with a `role`. 990 "bindingId": "A String", # This is deprecated and has no effect. Do not use. 991 "condition": { # 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: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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 principals 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). 992 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 993 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 994 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 995 "title": "A String", # 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. 996 }, 997 "members": [ # Specifies the principals 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, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?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, `[email protected]?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, `[email protected]?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`. 998 "A String", 999 ], 1000 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 1001 }, 1002 ], 1003 "etag": "A String", # `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. 1004 "rules": [ # This is deprecated and has no effect. Do not use. 1005 { # This is deprecated and has no effect. Do not use. 1006 "action": "A String", # This is deprecated and has no effect. Do not use. 1007 "conditions": [ # This is deprecated and has no effect. Do not use. 1008 { # This is deprecated and has no effect. Do not use. 1009 "iam": "A String", # This is deprecated and has no effect. Do not use. 1010 "op": "A String", # This is deprecated and has no effect. Do not use. 1011 "svc": "A String", # This is deprecated and has no effect. Do not use. 1012 "sys": "A String", # This is deprecated and has no effect. Do not use. 1013 "values": [ # This is deprecated and has no effect. Do not use. 1014 "A String", 1015 ], 1016 }, 1017 ], 1018 "description": "A String", # This is deprecated and has no effect. Do not use. 1019 "ins": [ # This is deprecated and has no effect. Do not use. 1020 "A String", 1021 ], 1022 "logConfigs": [ # This is deprecated and has no effect. Do not use. 1023 { # This is deprecated and has no effect. Do not use. 1024 "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 1025 "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 1026 "permissionType": "A String", # This is deprecated and has no effect. Do not use. 1027 }, 1028 "logName": "A String", # This is deprecated and has no effect. Do not use. 1029 }, 1030 "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 1031 "customFields": [ # This is deprecated and has no effect. Do not use. 1032 { # This is deprecated and has no effect. Do not use. 1033 "name": "A String", # This is deprecated and has no effect. Do not use. 1034 "value": "A String", # This is deprecated and has no effect. Do not use. 1035 }, 1036 ], 1037 "field": "A String", # This is deprecated and has no effect. Do not use. 1038 "metric": "A String", # This is deprecated and has no effect. Do not use. 1039 }, 1040 "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 1041 "logMode": "A String", # This is deprecated and has no effect. Do not use. 1042 }, 1043 }, 1044 ], 1045 "notIns": [ # This is deprecated and has no effect. Do not use. 1046 "A String", 1047 ], 1048 "permissions": [ # This is deprecated and has no effect. Do not use. 1049 "A String", 1050 ], 1051 }, 1052 ], 1053 "version": 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). 1054 }, 1055} 1056 1057 x__xgafv: string, V1 error format. 1058 Allowed values 1059 1 - v1 error format 1060 2 - v2 error format 1061 1062Returns: 1063 An object of the form: 1064 1065 { # 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`, or principals, to a single `role`. Principals 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:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). 1066 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 1067 { # 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: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 1068 "auditLogConfigs": [ # The configuration for logging of each type of permission. 1069 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 1070 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 1071 "A String", 1072 ], 1073 "ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use. 1074 "logType": "A String", # The log type that this config enables. 1075 }, 1076 ], 1077 "exemptedMembers": [ # This is deprecated and has no effect. Do not use. 1078 "A String", 1079 ], 1080 "service": "A String", # 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. 1081 }, 1082 ], 1083 "bindings": [ # Associates a list of `members`, or principals, with 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 principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 1084 { # Associates `members`, or principals, with a `role`. 1085 "bindingId": "A String", # This is deprecated and has no effect. Do not use. 1086 "condition": { # 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: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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 principals 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). 1087 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 1088 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 1089 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 1090 "title": "A String", # 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. 1091 }, 1092 "members": [ # Specifies the principals 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, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?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, `[email protected]?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, `[email protected]?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`. 1093 "A String", 1094 ], 1095 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 1096 }, 1097 ], 1098 "etag": "A String", # `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. 1099 "rules": [ # This is deprecated and has no effect. Do not use. 1100 { # This is deprecated and has no effect. Do not use. 1101 "action": "A String", # This is deprecated and has no effect. Do not use. 1102 "conditions": [ # This is deprecated and has no effect. Do not use. 1103 { # This is deprecated and has no effect. Do not use. 1104 "iam": "A String", # This is deprecated and has no effect. Do not use. 1105 "op": "A String", # This is deprecated and has no effect. Do not use. 1106 "svc": "A String", # This is deprecated and has no effect. Do not use. 1107 "sys": "A String", # This is deprecated and has no effect. Do not use. 1108 "values": [ # This is deprecated and has no effect. Do not use. 1109 "A String", 1110 ], 1111 }, 1112 ], 1113 "description": "A String", # This is deprecated and has no effect. Do not use. 1114 "ins": [ # This is deprecated and has no effect. Do not use. 1115 "A String", 1116 ], 1117 "logConfigs": [ # This is deprecated and has no effect. Do not use. 1118 { # This is deprecated and has no effect. Do not use. 1119 "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 1120 "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 1121 "permissionType": "A String", # This is deprecated and has no effect. Do not use. 1122 }, 1123 "logName": "A String", # This is deprecated and has no effect. Do not use. 1124 }, 1125 "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 1126 "customFields": [ # This is deprecated and has no effect. Do not use. 1127 { # This is deprecated and has no effect. Do not use. 1128 "name": "A String", # This is deprecated and has no effect. Do not use. 1129 "value": "A String", # This is deprecated and has no effect. Do not use. 1130 }, 1131 ], 1132 "field": "A String", # This is deprecated and has no effect. Do not use. 1133 "metric": "A String", # This is deprecated and has no effect. Do not use. 1134 }, 1135 "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 1136 "logMode": "A String", # This is deprecated and has no effect. Do not use. 1137 }, 1138 }, 1139 ], 1140 "notIns": [ # This is deprecated and has no effect. Do not use. 1141 "A String", 1142 ], 1143 "permissions": [ # This is deprecated and has no effect. Do not use. 1144 "A String", 1145 ], 1146 }, 1147 ], 1148 "version": 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). 1149}</pre> 1150</div> 1151 1152<div class="method"> 1153 <code class="details" id="setNodeTemplate">setNodeTemplate(project, zone, nodeGroup, body=None, requestId=None, x__xgafv=None)</code> 1154 <pre>Updates the node template of the node group. 1155 1156Args: 1157 project: string, Project ID for this request. (required) 1158 zone: string, The name of the zone for this request. (required) 1159 nodeGroup: string, Name of the NodeGroup resource to update. (required) 1160 body: object, The request body. 1161 The object takes the form of: 1162 1163{ 1164 "nodeTemplate": "A String", # Full or partial URL of the node template resource to be updated for this node group. 1165} 1166 1167 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). 1168 x__xgafv: string, V1 error format. 1169 Allowed values 1170 1 - v1 error format 1171 2 - v2 error format 1172 1173Returns: 1174 An object of the form: 1175 1176 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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. 1177 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1178 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1179 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1180 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1181 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1182 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1183 { 1184 "code": "A String", # [Output Only] The error type identifier for this error. 1185 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1186 "message": "A String", # [Output Only] An optional, human-readable error message. 1187 }, 1188 ], 1189 }, 1190 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1191 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. 1192 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1193 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1194 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1195 "name": "A String", # [Output Only] Name of the operation. 1196 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 1197 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1198 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 1199 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1200 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1201 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1202 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1203 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1204 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1205 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 1206 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1207 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1208 { 1209 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 1210 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1211 { 1212 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 1213 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1214 }, 1215 ], 1216 "message": "A String", # [Output Only] A human-readable description of the warning code. 1217 }, 1218 ], 1219 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1220}</pre> 1221</div> 1222 1223<div class="method"> 1224 <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</code> 1225 <pre>Returns permissions that a caller has on the specified resource. 1226 1227Args: 1228 project: string, Project ID for this request. (required) 1229 zone: string, The name of the zone for this request. (required) 1230 resource: string, Name or id of the resource for this request. (required) 1231 body: object, The request body. 1232 The object takes the form of: 1233 1234{ 1235 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 1236 "A String", 1237 ], 1238} 1239 1240 x__xgafv: string, V1 error format. 1241 Allowed values 1242 1 - v1 error format 1243 2 - v2 error format 1244 1245Returns: 1246 An object of the form: 1247 1248 { 1249 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 1250 "A String", 1251 ], 1252}</pre> 1253</div> 1254 1255</body></html>