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

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

[diff] [blame]

83

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

84

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

Dan O'Meara

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

[diff] [blame]

85

<p class="firstline">Returns the specified License resource. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.</p>

Bu Sun Kim

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

[diff] [blame]

86

Dan O'Meara

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

[diff] [blame]

87

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

88

<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.</p>

Bu Sun Kim

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

[diff] [blame]

89

Dan O'Meara

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

[diff] [blame]

90

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

91

<p class="firstline">Create a License resource in the specified project. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.</p>

Bu Sun Kim

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

[diff] [blame]

92

Dmitry Frenkel

3e17f89

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

[diff] [blame]

93

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

Dan O'Meara

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

[diff] [blame]

94

<p class="firstline">Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.</p>

Bu Sun Kim

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

[diff] [blame]

95

96

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

97

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

98

Dan O'Meara

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

[diff] [blame]

99

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

100

<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.</p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

101

<h3>Method Details</h3>

102

Dmitry Frenkel

3e17f89

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

[diff] [blame]

103

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

104

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

108

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

Dan O'Meara

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

[diff] [blame]

109

<pre>Deletes the specified license. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.

Bu Sun Kim

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

[diff] [blame]

110

111

Args:

112

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

113

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

114

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.

115

116

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.

117

118

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

119

120

Returns:

121

An object of the form:

122

123

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame^]

124

#

125

# Google Compute Engine has three Operation resources:

126

#

127

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

128

#

129

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

130

#

131

# Operations can be global, regional or zonal.

132

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

133

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

134

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

135

#

136

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

137

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

138

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

139

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

140

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

141

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

142

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

Bu Sun Kim

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

[diff] [blame]

143

{

Yoshi Automation Bot

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

[diff] [blame^]

144

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

145

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

146

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

Bu Sun Kim

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

[diff] [blame]

147

},

148

],

Yoshi Automation Bot

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

[diff] [blame^]

149

},

150

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

151

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

152

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

153

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

154

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

155

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

156

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

157

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

158

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

159

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

160

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

161

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

162

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

163

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

164

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

165

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

166

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

167

{

168

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

169

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

170

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

171

{

172

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

173

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

174

},

175

],

176

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

177

},

178

],

179

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

180

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

184

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

Dan O'Meara

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

[diff] [blame]

185

<pre>Returns the specified License resource. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

186

187

Args:

188

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

189

license: string, Name of the License resource to return. (required)

190

191

Returns:

192

An object of the form:

193

Dan O'Meara

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

[diff] [blame]

194

{ # Represents a License resource.

Yoshi Automation Bot

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

[diff] [blame^]

195

#

196

# A License represents billing and aggregate usage data for public and marketplace images. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. (== resource_for {$api_version}.licenses ==)

197

"chargesUseFee": True or False, # [Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee.

198

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

199

"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.

200

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

201

"kind": "compute#license", # [Output Only] Type of resource. Always compute#license for licenses.

202

"licenseCode": "A String", # [Output Only] The unique code used to attach this license to images, snapshots, and disks.

203

"name": "A String", # Name of the resource. The name must be 1-63 characters long and comply with RFC1035.

204

"resourceRequirements": {

205

"minGuestCpuCount": 42, # Minimum number of guest cpus required to use the Instance. Enforced at Instance creation and Instance start.

206

"minMemoryMb": 42, # Minimum memory required to use the Instance. Enforced at Instance creation and Instance start.

207

},

208

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

209

"transferable": True or False, # If false, licenses will not be copied from the source resource when creating an image from a disk, disk from snapshot, or snapshot from disk.

210

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

214

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

215

<pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.

Bu Sun Kim

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

[diff] [blame]

216

217

Args:

218

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

219

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

Dan O'Meara

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

[diff] [blame]

220

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

Bu Sun Kim

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

[diff] [blame]

221

222

Returns:

223

An object of the form:

224

Dan O'Meara

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

[diff] [blame]

225

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

Yoshi Automation Bot

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

[diff] [blame^]

#

#

#

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

230

#

231

# 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

240

#

241

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

242

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

243

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

244

#

245

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

246

#

247

# Example Policy with multiple AuditConfigs:

248

#

249

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

250

#

251

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

252

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

253

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

Bu Sun Kim

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

[diff] [blame]

254

#

Yoshi Automation Bot

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

[diff] [blame^]

255

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

Bu Sun Kim

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

[diff] [blame]

256

#

Yoshi Automation Bot

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

[diff] [blame^]

257

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

258

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

259

"A String",

260

],

261

"ignoreChildExemptions": True or False,

262

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

Bu Sun Kim

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

[diff] [blame]

263

},

Yoshi Automation Bot

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

[diff] [blame^]

],

"exemptedMembers": [

"A String",

],

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

269

},

270

],

271

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

272

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

273

"bindingId": "A String",

