Blame - docs/dyn/compute_beta.reservations.html - platform/external/python/google-api-python-client

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

[diff] [blame]

79

<p class="firstline">Retrieves an aggregated list of reservations.</p>

80

81

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

82

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

83

Dmitry Frenkel

3e17f89

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

[diff] [blame]

84

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

85

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

86

Bu Sun Kim

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

[diff] [blame]

87

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

88

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

89

90

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

Dan O'Meara

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

[diff] [blame]

91

<p class="firstline">Retrieves information about the specified reservation.</p>

Bu Sun Kim

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

[diff] [blame]

92

Dan O'Meara

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

[diff] [blame]

93

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

94

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

95

Dan O'Meara

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

[diff] [blame]

96

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

97

<p class="firstline">Creates a new reservation. For more information, read Reserving zonal resources.</p>

Bu Sun Kim

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

[diff] [blame]

98

Dmitry Frenkel

3e17f89

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

[diff] [blame]

99

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

Dan O'Meara

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

[diff] [blame]

100

<p class="firstline">A list of all the reservations that have been configured for the specified project in specified zone.</p>

Bu Sun Kim

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

[diff] [blame]

101

102

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

103

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

104

Dan O'Meara

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

[diff] [blame]

105

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

106

<p class="firstline">Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations.</p>

Bu Sun Kim

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

[diff] [blame]

107

Dan O'Meara

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

[diff] [blame]

108

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

109

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

110

Dan O'Meara

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

[diff] [blame]

111

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

112

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

113

<h3>Method Details</h3>

114

Dmitry Frenkel

3e17f89

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

[diff] [blame]

115

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

116

<pre>Retrieves an aggregated list of reservations.

117

118

Args:

119

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

Dan O'Meara

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

[diff] [blame]

120

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]

121

Dan O'Meara

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

[diff] [blame]

122

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]

123

Dan O'Meara

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

[diff] [blame]

124

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]

125

Bu Sun Kim

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

[diff] [blame]

126

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]

127

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]

128

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

129

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

130

131

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.

132

133

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

134

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

135

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]

136

137

Returns:

138

An object of the form:

139

140

{ # Contains a list of reservations.

Yoshi Automation Bot

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

[diff] [blame]

141

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

142

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

143

"a_key": { # Name of the scope containing this set of reservations.

144

"reservations": [ # A list of reservations contained in this scope.

145

{ # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for {$api_version}.reservations ==)

146

"commitment": "A String", # [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.

147

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

148

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

149

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

150

"kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations.

151

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

yoshi-code-bot

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

[diff] [blame^]

152

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

Yoshi Automation Bot

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

[diff] [blame]

153

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

154

"specificReservation": { # This reservation type allows to pre allocate specific instance configuration. # Reservation for instances with specific machine shapes.

155

"count": "A String", # Specifies the number of resources that are allocated.

156

"inUseCount": "A String", # [Output Only] Indicates how many instances are in use.

157

"instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # The instance properties for the reservation.

158

"guestAccelerators": [ # Specifies accelerator type and count.

159

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

160

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

161

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

162

},

163

],

164

"localSsds": [ # Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.

165

{

166

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

167

"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.

168

},

169

],

yoshi-code-bot

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

[diff] [blame^]

170

"locationHint": "A String", # An opaque location hint used to place the allocation close to other resources. This field is for use by internal tools that use the public API.

Yoshi Automation Bot

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

[diff] [blame]

171

"machineType": "A String", # Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.

172

"minCpuPlatform": "A String", # Minimum cpu platform the reservation.

Bu Sun Kim

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

[diff] [blame]

173

},

Bu Sun Kim

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

[diff] [blame]

174

},

Yoshi Automation Bot

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

[diff] [blame]

175

"specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.

176

"status": "A String", # [Output Only] The status of the reservation.

177

"zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.

Bu Sun Kim

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

[diff] [blame]

178

},

179

],

Yoshi Automation Bot

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

[diff] [blame]

180

"warning": { # Informational warning which replaces the list of reservations when the list is empty.

181

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

182

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

183

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

184

{

185

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

186

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

187

},

188

],

189

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

190

},

Bu Sun Kim

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

