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.

yoshi-code-bot

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

[diff] [blame^]

185

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

186

#

187

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

188

#

189

# Example 1: Pack and unpack a message in C++.

190

#

191

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

192

#

193

# Example 2: Pack and unpack a message in Java.

194

#

195

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

196

#

197

# Example 3: Pack and unpack a message in Python.

198

#

199

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

200

#

201

# Example 4: Pack and unpack a message in Go

202

#

203

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

204

#

205

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

210

#

211

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

212

#

213

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

214

#

215

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

216

#

217

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

218

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

219

#

220

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

221

#

222

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

223

#

224

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

225

#

226

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

227

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

228

},

Yoshi Automation Bot

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

[diff] [blame]

229

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

yoshi-code-bot

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

[diff] [blame^]

230

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

231

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

232

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

233

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

234

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

235

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

236

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

237

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

238

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

239

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

240

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

241

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

242

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

243

{

244

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

245

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

246

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

247

{

248

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

249

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

250

},

251

],

252

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

253

},

254

],

255

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

256

}</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]

260

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

261

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

262

263

Args:

264

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

Dan O'Meara

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

[diff] [blame]

265

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]

266

Dan O'Meara

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

[diff] [blame]

267

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]

268

Dan O'Meara

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

[diff] [blame]

269

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]

270

Bu Sun Kim

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

[diff] [blame]

271

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]

272

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]

273

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

274

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

275

276

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.

277

278

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

279

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^]

280

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]

281

282

Returns:

283

An object of the form:

284

285

{

Yoshi Automation Bot

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

[diff] [blame]

286

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

287

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

288

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

289

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

290

{ # Represent a sole-tenant Node Group resource.

291

#

292

# 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 ==)

293

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

294

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

295

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

296

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

297

},

Yoshi Automation Bot

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

[diff] [blame]

298

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

299

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

300

"fingerprint": "A String",

301

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

302

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

303

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

304

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

305

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

306

"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^]

307

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

308

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

309

"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

310

},

Yoshi Automation Bot

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

[diff] [blame]

311

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

312

},

313

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

314

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

315

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

316

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

317

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

318

"status": "A String",

319

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

320

},

321

],

Yoshi Automation Bot

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

[diff] [blame]

322

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

323

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

324

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

325

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

326

{

327

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

328

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

329

},

330

],

331

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

332

},

Bu Sun Kim

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

[diff] [blame]

333

},

Yoshi Automation Bot

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

[diff] [blame]

334

},

335

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

336

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

337

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

338

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

339

"A String",

340

],

341

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

342

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

343

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

344

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

345

{

346

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

347

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

348

},

349

],

350

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

351

},

352

}</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>

357

<pre>Retrieves the next page of results.

358

359

Args:

360

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

361

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

362

363

Returns:

Bu Sun Kim

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

[diff] [blame]

364

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]

365

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]

370

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

371

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

375

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

376

<pre>Deletes the specified NodeGroup resource.

377

378

Args:

379

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

380

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

381

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

382

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.

383

384

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.

385

386

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

387

388

Returns:

389

An object of the form:

390

391

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

392

#

393

# Google Compute Engine has three Operation resources:

394

#

395

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

396

#

397

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

398

#

399

# Operations can be global, regional or zonal.

400

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

401

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

402

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

403

#

404

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

405

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

406

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

407

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

408

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

409

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

410

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

Bu Sun Kim

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

[diff] [blame]

411

{

Yoshi Automation Bot

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

[diff] [blame]

412

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

413

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

414

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

Bu Sun Kim

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

[diff] [blame]

415

},

416

],

Yoshi Automation Bot

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

[diff] [blame]

417

},

418

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

419

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

420

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

421

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

422

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

yoshi-code-bot

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

[diff] [blame^]

423

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

424

#

425

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

426

#

427

# Example 1: Pack and unpack a message in C++.

428

#

429

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

430

#

431

# Example 2: Pack and unpack a message in Java.

432

#

433

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

434

#

435

# Example 3: Pack and unpack a message in Python.

436

#

437

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

438

#

439

# Example 4: Pack and unpack a message in Go