274

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

275

#

276

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

277

#

278

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

279

#

280

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

281

#

282

# Example (Comparison):

283

#

284

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

285

#

286

# Example (Equality):

287

#

288

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

293

#

294

# Example (Data Manipulation):

295

#

296

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

297

#

298

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

299

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

300

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

301

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

302

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

Bu Sun Kim

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

[diff] [blame]

303

},

Yoshi Automation Bot

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

[diff] [blame^]

304

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

305

#

306

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

307

#

308

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

309

#

310

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

315

#

316

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

317

#

318

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

319

#

320

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

321

#

322

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

327

"A String",

328

],

329

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

330

},

331

],

332

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

333

#

334

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

335

"iamOwned": True or False,

336

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

337

{ # A rule to be applied in a Policy.

338

"action": "A String", # Required

339

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

340

{ # A condition to be met.

341

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

342

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

343

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

344

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

345

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

"A String",

],

},

],

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

351

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

352

"A String",

353

],

354

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

355

{ # Specifies what kind of log the caller must write

356

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

357

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

358

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

359

},

360

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

Bu Sun Kim

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

[diff] [blame]

361

},

Yoshi Automation Bot

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

[diff] [blame^]

362

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

363

#

364

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

365

#

366

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

367

#

368

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

369

#

370

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

371

"customFields": [ # Custom fields.

372

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

373

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

374

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

Bu Sun Kim

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

[diff] [blame]

375

},

Yoshi Automation Bot

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

[diff] [blame^]

376

],

377

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

378

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

Bu Sun Kim

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

[diff] [blame]

379

},

Yoshi Automation Bot

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

[diff] [blame^]

380

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

381

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

386

"A String",

387

],

388

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

394

#

395

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

396

#

397

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

398

#

399

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

400

#

401

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

402

#

403

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

404

#

405

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

406

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

410

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

411

<pre>Create a License resource in the specified project. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.

Bu Sun Kim

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

[diff] [blame]

412

413

Args:

414

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

Dan O'Meara

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

[diff] [blame]

415

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

416

The object takes the form of:

417

Dan O'Meara

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

[diff] [blame]

418

{ # Represents a License resource.

Bu Sun Kim

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

[diff] [blame]

419

#

420

# A License represents billing and aggregate usage data for public and marketplace images. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. (== resource_for {$api_version}.licenses ==)

421

"chargesUseFee": True or False, # [Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee.

422

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

423

"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.

424

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

425

"kind": "compute#license", # [Output Only] Type of resource. Always compute#license for licenses.

426

"licenseCode": "A String", # [Output Only] The unique code used to attach this license to images, snapshots, and disks.

427

"name": "A String", # Name of the resource. The name must be 1-63 characters long and comply with RFC1035.

428

"resourceRequirements": {

429

"minGuestCpuCount": 42, # Minimum number of guest cpus required to use the Instance. Enforced at Instance creation and Instance start.

430

"minMemoryMb": 42, # Minimum memory required to use the Instance. Enforced at Instance creation and Instance start.

431

},

432

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

433

"transferable": True or False, # If false, licenses will not be copied from the source resource when creating an image from a disk, disk from snapshot, or snapshot from disk.

434

}

Bu Sun Kim

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

[diff] [blame]

435

436

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.

437

438

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.

439

440

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

441

442

Returns:

443

An object of the form:

444

445

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame^]

446

#

447

# Google Compute Engine has three Operation resources:

448

#

449

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

450

#

451

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

452

#

453

# Operations can be global, regional or zonal.

454

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

455

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

456

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

457

#

458

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

459

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

460

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

461

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

462

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

463

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

464

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

Bu Sun Kim

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

[diff] [blame]

465

{

Yoshi Automation Bot

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

[diff] [blame^]

466

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

467

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

468

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

Bu Sun Kim

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

[diff] [blame]

469

},

470

],

Yoshi Automation Bot

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

[diff] [blame^]

471

},

472

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

473

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

474

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

475

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

476

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

477

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

478

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

479

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

480

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

481

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

482

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

483

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

484

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

485

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

486

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

487

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

488

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

489

{

490

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

491

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

492

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

493

{

494

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

495

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

496

},

497

],

498

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

499

},

500

],

501

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

502

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dmitry Frenkel

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

[diff] [blame]

506

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

Dan O'Meara

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

[diff] [blame]

507

<pre>Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.

Bu Sun Kim

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

[diff] [blame]

508

509

Args:

510

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

Dan O'Meara

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

[diff] [blame]

511

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

Bu Sun Kim

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

[diff] [blame]

512

Dan O'Meara

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

[diff] [blame]

513

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

Bu Sun Kim

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

[diff] [blame]

514

Dan O'Meara

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

[diff] [blame]

515

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

Bu Sun Kim

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

[diff] [blame]

516

Bu Sun Kim

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

