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

2014-04-24 15:46:26 -0400

[diff] [blame]

80

81

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

Bu Sun Kim

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

[diff] [blame]

82

<p class="firstline">Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request.</p>

83

84

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

85

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

86

Bu Sun Kim

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

[diff] [blame]

87

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

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

88

<p class="firstline">Retrieves the list of Snapshot resources contained within the specified project.</p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

89

90

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

91

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

92

Dan O'Meara

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

[diff] [blame]

93

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

Bu Sun Kim

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

[diff] [blame]

94

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

95

Dan O'Meara

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

[diff] [blame]

96

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

Bu Sun Kim

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

[diff] [blame]

97

<p class="firstline">Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation.</p>

98

Dan O'Meara

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

[diff] [blame]

99

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

Bu Sun Kim

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

[diff] [blame]

100

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

101

<h3>Method Details</h3>

102

Bu Sun Kim

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

[diff] [blame]

103

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

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

104

<pre>Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot.

105

Bu Sun Kim

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

[diff] [blame]

106

For more information, see Deleting snapshots.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

107

108

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

109

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

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

110

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

Bu Sun Kim

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

[diff] [blame]

111

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.

112

113

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.

114

115

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

116

117

Returns:

118

An object of the form:

119

Bu Sun Kim

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

[diff] [blame]

120

{ # Represents an Operation resource.

121

#

Dan O'Meara

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

[diff] [blame]

122

# Google Compute Engine has three Operation resources:

123

#

124

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

125

#

Bu Sun Kim

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

[diff] [blame]

126

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

127

#

128

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

129

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

130

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

131

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

Bu Sun Kim

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

[diff] [blame]

132

#

Dan O'Meara

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

[diff] [blame]

133

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

Bu Sun Kim

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

[diff] [blame]

134

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

135

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

136

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

137

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

138

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

139

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

140

{

Bu Sun Kim

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

[diff] [blame]

141

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

142

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

143

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

144

},

145

],

146

},

Bu Sun Kim

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

[diff] [blame]

147

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

148

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

149

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

150

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

151

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

152

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

153

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

154

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

155

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

156

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

157

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

158

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

159

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

160

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

161

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

162

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

163

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

164

{

165

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

166

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

167

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

168

{

169

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

170

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

171

},

172

],

173

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

174

},

175

],

176

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

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

Bu Sun Kim

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

[diff] [blame]

182

<pre>Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

183

184

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

185

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

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

186

snapshot: string, Name of the Snapshot resource to return. (required)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

187

188

Returns:

189

An object of the form:

190

Bu Sun Kim

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

[diff] [blame]

191

{ # Represents a Persistent Disk Snapshot resource.

192

#

Dan O'Meara

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

[diff] [blame]

193

# You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. (== resource_for {$api_version}.snapshots ==)

Bu Sun Kim

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

[diff] [blame]

194

"autoCreated": True or False, # [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.

195

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

196

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

197

"diskSizeGb": "A String", # [Output Only] Size of the source disk, specified in GB.

198

"downloadBytes": "A String", # [Output Only] Number of bytes downloaded to restore a snapshot to a disk.

199

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

200

"kind": "compute#snapshot", # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.

201

"labelFingerprint": "A String", # A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.

202

#

203

# To see the latest fingerprint, make a get() request to retrieve a snapshot.

204

"labels": { # Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.

205

"a_key": "A String",

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

206

},

Bu Sun Kim

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

[diff] [blame]

207

"licenseCodes": [ # [Output Only] Integer license codes indicating which licenses are attached to this snapshot.

208

"A String",

209

],

210

"licenses": [ # [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).

211

"A String",

212

],

213

"name": "A String", # Name of the resource; provided by the client when the resource is created. The 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.

214

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

215

"snapshotEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the snapshot using a customer-supplied encryption key.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

216

#

Bu Sun Kim

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

[diff] [blame]

217

# After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

218

#

Bu Sun Kim

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

[diff] [blame]

219

# Customer-supplied encryption keys do not protect access to metadata of the snapshot.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

220

#

221

# If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.

Bu Sun Kim

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

[diff] [blame]

222

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

223

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

224

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

225

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

226

},