[diff] [blame]

191

},

Yoshi Automation Bot

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

[diff] [blame]

192

},

193

"kind": "compute#reservationAggregatedList", # Type of resource.

194

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

195

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

196

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

197

"A String",

198

],

199

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

200

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

201

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

202

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

203

{

204

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

205

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

206

},

207

],

208

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

209

},

210

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

215

<pre>Retrieves the next page of results.

216

217

Args:

218

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

219

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

220

221

Returns:

Bu Sun Kim

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

[diff] [blame]

222

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]

223

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]

228

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

229

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

233

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

234

<pre>Deletes the specified reservation.

235

236

Args:

237

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

238

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

239

reservation: string, Name of the reservation to delete. (required)

240

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.

241

242

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.

243

244

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

245

246

Returns:

247

An object of the form:

248

249

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

250

#

251

# Google Compute Engine has three Operation resources:

252

#

253

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

254

#

255

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

256

#

257

# Operations can be global, regional or zonal.

258

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

259

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

260

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

261

#

262

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

263

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

264

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

265

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

266

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

267

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

268

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

Bu Sun Kim

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

[diff] [blame]

269

{

Yoshi Automation Bot

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

[diff] [blame]

270

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

271

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

272

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

Bu Sun Kim

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

[diff] [blame]

273

},

274

],

Yoshi Automation Bot

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

[diff] [blame]

275

},

276

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

277

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

278

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

279

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

280

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

281

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

yoshi-code-bot

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

[diff] [blame^]

282

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

283

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

284

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

285

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

286

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

287

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

288

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

289

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

290

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

291

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

292

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

293

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

294

{

295

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

296

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

297

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

298

{

299

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

300

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

301

},

302

],

303

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

304

},

305

],

306

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

307

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

Dan O'Meara

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

[diff] [blame]

312

<pre>Retrieves information about the specified reservation.

Bu Sun Kim

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

[diff] [blame]

313

314

Args:

315

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

316

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

317

reservation: string, Name of the reservation to retrieve. (required)

318

319

Returns:

320

An object of the form:

321

Dan O'Meara

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

[diff] [blame]

322

{ # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for {$api_version}.reservations ==)

Yoshi Automation Bot

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

[diff] [blame]

323

"commitment": "A String", # [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.

324

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

325

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

326

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

327

"kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations.

328

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

yoshi-code-bot

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

[diff] [blame^]

329

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

Yoshi Automation Bot

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

[diff] [blame]

330

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

331

"specificReservation": { # This reservation type allows to pre allocate specific instance configuration. # Reservation for instances with specific machine shapes.

332

"count": "A String", # Specifies the number of resources that are allocated.

333

"inUseCount": "A String", # [Output Only] Indicates how many instances are in use.

334

"instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # The instance properties for the reservation.

335

"guestAccelerators": [ # Specifies accelerator type and count.

336

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

337

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

338

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

339

},

340

],

341

"localSsds": [ # Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.

342

{

343

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

344

"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.

345

},

346

],

yoshi-code-bot

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

[diff] [blame^]

347

"locationHint": "A String", # An opaque location hint used to place the allocation close to other resources. This field is for use by internal tools that use the public API.

Yoshi Automation Bot

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

[diff] [blame]

348

"machineType": "A String", # Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.

349

"minCpuPlatform": "A String", # Minimum cpu platform the reservation.

Bu Sun Kim

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

[diff] [blame]

350

},

Yoshi Automation Bot

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

[diff] [blame]

351

},

352

"specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.

353

"status": "A String", # [Output Only] The status of the reservation.

354

"zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.

355

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

359

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

Bu Sun Kim

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

[diff] [blame]

360

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

361

362

Args:

363

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

364

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

365

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

Dan O'Meara

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

[diff] [blame]

366

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

Bu Sun Kim

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

[diff] [blame]

367

368

Returns:

369

An object of the form:

370

Dan O'Meara

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

[diff] [blame]

371

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

376

#

377

# 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

386

#

387

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

388

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

389

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

390

#

391

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

392

#

393

# Example Policy with multiple AuditConfigs:

394

#

395

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

396

#

397

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

398

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

399

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