[diff] [blame]

517

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

518

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

519

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

520

521

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.

522

523

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

524

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.

Dmitry Frenkel

3e17f89

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

[diff] [blame]

525

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Bu Sun Kim

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

[diff] [blame]

526

527

Returns:

528

An object of the form:

529

530

{

Yoshi Automation Bot

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

[diff] [blame^]

531

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

532

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

533

{ # Represents a License resource.

534

#

535

# A License represents billing and aggregate usage data for public and marketplace images. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. (== resource_for {$api_version}.licenses ==)

536

"chargesUseFee": True or False, # [Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee.

537

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

538

"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.

539

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

540

"kind": "compute#license", # [Output Only] Type of resource. Always compute#license for licenses.

541

"licenseCode": "A String", # [Output Only] The unique code used to attach this license to images, snapshots, and disks.

542

"name": "A String", # Name of the resource. The name must be 1-63 characters long and comply with RFC1035.

543

"resourceRequirements": {

544

"minGuestCpuCount": 42, # Minimum number of guest cpus required to use the Instance. Enforced at Instance creation and Instance start.

545

"minMemoryMb": 42, # Minimum memory required to use the Instance. Enforced at Instance creation and Instance start.

546

},

547

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

548

"transferable": True or False, # If false, licenses will not be copied from the source resource when creating an image from a disk, disk from snapshot, or snapshot from disk.

549

},

550

],

551

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

552

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

553

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

554

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

555

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

556

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

557

{

558

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

559

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

Bu Sun Kim

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

[diff] [blame]

560

},

Bu Sun Kim

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

[diff] [blame]

561

],

Yoshi Automation Bot

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

[diff] [blame^]

562

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

563

},

564

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

569

<pre>Retrieves the next page of results.

570

571

Args:

572

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

573

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

574

575

Returns:

Bu Sun Kim

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

[diff] [blame]

576

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

Bu Sun Kim

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

[diff] [blame]

577

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

</pre>

</div>

Dan O'Meara

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

[diff] [blame]

582

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

583

<pre>Sets the access control policy on the specified resource. Replaces any existing policy. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.

Bu Sun Kim

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

[diff] [blame]

584

585

Args:

586

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

587

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

Dan O'Meara

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

[diff] [blame]

588

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

589

The object takes the form of:

590

591

{

Yoshi Automation Bot

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

[diff] [blame^]

592

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

593

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

594

"bindingId": "A String",

595

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

Bu Sun Kim

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

[diff] [blame]

596

#

Yoshi Automation Bot

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

[diff] [blame^]

597

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

Bu Sun Kim

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

[diff] [blame]

598

#

Yoshi Automation Bot

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

[diff] [blame^]

599

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

Bu Sun Kim

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

[diff] [blame]

600

#

601

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

Yoshi Automation Bot

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

[diff] [blame^]

602

#

603

# Example (Comparison):

604

#

605

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

606

#

607

# Example (Equality):

608

#

609

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

614

#

615

# Example (Data Manipulation):

616

#

617

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

618

#

619

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

620

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

621

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

622

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

623

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

624

},

625

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

626

#

627

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

628

#

629

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

630

#

631

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

636

#

637

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

638

#

639

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

640

#

641

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

642

#

643

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

648

"A String",

649

],

650

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

Bu Sun Kim

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

[diff] [blame]

651

},

Yoshi Automation Bot

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

[diff] [blame^]

652

],

653

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

654

"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.

Bu Sun Kim

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

[diff] [blame]

655

#

656

#

657

#

Dan O'Meara

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

[diff] [blame]

658

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

Bu Sun Kim

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

[diff] [blame]

659

#

Bu Sun Kim

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

[diff] [blame]

660

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

Bu Sun Kim

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

[diff] [blame]

661

#

Dan O'Meara

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

[diff] [blame]

662

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

663

#

Bu Sun Kim

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

[diff] [blame]

664

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

Bu Sun Kim

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

[diff] [blame]

665

#

Dan O'Meara

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

[diff] [blame]

666

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

667

#

Bu Sun Kim

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

[diff] [blame]

668

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

Bu Sun Kim

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

[diff] [blame]

669

#

Dan O'Meara

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

[diff] [blame]

670

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

Bu Sun Kim

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

[diff] [blame]

671

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

Bu Sun Kim

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

[diff] [blame]

672

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

673

#

674

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

675

#

676

# Example Policy with multiple AuditConfigs:

677

#

Bu Sun Kim

d059ad8

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

[diff] [blame]

678

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

Bu Sun Kim

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

[diff] [blame]

679

#

Dan O'Meara

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

[diff] [blame]

680

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

Bu Sun Kim

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

[diff] [blame]

681

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

Bu Sun Kim

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

[diff] [blame]

682

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

683

#

Bu Sun Kim

d059ad8

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