440

#

441

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

442

#

443

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

448

#

449

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

450

#

451

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

452

#

453

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

454

#

455

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

456

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

457

#

458

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

459

#

460

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

461

#

462

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

463

#

464

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

465

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

466

},

Yoshi Automation Bot

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

[diff] [blame]

467

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

yoshi-code-bot

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

[diff] [blame^]

468

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

469

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

470

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

471

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

472

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

473

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

474

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

475

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

476

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

477

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

478

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

479

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

480

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

481

{

482

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

483

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

484

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

485

{

486

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

487

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

488

},

489

],

490

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

491

},

492

],

493

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

494

}</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]

498

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

499

<pre>Deletes specified nodes from the node group.

500

501

Args:

502

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

503

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

Dan O'Meara

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

[diff] [blame]

504

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

505

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

506

The object takes the form of:

507

508

{

Yoshi Automation Bot

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

[diff] [blame]

509

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

510

"A String",

511

],

512

}

Bu Sun Kim

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

[diff] [blame]

513

514

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.

515

516

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.

517

518

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

519

520

Returns:

521

An object of the form:

522

523

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

524

#

525

# Google Compute Engine has three Operation resources:

526

#

527

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

528

#

529

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

530

#

531

# Operations can be global, regional or zonal.

532

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

533

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

534

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

535

#

536

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

537

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

538

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

539

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

540

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

541

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

542

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

Bu Sun Kim

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

[diff] [blame]

543

{

Yoshi Automation Bot

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

[diff] [blame]

544

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

545

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

546

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

Bu Sun Kim

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

[diff] [blame]

547

},

548

],

Yoshi Automation Bot

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

[diff] [blame]

549

},

550

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

551

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

552

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

553

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

554

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

yoshi-code-bot

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

[diff] [blame^]

555

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

556

#

557

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

558

#

559

# Example 1: Pack and unpack a message in C++.

560

#

561

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

562

#

563

# Example 2: Pack and unpack a message in Java.

564

#

565

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

566

#

567

# Example 3: Pack and unpack a message in Python.

568

#

569

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

570

#

571

# Example 4: Pack and unpack a message in Go

572

#

573

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

574

#

575

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

580

#

581

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

582

#

583

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

584

#

585

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

586

#

587

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

588

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

589

#

590

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

591

#

592

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

593

#

594

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

595

#

596

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

597

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

598

},

Yoshi Automation Bot

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

[diff] [blame]

599

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

yoshi-code-bot

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

[diff] [blame^]

600

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

601

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

602

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

603

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

604

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

605

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

606

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

607

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

608

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

609

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

610

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

611

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

612

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

613

{

614

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

615

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

616

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

617

{

618

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

619

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

620

},

621

],

622

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

623

},

624

],

625

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

626

}</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]

631

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

632

633

Args:

634

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

635

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

636

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

637

638

Returns:

639

An object of the form:

640

641

{ # Represent a sole-tenant Node Group resource.

Yoshi Automation Bot

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

[diff] [blame]

642

#

643

# 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 ==)

644

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

645

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

646

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

647

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

648

},

649

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

650

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

651

"fingerprint": "A String",

652

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

653

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

654

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

655

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

656

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

657

"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^]

658

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

659

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

660

"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

661

},

Yoshi Automation Bot

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

[diff] [blame]

662

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

663

},

664

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

665

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

666

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

667

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

668

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

669

"status": "A String",

670

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

671

}</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]

675

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

Bu Sun Kim

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

[diff] [blame]

676

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

677

678

Args:

679

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

680

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

681

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

Dan O'Meara

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

[diff] [blame]

682

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

Bu Sun Kim

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

[diff] [blame]

683

684

Returns:

685

An object of the form:

686

Dan O'Meara

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

[diff] [blame]

687

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

692

#

693

# 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

702

#

703

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

704

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

705

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

706

#

707

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

708

#

709

# Example Policy with multiple AuditConfigs:

710

#

711

# { "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" ] } ] } ] }

712

#

713

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

714

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

715

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

Bu Sun Kim

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

[diff] [blame]

716

#

Yoshi Automation Bot

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