Bu Sun Kim

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

[diff] [blame]

227

"sourceDisk": "A String", # [Output Only] The source disk used to create this snapshot.

228

"sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.

229

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

230

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

231

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

232

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

233

},

Bu Sun Kim

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

[diff] [blame]

234

"sourceDiskId": "A String", # [Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.

235

"status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.

236

"storageBytes": "A String", # [Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.

237

"storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.

238

"storageLocations": [ # Cloud Storage bucket storage location of the snapshot (regional or multi-regional).

239

"A String",

Bu Sun Kim

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

[diff] [blame]

240

],

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

245

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

246

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

247

248

Args:

249

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

250

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

251

252

Returns:

253

An object of the form:

254

Dan O'Meara

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

[diff] [blame]

255

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

Bu Sun Kim

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

[diff] [blame]

256

#

257

#

258

#

Dan O'Meara

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

[diff] [blame]

259

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

260

#

Bu Sun Kim

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

[diff] [blame]

261

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

262

#

Dan O'Meara

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

[diff] [blame]

263

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

264

#

Bu Sun Kim

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

[diff] [blame]

265

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

266

#

Dan O'Meara

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

[diff] [blame]

267

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

268

#

Bu Sun Kim

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

[diff] [blame]

269

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

270

#

Dan O'Meara

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

[diff] [blame]

271

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

272

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

Bu Sun Kim

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

[diff] [blame]

273

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

274

#

275

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

276

#

277

# Example Policy with multiple AuditConfigs:

278

#

Bu Sun Kim

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

[diff] [blame^]

279

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

280

#

Dan O'Meara

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

[diff] [blame]

281

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

282

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

Bu Sun Kim

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

[diff] [blame]

283

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

284

#

Bu Sun Kim

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

[diff] [blame^]

285

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

286

#

Bu Sun Kim

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

[diff] [blame]

287

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

288

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

289

"A String",

Bu Sun Kim

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

[diff] [blame]

290

],

Bu Sun Kim

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

[diff] [blame]

291

"ignoreChildExemptions": True or False,

292

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

Bu Sun Kim

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

[diff] [blame]

293

},

294

],

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]

299

},

300

],

Bu Sun Kim

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

[diff] [blame]

301

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

302

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

Bu Sun Kim

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

[diff] [blame]

303

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

304

#

305

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

306

#

307

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

308

#

309

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

310

#

311

# Example (Comparison):

312

#

313

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

314

#

315

# Example (Equality):

316

#

317

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

322

#

323

# Example (Data Manipulation):

324

#

325

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

326

#

327

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

328

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

329

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

330

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

331

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

332

},

333

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

334

#

335

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

336

#

337

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

338

#

Dan O'Meara

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

[diff] [blame]

339

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

344

#

345

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

346

#

Dan O'Meara

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

[diff] [blame]

347

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

348

#

349

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

350

#

351

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

352

#

Bu Sun Kim

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

[diff] [blame]

353

#

354

#

355

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

356

"A String",

Bu Sun Kim

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

[diff] [blame]

357

],

Bu Sun Kim

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

[diff] [blame]

358

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

359

},

360

],

Bu Sun Kim

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

[diff] [blame]

361

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

362

#

363

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

364

"iamOwned": True or False,

365

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

366

{ # A rule to be applied in a Policy.

367

"action": "A String", # Required

368

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

369

{ # A condition to be met.

370

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

371

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

372

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

373

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

374

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

"A String",

],

},

],

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

380

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

381

"A String",

382

],

383

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

384

{ # Specifies what kind of log the caller must write

385

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

386

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

387

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

388

},

389

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

390

},

391

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

392

#

393

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

394

#

395

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

396

#

397

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

398

#

399

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

400

"customFields": [ # Custom fields.

401

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

402

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

403

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

404

},

405

],

406

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

407

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

408

},

409

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

410

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

415

"A String",

416

],

417

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

423

#

424

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

425

#

426

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

427

#

428

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

429

#

430

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

431

#

432

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

433

#

434

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

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

439

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

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

440

<pre>Retrieves the list of Snapshot resources contained within the specified project.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

441

442

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

443

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

Dan O'Meara

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