[diff] [blame]

684

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

Bu Sun Kim

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

[diff] [blame]

685

#

Bu Sun Kim

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

[diff] [blame]

686

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

687

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

688

"A String",

Bu Sun Kim

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

[diff] [blame]

689

],

Bu Sun Kim

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

[diff] [blame]

690

"ignoreChildExemptions": True or False,

691

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

Bu Sun Kim

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

[diff] [blame]

692

},

693

],

Bu Sun Kim

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

[diff] [blame]

"exemptedMembers": [

"A String",

],

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

Bu Sun Kim

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

[diff] [blame]

698

},

699

],

Bu Sun Kim

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

[diff] [blame]

700

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

Bu Sun Kim

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

[diff] [blame]

701

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

Yoshi Automation Bot

0d561ef

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

[diff] [blame]

702

"bindingId": "A String",

Bu Sun Kim

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

[diff] [blame]

703

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

704

#

705

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

706

#

707

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

708

#

709

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

710

#

711

# Example (Comparison):

712

#

713

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

714

#

715

# Example (Equality):

716

#

717

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

722

#

723

# Example (Data Manipulation):

724

#

725

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

726

#

727

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

728

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

729

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

730

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

731

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

732

},

733

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

Bu Sun Kim

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

[diff] [blame]

734

#

735

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

736

#

737

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

738

#

Dan O'Meara

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

[diff] [blame]

739

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

Bu Sun Kim

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

[diff] [blame]

#

#

#

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

744

#

745

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

746

#

Dan O'Meara

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

[diff] [blame]

747

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

748

#

749

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

750

#

751

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

752

#

Bu Sun Kim

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

[diff] [blame]

753

#

754

#

755

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

Bu Sun Kim

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

[diff] [blame]

756

"A String",

Bu Sun Kim

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

[diff] [blame]

757

],

Bu Sun Kim

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

[diff] [blame]

758

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

Bu Sun Kim

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

[diff] [blame]

759

},

760

],

Bu Sun Kim

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

[diff] [blame]

761

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

762

#

763

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

764

"iamOwned": True or False,

765

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

766

{ # A rule to be applied in a Policy.

767

"action": "A String", # Required

768

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

769

{ # A condition to be met.

770

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

771

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

772

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

773

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

774

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

"A String",

],

},

],

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

780

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

781

"A String",

782

],

783

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

784

{ # Specifies what kind of log the caller must write

785

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

786

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

787

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

788

},

789

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

790

},

791

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

792

#

793

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

794

#

795

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

796

#

797

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

798

#

799

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

800

"customFields": [ # Custom fields.

801

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

802

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

803

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

804

},

805

],

806

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

807

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

808

},

809

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

810

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

815

"A String",

816

],

817

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

823

#

824

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

825

#

826

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

827

#

828

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

829

#

830

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

831

#

832

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

833

#

834

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

Yoshi Automation Bot

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

[diff] [blame^]

},

}

Returns:

An object of the form:

841

842

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

847

#

848

# 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

857

#

858

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

859

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

860

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

861

#

862

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

863

#

864

# Example Policy with multiple AuditConfigs:

865

#

866

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

867

#

868

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

869

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

870

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

871

#

872

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

873

#

874

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

875

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

876

"A String",

877

],

878

"ignoreChildExemptions": True or False,

879

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

886

},

887

],

888

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

889

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

890

"bindingId": "A String",

891

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

892

#

893

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

894

#

895

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

896

#

897

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

898

#

899

# Example (Comparison):

900

#

901

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

902

#

903

# Example (Equality):

904

#

905

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

910

#

911

# Example (Data Manipulation):

912

#

913

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

914

#

915

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

916

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

917

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

918

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

919

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

920

},

921

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

922

#

923

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

924

#

925

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

926

#

927

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

932

#

933

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

934

#

935

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

936

#

937

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

938

#

939

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

944

"A String",

945

],

946

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

947

},

948

],

949

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

950

#

951

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

952

"iamOwned": True or False,

953

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

954

{ # A rule to be applied in a Policy.

955

"action": "A String", # Required

956

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

957

{ # A condition to be met.

958

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

959

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

960

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

961

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

962

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

"A String",

],

},

],

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

968

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

969

"A String",

970

],

971

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

972

{ # Specifies what kind of log the caller must write

973

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

974

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

975

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

976

},

977

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

978

},

979

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

980

#

981

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

982

#

983

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

984

#

985

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

986

#

987

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

988

"customFields": [ # Custom fields.

989

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

990

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

991

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

992

},

993

],

994

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

995

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

996

},

997

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

998

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

1003

"A String",

1004

],

1005

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

1011

#

1012

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

1013

#

1014

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

1015

#

1016

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

1017

#

1018

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

1019

#

1020

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

1021

#

1022

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

1023

}</pre>

Sai Cheemalapati