1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.nodeGroups.html">nodeGroups</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#addNodes">addNodes(project, zone, nodeGroup, body, requestId=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, orderBy=None, maxResults=None, pageToken=None, filter=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="#delete">delete(project, zone, nodeGroup, requestId=None)</a></code></p> 88<p class="firstline">Deletes the specified NodeGroup resource.</p> 89<p class="toc_element"> 90 <code><a href="#deleteNodes">deleteNodes(project, zone, nodeGroup, body, requestId=None)</a></code></p> 91<p class="firstline">Deletes specified nodes from the node group.</p> 92<p class="toc_element"> 93 <code><a href="#get">get(project, zone, nodeGroup)</a></code></p> 94<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> 95<p class="toc_element"> 96 <code><a href="#getIamPolicy">getIamPolicy(project, zone, resource)</a></code></p> 97<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p> 98<p class="toc_element"> 99 <code><a href="#insert">insert(project, zone, initialNodeCount, body, requestId=None)</a></code></p> 100<p class="firstline">Creates a NodeGroup resource in the specified project using the data included in the request.</p> 101<p class="toc_element"> 102 <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 103<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> 104<p class="toc_element"> 105 <code><a href="#listNodes">listNodes(project, zone, nodeGroup, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 106<p class="firstline">Lists nodes in the node group.</p> 107<p class="toc_element"> 108 <code><a href="#listNodes_next">listNodes_next(previous_request, previous_response)</a></code></p> 109<p class="firstline">Retrieves the next page of results.</p> 110<p class="toc_element"> 111 <code><a href="#list_next">list_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="#setAutoscalingPolicy">setAutoscalingPolicy(project, zone, nodeGroup, body, requestId=None)</a></code></p> 115<p class="firstline">Sets the autoscaling policy of the node group.</p> 116<p class="toc_element"> 117 <code><a href="#setIamPolicy">setIamPolicy(project, zone, resource, body)</a></code></p> 118<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p> 119<p class="toc_element"> 120 <code><a href="#setNodeTemplate">setNodeTemplate(project, zone, nodeGroup, body, requestId=None)</a></code></p> 121<p class="firstline">Updates the node template of the node group.</p> 122<p class="toc_element"> 123 <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body)</a></code></p> 124<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 125<h3>Method Details</h3> 126<div class="method"> 127 <code class="details" id="addNodes">addNodes(project, zone, nodeGroup, body, requestId=None)</code> 128 <pre>Adds specified number of nodes to the node group. 129 130Args: 131 project: string, Project ID for this request. (required) 132 zone: string, The name of the zone for this request. (required) 133 nodeGroup: string, Name of the NodeGroup resource. (required) 134 body: object, The request body. (required) 135 The object takes the form of: 136 137{ 138 "additionalNodeCount": 42, # Count of additional nodes to be added to the node group. 139 } 140 141 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. 142 143For 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. 144 145The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 146 147Returns: 148 An object of the form: 149 150 { # Represents an Operation resource. 151 # 152 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 153 # 154 # Operations can be global, regional or zonal. 155 # - For global operations, use the globalOperations resource. 156 # - For regional operations, use the regionOperations resource. 157 # - For zonal operations, use the zonalOperations resource. 158 # 159 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 160 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 161 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 162 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 163 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 164 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 165 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 166 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 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 "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. 169 "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. 170 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 171 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 172 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 173 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 174 { 175 "message": "A String", # [Output Only] A human-readable description of the warning code. 176 "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. 177 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 178 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 179 { 180 "value": "A String", # [Output Only] A warning data value corresponding to the key. 181 "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). 182 }, 183 ], 184 }, 185 ], 186 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 187 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 188 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 189 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 190 "name": "A String", # [Output Only] Name of the resource. 191 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 192 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 193 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 194 { 195 "message": "A String", # [Output Only] An optional, human-readable error message. 196 "code": "A String", # [Output Only] The error type identifier for this error. 197 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 198 }, 199 ], 200 }, 201 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 202 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 203 "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. 204 }</pre> 205</div> 206 207<div class="method"> 208 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 209 <pre>Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. 210 211Args: 212 project: string, Project ID for this request. (required) 213 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 214 215You 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. 216 217Currently, only sorting by name or creationTimestamp desc is supported. 218 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) 219 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. 220 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. 221 222For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. 223 224You 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. 225 226To 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). 227 228Returns: 229 An object of the form: 230 231 { 232 "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. 233 "kind": "compute#nodeGroupAggregatedList", # [Output Only] Type of resource.Always compute#nodeGroupAggregatedList for aggregated lists of node groups. 234 "items": { # A list of NodeGroupsScopedList resources. 235 "a_key": { # [Output Only] Name of the scope containing this set of node groups. 236 "warning": { # [Output Only] An informational warning that appears when the nodeGroup list is empty. 237 "message": "A String", # [Output Only] A human-readable description of the warning code. 238 "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. 239 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 240 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 241 { 242 "value": "A String", # [Output Only] A warning data value corresponding to the key. 243 "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). 244 }, 245 ], 246 }, 247 "nodeGroups": [ # [Output Only] A list of node groups contained in this scope. 248 { # Represent a sole-tenant Node Group resource. 249 # 250 # 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. (== resource_for beta.nodeGroups ==) (== resource_for v1.nodeGroups ==) NextID: 15 251 "size": 42, # [Output Only] The total number of nodes in the node group. 252 "status": "A String", 253 "kind": "compute#nodeGroup", # [Output Only] The type of the resource. Always compute#nodeGroup for node group. 254 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 255 "zone": "A String", # [Output Only] The name of the zone where the node group resides, such as us-central1-a. 256 "nodeTemplate": "A String", # The URL of the node template to which this node group belongs. 257 "autoscalingPolicy": { 258 "minSize": 42, 259 "maxSize": 42, 260 }, 261 "managedHoldback": "A String", 262 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 263 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 264 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 265 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 266 "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. 267 }, 268 ], 269 }, 270 }, 271 "warning": { # [Output Only] Informational warning message. 272 "message": "A String", # [Output Only] A human-readable description of the warning code. 273 "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. 274 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 275 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 276 { 277 "value": "A String", # [Output Only] A warning data value corresponding to the key. 278 "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). 279 }, 280 ], 281 }, 282 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 283 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 284 }</pre> 285</div> 286 287<div class="method"> 288 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 289 <pre>Retrieves the next page of results. 290 291Args: 292 previous_request: The request for the previous page. (required) 293 previous_response: The response from the request for the previous page. (required) 294 295Returns: 296 A request object that you can call 'execute()' on to request the next 297 page. Returns None if there are no more items in the collection. 298 </pre> 299</div> 300 301<div class="method"> 302 <code class="details" id="delete">delete(project, zone, nodeGroup, requestId=None)</code> 303 <pre>Deletes the specified NodeGroup resource. 304 305Args: 306 project: string, Project ID for this request. (required) 307 zone: string, The name of the zone for this request. (required) 308 nodeGroup: string, Name of the NodeGroup resource to delete. (required) 309 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. 310 311For 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. 312 313The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 314 315Returns: 316 An object of the form: 317 318 { # Represents an Operation resource. 319 # 320 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 321 # 322 # Operations can be global, regional or zonal. 323 # - For global operations, use the globalOperations resource. 324 # - For regional operations, use the regionOperations resource. 325 # - For zonal operations, use the zonalOperations resource. 326 # 327 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 328 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 329 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 330 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 331 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 332 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 333 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 334 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 335 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 336 "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. 337 "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. 338 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 339 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 340 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 341 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 342 { 343 "message": "A String", # [Output Only] A human-readable description of the warning code. 344 "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. 345 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 346 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 347 { 348 "value": "A String", # [Output Only] A warning data value corresponding to the key. 349 "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). 350 }, 351 ], 352 }, 353 ], 354 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 355 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 356 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 357 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 358 "name": "A String", # [Output Only] Name of the resource. 359 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 360 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 361 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 362 { 363 "message": "A String", # [Output Only] An optional, human-readable error message. 364 "code": "A String", # [Output Only] The error type identifier for this error. 365 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 366 }, 367 ], 368 }, 369 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 370 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 371 "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. 372 }</pre> 373</div> 374 375<div class="method"> 376 <code class="details" id="deleteNodes">deleteNodes(project, zone, nodeGroup, body, requestId=None)</code> 377 <pre>Deletes specified nodes from the node group. 378 379Args: 380 project: string, Project ID for this request. (required) 381 zone: string, The name of the zone for this request. (required) 382 nodeGroup: string, Name of the NodeGroup resource to delete. (required) 383 body: object, The request body. (required) 384 The object takes the form of: 385 386{ 387 "nodes": [ 388 "A String", 389 ], 390 } 391 392 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. 393 394For 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. 395 396The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 397 398Returns: 399 An object of the form: 400 401 { # Represents an Operation resource. 402 # 403 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 404 # 405 # Operations can be global, regional or zonal. 406 # - For global operations, use the globalOperations resource. 407 # - For regional operations, use the regionOperations resource. 408 # - For zonal operations, use the zonalOperations resource. 409 # 410 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 411 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 412 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 413 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 414 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 415 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 416 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 417 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 418 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 419 "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. 420 "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. 421 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 422 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 423 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 424 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 425 { 426 "message": "A String", # [Output Only] A human-readable description of the warning code. 427 "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. 428 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 429 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 430 { 431 "value": "A String", # [Output Only] A warning data value corresponding to the key. 432 "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). 433 }, 434 ], 435 }, 436 ], 437 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 438 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 439 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 440 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 441 "name": "A String", # [Output Only] Name of the resource. 442 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 443 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 444 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 445 { 446 "message": "A String", # [Output Only] An optional, human-readable error message. 447 "code": "A String", # [Output Only] The error type identifier for this error. 448 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 449 }, 450 ], 451 }, 452 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 453 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 454 "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. 455 }</pre> 456</div> 457 458<div class="method"> 459 <code class="details" id="get">get(project, zone, nodeGroup)</code> 460 <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. 461 462Args: 463 project: string, Project ID for this request. (required) 464 zone: string, The name of the zone for this request. (required) 465 nodeGroup: string, Name of the node group to return. (required) 466 467Returns: 468 An object of the form: 469 470 { # Represent a sole-tenant Node Group resource. 471 # 472 # 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. (== resource_for beta.nodeGroups ==) (== resource_for v1.nodeGroups ==) NextID: 15 473 "size": 42, # [Output Only] The total number of nodes in the node group. 474 "status": "A String", 475 "kind": "compute#nodeGroup", # [Output Only] The type of the resource. Always compute#nodeGroup for node group. 476 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 477 "zone": "A String", # [Output Only] The name of the zone where the node group resides, such as us-central1-a. 478 "nodeTemplate": "A String", # The URL of the node template to which this node group belongs. 479 "autoscalingPolicy": { 480 "minSize": 42, 481 "maxSize": 42, 482 }, 483 "managedHoldback": "A String", 484 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 485 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 486 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 487 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 488 "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. 489 }</pre> 490</div> 491 492<div class="method"> 493 <code class="details" id="getIamPolicy">getIamPolicy(project, zone, resource)</code> 494 <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists. 495 496Args: 497 project: string, Project ID for this request. (required) 498 zone: string, The name of the zone for this request. (required) 499 resource: string, Name or id of the resource for this request. (required) 500 501Returns: 502 An object of the form: 503 504 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. 505 # 506 # 507 # 508 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. 509 # 510 # **JSON Example** 511 # 512 # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } 513 # 514 # **YAML Example** 515 # 516 # bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer 517 # 518 # 519 # 520 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). 521 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 522 { # 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. 523 # 524 # 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. 525 # 526 # Example Policy with multiple AuditConfigs: 527 # 528 # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } 529 # 530 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. 531 "exemptedMembers": [ 532 "A String", 533 ], 534 "auditLogConfigs": [ # The configuration for logging of each type of permission. 535 { # Provides the configuration for logging a type of permissions. Example: 536 # 537 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } 538 # 539 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. 540 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. 541 "A String", 542 ], 543 "logType": "A String", # The log type that this config enables. 544 }, 545 ], 546 "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. 547 }, 548 ], 549 "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. 550 { # A rule to be applied in a Policy. 551 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. 552 { # Specifies what kind of log the caller must write 553 "counter": { # Increment a streamz counter with the specified metric and field names. # Counter options. 554 # 555 # Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. 556 # 557 # Field names correspond to IAM request parameters and field values are their respective values. 558 # 559 # Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. 560 # 561 # Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} 562 # 563 # At this time we do not support multiple field names (though this may be supported in the future). 564 "field": "A String", # The field value to attribute. 565 "metric": "A String", # The metric to update. 566 }, 567 "dataAccess": { # Write a Data Access (Gin) log # Data access options. 568 "logMode": "A String", # Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. 569 }, 570 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options. 571 "logName": "A String", # The log_name to populate in the Cloud Audit Record. 572 "authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline. 573 "permissionType": "A String", # The type of the permission that was checked. 574 }, 575 }, 576 }, 577 ], 578 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. 579 "A String", 580 ], 581 "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. 582 "A String", 583 ], 584 "action": "A String", # Required 585 "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. 586 "A String", 587 ], 588 "conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match. 589 { # A condition to be met. 590 "iam": "A String", # Trusted attributes supplied by the IAM system. 591 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. 592 "values": [ # The objects of the condition. 593 "A String", 594 ], 595 "svc": "A String", # Trusted attributes discharged by the service. 596 "op": "A String", # An operator to apply the subject with. 597 }, 598 ], 599 "description": "A String", # Human-readable description of the rule. 600 }, 601 ], 602 "version": 42, # Deprecated. 603 "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. 604 # 605 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. 606 "bindings": [ # Associates a list of `members` to a `role`. `bindings` with no members will result in an error. 607 { # Associates `members` with a `role`. 608 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 609 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: 610 # 611 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. 612 # 613 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. 614 # 615 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . 616 # 617 # 618 # 619 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. 620 # 621 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. 622 # 623 # 624 # 625 # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 626 "A String", 627 ], 628 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. 629 # 630 # title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" 631 "title": "A String", # An 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. 632 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 633 # 634 # The application context of the containing message determines which well-known feature set of CEL is supported. 635 "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 636 "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 637 }, 638 }, 639 ], 640 "iamOwned": True or False, 641 }</pre> 642</div> 643 644<div class="method"> 645 <code class="details" id="insert">insert(project, zone, initialNodeCount, body, requestId=None)</code> 646 <pre>Creates a NodeGroup resource in the specified project using the data included in the request. 647 648Args: 649 project: string, Project ID for this request. (required) 650 zone: string, The name of the zone for this request. (required) 651 initialNodeCount: integer, Initial count of nodes in the node group. (required) 652 body: object, The request body. (required) 653 The object takes the form of: 654 655{ # Represent a sole-tenant Node Group resource. 656 # 657 # 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. (== resource_for beta.nodeGroups ==) (== resource_for v1.nodeGroups ==) NextID: 15 658 "size": 42, # [Output Only] The total number of nodes in the node group. 659 "status": "A String", 660 "kind": "compute#nodeGroup", # [Output Only] The type of the resource. Always compute#nodeGroup for node group. 661 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 662 "zone": "A String", # [Output Only] The name of the zone where the node group resides, such as us-central1-a. 663 "nodeTemplate": "A String", # The URL of the node template to which this node group belongs. 664 "autoscalingPolicy": { 665 "minSize": 42, 666 "maxSize": 42, 667 }, 668 "managedHoldback": "A String", 669 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 670 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 671 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 672 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 673 "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. 674 } 675 676 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. 677 678For 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. 679 680The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 681 682Returns: 683 An object of the form: 684 685 { # Represents an Operation resource. 686 # 687 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 688 # 689 # Operations can be global, regional or zonal. 690 # - For global operations, use the globalOperations resource. 691 # - For regional operations, use the regionOperations resource. 692 # - For zonal operations, use the zonalOperations resource. 693 # 694 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 695 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 696 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 697 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 698 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 699 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 700 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 701 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 702 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 703 "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. 704 "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. 705 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 706 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 707 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 708 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 709 { 710 "message": "A String", # [Output Only] A human-readable description of the warning code. 711 "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. 712 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 713 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 714 { 715 "value": "A String", # [Output Only] A warning data value corresponding to the key. 716 "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). 717 }, 718 ], 719 }, 720 ], 721 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 722 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 723 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 724 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 725 "name": "A String", # [Output Only] Name of the resource. 726 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 727 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 728 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 729 { 730 "message": "A String", # [Output Only] An optional, human-readable error message. 731 "code": "A String", # [Output Only] The error type identifier for this error. 732 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 733 }, 734 ], 735 }, 736 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 737 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 738 "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. 739 }</pre> 740</div> 741 742<div class="method"> 743 <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 744 <pre>Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group. 745 746Args: 747 project: string, Project ID for this request. (required) 748 zone: string, The name of the zone for this request. (required) 749 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 750 751You 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. 752 753Currently, only sorting by name or creationTimestamp desc is supported. 754 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) 755 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. 756 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. 757 758For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. 759 760You 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. 761 762To 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). 763 764Returns: 765 An object of the form: 766 767 { # Contains a list of nodeGroups. 768 "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. 769 "kind": "compute#nodeGroupList", # [Output Only] Type of resource.Always compute#nodeGroupList for lists of node groups. 770 "items": [ # A list of NodeGroup resources. 771 { # Represent a sole-tenant Node Group resource. 772 # 773 # 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. (== resource_for beta.nodeGroups ==) (== resource_for v1.nodeGroups ==) NextID: 15 774 "size": 42, # [Output Only] The total number of nodes in the node group. 775 "status": "A String", 776 "kind": "compute#nodeGroup", # [Output Only] The type of the resource. Always compute#nodeGroup for node group. 777 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 778 "zone": "A String", # [Output Only] The name of the zone where the node group resides, such as us-central1-a. 779 "nodeTemplate": "A String", # The URL of the node template to which this node group belongs. 780 "autoscalingPolicy": { 781 "minSize": 42, 782 "maxSize": 42, 783 }, 784 "managedHoldback": "A String", 785 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 786 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 787 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 788 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 789 "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. 790 }, 791 ], 792 "warning": { # [Output Only] Informational warning message. 793 "message": "A String", # [Output Only] A human-readable description of the warning code. 794 "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. 795 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 796 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 797 { 798 "value": "A String", # [Output Only] A warning data value corresponding to the key. 799 "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). 800 }, 801 ], 802 }, 803 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 804 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 805 }</pre> 806</div> 807 808<div class="method"> 809 <code class="details" id="listNodes">listNodes(project, zone, nodeGroup, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 810 <pre>Lists nodes in the node group. 811 812Args: 813 project: string, Project ID for this request. (required) 814 zone: string, The name of the zone for this request. (required) 815 nodeGroup: string, Name of the NodeGroup resource whose nodes you want to list. (required) 816 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 817 818You 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. 819 820Currently, only sorting by name or creationTimestamp desc is supported. 821 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) 822 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. 823 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. 824 825For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. 826 827You 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. 828 829To 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). 830 831Returns: 832 An object of the form: 833 834 { 835 "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. 836 "kind": "compute#nodeGroupsListNodes", # [Output Only] The resource type, which is always compute.nodeGroupsListNodes for the list of nodes in the specified node group. 837 "items": [ # A list of Node resources. 838 { 839 "status": "A String", 840 "serverBinding": { # Binding properties for the physical server. 841 "type": "A String", 842 }, 843 "nodeType": "A String", # The type of this node. 844 "name": "A String", # The name of the node. 845 "disks": [ # Local disk configurations. 846 { 847 "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. 848 "diskCount": "A String", # Specifies the number of such disks. 849 "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. 850 }, 851 ], 852 "instances": [ # Instances scheduled on this node. 853 "A String", 854 ], 855 }, 856 ], 857 "warning": { # [Output Only] Informational warning message. 858 "message": "A String", # [Output Only] A human-readable description of the warning code. 859 "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. 860 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 861 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 862 { 863 "value": "A String", # [Output Only] A warning data value corresponding to the key. 864 "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). 865 }, 866 ], 867 }, 868 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 869 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 870 }</pre> 871</div> 872 873<div class="method"> 874 <code class="details" id="listNodes_next">listNodes_next(previous_request, previous_response)</code> 875 <pre>Retrieves the next page of results. 876 877Args: 878 previous_request: The request for the previous page. (required) 879 previous_response: The response from the request for the previous page. (required) 880 881Returns: 882 A request object that you can call 'execute()' on to request the next 883 page. Returns None if there are no more items in the collection. 884 </pre> 885</div> 886 887<div class="method"> 888 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 889 <pre>Retrieves the next page of results. 890 891Args: 892 previous_request: The request for the previous page. (required) 893 previous_response: The response from the request for the previous page. (required) 894 895Returns: 896 A request object that you can call 'execute()' on to request the next 897 page. Returns None if there are no more items in the collection. 898 </pre> 899</div> 900 901<div class="method"> 902 <code class="details" id="setAutoscalingPolicy">setAutoscalingPolicy(project, zone, nodeGroup, body, requestId=None)</code> 903 <pre>Sets the autoscaling policy of the node group. 904 905Args: 906 project: string, Project ID for this request. (required) 907 zone: string, The name of the zone for this request. (required) 908 nodeGroup: string, Name of the NodeGroup resource to update. (required) 909 body: object, The request body. (required) 910 The object takes the form of: 911 912{ 913 "autoscalingPolicy": { 914 "minSize": 42, 915 "maxSize": 42, 916 }, 917 } 918 919 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. 920 921For 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. 922 923The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 924 925Returns: 926 An object of the form: 927 928 { # Represents an Operation resource. 929 # 930 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 931 # 932 # Operations can be global, regional or zonal. 933 # - For global operations, use the globalOperations resource. 934 # - For regional operations, use the regionOperations resource. 935 # - For zonal operations, use the zonalOperations resource. 936 # 937 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 938 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 939 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 940 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 941 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 942 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 943 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 944 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 945 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 946 "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. 947 "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. 948 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 949 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 950 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 951 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 952 { 953 "message": "A String", # [Output Only] A human-readable description of the warning code. 954 "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. 955 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 956 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 957 { 958 "value": "A String", # [Output Only] A warning data value corresponding to the key. 959 "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). 960 }, 961 ], 962 }, 963 ], 964 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 965 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 966 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 967 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 968 "name": "A String", # [Output Only] Name of the resource. 969 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 970 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 971 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 972 { 973 "message": "A String", # [Output Only] An optional, human-readable error message. 974 "code": "A String", # [Output Only] The error type identifier for this error. 975 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 976 }, 977 ], 978 }, 979 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 980 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 981 "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. 982 }</pre> 983</div> 984 985<div class="method"> 986 <code class="details" id="setIamPolicy">setIamPolicy(project, zone, resource, body)</code> 987 <pre>Sets the access control policy on the specified resource. Replaces any existing policy. 988 989Args: 990 project: string, Project ID for this request. (required) 991 zone: string, The name of the zone for this request. (required) 992 resource: string, Name or id of the resource for this request. (required) 993 body: object, The request body. (required) 994 The object takes the form of: 995 996{ 997 "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. # 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. 998 # 999 # 1000 # 1001 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. 1002 # 1003 # **JSON Example** 1004 # 1005 # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } 1006 # 1007 # **YAML Example** 1008 # 1009 # bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer 1010 # 1011 # 1012 # 1013 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). 1014 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 1015 { # 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. 1016 # 1017 # 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. 1018 # 1019 # Example Policy with multiple AuditConfigs: 1020 # 1021 # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } 1022 # 1023 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. 1024 "exemptedMembers": [ 1025 "A String", 1026 ], 1027 "auditLogConfigs": [ # The configuration for logging of each type of permission. 1028 { # Provides the configuration for logging a type of permissions. Example: 1029 # 1030 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } 1031 # 1032 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. 1033 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. 1034 "A String", 1035 ], 1036 "logType": "A String", # The log type that this config enables. 1037 }, 1038 ], 1039 "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. 1040 }, 1041 ], 1042 "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. 1043 { # A rule to be applied in a Policy. 1044 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. 1045 { # Specifies what kind of log the caller must write 1046 "counter": { # Increment a streamz counter with the specified metric and field names. # Counter options. 1047 # 1048 # Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. 1049 # 1050 # Field names correspond to IAM request parameters and field values are their respective values. 1051 # 1052 # Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. 1053 # 1054 # Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} 1055 # 1056 # At this time we do not support multiple field names (though this may be supported in the future). 1057 "field": "A String", # The field value to attribute. 1058 "metric": "A String", # The metric to update. 1059 }, 1060 "dataAccess": { # Write a Data Access (Gin) log # Data access options. 1061 "logMode": "A String", # Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. 1062 }, 1063 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options. 1064 "logName": "A String", # The log_name to populate in the Cloud Audit Record. 1065 "authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline. 1066 "permissionType": "A String", # The type of the permission that was checked. 1067 }, 1068 }, 1069 }, 1070 ], 1071 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. 1072 "A String", 1073 ], 1074 "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. 1075 "A String", 1076 ], 1077 "action": "A String", # Required 1078 "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. 1079 "A String", 1080 ], 1081 "conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match. 1082 { # A condition to be met. 1083 "iam": "A String", # Trusted attributes supplied by the IAM system. 1084 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. 1085 "values": [ # The objects of the condition. 1086 "A String", 1087 ], 1088 "svc": "A String", # Trusted attributes discharged by the service. 1089 "op": "A String", # An operator to apply the subject with. 1090 }, 1091 ], 1092 "description": "A String", # Human-readable description of the rule. 1093 }, 1094 ], 1095 "version": 42, # Deprecated. 1096 "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. 1097 # 1098 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. 1099 "bindings": [ # Associates a list of `members` to a `role`. `bindings` with no members will result in an error. 1100 { # Associates `members` with a `role`. 1101 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 1102 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: 1103 # 1104 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. 1105 # 1106 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. 1107 # 1108 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . 1109 # 1110 # 1111 # 1112 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. 1113 # 1114 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. 1115 # 1116 # 1117 # 1118 # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 1119 "A String", 1120 ], 1121 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. 1122 # 1123 # title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" 1124 "title": "A String", # An 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. 1125 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 1126 # 1127 # The application context of the containing message determines which well-known feature set of CEL is supported. 1128 "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 1129 "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 1130 }, 1131 }, 1132 ], 1133 "iamOwned": True or False, 1134 }, 1135 "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. 1136 { # Associates `members` with a `role`. 1137 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 1138 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: 1139 # 1140 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. 1141 # 1142 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. 1143 # 1144 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . 1145 # 1146 # 1147 # 1148 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. 1149 # 1150 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. 1151 # 1152 # 1153 # 1154 # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 1155 "A String", 1156 ], 1157 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. 1158 # 1159 # title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" 1160 "title": "A String", # An 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. 1161 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 1162 # 1163 # The application context of the containing message determines which well-known feature set of CEL is supported. 1164 "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 1165 "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 1166 }, 1167 }, 1168 ], 1169 "etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. 1170 } 1171 1172 1173Returns: 1174 An object of the form: 1175 1176 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. 1177 # 1178 # 1179 # 1180 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. 1181 # 1182 # **JSON Example** 1183 # 1184 # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } 1185 # 1186 # **YAML Example** 1187 # 1188 # bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer 1189 # 1190 # 1191 # 1192 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). 1193 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 1194 { # 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. 1195 # 1196 # 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. 1197 # 1198 # Example Policy with multiple AuditConfigs: 1199 # 1200 # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } 1201 # 1202 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. 1203 "exemptedMembers": [ 1204 "A String", 1205 ], 1206 "auditLogConfigs": [ # The configuration for logging of each type of permission. 1207 { # Provides the configuration for logging a type of permissions. Example: 1208 # 1209 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } 1210 # 1211 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. 1212 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. 1213 "A String", 1214 ], 1215 "logType": "A String", # The log type that this config enables. 1216 }, 1217 ], 1218 "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. 1219 }, 1220 ], 1221 "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. 1222 { # A rule to be applied in a Policy. 1223 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. 1224 { # Specifies what kind of log the caller must write 1225 "counter": { # Increment a streamz counter with the specified metric and field names. # Counter options. 1226 # 1227 # Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. 1228 # 1229 # Field names correspond to IAM request parameters and field values are their respective values. 1230 # 1231 # Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. 1232 # 1233 # Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} 1234 # 1235 # At this time we do not support multiple field names (though this may be supported in the future). 1236 "field": "A String", # The field value to attribute. 1237 "metric": "A String", # The metric to update. 1238 }, 1239 "dataAccess": { # Write a Data Access (Gin) log # Data access options. 1240 "logMode": "A String", # Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. 1241 }, 1242 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options. 1243 "logName": "A String", # The log_name to populate in the Cloud Audit Record. 1244 "authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline. 1245 "permissionType": "A String", # The type of the permission that was checked. 1246 }, 1247 }, 1248 }, 1249 ], 1250 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. 1251 "A String", 1252 ], 1253 "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. 1254 "A String", 1255 ], 1256 "action": "A String", # Required 1257 "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. 1258 "A String", 1259 ], 1260 "conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match. 1261 { # A condition to be met. 1262 "iam": "A String", # Trusted attributes supplied by the IAM system. 1263 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. 1264 "values": [ # The objects of the condition. 1265 "A String", 1266 ], 1267 "svc": "A String", # Trusted attributes discharged by the service. 1268 "op": "A String", # An operator to apply the subject with. 1269 }, 1270 ], 1271 "description": "A String", # Human-readable description of the rule. 1272 }, 1273 ], 1274 "version": 42, # Deprecated. 1275 "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. 1276 # 1277 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. 1278 "bindings": [ # Associates a list of `members` to a `role`. `bindings` with no members will result in an error. 1279 { # Associates `members` with a `role`. 1280 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 1281 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: 1282 # 1283 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. 1284 # 1285 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. 1286 # 1287 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . 1288 # 1289 # 1290 # 1291 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. 1292 # 1293 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. 1294 # 1295 # 1296 # 1297 # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 1298 "A String", 1299 ], 1300 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. 1301 # 1302 # title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" 1303 "title": "A String", # An 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. 1304 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 1305 # 1306 # The application context of the containing message determines which well-known feature set of CEL is supported. 1307 "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 1308 "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 1309 }, 1310 }, 1311 ], 1312 "iamOwned": True or False, 1313 }</pre> 1314</div> 1315 1316<div class="method"> 1317 <code class="details" id="setNodeTemplate">setNodeTemplate(project, zone, nodeGroup, body, requestId=None)</code> 1318 <pre>Updates the node template of the node group. 1319 1320Args: 1321 project: string, Project ID for this request. (required) 1322 zone: string, The name of the zone for this request. (required) 1323 nodeGroup: string, Name of the NodeGroup resource to update. (required) 1324 body: object, The request body. (required) 1325 The object takes the form of: 1326 1327{ 1328 "nodeTemplate": "A String", # Full or partial URL of the node template resource to be updated for this node group. 1329 } 1330 1331 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. 1332 1333For 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. 1334 1335The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 1336 1337Returns: 1338 An object of the form: 1339 1340 { # Represents an Operation resource. 1341 # 1342 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 1343 # 1344 # Operations can be global, regional or zonal. 1345 # - For global operations, use the globalOperations resource. 1346 # - For regional operations, use the regionOperations resource. 1347 # - For zonal operations, use the zonalOperations resource. 1348 # 1349 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 1350 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1351 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1352 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1353 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1354 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1355 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1356 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 1357 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 1358 "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. 1359 "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. 1360 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1361 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 1362 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1363 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1364 { 1365 "message": "A String", # [Output Only] A human-readable description of the warning code. 1366 "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. 1367 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1368 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1369 { 1370 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1371 "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). 1372 }, 1373 ], 1374 }, 1375 ], 1376 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 1377 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 1378 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1379 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 1380 "name": "A String", # [Output Only] Name of the resource. 1381 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1382 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1383 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1384 { 1385 "message": "A String", # [Output Only] An optional, human-readable error message. 1386 "code": "A String", # [Output Only] The error type identifier for this error. 1387 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1388 }, 1389 ], 1390 }, 1391 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1392 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1393 "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. 1394 }</pre> 1395</div> 1396 1397<div class="method"> 1398 <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body)</code> 1399 <pre>Returns permissions that a caller has on the specified resource. 1400 1401Args: 1402 project: string, Project ID for this request. (required) 1403 zone: string, The name of the zone for this request. (required) 1404 resource: string, Name or id of the resource for this request. (required) 1405 body: object, The request body. (required) 1406 The object takes the form of: 1407 1408{ 1409 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 1410 "A String", 1411 ], 1412 } 1413 1414 1415Returns: 1416 An object of the form: 1417 1418 { 1419 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 1420 "A String", 1421 ], 1422 }</pre> 1423</div> 1424 1425</body></html>