[diff] [blame]

444

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

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

445

Dan O'Meara

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

[diff] [blame]

446

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

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

447

Dan O'Meara

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

[diff] [blame]

448

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.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

449

Bu Sun Kim

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

[diff] [blame]

450

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

451

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

452

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

453

454

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.

455

456

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

457

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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

458

459

Returns:

460

An object of the form:

461

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

462

{ # Contains a list of Snapshot resources.

Bu Sun Kim

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

[diff] [blame]

463

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

464

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

Bu Sun Kim

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

[diff] [blame]

465

{ # Represents a Persistent Disk Snapshot resource.

466

#

Dan O'Meara

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

[diff] [blame]

467

# You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. (== resource_for {$api_version}.snapshots ==)

Bu Sun Kim

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

[diff] [blame]

468

"autoCreated": True or False, # [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.

469

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

470

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

471

"diskSizeGb": "A String", # [Output Only] Size of the source disk, specified in GB.

472

"downloadBytes": "A String", # [Output Only] Number of bytes downloaded to restore a snapshot to a disk.

473

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

474

"kind": "compute#snapshot", # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.

475

"labelFingerprint": "A String", # A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.

476

#

477

# To see the latest fingerprint, make a get() request to retrieve a snapshot.

478

"labels": { # Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.

479

"a_key": "A String",

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

480

},

Bu Sun Kim

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

[diff] [blame]

481

"licenseCodes": [ # [Output Only] Integer license codes indicating which licenses are attached to this snapshot.

482

"A String",

483

],

484

"licenses": [ # [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).

485

"A String",

486

],

487

"name": "A String", # Name of the resource; provided by the client when the resource is created. The 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.

488

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

489

"snapshotEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the snapshot using a customer-supplied encryption key.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

490

#

Bu Sun Kim

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

[diff] [blame]

491

# After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

492

#

Bu Sun Kim

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

[diff] [blame]

493

# Customer-supplied encryption keys do not protect access to metadata of the snapshot.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

494

#

495

# If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.

Bu Sun Kim

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

[diff] [blame]

496

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

497

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

498

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

499

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

500

},

Bu Sun Kim

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

[diff] [blame]

501

"sourceDisk": "A String", # [Output Only] The source disk used to create this snapshot.

502

"sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.

503

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

504

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

505

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

506

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

507

},

Bu Sun Kim

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

[diff] [blame]

508

"sourceDiskId": "A String", # [Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.

509

"status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.

510

"storageBytes": "A String", # [Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.

511

"storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.

512

"storageLocations": [ # Cloud Storage bucket storage location of the snapshot (regional or multi-regional).

513

"A String",

Bu Sun Kim

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

[diff] [blame]

514

],

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

515

},

516

],

Bu Sun Kim

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

[diff] [blame]

517

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

518

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

519

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

520

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

521

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

522

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

523

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

Bu Sun Kim

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

[diff] [blame]

524

{

Bu Sun Kim

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

[diff] [blame]

525

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

526

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

Bu Sun Kim

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

[diff] [blame]

527

},

528

],

Bu Sun Kim

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

[diff] [blame]

529

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

Bu Sun Kim

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

[diff] [blame]

530

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

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

536

<pre>Retrieves the next page of results.

537

538

Args:

539

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

540

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

541

542

Returns:

Bu Sun Kim

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

[diff] [blame]

543

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

544

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

</pre>

</div>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

548

Dan O'Meara

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

[diff] [blame]

549

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

Bu Sun Kim

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

[diff] [blame]

550

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

551

552

Args:

553

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

Bu Sun Kim

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

[diff] [blame]

554

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

Dan O'Meara

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

[diff] [blame]

555

body: object, The request body.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

556

The object takes the form of:

557

558

{

Bu Sun Kim

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

[diff] [blame]

559

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

560

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

561

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

562

#

563

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

564

#

565

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

566

#

567

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

568

#

569

# Example (Comparison):

570

#

571

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

572

#

573

# Example (Equality):

574

#

575

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

580

#

581

# Example (Data Manipulation):

582

#

583

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

584

#

585

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

586

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

587

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

588

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

589

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

590

},

591

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

592