[diff] [blame]

717

# { "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]

718

#

Yoshi Automation Bot

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

[diff] [blame]

719

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

720

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

721

"A String",

722

],

723

"ignoreChildExemptions": True or False,

724

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

Bu Sun Kim

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

[diff] [blame]

725

},

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.

731

},

732

],

733

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

734

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

735

"bindingId": "A String",

736

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

737

#

738

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

739

#

740

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

741

#

742

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

743

#

744

# Example (Comparison):

745

#

746

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

747

#

748

# Example (Equality):

749

#

750

# 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'"

755

#

756

# Example (Data Manipulation):

757

#

758

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

759

#

760

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

761

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

762

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

763

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

764

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

765

},

Yoshi Automation Bot

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

[diff] [blame]

766

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

767

#

768

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

769

#

770

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

771

#

772

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

777

#

778

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

779

#

780

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

781

#

782

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

783

#

784

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

789

"A String",

790

],

791

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

792

},

793

],

794

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

795

#

796

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

797

"iamOwned": True or False,

798

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

799

{ # A rule to be applied in a Policy.

800

"action": "A String", # Required

801

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

802

{ # A condition to be met.

803

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

804

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

805

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

806

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

807

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

"A String",

],

},

],

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

813

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

814

"A String",

815

],

816

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

817

{ # Specifies what kind of log the caller must write

818

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

819

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

820

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

821

},

822

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

823

},

Yoshi Automation Bot

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

[diff] [blame]

824

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

825

#

826

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

827

#

828

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

829

#

830

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

831

#

832

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

833

"customFields": [ # Custom fields.

834

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

835

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

836

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

837

},

Yoshi Automation Bot

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

[diff] [blame]

838

],

839

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

840

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

Bu Sun Kim

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

[diff] [blame]

841

},

Yoshi Automation Bot

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

[diff] [blame]

842

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

843

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

848

"A String",

849

],

850

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

856

#

857

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

858

#

859

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

860

#

861

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

862

#

863

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

864

#

865

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

866

#

867

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

868

}</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]

872

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

873

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

874

875

Args:

876

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

877

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

878

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

Dan O'Meara

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

[diff] [blame]

879

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

880

The object takes the form of:

881

882

{ # Represent a sole-tenant Node Group resource.

Bu Sun Kim

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

[diff] [blame]

883

#

884

# 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 ==)

885

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

Bu Sun Kim

673ec5c

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

[diff] [blame]

886

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

887

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

Dmitry Frenkel

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

[diff] [blame]

888

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

889

},

890

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

891

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

892

"fingerprint": "A String",

893

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

894

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

895

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

896

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

897

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

898

"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^]

899

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

900

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

901

"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

902

},

Bu Sun Kim

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

[diff] [blame]

903

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

904

},

905

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

906

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

907

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

908

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

909

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

910

"status": "A String",

911

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

912

}

Bu Sun Kim

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

[diff] [blame]

913

914

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.

915

916

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.

917

918

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

919

920

Returns:

921

An object of the form:

922

923

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

924

#

925

# Google Compute Engine has three Operation resources:

926

#

927

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

928

#

929

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

930

#

931

# Operations can be global, regional or zonal.

932

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

933

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

934

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

935

#

936

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

937

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

938

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

939

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

940

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

941

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

942

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

Bu Sun Kim

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

[diff] [blame]

943

{

Yoshi Automation Bot

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

[diff] [blame]

944

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

945

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

946

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

Bu Sun Kim

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

[diff] [blame]

947

},

948

],

Yoshi Automation Bot

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

[diff] [blame]

949

},

950

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

951

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

952

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

953

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

954

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

yoshi-code-bot

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

[diff] [blame^]

955

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

956

#

957

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

958

#

959

# Example 1: Pack and unpack a message in C++.

960

#

961

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

962

#

963

# Example 2: Pack and unpack a message in Java.

964

#

965

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

966

#

967

# Example 3: Pack and unpack a message in Python.

968

#

969

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

970

#

971

# Example 4: Pack and unpack a message in Go

972

#

973

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

974

#

975

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

980

#

981

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

982

#