Bu Sun Kim

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

[diff] [blame]

400

#

Yoshi Automation Bot

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

[diff] [blame]

401

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

402

#

Yoshi Automation Bot

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

[diff] [blame]

403

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

404

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

405

"A String",

406

],

407

"ignoreChildExemptions": True or False,

408

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

Bu Sun Kim

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

[diff] [blame]

409

},

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.

415

},

416

],

417

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

418

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

419

"bindingId": "A String",

420

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

421

#

422

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

423

#

424

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

425

#

426

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

427

#

428

# Example (Comparison):

429

#

430

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

431

#

432

# Example (Equality):

433

#

434

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

439

#

440

# Example (Data Manipulation):

441

#

442

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

443

#

444

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

445

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

446

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

447

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

448

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

449

},

Yoshi Automation Bot

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

[diff] [blame]

450

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

451

#

452

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

453

#

454

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

455

#

456

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

461

#

462

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

463

#

464

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

465

#

466

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

467

#

468

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

473

"A String",

474

],

475

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

476

},

477

],

478

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

479

#

480

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

481

"iamOwned": True or False,

482

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

483

{ # A rule to be applied in a Policy.

484

"action": "A String", # Required

485

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

486

{ # A condition to be met.

487

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

488

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

489

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

490

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

491

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

"A String",

],

},

],

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

497

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

498

"A String",

499

],

500

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

501

{ # Specifies what kind of log the caller must write

502

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

503

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

504

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

505

},

506

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

507

},

Yoshi Automation Bot

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

[diff] [blame]

508

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

509

#

510

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

511

#

512

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

513

#

514

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

515

#

516

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

517

"customFields": [ # Custom fields.

518

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

519

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

520

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

521

},

Yoshi Automation Bot

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

[diff] [blame]

522

],

523

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

524

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

Bu Sun Kim

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

[diff] [blame]

525

},

Yoshi Automation Bot

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

[diff] [blame]

526

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

527

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

532

"A String",

533

],

534

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

540

#

541

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

542

#

543

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

544

#

545

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

546

#

547

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

548

#

549

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

550

#

551

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

552

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

556

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

557

<pre>Creates a new reservation. For more information, read Reserving zonal resources.

Bu Sun Kim

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

[diff] [blame]

558

559

Args:

560

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

561

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

Dan O'Meara

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

[diff] [blame]

562

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

563

The object takes the form of:

564

Dan O'Meara

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

[diff] [blame]

565

{ # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for {$api_version}.reservations ==)

Bu Sun Kim

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

[diff] [blame]

566

"commitment": "A String", # [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.

567

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

568

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

569

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

570

"kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations.

571

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

yoshi-code-bot

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

[diff] [blame^]

572

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

Bu Sun Kim

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

[diff] [blame]

573

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

574

"specificReservation": { # This reservation type allows to pre allocate specific instance configuration. # Reservation for instances with specific machine shapes.

575

"count": "A String", # Specifies the number of resources that are allocated.

576

"inUseCount": "A String", # [Output Only] Indicates how many instances are in use.

Bu Sun Kim

d059ad8

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

[diff] [blame]

577

"instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # The instance properties for the reservation.

Bu Sun Kim

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

[diff] [blame]

578

"guestAccelerators": [ # Specifies accelerator type and count.

Bu Sun Kim

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

[diff] [blame]

579

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

Bu Sun Kim

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

[diff] [blame]

580

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

581

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

582

},

583

],

Bu Sun Kim

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

[diff] [blame]

584

"localSsds": [ # Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.

Bu Sun Kim

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

[diff] [blame]

585

{

Bu Sun Kim

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

[diff] [blame]

586

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

587

"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.

Bu Sun Kim

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

[diff] [blame]

588

},

589

],

yoshi-code-bot

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

[diff] [blame^]

590

"locationHint": "A String", # An opaque location hint used to place the allocation close to other resources. This field is for use by internal tools that use the public API.

Bu Sun Kim

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

[diff] [blame]

591

"machineType": "A String", # Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.

592

"minCpuPlatform": "A String", # Minimum cpu platform the reservation.

Bu Sun Kim

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

[diff] [blame]

593

},

Bu Sun Kim

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

[diff] [blame]

594

},

Bu Sun Kim

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

[diff] [blame]

595

"specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.

596

"status": "A String", # [Output Only] The status of the reservation.

597

"zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.

Bu Sun Kim

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

[diff] [blame]

598

}

599

600

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.

601

602

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.

603

604

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

605

606

Returns:

607

An object of the form:

608

609

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

610

#

611

# Google Compute Engine has three Operation resources:

612

#

613

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

614

#

615

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

616

#

617

# Operations can be global, regional or zonal.

618

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

619

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

620

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

621

#

622

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

623

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

624

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

625

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

626

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

627

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

628

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

Bu Sun Kim

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

[diff] [blame]

629

{

Yoshi Automation Bot

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

[diff] [blame]

630

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

631

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

632

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

Bu Sun Kim

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

[diff] [blame]

633

},

634

],

Yoshi Automation Bot

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

[diff] [blame]

635

},

636

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

637

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

638

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

639

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

640

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

641

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

yoshi-code-bot

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

[diff] [blame^]

642

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

643

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

644

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

645

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

646

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

647

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

648

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

649

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

650

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

651

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

652

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

653

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

654

{

655

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

656

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

657

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

658

{

659

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

660

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

661

},

662

],

663

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

664

},

665

],

666

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

667

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dmitry Frenkel

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

[diff] [blame]

671

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

Dan O'Meara

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

[diff] [blame]

672

<pre>A list of all the reservations that have been configured for the specified project in specified zone.

Bu Sun Kim

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

[diff] [blame]

673

674

Args:

675

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

676

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

Dan O'Meara

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

[diff] [blame]

677

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]

678

Dan O'Meara

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

[diff] [blame]

679

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]

680

Dan O'Meara

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

[diff] [blame]

681

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]

682

Bu Sun Kim

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

[diff] [blame]

683

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

684

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

685

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

686

687

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.

688

689

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

690

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

691

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]

692

693

Returns:

694

An object of the form:

695

696

{

Yoshi Automation Bot

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

[diff] [blame]

697

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

698

"items": [ # [Output Only] A list of Allocation resources.

699

{ # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for {$api_version}.reservations ==)

700

"commitment": "A String", # [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.

701

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

702

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

703

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

704

"kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations.

705

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

yoshi-code-bot

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

[diff] [blame^]

706

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

Yoshi Automation Bot

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

[diff] [blame]

707

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

708

"specificReservation": { # This reservation type allows to pre allocate specific instance configuration. # Reservation for instances with specific machine shapes.

709

"count": "A String", # Specifies the number of resources that are allocated.

710

"inUseCount": "A String", # [Output Only] Indicates how many instances are in use.

711

"instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # The instance properties for the reservation.

712

"guestAccelerators": [ # Specifies accelerator type and count.

713

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

714

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

715

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

716

},

717

],

718

"localSsds": [ # Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.

719

{

720

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

721

"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.

722

},

723

],

yoshi-code-bot

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

[diff] [blame^]

724

"locationHint": "A String", # An opaque location hint used to place the allocation close to other resources. This field is for use by internal tools that use the public API.

Yoshi Automation Bot

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

[diff] [blame]

725

"machineType": "A String", # Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.

726

"minCpuPlatform": "A String", # Minimum cpu platform the reservation.

Bu Sun Kim

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

[diff] [blame]

727

},

Yoshi Automation Bot

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

[diff] [blame]

728

},

729

"specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.

730

"status": "A String", # [Output Only] The status of the reservation.

731

"zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.

732

},

733

],

734

"kind": "compute#reservationList", # [Output Only] Type of resource.Always compute#reservationsList for listsof reservations

735

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

736

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

737

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

738

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

739

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

740

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

741

{

742

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

743

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

Bu Sun Kim

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

[diff] [blame]

744

},

745

],

Yoshi Automation Bot

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

[diff] [blame]

746

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

747

},

748

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

753

<pre>Retrieves the next page of results.

754

755

Args:

756

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

757

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

758

759

Returns:

Bu Sun Kim

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

[diff] [blame]

760

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]

761

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]

766

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

767

<pre>Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations.

Bu Sun Kim

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

[diff] [blame]

768

769

Args:

770

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

771

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

772

reservation: string, Name of the reservation to update. (required)

Dan O'Meara

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

[diff] [blame]

773

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

774

The object takes the form of:

775

776

{

Yoshi Automation Bot

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

[diff] [blame]

777

"specificSkuCount": "A String", # Number of allocated resources can be resized with minimum = 1 and maximum = 1000.

778

}

Bu Sun Kim

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

[diff] [blame]

779

780

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.

781

782

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.

783

784

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

785

786

Returns:

787

An object of the form:

788

789

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

790

#

791

# Google Compute Engine has three Operation resources:

792

#

793

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

794

#

795

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

796

#

797

# Operations can be global, regional or zonal.

798

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

799

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

800

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

801

#

802

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

803

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

804

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

805

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

806

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

807

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

808

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

Bu Sun Kim

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

[diff] [blame]

809

{

Yoshi Automation Bot

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

[diff] [blame]

810

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

811

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

812

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

Bu Sun Kim

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

[diff] [blame]

813

},

814

],

Yoshi Automation Bot

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

[diff] [blame]

815

},

816

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

817

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

818

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

819

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

820

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

821

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

yoshi-code-bot

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

[diff] [blame^]

822

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

823

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

824

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

825

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

826

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

827

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

828

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

829

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

830

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

831

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

832

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

833

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

834

{

835

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

836

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

837

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

838

{

839

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

840

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

841

},

842

],

843

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

844

},

845

],

846

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

847

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

851

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

Bu Sun Kim

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

[diff] [blame]

852

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

853

854

Args:

855

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

856

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

857

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

Dan O'Meara

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

[diff] [blame]

858

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

859

The object takes the form of:

860

861

{

Yoshi Automation Bot

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

[diff] [blame]

862

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

863

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

864

"bindingId": "A String",

865

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

866

#

Yoshi Automation Bot

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

[diff] [blame]

867

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

868

#

Yoshi Automation Bot

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

[diff] [blame]

869

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

870

#

871

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

872

#

873

# Example (Comparison):

874

#

875

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

876

#

877

# Example (Equality):

878

#

879

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

884

#

885

# Example (Data Manipulation):

886

#

887

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

888

#

889

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

890

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

891

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

892

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

893

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

894

},

895

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

896

#

897

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

898

#

899

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

900

#

901

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

906

#

907

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

908

#

909

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

910

#

911

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

912

#

913

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

918

"A String",

919

],

920

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

921

},

Yoshi Automation Bot

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

[diff] [blame]

922

],

923

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

924

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

925

#

926

#

927

#

Dan O'Meara

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

[diff] [blame]

928

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

929

#

Bu Sun Kim

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

[diff] [blame]

930

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

931

#

Dan O'Meara

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

[diff] [blame]

932

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

933

#

Bu Sun Kim

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

[diff] [blame]

934

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

935

#

Dan O'Meara

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

[diff] [blame]

936

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

937

#

Bu Sun Kim

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

[diff] [blame]

938

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

939

#

Dan O'Meara

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

[diff] [blame]

940

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

941

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

Bu Sun Kim

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

[diff] [blame]

942

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

943

#

944

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

945

#

946

# Example Policy with multiple AuditConfigs:

947

#

Bu Sun Kim

d059ad8

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

[diff] [blame]

948

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

949

#

Dan O'Meara

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

[diff] [blame]

950

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

951

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

Bu Sun Kim

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

[diff] [blame]

952

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

953

#

Bu Sun Kim

d059ad8

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

[diff] [blame]

954

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

955

#

Bu Sun Kim

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

[diff] [blame]

956

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

957

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

958

"A String",

Bu Sun Kim

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

[diff] [blame]

959

],

Bu Sun Kim

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

[diff] [blame]

960

"ignoreChildExemptions": True or False,

961

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

Bu Sun Kim

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

[diff] [blame]

962

},

963

],

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]

968

},

969

],

Bu Sun Kim

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

[diff] [blame]

970

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

971

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

Yoshi Automation Bot

0d561ef

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

[diff] [blame]

972

"bindingId": "A String",

Bu Sun Kim

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

[diff] [blame]

973

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

974

#

975

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

976

#

977

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

978

#

979

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

980

#

981

# Example (Comparison):

982

#

983

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

984

#

985

# Example (Equality):

986

#

987

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

992

#

993

# Example (Data Manipulation):

994

#

995

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

996

#

997

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

998

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

999

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

1000

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

1001

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

1002

},

1003

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

1004

#

1005

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

1006

#

1007

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

1008

#

Dan O'Meara

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

[diff] [blame]

1009

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

1014

#

1015

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

1016

#

Dan O'Meara

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

[diff] [blame]

1017

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

1018

#

1019

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

1020

#

1021

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

1022

#

Bu Sun Kim

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

[diff] [blame]

1023

#

1024

#

1025

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

1026

"A String",

Bu Sun Kim

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

[diff] [blame]

1027

],

Bu Sun Kim

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

[diff] [blame]

1028

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

1029

},

1030

],

Bu Sun Kim

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

[diff] [blame]

1031

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

1032

#

1033

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

1034

"iamOwned": True or False,

1035

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

1036

{ # A rule to be applied in a Policy.

1037

"action": "A String", # Required

1038

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

1039

{ # A condition to be met.

1040

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

1041

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

1042

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

1043

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

1044

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

"A String",

],

},

],

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

1050

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

1051

"A String",

1052

],

1053

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

1054

{ # Specifies what kind of log the caller must write

1055

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

1056

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

1057

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

1058

},

1059

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

1060

},

1061

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

1062

#

1063

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

1064

#

1065

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

1066

#

1067

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

1068

#

1069

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

1070

"customFields": [ # Custom fields.

1071

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

1072

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

1073

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

1074

},

1075

],

1076

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

1077

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

1078

},

1079

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

1080

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

1085

"A String",

1086

],

1087

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

1093

#

1094

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

1095

#

1096

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

1097

#

1098

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

1099

#

1100

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

1101

#

1102

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

1103

#

1104

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

1111

1112

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

1117

#

1118

# 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

1127

#

1128

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

1129

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

1130

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

1131

#

1132

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

1133

#

1134

# Example Policy with multiple AuditConfigs:

1135

#

1136

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

1137

#

1138

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

1139

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

1140

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

1141

#

1142

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

1143

#

1144

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

1145

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

1146

"A String",

1147

],

1148

"ignoreChildExemptions": True or False,

1149

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

1156

},

1157

],

1158

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

1159

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

1160

"bindingId": "A String",

1161

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

1162

#

1163

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

1164

#

1165

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

1166

#

1167

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

1168

#

1169

# Example (Comparison):

1170

#

1171

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

1172

#

1173

# Example (Equality):

1174

#

1175

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

1180

#

1181

# Example (Data Manipulation):

1182

#

1183

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

1184

#

1185

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

1186

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

1187

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

1188

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

1189

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

1190

},

1191

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

1192

#

1193

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

1194

#

1195

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

1196

#

1197

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

1202

#

1203

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

1204

#

1205

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

1206

#

1207

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

1208

#

1209

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

1214

"A String",

1215

],

1216

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

1217

},

1218

],

1219

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

1220

#

1221

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

1222

"iamOwned": True or False,

1223

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

1224

{ # A rule to be applied in a Policy.

1225

"action": "A String", # Required

1226

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

1227

{ # A condition to be met.

1228

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

1229

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

1230

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

1231

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

1232

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

"A String",

],

},

],

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

1238

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

1239

"A String",

1240

],

1241

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

1242

{ # Specifies what kind of log the caller must write

1243

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

1244

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

1245

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

1246

},

1247

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

1248

},

1249

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

1250

#

1251

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

1252

#

1253

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

1254

#

1255

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

1256

#

1257

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

1258

"customFields": [ # Custom fields.

1259

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

1260

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

1261

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

1262

},

1263

],

1264

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

1265

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

1266

},

1267

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

1268

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

1273

"A String",

1274

],

1275

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

1281

#

1282

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

1283

#

1284

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

1285

#

1286

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

1287

#

1288

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

1289

#

1290

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

1291

#

1292

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

1293

}</pre>

Bu Sun Kim