#

593

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

594

#

595

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

596

#

597

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

602

#

603

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

604

#

605

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

606

#

607

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

608

#

609

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

614

"A String",

615

],

616

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

617

},

618

],

619

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

620

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

621

#

622

#

623

#

Dan O'Meara

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

[diff] [blame]

624

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

625

#

Bu Sun Kim

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

[diff] [blame]

626

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

627

#

Dan O'Meara

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

[diff] [blame]

628

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

629

#

Bu Sun Kim

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

[diff] [blame]

630

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

631

#

Dan O'Meara

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

[diff] [blame]

632

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

633

#

Bu Sun Kim

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

[diff] [blame]

634

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

635

#

Dan O'Meara

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

[diff] [blame]

636

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

637

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

Bu Sun Kim

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

[diff] [blame]

638

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

639

#

640

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

641

#

642

# Example Policy with multiple AuditConfigs:

643

#

Bu Sun Kim

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

[diff] [blame^]

644

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

645

#

Dan O'Meara

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

[diff] [blame]

646

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

647

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

Bu Sun Kim

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

[diff] [blame]

648

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

649

#

Bu Sun Kim

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

[diff] [blame^]

650

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

651

#

Bu Sun Kim

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

[diff] [blame]

652

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

653

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

654

"A String",

Bu Sun Kim

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

[diff] [blame]

655

],

Bu Sun Kim

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

[diff] [blame]

656

"ignoreChildExemptions": True or False,

657

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

Bu Sun Kim

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

[diff] [blame]

658

},

659

],

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]

664

},

665

],

Bu Sun Kim

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

[diff] [blame]

666

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

667

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

Bu Sun Kim

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

[diff] [blame]

668

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

669

#

670

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

671

#

672

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

673

#

674

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

675

#

676

# Example (Comparison):

677

#

678

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

679

#

680

# Example (Equality):

681

#

682

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

687

#

688

# Example (Data Manipulation):

689

#

690

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

691

#

692

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

693

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

694

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

695

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

696

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

697

},

698

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

699

#

700

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

701

#

702

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

703

#

Dan O'Meara

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

[diff] [blame]

704

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

709

#

710

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

711

#

Dan O'Meara

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

[diff] [blame]

712

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

713

#

714

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

715

#

716

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

717

#

Bu Sun Kim

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

[diff] [blame]

718

#

719

#

720

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

721

"A String",

Bu Sun Kim

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

[diff] [blame]

722

],

Bu Sun Kim

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

[diff] [blame]

723

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

724

},

725

],

Bu Sun Kim

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

[diff] [blame]

726

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

727

#

728

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

729

"iamOwned": True or False,

730

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

731

{ # A rule to be applied in a Policy.

732

"action": "A String", # Required

733

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

734

{ # A condition to be met.

735

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

736

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

737

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

738

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

739

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

"A String",

],

},

],

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

745

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

746

"A String",

747

],

748

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

749

{ # Specifies what kind of log the caller must write

750

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

751

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

752

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

753

},

754

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

755

},

756

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

757

#

758

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

759

#

760

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

761

#

762

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

763

#

764

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

765

"customFields": [ # Custom fields.

766

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

767

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

768

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

769

},

770

],

771

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

772

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

773

},

774

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

775

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

780

"A String",

781

],

782

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

783

"A String",

784

],

Bu Sun Kim

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

[diff] [blame]

785

},

Bu Sun Kim

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

[diff] [blame]

786

],

787

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

788

#

789

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

790

#

791

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

792

#

793

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

794

#

795

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

796

#

797

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

798

#

799

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

800

},

Bu Sun Kim

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

[diff] [blame]

}

Returns:

An object of the form:

806

Dan O'Meara

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

[diff] [blame]

807

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

Bu Sun Kim

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

[diff] [blame]

808

#

809

#

810

#

Dan O'Meara

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

[diff] [blame]

811

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

812

#

Bu Sun Kim

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

[diff] [blame]

813

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

814

#

Dan O'Meara

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

[diff] [blame]

815

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

816

#

Bu Sun Kim

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

[diff] [blame]

817

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

818

#

Dan O'Meara

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

[diff] [blame]

