Blame - docs/dyn/compute_alpha.nodeGroups.html - platform/external/python/google-api-python-client

2019-06-14 16:50:42 -0700

[diff] [blame]

82

<p class="firstline">Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group.</p>

83

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

87

<code><a href="#close">close()</a></code></p>

88

<p class="firstline">Close httplib2 connections.</p>

89

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

90

<code><a href="#delete">delete(project, zone, nodeGroup, requestId=None)</a></code></p>

91

<p class="firstline">Deletes the specified NodeGroup resource.</p>

92

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

93

<code><a href="#deleteNodes">deleteNodes(project, zone, nodeGroup, body=None, requestId=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

94

<p class="firstline">Deletes specified nodes from the node group.</p>

95

96

<code><a href="#get">get(project, zone, nodeGroup)</a></code></p>

97

<p class="firstline">Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the "nodes" field should not be used. Use nodeGroups.listNodes instead.</p>

98

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

99

<code><a href="#getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

100

<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p>

101

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

102

<code><a href="#insert">insert(project, zone, initialNodeCount, body=None, requestId=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

103

<p class="firstline">Creates a NodeGroup resource in the specified project using the data included in the request.</p>

104

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

105

<code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

106

<p class="firstline">Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group.</p>

107

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

108

<code><a href="#listNodes">listNodes(project, zone, nodeGroup, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

109

<p class="firstline">Lists nodes in the node group.</p>

110

111

<code><a href="#listNodes_next">listNodes_next(previous_request, previous_response)</a></code></p>

112

<p class="firstline">Retrieves the next page of results.</p>

113

114

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

115

<p class="firstline">Retrieves the next page of results.</p>

116

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

117

<code><a href="#patch">patch(project, zone, nodeGroup, body=None, requestId=None)</a></code></p>

118

<p class="firstline">Updates the specified node group.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

119

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

120

<code><a href="#setIamPolicy">setIamPolicy(project, zone, resource, body=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

121

<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>

122

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

123

<code><a href="#setNodeTemplate">setNodeTemplate(project, zone, nodeGroup, body=None, requestId=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

124

<p class="firstline">Updates the node template of the node group.</p>

125

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

126

<code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

127

<p class="firstline">Returns permissions that a caller has on the specified resource.</p>

128

<h3>Method Details</h3>

129

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

130

<code class="details" id="addNodes">addNodes(project, zone, nodeGroup, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

131

<pre>Adds specified number of nodes to the node group.

132

133

Args:

134

project: string, Project ID for this request. (required)

135

zone: string, The name of the zone for this request. (required)

136

nodeGroup: string, Name of the NodeGroup resource. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

137

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

138

The object takes the form of:

139

140

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

141

"additionalNodeCount": 42, # Count of additional nodes to be added to the node group.

142

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

143

144

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

145

146

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

147

148

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

149

150

Returns:

151

An object of the form:

152

153

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

154

#

155

# Google Compute Engine has three Operation resources:

156

#

157

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

158

#

159

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

160

#

161

# Operations can be global, regional or zonal.

162

# - For global operations, use the `globalOperations` resource.

163

# - For regional operations, use the `regionOperations` resource.

164

# - For zonal operations, use the `zonalOperations` resource.

165

#

166

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

167

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

168

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

169

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

170

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

171

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

172

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

173

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

174

"code": "A String", # [Output Only] The error type identifier for this error.

175

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

176

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

177

},

178

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

179

},

180

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

181

"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.

182

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

183

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

184

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

185

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

186

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

187

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

188

"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.

189

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

190

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

191

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

192

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

193

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

194

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

195

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

196

"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.

197

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

198

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

199

{

200

"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.

201

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

202

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

203

{

204

"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).

205

"value": "A String", # [Output Only] A warning data value corresponding to the key.

206

},

207

],

208

"message": "A String", # [Output Only] A human-readable description of the warning code.

209

},

210

],

211

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

212

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

216

<code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

217

<pre>Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group.

218

219

Args:

220

project: string, Project ID for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

221

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 `<`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

222

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

223

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

224

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

225

You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

226

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

227

To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

228

includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

229

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`)

230

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

231

232

You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

233

234

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

235

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

236

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

237

238

Returns:

239

An object of the form:

240

241

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

242

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

243

"items": { # A list of NodeGroupsScopedList resources.

244

"a_key": { # [Output Only] Name of the scope containing this set of node groups.

245

"nodeGroups": [ # [Output Only] A list of node groups contained in this scope.

246

{ # Represent a sole-tenant Node Group resource.

247

#

248

# 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 {$api_version}.nodeGroups ==)

249

"autoscalingPolicy": { # Specifies how autoscaling should behave.

250

"maxNodes": 42, # The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100.

251

"minNodes": 42, # The minimum number of nodes that the group should have.

252

"mode": "A String", # The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For more information, see Autoscaler modes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

253

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

254

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

255

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

256

"fingerprint": "A String",

257

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

258

"kind": "compute#nodeGroup", # [Output Only] The type of the resource. Always compute#nodeGroup for node group.

259

"locationHint": "A String", # An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate.

260

"maintenancePolicy": "A String", # Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.

261

"maintenanceWindow": { # Time window specified for daily maintenance operations. GCE's internal maintenance will be performed within this window.

262

"duration": "A String", # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

263

"maintenanceDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.

264

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

265

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

266

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

267

"startTime": "A String", # Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.

268

},

269

"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.

270

"nodeTemplate": "A String", # URL of the node template to create the node group from.

271

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

272

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

273

"shareSettings": { # The share setting for reservations and sole tenancy node groups. # Share-settings for the node group

274

"projects": [ # A List of Project names to specify consumer projects for this shared-reservation. This is only valid when share_type's value is SPECIFIC_PROJECTS.

275

"A String",

276

],

277

"shareType": "A String", # Type of sharing for this shared-reservation

278

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

279

"size": 42, # [Output Only] The total number of nodes in the node group.

280

"status": "A String",

281

"zone": "A String", # [Output Only] The name of the zone where the node group resides, such as us-central1-a.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

282

},

283

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

284

"warning": { # [Output Only] An informational warning that appears when the nodeGroup list is empty.

285

"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.

286

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

287

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

288

{

289

"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).

290

"value": "A String", # [Output Only] A warning data value corresponding to the key.

291

},

292

],

293

"message": "A String", # [Output Only] A human-readable description of the warning code.

294

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

295

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

296

},

297

"kind": "compute#nodeGroupAggregatedList", # [Output Only] Type of resource.Always compute#nodeGroupAggregatedList for aggregated lists of node groups.

298

"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.

299

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

300

"unreachables": [ # [Output Only] Unreachable resources.

301

"A String",

302

],

303

"warning": { # [Output Only] Informational warning message.

304

"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.

305

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

306

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

307

{

308

"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).

309

"value": "A String", # [Output Only] A warning data value corresponding to the key.

310

},

311

],

312

"message": "A String", # [Output Only] A human-readable description of the warning code.

313

},

314

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

<code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>

319

<pre>Retrieves the next page of results.

320

321

Args:

322

previous_request: The request for the previous page. (required)

323

previous_response: The response from the request for the previous page. (required)

324

325

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

326

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

327

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

332

<code class="details" id="close">close()</code>

333

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

337

<code class="details" id="delete">delete(project, zone, nodeGroup, requestId=None)</code>

338

<pre>Deletes the specified NodeGroup resource.

339

340

Args:

341

project: string, Project ID for this request. (required)

342

zone: string, The name of the zone for this request. (required)

343

nodeGroup: string, Name of the NodeGroup resource to delete. (required)

344

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.

345

346

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

347

348

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

349

350

Returns:

351

An object of the form:

352

353

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

354

#

355

# Google Compute Engine has three Operation resources:

356

#

357

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

358

#

359

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

360

#

361

# Operations can be global, regional or zonal.

362

# - For global operations, use the `globalOperations` resource.

363

# - For regional operations, use the `regionOperations` resource.

364

# - For zonal operations, use the `zonalOperations` resource.

365

#

366

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

367

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

368

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

369

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

370

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

371

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

372

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

373

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

374

"code": "A String", # [Output Only] The error type identifier for this error.

375

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

376

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

377

},

378

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

379

},

380

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

381

"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.

382

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

383

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

384

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

385

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

386

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

387

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

388

"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.

389

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

390

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

391

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

392

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

393

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

394

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

395

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

396

"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.

397

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

398

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

399

{

400

"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.

401

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

402

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

403

{

404

"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).

405

"value": "A String", # [Output Only] A warning data value corresponding to the key.

406

},

407

],

408

"message": "A String", # [Output Only] A human-readable description of the warning code.

409

},

410

],

411

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

412

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

416

<code class="details" id="deleteNodes">deleteNodes(project, zone, nodeGroup, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

417

<pre>Deletes specified nodes from the node group.

418

419

Args:

420

project: string, Project ID for this request. (required)

421

zone: string, The name of the zone for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

422

nodeGroup: string, Name of the NodeGroup resource whose nodes will be deleted. (required)

423

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

424

The object takes the form of:

425

426

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

427

"nodes": [ # Names of the nodes to delete.

428

"A String",

429

],

430

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

431

432

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.

433

434

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

435

436

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

437

438

Returns:

439

An object of the form:

440

441

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

442

#

443

# Google Compute Engine has three Operation resources:

444

#

445

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

446

#

447

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

448

#

449

# Operations can be global, regional or zonal.

450

# - For global operations, use the `globalOperations` resource.

451

# - For regional operations, use the `regionOperations` resource.

452

# - For zonal operations, use the `zonalOperations` resource.

453

#

454

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

455

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

456

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

457

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

458

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

459

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

460

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

461

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

462

"code": "A String", # [Output Only] The error type identifier for this error.

463

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

464

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

465

},

466

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

467

},

468

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

469

"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.

470

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

471

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

472

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

473

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

474

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

475

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

476

"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.

477

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

478

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

479

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

480

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

481

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

482

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

483

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

484

"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.

485

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

486

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

487

{

488

"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.

489

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

490

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

491

{

492

"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).

493

"value": "A String", # [Output Only] A warning data value corresponding to the key.

494

},

495

],

496

"message": "A String", # [Output Only] A human-readable description of the warning code.

497

},

498

],

499

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

500

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

<code class="details" id="get">get(project, zone, nodeGroup)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

505

<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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

506

507

Args:

508

project: string, Project ID for this request. (required)

509

zone: string, The name of the zone for this request. (required)

510

nodeGroup: string, Name of the node group to return. (required)

511

512

Returns:

513

An object of the form:

514

515

{ # Represent a sole-tenant Node Group resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

516

#

517

# 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 {$api_version}.nodeGroups ==)

518

"autoscalingPolicy": { # Specifies how autoscaling should behave.

519

"maxNodes": 42, # The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100.

520

"minNodes": 42, # The minimum number of nodes that the group should have.

521

"mode": "A String", # The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For more information, see Autoscaler modes.

522

},

523

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

524

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

525

"fingerprint": "A String",

526

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

527

"kind": "compute#nodeGroup", # [Output Only] The type of the resource. Always compute#nodeGroup for node group.

528

"locationHint": "A String", # An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate.

529

"maintenancePolicy": "A String", # Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.

530

"maintenanceWindow": { # Time window specified for daily maintenance operations. GCE's internal maintenance will be performed within this window.

531

"duration": "A String", # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

532

"maintenanceDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.

533

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

534

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

535

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

536

"startTime": "A String", # Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.

537

},

538

"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.

539

"nodeTemplate": "A String", # URL of the node template to create the node group from.

540

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

541

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

542

"shareSettings": { # The share setting for reservations and sole tenancy node groups. # Share-settings for the node group

543

"projects": [ # A List of Project names to specify consumer projects for this shared-reservation. This is only valid when share_type's value is SPECIFIC_PROJECTS.

544

"A String",

545

],

546

"shareType": "A String", # Type of sharing for this shared-reservation

547

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

548

"size": 42, # [Output Only] The total number of nodes in the node group.

549

"status": "A String",

550

"zone": "A String", # [Output Only] The name of the zone where the node group resides, such as us-central1-a.

551

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

555

<code class="details" id="getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

556

<pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.

557

558

Args:

559

project: string, Project ID for this request. (required)

560

zone: string, The name of the zone for this request. (required)

561

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

562

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

563

564

Returns:

565

An object of the form:

566

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

567

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

#

#

#

# A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.

572

#

573

# For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

#

# **JSON example:**

#

# { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }

#

# **YAML example:**

#

# bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3

582

#

583

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

584

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

585

{ # 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.

586

#

587

# 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.

588

#

589

# Example Policy with multiple AuditConfigs:

590

#

591

# { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }

592

#

593

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

594

"auditLogConfigs": [ # The configuration for logging of each type of permission.

595

{ # Provides the configuration for logging a type of permissions. Example:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

596

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

597

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] }

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

598

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

599

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

600

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

601

"A String",

602

],

603

"ignoreChildExemptions": True or False,

604

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

605

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

],

"exemptedMembers": [

"A String",

],

"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.

611

},

612

],

613

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

614

{ # Associates `members` with a `role`.

615

"bindingId": "A String",

616

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.

617

#

618

# If the condition evaluates to `true`, then this binding applies to the current request.

619

#

620

# If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.

621

#

622

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

623

#

624

# Example (Comparison):

625

#

626

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

627

#

628

# Example (Equality):

629

#

630

# title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'"

635

#

636

# Example (Data Manipulation):

637

#

638

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

639

#

640

# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

641

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

642

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

643

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

644

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

645

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

646

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

647

#

648

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

649

#

650

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

651

#

652

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

657

#

658

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

659

#

660

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.

661

#

662

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.

663

#

664

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

#

#

#

# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

669

"A String",

670

],

671

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

672

},

673

],

674

"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.

675

#

676

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

677

"iamOwned": True or False,

678

"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.

679

{ # A rule to be applied in a Policy.

680

"action": "A String", # Required

681

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

682

{ # A condition to be met.

683

"iam": "A String", # Trusted attributes supplied by the IAM system.

684

"op": "A String", # An operator to apply the subject with.

685

"svc": "A String", # Trusted attributes discharged by the service.

686

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

687

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

693

"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.

694

"A String",

695

],

696

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

697

{ # Specifies what kind of log the caller must write

698

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

699

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

700

"permissionType": "A String", # The type of the permission that was checked.

701

},

702

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

703

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

704

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

705

#

706

# 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.

707

#

708

# Field names correspond to IAM request parameters and field values are their respective values.

709

#

710

# 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.

711

#

712

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

713

"customFields": [ # Custom fields.

714

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

715

"name": "A String", # Name is the field name.

716

"value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

717

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

718

],

719

"field": "A String", # The field value to attribute.

720

"metric": "A String", # The metric to update.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

721

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

722

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

723

"logMode": "A String",

},

},

],

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

728

"A String",

729

],

730

"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.

"A String",

],

},

],

"version": 42, # Specifies the format of the policy.

736

#

737

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

738

#

739

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

740

#

741

# * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions

742

#

743

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

744

#

745

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

746

#

747

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

748

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

752

<code class="details" id="insert">insert(project, zone, initialNodeCount, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

753

<pre>Creates a NodeGroup resource in the specified project using the data included in the request.

754

755

Args:

756

project: string, Project ID for this request. (required)

757

zone: string, The name of the zone for this request. (required)

758

initialNodeCount: integer, Initial count of nodes in the node group. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

759

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

760

The object takes the form of:

761

762

{ # Represent a sole-tenant Node Group resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

763

#

764

# 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 {$api_version}.nodeGroups ==)

765

"autoscalingPolicy": { # Specifies how autoscaling should behave.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

766

"maxNodes": 42, # The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

767

"minNodes": 42, # The minimum number of nodes that the group should have.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

768

"mode": "A String", # The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For more information, see Autoscaler modes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

769

},

770

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

771

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

772

"fingerprint": "A String",

773

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

774

"kind": "compute#nodeGroup", # [Output Only] The type of the resource. Always compute#nodeGroup for node group.

775

"locationHint": "A String", # An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

776

"maintenancePolicy": "A String", # Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

777

"maintenanceWindow": { # Time window specified for daily maintenance operations. GCE's internal maintenance will be performed within this window.

778

"duration": "A String", # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

779

"maintenanceDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.

780

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

781

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

782

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

783

"startTime": "A String", # Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.

784

},

785

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

786

"nodeTemplate": "A String", # URL of the node template to create the node group from.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

787

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

788

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

789

"shareSettings": { # The share setting for reservations and sole tenancy node groups. # Share-settings for the node group

790

"projects": [ # A List of Project names to specify consumer projects for this shared-reservation. This is only valid when share_type's value is SPECIFIC_PROJECTS.

791

"A String",

792

],

793

"shareType": "A String", # Type of sharing for this shared-reservation

794

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

795

"size": 42, # [Output Only] The total number of nodes in the node group.

796

"status": "A String",

797

"zone": "A String", # [Output Only] The name of the zone where the node group resides, such as us-central1-a.

798

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

799

800

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.

801

802

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

803

804

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

805

806

Returns:

807

An object of the form:

808

809

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

810

#

811

# Google Compute Engine has three Operation resources:

812

#

813

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

814

#

815

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

816

#

817

# Operations can be global, regional or zonal.

818

# - For global operations, use the `globalOperations` resource.

819

# - For regional operations, use the `regionOperations` resource.

820

# - For zonal operations, use the `zonalOperations` resource.

821

#

822

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

823

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

824

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

825

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

826

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

827

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

828

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

829

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

830

"code": "A String", # [Output Only] The error type identifier for this error.

831

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

832

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

833

},

834

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

835

},

836

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

837

"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.

838

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

839

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

840

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

841

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

842

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

843

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

844

"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.

845

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

846

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

847

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

848

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

849

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

850

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

851

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

852

"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.

853

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

854

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

855

{

856

"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.

857

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

858

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

859

{

860

"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).

861

"value": "A String", # [Output Only] A warning data value corresponding to the key.

862

},

863

],

864

"message": "A String", # [Output Only] A human-readable description of the warning code.

865

},

866

],

867

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

868

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

872

<code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

873

<pre>Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group.

874

875

Args:

876

project: string, Project ID for this request. (required)

877

zone: string, The name of the zone for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

878

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 `<`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

879

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

880

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

881

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

882

You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

883

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

884

To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

885

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`)

886

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

887

888

You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

889

890

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

891

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

892

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

893

894

Returns:

895

An object of the form:

896

897

{ # Contains a list of nodeGroups.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

898

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

899

"items": [ # A list of NodeGroup resources.

900

{ # Represent a sole-tenant Node Group resource.

901

#

902

# 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 {$api_version}.nodeGroups ==)

903

"autoscalingPolicy": { # Specifies how autoscaling should behave.

904

"maxNodes": 42, # The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100.

905

"minNodes": 42, # The minimum number of nodes that the group should have.

906

"mode": "A String", # The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For more information, see Autoscaler modes.

907

},

908

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

909

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

910

"fingerprint": "A String",

911

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

912

"kind": "compute#nodeGroup", # [Output Only] The type of the resource. Always compute#nodeGroup for node group.

913

"locationHint": "A String", # An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate.

914

"maintenancePolicy": "A String", # Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.

915

"maintenanceWindow": { # Time window specified for daily maintenance operations. GCE's internal maintenance will be performed within this window.

916

"duration": "A String", # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

917

"maintenanceDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.

918

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

919

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

920

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

921

"startTime": "A String", # Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.

922

},

923

"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.

924

"nodeTemplate": "A String", # URL of the node template to create the node group from.

925

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

926

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

927

"shareSettings": { # The share setting for reservations and sole tenancy node groups. # Share-settings for the node group

928

"projects": [ # A List of Project names to specify consumer projects for this shared-reservation. This is only valid when share_type's value is SPECIFIC_PROJECTS.

929

"A String",

930

],

931

"shareType": "A String", # Type of sharing for this shared-reservation

932

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

933

"size": 42, # [Output Only] The total number of nodes in the node group.

934

"status": "A String",

935

"zone": "A String", # [Output Only] The name of the zone where the node group resides, such as us-central1-a.

936

},

937

],

938

"kind": "compute#nodeGroupList", # [Output Only] Type of resource.Always compute#nodeGroupList for lists of node groups.

939

"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.

940

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

941

"warning": { # [Output Only] Informational warning message.

942

"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.

943

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

944

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

945

{

946

"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).

947

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

948

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

949

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

950

"message": "A String", # [Output Only] A human-readable description of the warning code.

951

},

952

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

956

<code class="details" id="listNodes">listNodes(project, zone, nodeGroup, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

957

<pre>Lists nodes in the node group.

958

959

Args:

960

project: string, Project ID for this request. (required)

961

zone: string, The name of the zone for this request. (required)

962

nodeGroup: string, Name of the NodeGroup resource whose nodes you want to list. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

963

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 `<`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

964

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

965

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

966

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

967

You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

968

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

969

To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

970

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`)

971

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

972

973

You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

974

975

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

976

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

977

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

978

979

Returns:

980

An object of the form:

981

982

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

983

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

984

"items": [ # A list of Node resources.

985

{

986

"accelerators": [ # Accelerators for this node.

987

{ # A specification of the type and number of accelerator cards attached to the instance.

988

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

989

"acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

990

},

991

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

992

"cpuOvercommitType": "A String", # CPU overcommit.

993

"disks": [ # Local disk configurations.

994

{

995

"diskCount": 42, # Specifies the number of such disks.

996

"diskSizeGb": 42, # Specifies the size of the disk in base-2 GB.

997

"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.

998

},

999

],

1000

"instances": [ # Instances scheduled on this node.

1001

"A String",

1002

],

1003

"name": "A String", # The name of the node.

1004

"nodeType": "A String", # The type of this node.

1005

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

1006

"serverBinding": { # Binding properties for the physical server.

1007

"type": "A String",

1008

},

1009

"serverId": "A String", # Server ID associated with this node.

1010

"status": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1011

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1012

],

1013

"kind": "compute#nodeGroupsListNodes", # [Output Only] The resource type, which is always compute.nodeGroupsListNodes for the list of nodes in the specified node group.

1014

"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.

1015

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

1016

"warning": { # [Output Only] Informational warning message.

1017

"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.

1018

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1019

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1020

{

1021

"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).

1022

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1023

},

1024

],

1025

"message": "A String", # [Output Only] A human-readable description of the warning code.

1026

},

1027

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

<code class="details" id="listNodes_next">listNodes_next(previous_request, previous_response)</code>

1032

<pre>Retrieves the next page of results.

1033

1034

Args:

1035

previous_request: The request for the previous page. (required)

1036

previous_response: The response from the request for the previous page. (required)

1037

1038

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1039

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1040

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1046

<pre>Retrieves the next page of results.

1047

1048

Args:

1049

previous_request: The request for the previous page. (required)

1050

previous_response: The response from the request for the previous page. (required)

1051

1052

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1053

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1054

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1059

<code class="details" id="patch">patch(project, zone, nodeGroup, body=None, requestId=None)</code>

1060

<pre>Updates the specified node group.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1061

1062

Args:

1063

project: string, Project ID for this request. (required)

1064

zone: string, The name of the zone for this request. (required)

1065

nodeGroup: string, Name of the NodeGroup resource to update. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1066

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1067

The object takes the form of:

1068

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1069

{ # Represent a sole-tenant Node Group resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1070

#

1071

# 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 {$api_version}.nodeGroups ==)

1072

"autoscalingPolicy": { # Specifies how autoscaling should behave.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

1073

"maxNodes": 42, # The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1074

"minNodes": 42, # The minimum number of nodes that the group should have.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1075

"mode": "A String", # The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For more information, see Autoscaler modes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1076

},

1077

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1078

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1079

"fingerprint": "A String",

1080

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

1081

"kind": "compute#nodeGroup", # [Output Only] The type of the resource. Always compute#nodeGroup for node group.

1082

"locationHint": "A String", # An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1083

"maintenancePolicy": "A String", # Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1084

"maintenanceWindow": { # Time window specified for daily maintenance operations. GCE's internal maintenance will be performed within this window.

1085

"duration": "A String", # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1086

"maintenanceDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.

1087

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1088

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1089

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1090

"startTime": "A String", # Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.

1091

},

1092

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1093

"nodeTemplate": "A String", # URL of the node template to create the node group from.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1094

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1095

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

1096

"shareSettings": { # The share setting for reservations and sole tenancy node groups. # Share-settings for the node group

1097

"projects": [ # A List of Project names to specify consumer projects for this shared-reservation. This is only valid when share_type's value is SPECIFIC_PROJECTS.

1098

"A String",

1099

],

1100

"shareType": "A String", # Type of sharing for this shared-reservation

1101

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1102

"size": 42, # [Output Only] The total number of nodes in the node group.

1103

"status": "A String",

1104

"zone": "A String", # [Output Only] The name of the zone where the node group resides, such as us-central1-a.

1105

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1106

1107

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.

1108

1109

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

1110

1111

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

1112

1113

Returns:

1114

An object of the form:

1115

1116

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1117

#

1118

# Google Compute Engine has three Operation resources:

1119

#

1120

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1121

#

1122

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1123

#

1124

# Operations can be global, regional or zonal.

1125

# - For global operations, use the `globalOperations` resource.

1126

# - For regional operations, use the `regionOperations` resource.

1127

# - For zonal operations, use the `zonalOperations` resource.

1128

#

1129

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

1130

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1131

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1132

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1133

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1134

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1135

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1136

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1137

"code": "A String", # [Output Only] The error type identifier for this error.

1138

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1139

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1140

},

1141

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1142

},

1143

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1144

"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.

1145

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1146

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1147

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1148

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1149

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1150

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1151

"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.

1152

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1153

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1154

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1155

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1156

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1157

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1158

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1159

"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.

1160

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1161

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1162

{

1163

"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.

1164

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1165

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1166

{

1167

"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).

1168

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1169

},

1170

],

1171

"message": "A String", # [Output Only] A human-readable description of the warning code.

1172

},

1173

],

1174

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

1175

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1179

<code class="details" id="setIamPolicy">setIamPolicy(project, zone, resource, body=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1180

<pre>Sets the access control policy on the specified resource. Replaces any existing policy.

1181

1182

Args:

1183

project: string, Project ID for this request. (required)

1184

zone: string, The name of the zone for this request. (required)

1185

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1186

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1187

The object takes the form of:

1188

1189

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1190

"bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.

1191

{ # Associates `members` with a `role`.

1192

"bindingId": "A String",

1193

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1194

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1195

# If the condition evaluates to `true`, then this binding applies to the current request.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1196

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1197

# If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1198

#

1199

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1200

#

1201

# Example (Comparison):

1202

#

1203

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

1204

#

1205

# Example (Equality):

1206

#

1207

# title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'"

1212

#

1213

# Example (Data Manipulation):

1214

#

1215

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

1216

#

1217

# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

1218

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

1219

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1220

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

1221

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

1222

},

1223

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

1224

#

1225

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

1226

#

1227

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

1228

#

1229

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

1234

#

1235

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

1236

#

1237

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.

1238

#

1239

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.

1240

#

1241

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

#

#

#

# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

1246

"A String",

1247

],

1248

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1249

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1250

],

1251

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.

1252

"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud 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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1253

#

1254

#

1255

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1256

# A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1257

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1258

# For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1259

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1260

# **JSON example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1261

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1262

# { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1263

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1264

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1265

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1266

# bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1267

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1268

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1269

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1270

{ # 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.

1271

#

1272

# 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.

1273

#

1274

# Example Policy with multiple AuditConfigs:

1275

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1276

# { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1277

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1278

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1279

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1280

{ # Provides the configuration for logging a type of permissions. Example:

1281

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1282

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1283

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1284

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

1285

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

1286

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1287

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1288

"ignoreChildExemptions": True or False,

1289

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1290

},

1291

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"exemptedMembers": [

"A String",

],

"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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1296

},

1297

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1298

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1299

{ # Associates `members` with a `role`.

Yoshi Automation Bot

0d561ef

2020-11-25 07:50:41 -0800

[diff] [blame]

1300

"bindingId": "A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1301

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.

1302

#

1303

# If the condition evaluates to `true`, then this binding applies to the current request.

1304

#

1305

# If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.

1306

#

1307

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1308

#

1309

# Example (Comparison):

1310

#

1311

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

1312

#

1313

# Example (Equality):

1314

#

1315

# title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'"

1320

#

1321

# Example (Data Manipulation):

1322

#

1323

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

1324

#

1325

# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

1326

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

1327

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1328

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

1329

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

1330

},

1331

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1332

#

1333

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

1334

#

1335

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

1336

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1337

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

1342

#

1343

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

1344

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1345

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.

1346

#

1347

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.

1348

#

1349

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

1350

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1351

#

1352

#

1353

# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1354

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1355

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1356

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1357

},

1358

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1359

"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.

1360

#

1361

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

1362

"iamOwned": True or False,

1363

"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.

1364

{ # A rule to be applied in a Policy.

1365

"action": "A String", # Required

1366

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

1367

{ # A condition to be met.

1368

"iam": "A String", # Trusted attributes supplied by the IAM system.

1369

"op": "A String", # An operator to apply the subject with.

1370

"svc": "A String", # Trusted attributes discharged by the service.

1371

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

1372

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

1378

"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.

1379

"A String",

1380

],

1381

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

1382

{ # Specifies what kind of log the caller must write

1383

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

1384

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

1385

"permissionType": "A String", # The type of the permission that was checked.

1386

},

1387

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

1388

},

1389

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

1390

#

1391

# 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.

1392

#

1393

# Field names correspond to IAM request parameters and field values are their respective values.

1394

#

1395

# 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.

1396

#

1397

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

1398

"customFields": [ # Custom fields.

1399

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

1400

"name": "A String", # Name is the field name.

1401

"value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.

1402

},

1403

],

1404

"field": "A String", # The field value to attribute.

1405

"metric": "A String", # The metric to update.

1406

},

1407

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

1408

"logMode": "A String",

},

},

],

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

1413

"A String",

1414

],

1415

"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.

"A String",

],

},

],

"version": 42, # Specifies the format of the policy.

1421

#

1422

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

1423

#

1424

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

1425

#

1426

# * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions

1427

#

1428

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

1429

#

1430

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

1431

#

1432

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

},

}

Returns:

An object of the form:

1439

1440

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

#

#

#

# A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.

1445

#

1446

# For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

#

# **JSON example:**

#

# { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }

#

# **YAML example:**

#

# bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3

1455

#

1456

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

1457

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

1458

{ # 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.

1459

#

1460

# 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.

1461

#

1462

# Example Policy with multiple AuditConfigs:

1463

#

1464

# { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }

1465

#

1466

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

1467

"auditLogConfigs": [ # The configuration for logging of each type of permission.

1468

{ # Provides the configuration for logging a type of permissions. Example:

1469

#

1470

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] }

1471

#

1472

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

1473

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

1474

"A String",

1475

],

1476

"ignoreChildExemptions": True or False,

1477

"logType": "A String", # The log type that this config enables.

},

],

"exemptedMembers": [

"A String",

],

"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.

1484

},

1485

],

1486

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

1487

{ # Associates `members` with a `role`.

1488

"bindingId": "A String",

1489

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.

1490

#

1491

# If the condition evaluates to `true`, then this binding applies to the current request.

1492

#

1493

# If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.

1494

#

1495

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1496

#

1497

# Example (Comparison):

1498

#

1499

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

1500

#

1501

# Example (Equality):

1502

#

1503

# title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'"

1508

#

1509

# Example (Data Manipulation):

1510

#

1511

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

1512

#

1513

# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

1514

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

1515

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1516

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

1517

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

1518

},

1519

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

1520

#

1521

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

1522

#

1523

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

1524

#

1525

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

1530

#

1531

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

1532

#

1533

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.

1534

#

1535

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.

1536

#

1537

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

#

#

#

# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

1542

"A String",

1543

],

1544

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

1545

},

1546

],

1547

"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.

1548

#

1549

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

1550

"iamOwned": True or False,

1551

"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.

1552

{ # A rule to be applied in a Policy.

1553

"action": "A String", # Required

1554

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

1555

{ # A condition to be met.

1556

"iam": "A String", # Trusted attributes supplied by the IAM system.

1557

"op": "A String", # An operator to apply the subject with.

1558

"svc": "A String", # Trusted attributes discharged by the service.

1559

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

1560

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

1566

"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.

1567

"A String",

1568

],

1569

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

1570

{ # Specifies what kind of log the caller must write

1571

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

1572

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

1573

"permissionType": "A String", # The type of the permission that was checked.

1574

},

1575

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

1576

},

1577

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

1578

#

1579

# 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.

1580

#

1581

# Field names correspond to IAM request parameters and field values are their respective values.

1582

#

1583

# 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.

1584

#

1585

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

1586

"customFields": [ # Custom fields.

1587

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

1588

"name": "A String", # Name is the field name.

1589

"value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.

1590

},

1591

],

1592

"field": "A String", # The field value to attribute.

1593

"metric": "A String", # The metric to update.

1594

},

1595

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

1596

"logMode": "A String",

},

},

],

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

1601

"A String",

1602

],

1603

"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.

"A String",

],

},

],

"version": 42, # Specifies the format of the policy.

1609

#

1610

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

1611

#

1612

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

1613

#

1614

# * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions

1615

#

1616

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

1617

#

1618

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

1619

#

1620

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1621

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1625

<code class="details" id="setNodeTemplate">setNodeTemplate(project, zone, nodeGroup, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1626

<pre>Updates the node template of the node group.

1627

1628

Args:

1629

project: string, Project ID for this request. (required)

1630

zone: string, The name of the zone for this request. (required)

1631

nodeGroup: string, Name of the NodeGroup resource to update. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1632

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1633

The object takes the form of:

1634

1635

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1636

"nodeTemplate": "A String", # Full or partial URL of the node template resource to be updated for this node group.

1637

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1638

1639

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.

1640

1641

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

1642

1643

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

1644

1645

Returns:

1646

An object of the form:

1647

1648

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1649

#

1650

# Google Compute Engine has three Operation resources:

1651

#

1652

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1653

#

1654

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1655

#

1656

# Operations can be global, regional or zonal.

1657

# - For global operations, use the `globalOperations` resource.

1658

# - For regional operations, use the `regionOperations` resource.

1659

# - For zonal operations, use the `zonalOperations` resource.

1660

#

1661

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

1662

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1663

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1664

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1665

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1666

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1667

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1668

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1669

"code": "A String", # [Output Only] The error type identifier for this error.

1670

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1671

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1672

},

1673

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1674

},

1675

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1676

"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.

1677

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1678

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1679

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1680

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1681

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot