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

<code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None)</a></code></p>

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

84

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

85

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

86

87

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

88

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

89

90

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

91

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

92

93

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

94

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

95

96

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

97

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

98

99

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

100

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

101

102

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

103

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

104

105

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

106

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

107

108

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

109

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

110

<h3>Method Details</h3>

111

112

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

113

<pre>Retrieves an aggregated list of reservations.

114

115

Args:

116

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

117

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

118

119

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

120

121

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.

122

123

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

124

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.

125

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

126

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

127

128

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.

129

130

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

131

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.

132

133

Returns:

134

An object of the form:

135

136

{ # Contains a list of reservations.

137

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

138

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

139

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

140

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

141

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

142

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

143

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

144

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

145

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

146

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

147

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

148

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

149

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

150

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

151

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

152

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

Bu Sun Kim

6502091

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

[diff] [blame]

153

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

154

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

155

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

156

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

157

},

158

],

159

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

160

{

161

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

162

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

163

},

164

],

165

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

Bu Sun Kim

d059ad8

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

[diff] [blame]

166

"maintenanceInterval": "A String", # Specifies whether this VM may be a stable fleet VM. Setting this to "Periodic" designates this VM as a Stable Fleet VM.

167

#

168

# See go/stable-fleet-ug for more details.

Bu Sun Kim

6502091

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

[diff] [blame]

169

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

170

},

171

},

172

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

173

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

174

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

175

},

176

],

177

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

178

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

179

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

180

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

181

{

182

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

183

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

184

},

185

],

186

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

},

},

},

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

191

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

192

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

193

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

194

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

195

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

196

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

197

{

198

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

199

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

200

},

201

],

202

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

},

}</pre>

</div>

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

209

<pre>Retrieves the next page of results.

210

211

Args:

212

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

213

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

214

215

Returns:

216

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

217

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

</pre>

</div>

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

223

<pre>Deletes the specified reservation.

224

225

Args:

226

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

227

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

228

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

229

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.

230

231

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.

232

233

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

234

235

Returns:

236

An object of the form:

237

238

{ # Represents an Operation resource.

239

#

240

# Google Compute Engine has three Operation resources:

241

#

242

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

243

#

244

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

245

#

246

# Operations can be global, regional or zonal.

247

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

248

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

249

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

250

#

251

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

252

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

253

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

254

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

255

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

256

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

257

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

258

{

259

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

260

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

261

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

},

],

},

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

266

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

267

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

268

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

269

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

270

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

271

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

272

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

273

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

274

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

275

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

276

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

277

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

278

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

279

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

280

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

281

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

282

{

283

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

284

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

285

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

286

{

287

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

288

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

289

},

290

],

291

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

292

},

293

],

294

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

}</pre>

</div>

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

300

<pre>Retrieves information about the specified reservation.

301

302

Args:

303

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

304

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

305

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

306

307

Returns:

308

An object of the form:

309

310

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

311

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

312

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

313

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

314

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

315

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

316

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

317

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

318

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

319

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

320

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

321

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

Bu Sun Kim

6502091

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

[diff] [blame]

322

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

323

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

324

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

325

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

326

},

327

],

328

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

329

{

330

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

331

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

332

},

333

],

334

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

Bu Sun Kim

d059ad8

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

[diff] [blame]

335

"maintenanceInterval": "A String", # Specifies whether this VM may be a stable fleet VM. Setting this to "Periodic" designates this VM as a Stable Fleet VM.

336

#

337

# See go/stable-fleet-ug for more details.

Bu Sun Kim

6502091

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

[diff] [blame]

338

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

339

},

340

},

341

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

342

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

343

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

}</pre>

</div>

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

349

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

350

351

Args:

352

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

353

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

354

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

355

356

Returns:

357

An object of the form:

358

359

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

364

#

365

# 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

374

#

375

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

376

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

377

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

378

#

379

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

380

#

381

# Example Policy with multiple AuditConfigs:

382

#

Bu Sun Kim

d059ad8

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

[diff] [blame]

383

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

6502091

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

[diff] [blame]

384

#

385

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

386

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

387

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

388

#

Bu Sun Kim

d059ad8

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

[diff] [blame]

389

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

Bu Sun Kim

6502091

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

[diff] [blame]

390

#

391

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

392

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

393

"A String",

394

],

395

"ignoreChildExemptions": True or False,

396

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

403

},

404

],

405

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

406

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

407

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

408

#

409

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

410

#

411

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

412

#

413

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

414

#

415

# Example (Comparison):

416

#

417

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

418

#

419

# Example (Equality):

420

#

421

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

426

#

427

# Example (Data Manipulation):

428

#

429

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

430

#

431

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

432

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

433

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

434

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

435

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

436

},

437

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

438

#

439

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

440

#

441

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

442

#

443

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

448

#

449

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

450

#

451

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

452

#

453

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

454

#

455

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

460

"A String",

461

],

462

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

463

},

464

],

465

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

466

#

467

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

468

"iamOwned": True or False,

469

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

470

{ # A rule to be applied in a Policy.

471

"action": "A String", # Required

472

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

473

{ # A condition to be met.

474

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

475

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

476

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

477

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

478

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

"A String",

],

},

],

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

484

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

485

"A String",

486

],

487

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

488

{ # Specifies what kind of log the caller must write

489

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

490

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

491

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

492

},

493

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

494

},

495

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

496

#

497

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

498

#

499

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

500

#

501

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

502

#

503

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

504

"customFields": [ # Custom fields.

505

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

506

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

507

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

508

},

509

],

510

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

511

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

512

},

513

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

514

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

519

"A String",

520

],

521

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

527

#

528

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

529

#

530

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

531

#

532

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

533

#

534

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

535

#

536

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

537

#

538

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

}</pre>

</div>

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

544

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

545

546

Args:

547

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

548

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

549

body: object, The request body.

550

The object takes the form of:

551

552

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

553

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

554

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

555

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

556

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

557

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

558

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

559

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

560

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

561

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

562

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

563

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

Bu Sun Kim

6502091

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

[diff] [blame]

564

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

565

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

566

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

567

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

568

},

569

],

570

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

571

{

572

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

573

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

574

},

575

],

576

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

Bu Sun Kim

d059ad8

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

[diff] [blame]

577

"maintenanceInterval": "A String", # Specifies whether this VM may be a stable fleet VM. Setting this to "Periodic" designates this VM as a Stable Fleet VM.

578

#

579

# See go/stable-fleet-ug for more details.

Bu Sun Kim

6502091

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

[diff] [blame]

580

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

581

},

582

},

583

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

584

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

585

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

586

}

587

588

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.

589

590

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.

591

592

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

593

594

Returns:

595

An object of the form:

596

597

{ # Represents an Operation resource.

598

#

599

# Google Compute Engine has three Operation resources:

600

#

601

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

602

#

603

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

604

#

605

# Operations can be global, regional or zonal.

606

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

607

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

608

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

609

#

610

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

611

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

612

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

613

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

614

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

615

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

616

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

617

{

618

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

619

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

620

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

},

],

},

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

625

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

626

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

627

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

628

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

629

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

630

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

631

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

632

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

633

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

634

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

635

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

636

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

637

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

638

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

639

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

640

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

641

{

642

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

643

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

644

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

645

{

646

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

647

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

648

},

649

],

650

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

651

},

652

],

653

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

}</pre>

</div>

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

659

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

660

661

Args:

662

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

663

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

664

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

665

666

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

667

668

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.

669

670

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

671

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

672

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

673

674

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.

675

676

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

677

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.

678

679

Returns:

680

An object of the form:

681

682

{

683

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

684

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

685

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

686

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

687

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

688

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

689

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

690

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

691

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

692

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

693

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

694

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

695

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

696

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

Bu Sun Kim

6502091

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

[diff] [blame]

697

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

698

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

699

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

700

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

701

},

702

],

703

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

704

{

705

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

706

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

707

},

708

],

709

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

Bu Sun Kim

d059ad8

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

[diff] [blame]

710

"maintenanceInterval": "A String", # Specifies whether this VM may be a stable fleet VM. Setting this to "Periodic" designates this VM as a Stable Fleet VM.

711

#

712

# See go/stable-fleet-ug for more details.

Bu Sun Kim

6502091

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

[diff] [blame]

713

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

714

},

715

},

716

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

717

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

718

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

719

},

720

],

721

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

722

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

723

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

724

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

725

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

726

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

727

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

728

{

729

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

730

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

731

},

732

],

733

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

},

}</pre>

</div>

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

740

<pre>Retrieves the next page of results.

741

742

Args:

743

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

744

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

745

746

Returns:

747

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

748

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

</pre>

</div>

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

754

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

755

756

Args:

757

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

758

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

759

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

760

body: object, The request body.

761

The object takes the form of:

762

763

{

764

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

765

}

766

767

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.

768

769

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.

770

771

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

772

773

Returns:

774

An object of the form:

775

776

{ # Represents an Operation resource.

777

#

778

# Google Compute Engine has three Operation resources:

779

#

780

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

781

#

782

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

783

#

784

# Operations can be global, regional or zonal.

785

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

786

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

787

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

788

#

789

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

790

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

791

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

792

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

793

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

794

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

795

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

796

{

797

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

798

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

799

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

},

],

},

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

804

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

805

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

806

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

807

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

808

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

809

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

810

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

811

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

812

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

813

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

814

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

815

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

816

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

817

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

818

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

819

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

820

{

821

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

822

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

823

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

824

{

825

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

826

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

827

},

828

],

829

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

830

},

831

],

832

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

}</pre>

</div>

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

838

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

839

840

Args:

841

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

842

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

843

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

844

body: object, The request body.

845

The object takes the form of:

846

847

{

848

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

849

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

850

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

851

#

852

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

853

#

854

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

855

#

856

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

857

#

858

# Example (Comparison):

859

#

860

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

861

#

862

# Example (Equality):

863

#

864

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

869

#

870

# Example (Data Manipulation):

871

#

872

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

873

#

874

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

875

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

876

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

877

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

878

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

879

},

880

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

881

#

882

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

883

#

884

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

885

#

886

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

891

#

892

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

893

#

894

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

895

#

896

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

897

#

898

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

903

"A String",

904

],

905

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

906

},

907

],

908

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

909

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

#

#

#

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

914

#

915

# 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

924

#

925

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

926

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

927

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

928

#

929

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

930

#

931

# Example Policy with multiple AuditConfigs:

932

#

Bu Sun Kim

d059ad8

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

[diff] [blame]

933

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

6502091

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

[diff] [blame]

934

#

935

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

936

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

937

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

938

#

Bu Sun Kim

d059ad8

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

[diff] [blame]

939

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

Bu Sun Kim

6502091

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

[diff] [blame]

940

#

941

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

942

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

943

"A String",

944

],

945

"ignoreChildExemptions": True or False,

946

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

953

},

954

],

955

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

956

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

957

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

958

#

959

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

960

#

961

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

962

#

963

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

964

#

965

# Example (Comparison):

966

#

967

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

968

#

969

# Example (Equality):

970

#

971

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

976

#

977

# Example (Data Manipulation):

978

#

979

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

980

#

981

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

982

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

983

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

984

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

985

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

986

},

987

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

988

#

989

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

990

#

991

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

992

#

993

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

998

#

999

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

1000

#

1001

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

1002

#

1003

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

1004

#

1005

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

1010

"A String",

1011

],

1012

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

1013

},

1014

],

1015

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

1016

#

1017

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

1018

"iamOwned": True or False,

1019

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

1020

{ # A rule to be applied in a Policy.

1021

"action": "A String", # Required

1022

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

1023

{ # A condition to be met.

1024

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

1025

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

1026

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

1027

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

1028

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

"A String",

],

},

],

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

1034

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

1035

"A String",

1036

],

1037

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

1038

{ # Specifies what kind of log the caller must write

1039

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

1040

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

1041

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

1042

},

1043

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

1044

},

1045

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

1046

#

1047

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

1048

#

1049

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

1050

#

1051

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

1052

#

1053

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

1054

"customFields": [ # Custom fields.

1055

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

1056

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

1057

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

1058

},

1059

],

1060

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

1061

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

1062

},

1063

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

1064

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

1069

"A String",

1070

],

1071

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

1077

#

1078

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

1079

#

1080

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

1081

#

1082

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

1083

#

1084

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

1085

#

1086

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

1087

#

1088

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

},

}

Returns:

An object of the form:

1095

1096

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

1101

#

1102

# 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

1111

#

1112

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

1113

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

1114

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

1115

#

1116

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

1117

#

1118

# Example Policy with multiple AuditConfigs:

1119

#

Bu Sun Kim

d059ad8

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

[diff] [blame]

1120

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

6502091

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

[diff] [blame]

1121

#

1122

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

1123

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

1124

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

1125

#

Bu Sun Kim

d059ad8

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

[diff] [blame]

1126

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

Bu Sun Kim

6502091

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

[diff] [blame]

1127

#

1128

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

1129

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

1130

"A String",

1131

],

1132

"ignoreChildExemptions": True or False,

1133

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

1140

},

1141

],

1142

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

1143

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

1144

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

1145

#

1146

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

1147

#

1148

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

1149

#

1150

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

1151

#

1152

# Example (Comparison):

1153

#

1154

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

1155

#

1156

# Example (Equality):

1157

#

1158

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

1163

#

1164

# Example (Data Manipulation):

1165

#

1166

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

1167

#

1168

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

1169

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

1170

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

1171

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

1172

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

1173

},

1174

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

1175

#

1176

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

1177

#

1178

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

1179

#

1180

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

1185

#

1186

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

1187

#

1188

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

1189

#

1190

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

1191

#

1192

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

1197

"A String",

1198

],

1199

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

1200

},

1201

],

1202

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

1203

#

1204

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

1205

"iamOwned": True or False,

1206

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

1207

{ # A rule to be applied in a Policy.

1208

"action": "A String", # Required

1209

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

1210

{ # A condition to be met.

1211

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

1212

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

1213

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

1214

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

1215

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

"A String",

],

},

],

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

1221

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

1222

"A String",

1223

],

1224

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

1225

{ # Specifies what kind of log the caller must write

1226

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

1227

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

1228

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

1229

},

1230

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

1231

},

1232

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

1233

#

1234

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

1235

#

1236

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

1237

#

1238

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

1239

#

1240

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

1241

"customFields": [ # Custom fields.

1242

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

1243

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

1244

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

1245

},

1246

],

1247

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

1248

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

1249

},

1250

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

1251

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

1256

"A String",

1257

],

1258

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

1264

#

1265

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

1266

#

1267

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

1268

#

1269

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

1270

#

1271

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

1272

#

1273

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

1274

#

1275

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

}</pre>

</div>

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

1281

<pre>Returns permissions that a caller has on the specified resource.

1282

1283