983

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

984

#

985

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

986

#

987

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

988

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

989

#

990

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

991

#

992

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

993

#

994

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

995

#

996

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

997

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

998

},

Yoshi Automation Bot

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

[diff] [blame]

999

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

yoshi-code-bot

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

[diff] [blame^]

1000

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

1001

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

1002

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

1003

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

1004

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

1005

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

1006

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

1007

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

1008

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

1009

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

1010

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

1011

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

1012

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

1013

{

1014

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

1015

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

1016

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

1017

{

1018

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

1019

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

1020

},

1021

],

1022

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

1023

},

1024

],

1025

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

1026

}</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]

1030

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

1031

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

1032

1033

Args:

1034

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

1035

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

Dan O'Meara

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

[diff] [blame]

1036

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]

1037

Dan O'Meara

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

[diff] [blame]

1038

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]

1039

Dan O'Meara

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

[diff] [blame]

1040

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]

1041

Bu Sun Kim

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

[diff] [blame]

1042

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

1043

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

1044

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

1045

1046

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.

1047

1048

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

1049

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^]

1050

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]

1051

1052

Returns:

1053

An object of the form:

1054

1055

{ # Contains a list of nodeGroups.

Yoshi Automation Bot

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

[diff] [blame]

1056

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

1057

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

1058

{ # Represent a sole-tenant Node Group resource.

1059

#

1060

# 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 ==)

1061

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

1062

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

1063

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

1064

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

1065

},

1066

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

1067

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

1068

"fingerprint": "A String",

1069

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

1070

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

1071

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

1072

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

1073

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

1074

"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^]

1075

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

1076

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

1077

"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

1078

},

Yoshi Automation Bot

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

[diff] [blame]

1079

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

1080

},

1081

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

1082

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

1083

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

1084

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

1085

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

1086

"status": "A String",

1087

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

1088

},

1089

],

1090

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

1091

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

1092

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

1093

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

1094

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

1095

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

1096

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

1097

{

1098

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

1099

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

1100

},

Bu Sun Kim

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

[diff] [blame]

1101

],

Yoshi Automation Bot

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

[diff] [blame]

1102

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

1103

},

1104

}</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]

1108

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

1109

<pre>Lists nodes in the node group.

1110

1111

Args:

1112

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

1113

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

1114

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]

1115

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]

1116

Dan O'Meara

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

[diff] [blame]

1117

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]

1118

Dan O'Meara

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

[diff] [blame]

1119

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]

1120

Bu Sun Kim

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

[diff] [blame]

1121

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

1122

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

1123

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

1124

1125

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.

1126

1127

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

1128

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^]

1129

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]

1130

1131

Returns:

1132

An object of the form:

1133

1134

{

Yoshi Automation Bot

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

[diff] [blame]

1135

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

1136

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

1137

{

1138

"accelerators": [ # Accelerators for this node.

1139

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

1140

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

1141

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

1142

},

1143

],

Yoshi Automation Bot

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

[diff] [blame]

1144

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

1145

"disks": [ # Local disk configurations.

1146

{

1147

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

1148

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

1149

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

1150

},

1151

],

1152

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

1153

"A String",

1154

],

1155

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

1156

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

1157

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

1158

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

1159

"type": "A String",

1160

},

1161

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

1162

"status": "A String",

Bu Sun Kim

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

[diff] [blame]

1163

},

Yoshi Automation Bot

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

[diff] [blame]

1164

],

1165

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

1166

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

1167

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

1168

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

1169

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

1170

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

1171

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

1172

{

1173

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

1174

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

1175

},

1176

],

1177

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

1178

},

1179

}</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>

1184

<pre>Retrieves the next page of results.

1185

1186

Args:

1187

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

1188

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

1189

1190

Returns:

Bu Sun Kim

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

[diff] [blame]

1191

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]

1192

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>

1198

<pre>Retrieves the next page of results.

1199

1200

Args:

1201

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

1202

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

1203

1204

Returns:

Bu Sun Kim

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

[diff] [blame]

1205

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]

1206

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]

1211

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

1212

<pre>Updates the specified node group.

Bu Sun Kim

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