819

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

820

#

Bu Sun Kim

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

[diff] [blame]

821

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

822

#

Dan O'Meara

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

[diff] [blame]

823

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

824

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

Bu Sun Kim

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

[diff] [blame]

825

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

826

#

827

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

828

#

829

# Example Policy with multiple AuditConfigs:

830

#

Bu Sun Kim

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

[diff] [blame^]

831

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

832

#

Dan O'Meara

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

[diff] [blame]

833

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

834

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

Bu Sun Kim

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

[diff] [blame]

835

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

836

#

Bu Sun Kim

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

[diff] [blame^]

837

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

838

#

Bu Sun Kim

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

[diff] [blame]

839

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

840

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

841

"A String",

Bu Sun Kim

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

[diff] [blame]

842

],

Bu Sun Kim

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

[diff] [blame]

843

"ignoreChildExemptions": True or False,

844

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

Bu Sun Kim

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

[diff] [blame]

845

},

846

],

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]

851

},

852

],

Bu Sun Kim

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

[diff] [blame]

853

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

854

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

Bu Sun Kim

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

[diff] [blame]

855

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

856

#

857

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

858

#

859

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

860

#

861

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

862

#

863

# Example (Comparison):

864

#

865

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

866

#

867

# Example (Equality):

868

#

869

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

874

#

875

# Example (Data Manipulation):

876

#

877

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

878

#

879

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

880

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

881

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

882

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

883

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

884

},

885

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

886

#

887

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

888

#

889

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

890

#

Dan O'Meara

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

[diff] [blame]

891

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

896

#

897

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

898

#

Dan O'Meara

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

[diff] [blame]

899

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

900

#

901

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

902

#

903

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

904

#

Bu Sun Kim

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

[diff] [blame]

905

#

906

#

907

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

908

"A String",

Bu Sun Kim

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

[diff] [blame]

909

],

Bu Sun Kim

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

[diff] [blame]

910

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

911

},

912

],

Bu Sun Kim

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

[diff] [blame]

913

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

914

#

915

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

916

"iamOwned": True or False,

917

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

918

{ # A rule to be applied in a Policy.

919

"action": "A String", # Required

920

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

921

{ # A condition to be met.

922

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

923

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

924

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

925

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

926

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

"A String",

],

},

],

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

932

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

933

"A String",

934

],

935

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

936

{ # Specifies what kind of log the caller must write

937

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

938

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

939

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

940

},

941

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

942

},

943

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

944

#

945

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

946

#

947

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

948

#

949

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

950

#

951

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

952

"customFields": [ # Custom fields.

953

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

954

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

955

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

956

},

957

],

958

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

959

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

960

},

961

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

962

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

967

"A String",

968

],

969

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

975

#

976

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

977

#

978

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

979

#

980

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

981

#

982

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

983

#

984

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

985

#

986

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

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

991

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

Bu Sun Kim

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

[diff] [blame]

992

<pre>Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation.

993

994

Args:

995

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

996

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

Dan O'Meara

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

[diff] [blame]

997

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

998

The object takes the form of:

999

1000

{

Bu Sun Kim

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

[diff] [blame]

1001

"labelFingerprint": "A String", # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint.

1002

"labels": { # A list of labels to apply for this resource. Each label key & value must 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. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": "").

1003

"a_key": "A String",

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

},

}

Returns:

An object of the form:

1010

Bu Sun Kim

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

[diff] [blame]

1011

{ # Represents an Operation resource.

1012

#

Dan O'Meara

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

[diff] [blame]

1013

# Google Compute Engine has three Operation resources:

1014

#

1015

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

1016

#

Bu Sun Kim

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

[diff] [blame]

1017

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

1018

#

1019

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1020

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

1021

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

1022

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

Bu Sun Kim

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

[diff] [blame]

1023

#

Dan O'Meara

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

[diff] [blame]

1024

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

Bu Sun Kim

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

[diff] [blame]

1025

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

1026

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

1027

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

1028

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

1029

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

1030

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1031

{

Bu Sun Kim

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

[diff] [blame]

1032

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

1033

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

1034

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1035

},

1036

],

1037

},

Bu Sun Kim