[diff] [blame]

1213

1214

Args:

1215

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

1216

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

1217

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

Dan O'Meara

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

[diff] [blame]

1218

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1219

The object takes the form of:

1220

Dan O'Meara

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

[diff] [blame]

1221

{ # Represent a sole-tenant Node Group resource.

Bu Sun Kim

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

[diff] [blame]

1222

#

1223

# 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 ==)

1224

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

Bu Sun Kim

673ec5c

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

[diff] [blame]

1225

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

1226

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

Dmitry Frenkel

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

[diff] [blame]

1227

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

1228

},

1229

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

1230

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

1231

"fingerprint": "A String",

1232

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

1233

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

1234

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

1235

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

1236

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

1237

"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^]

1238

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

1239

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

1240

"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

1241

},

Bu Sun Kim

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

[diff] [blame]

1242

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

1243

},

1244

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

1245

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

1246

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

1247

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

1248

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

1249

"status": "A String",

1250

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

1251

}

Bu Sun Kim

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

[diff] [blame]

1252

1253

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.

1254

1255

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.

1256

1257

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

1258

1259

Returns:

1260

An object of the form:

1261

1262

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

1263

#

1264

# Google Compute Engine has three Operation resources:

1265

#

1266

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

1267

#

1268

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

1269

#

1270

# Operations can be global, regional or zonal.

1271

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

1272

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

1273

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

1274

#

1275

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

1276

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

1277

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

1278

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

1279

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

1280

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

1281

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

Bu Sun Kim

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

[diff] [blame]

1282

{

Yoshi Automation Bot

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

[diff] [blame]

1283

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

1284

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

1285

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

Bu Sun Kim

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

[diff] [blame]

1286

},

1287

],

Yoshi Automation Bot

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

[diff] [blame]

1288

},

1289

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

1290

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

1291

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

1292

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

1293

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

yoshi-code-bot

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

[diff] [blame^]

1294

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

1295

#

1296

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

1297

#

1298

# Example 1: Pack and unpack a message in C++.

1299

#

1300

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

1301

#

1302

# Example 2: Pack and unpack a message in Java.

1303

#

1304

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

1305

#

1306

# Example 3: Pack and unpack a message in Python.

1307

#

1308

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

1309

#

1310

# Example 4: Pack and unpack a message in Go

1311

#

1312

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

1313

#

1314

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

1319

#

1320

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

1321

#

1322

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

1323

#

1324

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

1325

#

1326

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

1327

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

1328

#

1329

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

1330

#

1331

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

1332

#

1333

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

1334

#

1335

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

1336

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

1337

},

Yoshi Automation Bot

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

[diff] [blame]

1338

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

yoshi-code-bot

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

[diff] [blame^]

1339

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

1340

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

1341

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

1342

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

1343

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

1344

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

1345

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

1346

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

1347

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

1348

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

1349

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

1350

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

1351

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

1352

{

1353

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

1354

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

1355

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

1356

{

1357

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

1358

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

1359

},

1360

],

1361

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

1362

},

1363

],

1364

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

1365

}</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]

1369

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

Bu Sun Kim

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

[diff] [blame]

1370

<pre>Sets the access control policy on the specified resource. Replaces any existing policy.

1371

1372

Args:

1373

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

1374

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

1375

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

Dan O'Meara

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

[diff] [blame]

1376

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1377

The object takes the form of:

1378

1379

{

Yoshi Automation Bot

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

[diff] [blame]

1380

"bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.

1381

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

1382

"bindingId": "A String",

1383

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

1384

#

Yoshi Automation Bot

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

[diff] [blame]

1385

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

1386

#

Yoshi Automation Bot

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

[diff] [blame]

1387

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

1388

#

1389

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

1390

#

1391

# Example (Comparison):

1392

#

1393

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

1394

#

1395

# Example (Equality):

1396

#

1397

# 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'"

1402

#

1403

# Example (Data Manipulation):

1404

#

1405

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

1406

#

1407

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

1408

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

1409

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

1410

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

1411

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

1412

},

1413

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

1414

#

1415

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

1416

#

1417

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

1418

#

1419

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

1424

#

1425

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

1426

#

1427

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

1428

#

1429

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

1430

#

1431

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

1436

"A String",

1437

],

1438

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

1439

},

Yoshi Automation Bot

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

[diff] [blame]

1440

],

1441

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.

1442

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

1443

#

1444

#

1445

#

Dan O'Meara

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

[diff] [blame]

1446

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

1447

#

Bu Sun Kim

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

[diff] [blame]

1448

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

1449

#

Dan O'Meara

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

[diff] [blame]

1450

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

1451

#

Bu Sun Kim

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

[diff] [blame]

1452

# { "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]

1453

#

Dan O'Meara

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

[diff] [blame]

1454

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

1455

#

Bu Sun Kim

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

[diff] [blame]

1456

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

1457

#

Dan O'Meara

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

[diff] [blame]

1458

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

1459

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

Bu Sun Kim

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

[diff] [blame]

1460

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

1461

#

1462

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

1463

#

1464

# Example Policy with multiple AuditConfigs:

1465

#

Bu Sun Kim

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

[diff] [blame]

1466

# { "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]

1467

#

Dan O'Meara

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

[diff] [blame]

1468

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

1469

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

Bu Sun Kim

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

[diff] [blame]

1470

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

1471

#

Bu Sun Kim

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

[diff] [blame]

1472

# { "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]

1473

#

Bu Sun Kim

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

[diff] [blame]

1474

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

1475

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

1476

"A String",

Bu Sun Kim

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

[diff] [blame]

1477

],

Bu Sun Kim

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

[diff] [blame]

1478

"ignoreChildExemptions": True or False,

1479

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

Bu Sun Kim

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

[diff] [blame]

1480

},

1481

],

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]

1486

},

1487

],

Bu Sun Kim

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

[diff] [blame]

1488

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

1489

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

Yoshi Automation Bot

0d561ef

2020-11-25 07:50:41 -0800

[diff] [blame]

1490

"bindingId": "A String",

Bu Sun Kim

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

[diff] [blame]

1491

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

1492

#

1493

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

1494

#

1495

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

1496

#

1497

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

1498

#

1499

# Example (Comparison):

1500

#

1501

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

1502

#

1503

# Example (Equality):

1504

#

1505

# 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'"

1510

#

1511

# Example (Data Manipulation):

1512

#

1513

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

1514

#

1515

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

1516

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

1517

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

1518

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

1519

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

1520

},

1521

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

1522

#

1523

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

1524

#

1525

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

1526

#

Dan O'Meara

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

[diff] [blame]

1527

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

1532

#

1533

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

1534

#

Dan O'Meara

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

[diff] [blame]

1535

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

1536

#

1537

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

1538

#

1539

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

1540

#

Bu Sun Kim

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

[diff] [blame]

1541

#

1542

#

1543

# * `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]

1544

"A String",

Bu Sun Kim

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

[diff] [blame]

1545

],

Bu Sun Kim

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

[diff] [blame]

1546

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

1547

},

1548

],

Bu Sun Kim

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

[diff] [blame]

1549

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

1550

#

1551

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

1552

"iamOwned": True or False,

1553

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

1554

{ # A rule to be applied in a Policy.

1555

"action": "A String", # Required

1556

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

1557

{ # A condition to be met.

1558

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

1559

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

1560

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

1561

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

1562

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

"A String",

],

},

],

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

1568

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

1569

"A String",

1570

],

1571

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

1572

{ # Specifies what kind of log the caller must write

1573

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

1574

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

1575

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

1576

},

1577

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

1578

},

1579

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

1580

#

1581

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

1582

#

1583

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

1584

#

1585

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

1586

#

1587

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

1588

"customFields": [ # Custom fields.

1589

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

1590

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

1591

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

1592

},

1593

],

1594

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

1595

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

1596

},

1597

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

1598

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

1603

"A String",

1604

],

1605

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

1611

#

1612

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

1613

#

1614

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

1615

#

1616

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

1617

#

1618

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

1619

#

1620

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

1621

#

1622

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

1629

1630

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

1635

#

1636

# 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

1645

#

1646

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

1647

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

1648

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

1649

#

1650

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

1651

#

1652

# Example Policy with multiple AuditConfigs:

1653

#

1654

# { "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" ] } ] } ] }

1655

#

1656

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

1657

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

1658

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

1659

#

1660

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

1661

#

1662

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

1663

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

1664

"A String",

1665

],

1666

"ignoreChildExemptions": True or False,

1667

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

1674

},

1675

],

1676

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

1677

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

1678

"bindingId": "A String",

1679

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

1680

#

1681

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

1682

#

1683

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

1684

#

1685

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

1686

#

1687

# Example (Comparison):

1688

#

1689

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

1690

#

1691

# Example (Equality):

1692

#

1693

# 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'"

1698

#

1699

# Example (Data Manipulation):

1700

#

1701

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

1702

#

1703

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

1704

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

1705

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

1706

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

1707

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

1708

},

1709

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

1710

#

1711

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

1712

#

1713

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

1714

#

1715

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

1720

#

1721

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

1722

#

1723

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

1724

#

1725

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

1726

#

1727

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

1732

"A String",

1733

],

1734

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

1735

},

1736

],

1737

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

1738

#

1739

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

1740

"iamOwned": True or False,

1741

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

1742

{ # A rule to be applied in a Policy.

1743

"action": "A String", # Required

1744

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

1745

{ # A condition to be met.

1746

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

1747

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

1748

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

1749

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

1750

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

"A String",

],

},

],

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

1756

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

1757

"A String",

1758

],

1759

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

1760

{ # Specifies what kind of log the caller must write

1761

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

1762

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

1763

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

1764

},

1765

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

1766

},

1767

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

1768

#

1769

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

1770

#

1771

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

1772

#

1773

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

1774

#

1775

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

1776

"customFields": [ # Custom fields.

1777

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

1778

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

1779

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

1780

},

1781

],

1782

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

1783

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

1784

},

1785

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

1786

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

1791

"A String",

1792

],

1793

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

1799

#

1800

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

1801

#

1802

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

1803

#

1804

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

1805

#

1806

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

1807

#

1808

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

1809

#

1810

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

1811

}</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]

1815

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

1816

<pre>Updates the node template of the node group.

1817

1818

Args:

1819

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

1820

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

1821

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

Dan O'Meara

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

[diff] [blame]

1822

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1823

The object takes the form of:

1824

1825

{

Yoshi Automation Bot

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

[diff] [blame]

1826

"nodeTemplate": "A String", # Full or partial URL of the node template resource to be updated for this node group.

1827

}

Bu Sun Kim

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

[diff] [blame]

1828

1829

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.

1830

1831

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.

1832

1833

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

1834

1835

Returns:

1836

An object of the form:

1837

1838

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

1839

#

1840

# Google Compute Engine has three Operation resources:

1841

#

1842

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

1843

#

1844

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

1845

#

1846

# Operations can be global, regional or zonal.

1847

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

1848

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

1849

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

1850

#

1851

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

1852

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

1853

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

1854

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

1855

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

1856

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

1857

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

Bu Sun Kim

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

[diff] [blame]

1858

{

Yoshi Automation Bot

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

[diff] [blame]

1859

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

1860

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

1861

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

Bu Sun Kim

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

[diff] [blame]

1862

},

1863

],

Yoshi Automation Bot

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

[diff] [blame]

1864

},

1865

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

1866

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

1867

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

1868

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1869

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

1870

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

1871

#

1872

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

1873

#

1874

# Example 1: Pack and unpack a message in C++.

1875

#

1876

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

1877

#

1878

# Example 2: Pack and unpack a message in Java.

1879

#

1880

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

1881

#

1882

# Example 3: Pack and unpack a message in Python.

1883

#

1884

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

1885

#

1886

# Example 4: Pack and unpack a message in Go

1887

#

1888

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

1889

#

1890

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

1895

#

1896

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

1897

#

1898

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

1899

#

1900

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

1901

#

1902

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

1903

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

1904

#

1905

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

1906

#

1907

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

1908

#

1909

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

1910

#

1911

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

1912

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

1913

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1914

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

1915

"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