Blame - docs/dyn/compute_alpha.resourcePolicies.html - platform/external/python/google-api-python-client

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

[diff] [blame]

79

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

80

81

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

82

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

83

84

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

85

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

86

87

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

88

<p class="firstline">Retrieves all information of the specified resource policy.</p>

89

Dan O'Meara

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

[diff] [blame]

90

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

Bu Sun Kim

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

[diff] [blame]

91

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

92

Dan O'Meara

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

[diff] [blame]

93

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

Bu Sun Kim

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

[diff] [blame]

94

<p class="firstline">Creates a new resource policy.</p>

95

Bu Sun Kim

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

[diff] [blame]

96

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

Bu Sun Kim

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

[diff] [blame]

97

<p class="firstline">A list all the resource policies that have been configured for the specified project in specified region.</p>

98

99

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

100

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

101

Dan O'Meara

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

[diff] [blame]

102

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

Bu Sun Kim

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

[diff] [blame]

103

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

104

Dan O'Meara

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

[diff] [blame]

105

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

Bu Sun Kim

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

[diff] [blame]

106

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

107

<h3>Method Details</h3>

108

Bu Sun Kim

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

[diff] [blame]

109

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

Bu Sun Kim

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

[diff] [blame]

110

<pre>Retrieves an aggregated list of resource policies.

111

112

Args:

113

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

Dan O'Meara

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

[diff] [blame]

114

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

Bu Sun Kim

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

[diff] [blame]

115

Dan O'Meara

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

[diff] [blame]

116

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

Bu Sun Kim

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

[diff] [blame]

117

Dan O'Meara

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

[diff] [blame]

118

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

Bu Sun Kim

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

[diff] [blame]

119

Bu Sun Kim

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

[diff] [blame]

120

To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

Dan O'Meara

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

[diff] [blame]

121

includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

Bu Sun Kim

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

[diff] [blame]

122

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

123

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

124

125

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.

126

127

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

128

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.

129

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

Bu Sun Kim

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

[diff] [blame]

130

131

Returns:

132

An object of the form:

133

134

{ # Contains a list of resourcePolicies.

Bu Sun Kim

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

[diff] [blame]

135

"etag": "A String",

136

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

137

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

138

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

139

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

Dan O'Meara

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

[diff] [blame]

140

{ # Represents a Resource Policy resource. You can use resource policies to schedule actions for some Compute Engine resources. For example, you can use them to schedule persistent disk snapshots.

Bu Sun Kim

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

[diff] [blame]

141

#

142

# (== resource_for {$api_version}.resourcePolicies ==)

143

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

144

"description": "A String",

145

"groupPlacementPolicy": { # A GroupPlacementPolicy specifies resource placement configuration. It specifies the failure bucket separation as well as network locality # Resource policy for instacnes for placement configuration.

146

"availabilityDomainCount": 42, # The number of availability domains instances will be spread across. If two instances are in different availability domain, they will not be put in the same low latency network

147

"collocation": "A String", # Specifies network collocation

148

"locality": "A String", # Specifies network locality

149

"style": "A String", # Specifies instances to hosts placement relationship

150

"vmCount": 42, # Number of vms in this placement group

Bu Sun Kim

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

[diff] [blame]

151

},

Bu Sun Kim

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

[diff] [blame]

152

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

153

"kind": "compute#resourcePolicy", # [Output Only] Type of the resource. Always compute#resource_policies for resource policies.

154

"name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

155

"region": "A String",

156

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

157

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

158

"snapshotSchedulePolicy": { # A snapshot schedule policy specifies when and how frequently snapshots are to be created for the target disk. Also specifies how many and how long these scheduled snapshots should be retained. # Resource policy for persistent disks for creating snapshots.

159

"retentionPolicy": { # Policy for retention of scheduled snapshots. # Retention policy applied to snapshots created by this resource policy.

160

"maxRetentionDays": 42, # Maximum age of the snapshot that is allowed to be kept.

161

"onPolicySwitch": "A String", # Specifies the behavior to apply to existing, scheduled snapshots snapshots if the policy is changed.

162

"onSourceDiskDelete": "A String", # Specifies the behavior to apply to scheduled snapshots when the source disk is deleted.

163

},

164

"schedule": { # A schedule for disks where the schedueled operations are performed. # A Vm Maintenance Policy specifies what kind of infrastructure maintenance we are allowed to perform on this VM and when. Schedule that is applied to disks covered by this policy.

165

"dailySchedule": { # Time window specified for daily operations.

166

"daysInCycle": 42, # Defines a schedule with units measured in months. The value determines how many months pass between the start of each cycle.

167

"duration": "A String", # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.

168

"startTime": "A String", # Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.

169

},

170

"hourlySchedule": { # Time window specified for hourly operations.

171

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.

172

"hoursInCycle": 42, # Defines a schedule with units measured in hours. The value determines how many hours pass between the start of each cycle.

173

"startTime": "A String", # Time within the window to start the operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-00] GMT.

174

},

175

"weeklySchedule": { # Time window specified for weekly operations.

176

"dayOfWeeks": [ # Up to 7 intervals/windows, one for each day of the week.

177

{

178

"day": "A String", # Defines a schedule that runs on specific days of the week. Specify one or more days. The following options are available: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.

179

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.

180

"startTime": "A String", # Time within the window to start the operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-00] GMT.

},

],

},

},

"snapshotProperties": { # Specified snapshot properties for scheduled snapshots created by this policy. # Properties with which snapshots are created such as labels, encryption keys.

186

"guestFlush": True or False, # Indication to perform a 'guest aware' snapshot.

187

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

188

"a_key": "A String",

189

},

190

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

"A String",

],

},

},

"status": "A String", # [Output Only] The status of resource policy creation.

196

"vmMaintenancePolicy": { # Resource policy applicable to VMs for infrastructure maintenance.

197

"concurrencyControlGroup": { # A concurrency control configuration. Defines a group config that, when attached to an instance, recognizes that instance as part of a group of instances where only up the concurrency_limit of instances in that group can undergo simultaneous maintenance. For more information: go/concurrency-control-design-doc

198

"concurrencyLimit": 42,

199

},

200

"maintenanceWindow": { # A maintenance window for VMs. When set, we restrict our maintenance operations to this window. # Maintenance windows that are applied to VMs covered by this policy.

201

"dailyMaintenanceWindow": { # Time window specified for daily operations.

202

"daysInCycle": 42, # Defines a schedule with units measured in months. The value determines how many months pass between the start of each cycle.

203

"duration": "A String", # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.

204

"startTime": "A String", # Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.

},

},

},

},

Bu Sun Kim

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

[diff] [blame]

209

],

Bu Sun Kim

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

[diff] [blame]

210

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

211

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

212

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

213

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

Bu Sun Kim

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

[diff] [blame]

214

{

Bu Sun Kim

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

[diff] [blame]

215

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

216

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

217

},

218

],

Bu Sun Kim

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

[diff] [blame]

219

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

220

},

221

},

222

},

Bu Sun Kim

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

[diff] [blame]

223

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

224

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

225

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

226

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

227

"A String",

Dan O'Meara

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

[diff] [blame]

228

],

Bu Sun Kim

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

[diff] [blame]

229

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

230

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

231

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

232

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

Bu Sun Kim

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

[diff] [blame]

233

{

Bu Sun Kim

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

[diff] [blame]

234

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

235

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

236

},

237

],

Bu Sun Kim

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

[diff] [blame]

238

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

239

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

245

<pre>Retrieves the next page of results.

246

247

Args:

248

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

249

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

250

251

Returns:

Bu Sun Kim

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

[diff] [blame]

252

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

Bu Sun Kim

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

[diff] [blame]

253

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

</pre>

</div>

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

259

<pre>Deletes the specified resource policy.

260

261

Args:

262

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

263

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

264

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

265

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.

266

267

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.

268

269

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

270

271

Returns:

272

An object of the form:

273

274

{ # Represents an Operation resource.

275

#

Dan O'Meara

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

[diff] [blame]

276

# Google Compute Engine has three Operation resources:

277

#

278

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

279

#

Bu Sun Kim

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

[diff] [blame]

280

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

281

#

282

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

283

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

284

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

285

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

Bu Sun Kim

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

[diff] [blame]

286

#

Dan O'Meara

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

[diff] [blame]

287

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

288

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

289

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

290

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

291

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

292

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

293

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

Bu Sun Kim

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

[diff] [blame]

294

{

Bu Sun Kim

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

[diff] [blame]

295

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

296

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

297

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

Bu Sun Kim

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

[diff] [blame]

298

},

299

],

300

},

Bu Sun Kim

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

[diff] [blame]

301

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

302

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

303

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

304

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

305

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

306

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

307

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

308

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

309

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

310

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

311

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

312

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

313

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

314

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

315

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

316

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

317

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

318

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

319

{

320

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

321

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

322

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

323

{

324

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

325

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

326

},

327

],

328

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

329

},

330

],

331

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

337

<pre>Retrieves all information of the specified resource policy.

338

339

Args:

340

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

341

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

342

resourcePolicy: string, Name of the resource policy to retrieve. (required)

343

344

Returns:

345

An object of the form:

346

Dan O'Meara

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

[diff] [blame]

347

{ # Represents a Resource Policy resource. You can use resource policies to schedule actions for some Compute Engine resources. For example, you can use them to schedule persistent disk snapshots.

Bu Sun Kim

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

[diff] [blame]

348

#

349

# (== resource_for {$api_version}.resourcePolicies ==)

350

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

351

"description": "A String",

352

"groupPlacementPolicy": { # A GroupPlacementPolicy specifies resource placement configuration. It specifies the failure bucket separation as well as network locality # Resource policy for instacnes for placement configuration.

353

"availabilityDomainCount": 42, # The number of availability domains instances will be spread across. If two instances are in different availability domain, they will not be put in the same low latency network

354

"collocation": "A String", # Specifies network collocation

355

"locality": "A String", # Specifies network locality

356

"style": "A String", # Specifies instances to hosts placement relationship

357

"vmCount": 42, # Number of vms in this placement group

358

},

359

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

360

"kind": "compute#resourcePolicy", # [Output Only] Type of the resource. Always compute#resource_policies for resource policies.

361

"name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

362

"region": "A String",

363

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

364

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

365

"snapshotSchedulePolicy": { # A snapshot schedule policy specifies when and how frequently snapshots are to be created for the target disk. Also specifies how many and how long these scheduled snapshots should be retained. # Resource policy for persistent disks for creating snapshots.

366

"retentionPolicy": { # Policy for retention of scheduled snapshots. # Retention policy applied to snapshots created by this resource policy.

367

"maxRetentionDays": 42, # Maximum age of the snapshot that is allowed to be kept.

368

"onPolicySwitch": "A String", # Specifies the behavior to apply to existing, scheduled snapshots snapshots if the policy is changed.

369

"onSourceDiskDelete": "A String", # Specifies the behavior to apply to scheduled snapshots when the source disk is deleted.

Bu Sun Kim

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

[diff] [blame]

370

},

Bu Sun Kim

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

[diff] [blame]

371

"schedule": { # A schedule for disks where the schedueled operations are performed. # A Vm Maintenance Policy specifies what kind of infrastructure maintenance we are allowed to perform on this VM and when. Schedule that is applied to disks covered by this policy.

372

"dailySchedule": { # Time window specified for daily operations.

373

"daysInCycle": 42, # Defines a schedule with units measured in months. The value determines how many months pass between the start of each cycle.

374

"duration": "A String", # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.

375

"startTime": "A String", # Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.

Bu Sun Kim

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

[diff] [blame]

376

},

Bu Sun Kim

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

[diff] [blame]

377

"hourlySchedule": { # Time window specified for hourly operations.

378

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.

379

"hoursInCycle": 42, # Defines a schedule with units measured in hours. The value determines how many hours pass between the start of each cycle.

380

"startTime": "A String", # Time within the window to start the operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-00] GMT.

Dan O'Meara

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

[diff] [blame]

381

},

Bu Sun Kim

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

[diff] [blame]

382

"weeklySchedule": { # Time window specified for weekly operations.

383

"dayOfWeeks": [ # Up to 7 intervals/windows, one for each day of the week.

384

{

385

"day": "A String", # Defines a schedule that runs on specific days of the week. Specify one or more days. The following options are available: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.

386

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.

387

"startTime": "A String", # Time within the window to start the operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-00] GMT.

388

},

Bu Sun Kim

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

[diff] [blame]

389

],

Bu Sun Kim

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

[diff] [blame]

390

},

391

},

Bu Sun Kim

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

[diff] [blame]

392

"snapshotProperties": { # Specified snapshot properties for scheduled snapshots created by this policy. # Properties with which snapshots are created such as labels, encryption keys.

393

"guestFlush": True or False, # Indication to perform a 'guest aware' snapshot.

394

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

395

"a_key": "A String",

396

},

397

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

"A String",

],

},

},

"status": "A String", # [Output Only] The status of resource policy creation.

403

"vmMaintenancePolicy": { # Resource policy applicable to VMs for infrastructure maintenance.

404

"concurrencyControlGroup": { # A concurrency control configuration. Defines a group config that, when attached to an instance, recognizes that instance as part of a group of instances where only up the concurrency_limit of instances in that group can undergo simultaneous maintenance. For more information: go/concurrency-control-design-doc

405

"concurrencyLimit": 42,

406

},

407

"maintenanceWindow": { # A maintenance window for VMs. When set, we restrict our maintenance operations to this window. # Maintenance windows that are applied to VMs covered by this policy.

408

"dailyMaintenanceWindow": { # Time window specified for daily operations.

409

"daysInCycle": 42, # Defines a schedule with units measured in months. The value determines how many months pass between the start of each cycle.

410

"duration": "A String", # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.

411

"startTime": "A String", # Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.

},

},

},

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

419

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

Bu Sun Kim

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

[diff] [blame]

420

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

421

422

Args:

423

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

424

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

425

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

Dan O'Meara

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

[diff] [blame]

426

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

Bu Sun Kim

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

[diff] [blame]

427

428

Returns:

429

An object of the form:

430

Dan O'Meara

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

[diff] [blame]

431

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

432

#

433

#

434

#

Dan O'Meara

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

[diff] [blame]

435

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

436

#

Bu Sun Kim

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

[diff] [blame]

437

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

438

#

Dan O'Meara

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

[diff] [blame]

439

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

440

#

Bu Sun Kim

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

[diff] [blame]

441

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

442

#

Dan O'Meara

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

[diff] [blame]

443

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

444

#

Bu Sun Kim

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

[diff] [blame]

445

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

446

#

Dan O'Meara

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

[diff] [blame]

447

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

448

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

Bu Sun Kim

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

[diff] [blame]

449

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

450

#

451

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

452

#

453

# Example Policy with multiple AuditConfigs:

454

#

Bu Sun Kim

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

[diff] [blame]

455

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

456

#

Dan O'Meara

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

[diff] [blame]

457

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

458

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

Bu Sun Kim

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

[diff] [blame]

459

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

460

#

Bu Sun Kim

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

[diff] [blame]

461

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

462

#

Bu Sun Kim

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

[diff] [blame]

463

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

464

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

465

"A String",

Bu Sun Kim

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

[diff] [blame]

466

],

Bu Sun Kim

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

[diff] [blame]

467

"ignoreChildExemptions": True or False,

468

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

Bu Sun Kim

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

[diff] [blame]

469

},

470

],

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]

475

},

476

],

Bu Sun Kim

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

[diff] [blame]

477

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

478

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

Bu Sun Kim

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

[diff] [blame]

479

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

480

#

481

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

482

#

483

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

484

#

485

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

486

#

487

# Example (Comparison):

488

#

489

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

490

#

491

# Example (Equality):

492

#

493

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

498

#

499

# Example (Data Manipulation):

500

#

501

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

502

#

503

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

504

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

505

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

506

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

507

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

508

},

509

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

510

#

511

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

512

#

513

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

514

#

Dan O'Meara

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

[diff] [blame]

515

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

520

#

521

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

522

#

Dan O'Meara

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

[diff] [blame]

523

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

524

#

525

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

526

#

527

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

528

#

Bu Sun Kim

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

[diff] [blame]

529

#

530

#

531

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

532

"A String",

Bu Sun Kim

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

[diff] [blame]

533

],

Bu Sun Kim

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

[diff] [blame]

534

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

535

},

536

],

Bu Sun Kim

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

[diff] [blame]

537

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

538

#

539

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

540

"iamOwned": True or False,

541

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

542

{ # A rule to be applied in a Policy.

543

"action": "A String", # Required

544

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

545

{ # A condition to be met.

546

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

547

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

548

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

549

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

550

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

"A String",

],

},

],

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

556

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

557

"A String",

558

],

559

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

560

{ # Specifies what kind of log the caller must write

561

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

562

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

563

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

564

},

565

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

566

},

567

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

568

#

569

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

570

#

571

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

572

#

573

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

574

#

575

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

576

"customFields": [ # Custom fields.

577

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

578

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

579

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

580

},

581

],

582

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

583

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

584

},

585

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

586

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

591

"A String",

592

],

593

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

599

#

600

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

601

#

602

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

603

#

604

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

605

#

606

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

607

#

608

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

609

#

610

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

615

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

Bu Sun Kim

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

[diff] [blame]

616

<pre>Creates a new resource policy.

617

618

Args:

619

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

620

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

Dan O'Meara

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

[diff] [blame]

621

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

622

The object takes the form of:

623

Dan O'Meara

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

[diff] [blame]

624

{ # Represents a Resource Policy resource. You can use resource policies to schedule actions for some Compute Engine resources. For example, you can use them to schedule persistent disk snapshots.

Bu Sun Kim

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

[diff] [blame]

625

#

626

# (== resource_for {$api_version}.resourcePolicies ==)

627

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

628

"description": "A String",

629

"groupPlacementPolicy": { # A GroupPlacementPolicy specifies resource placement configuration. It specifies the failure bucket separation as well as network locality # Resource policy for instacnes for placement configuration.

630

"availabilityDomainCount": 42, # The number of availability domains instances will be spread across. If two instances are in different availability domain, they will not be put in the same low latency network

631

"collocation": "A String", # Specifies network collocation

632

"locality": "A String", # Specifies network locality

633

"style": "A String", # Specifies instances to hosts placement relationship

634

"vmCount": 42, # Number of vms in this placement group

635

},

636

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

637

"kind": "compute#resourcePolicy", # [Output Only] Type of the resource. Always compute#resource_policies for resource policies.

638

"name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

639

"region": "A String",

640

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

641

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

642

"snapshotSchedulePolicy": { # A snapshot schedule policy specifies when and how frequently snapshots are to be created for the target disk. Also specifies how many and how long these scheduled snapshots should be retained. # Resource policy for persistent disks for creating snapshots.

643

"retentionPolicy": { # Policy for retention of scheduled snapshots. # Retention policy applied to snapshots created by this resource policy.

644

"maxRetentionDays": 42, # Maximum age of the snapshot that is allowed to be kept.

645

"onPolicySwitch": "A String", # Specifies the behavior to apply to existing, scheduled snapshots snapshots if the policy is changed.

646

"onSourceDiskDelete": "A String", # Specifies the behavior to apply to scheduled snapshots when the source disk is deleted.

Bu Sun Kim

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

[diff] [blame]

647

},

Bu Sun Kim

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

[diff] [blame]

648

"schedule": { # A schedule for disks where the schedueled operations are performed. # A Vm Maintenance Policy specifies what kind of infrastructure maintenance we are allowed to perform on this VM and when. Schedule that is applied to disks covered by this policy.

649

"dailySchedule": { # Time window specified for daily operations.

650

"daysInCycle": 42, # Defines a schedule with units measured in months. The value determines how many months pass between the start of each cycle.

651

"duration": "A String", # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.

652

"startTime": "A String", # Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.

Bu Sun Kim

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

[diff] [blame]

653

},

Bu Sun Kim

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

[diff] [blame]

654

"hourlySchedule": { # Time window specified for hourly operations.

655

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.

656

"hoursInCycle": 42, # Defines a schedule with units measured in hours. The value determines how many hours pass between the start of each cycle.

657

"startTime": "A String", # Time within the window to start the operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-00] GMT.

Dan O'Meara

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

[diff] [blame]

658

},

Bu Sun Kim

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

[diff] [blame]

659

"weeklySchedule": { # Time window specified for weekly operations.

660

"dayOfWeeks": [ # Up to 7 intervals/windows, one for each day of the week.

661

{

662

"day": "A String", # Defines a schedule that runs on specific days of the week. Specify one or more days. The following options are available: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.

663

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.

664

"startTime": "A String", # Time within the window to start the operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-00] GMT.

665

},

Bu Sun Kim

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

[diff] [blame]

666

],

Bu Sun Kim

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

[diff] [blame]

667

},

668

},

Bu Sun Kim

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

[diff] [blame]

669

"snapshotProperties": { # Specified snapshot properties for scheduled snapshots created by this policy. # Properties with which snapshots are created such as labels, encryption keys.

670

"guestFlush": True or False, # Indication to perform a 'guest aware' snapshot.

671

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

672

"a_key": "A String",

673

},

674

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

"A String",

],

},

},

"status": "A String", # [Output Only] The status of resource policy creation.

680

"vmMaintenancePolicy": { # Resource policy applicable to VMs for infrastructure maintenance.

681

"concurrencyControlGroup": { # A concurrency control configuration. Defines a group config that, when attached to an instance, recognizes that instance as part of a group of instances where only up the concurrency_limit of instances in that group can undergo simultaneous maintenance. For more information: go/concurrency-control-design-doc

682

"concurrencyLimit": 42,

683

},

684

"maintenanceWindow": { # A maintenance window for VMs. When set, we restrict our maintenance operations to this window. # Maintenance windows that are applied to VMs covered by this policy.

685

"dailyMaintenanceWindow": { # Time window specified for daily operations.

686

"daysInCycle": 42, # Defines a schedule with units measured in months. The value determines how many months pass between the start of each cycle.

687

"duration": "A String", # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.

688

"startTime": "A String", # Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.

},

},

},

}

Bu Sun Kim

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

[diff] [blame]

693

694

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.

695

696

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.

697

698

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

699

700

Returns:

701

An object of the form:

702

703

{ # Represents an Operation resource.

704

#

Dan O'Meara

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

[diff] [blame]

705

# Google Compute Engine has three Operation resources:

706

#

707

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

708

#

Bu Sun Kim

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

[diff] [blame]

709

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

710

#

711

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

712

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

713

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

714

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

Bu Sun Kim

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

[diff] [blame]

715

#

Dan O'Meara

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

[diff] [blame]

716

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

717

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

718

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

719

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

720

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

721

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

722

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

Bu Sun Kim

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

[diff] [blame]

723

{

Bu Sun Kim

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

[diff] [blame]

724

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

725

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

726

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

Bu Sun Kim

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

[diff] [blame]

727

},

728

],

729

},

Bu Sun Kim

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

[diff] [blame]

730

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

731

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

732

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

733

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

734

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

735

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

736

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

737

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

738

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

739

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

740

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

741

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

742

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

743

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

744

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

745

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

746

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

747

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

748

{

749

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

750

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

751

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

752

{

753

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

754

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

755

},

756

],

757

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

758

},

759

],

760

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

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]

765

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

Bu Sun Kim

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

[diff] [blame]

766

<pre>A list all the resource policies that have been configured for the specified project in specified region.

767

768

Args:

769

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

770

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

Dan O'Meara

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

[diff] [blame]

771

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

Bu Sun Kim

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

[diff] [blame]

772

Dan O'Meara

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

[diff] [blame]

773

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

Bu Sun Kim

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

[diff] [blame]

774

Dan O'Meara

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

[diff] [blame]

775

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

Bu Sun Kim

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

[diff] [blame]

776

Bu Sun Kim

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

[diff] [blame]

777

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

778

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

779

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

780

781

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.

782

783

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

784

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.

785

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

Bu Sun Kim

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

[diff] [blame]

786

787

Returns:

788

An object of the form:

789

790

{

Bu Sun Kim

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

[diff] [blame]

791

"etag": "A String",

792

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

793

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

Dan O'Meara

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

[diff] [blame]

794

{ # Represents a Resource Policy resource. You can use resource policies to schedule actions for some Compute Engine resources. For example, you can use them to schedule persistent disk snapshots.

Bu Sun Kim

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

[diff] [blame]

795

#

796

# (== resource_for {$api_version}.resourcePolicies ==)

797

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

798

"description": "A String",

799

"groupPlacementPolicy": { # A GroupPlacementPolicy specifies resource placement configuration. It specifies the failure bucket separation as well as network locality # Resource policy for instacnes for placement configuration.

800

"availabilityDomainCount": 42, # The number of availability domains instances will be spread across. If two instances are in different availability domain, they will not be put in the same low latency network

801

"collocation": "A String", # Specifies network collocation

802

"locality": "A String", # Specifies network locality

803

"style": "A String", # Specifies instances to hosts placement relationship

804

"vmCount": 42, # Number of vms in this placement group

Bu Sun Kim

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

[diff] [blame]

805

},

Bu Sun Kim

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

[diff] [blame]

806

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

807

"kind": "compute#resourcePolicy", # [Output Only] Type of the resource. Always compute#resource_policies for resource policies.

808

"name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

809

"region": "A String",

810

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

811

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

812

"snapshotSchedulePolicy": { # A snapshot schedule policy specifies when and how frequently snapshots are to be created for the target disk. Also specifies how many and how long these scheduled snapshots should be retained. # Resource policy for persistent disks for creating snapshots.

813

"retentionPolicy": { # Policy for retention of scheduled snapshots. # Retention policy applied to snapshots created by this resource policy.

814

"maxRetentionDays": 42, # Maximum age of the snapshot that is allowed to be kept.

815

"onPolicySwitch": "A String", # Specifies the behavior to apply to existing, scheduled snapshots snapshots if the policy is changed.

816

"onSourceDiskDelete": "A String", # Specifies the behavior to apply to scheduled snapshots when the source disk is deleted.

817

},

818

"schedule": { # A schedule for disks where the schedueled operations are performed. # A Vm Maintenance Policy specifies what kind of infrastructure maintenance we are allowed to perform on this VM and when. Schedule that is applied to disks covered by this policy.

819

"dailySchedule": { # Time window specified for daily operations.

820

"daysInCycle": 42, # Defines a schedule with units measured in months. The value determines how many months pass between the start of each cycle.

821

"duration": "A String", # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.

822

"startTime": "A String", # Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.

823

},

824

"hourlySchedule": { # Time window specified for hourly operations.

825

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.

826

"hoursInCycle": 42, # Defines a schedule with units measured in hours. The value determines how many hours pass between the start of each cycle.

827

"startTime": "A String", # Time within the window to start the operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-00] GMT.

828

},

829

"weeklySchedule": { # Time window specified for weekly operations.

830

"dayOfWeeks": [ # Up to 7 intervals/windows, one for each day of the week.

831

{

832

"day": "A String", # Defines a schedule that runs on specific days of the week. Specify one or more days. The following options are available: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.

833

"duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.

834

"startTime": "A String", # Time within the window to start the operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-00] GMT.

},

],

},

},

"snapshotProperties": { # Specified snapshot properties for scheduled snapshots created by this policy. # Properties with which snapshots are created such as labels, encryption keys.

840

"guestFlush": True or False, # Indication to perform a 'guest aware' snapshot.

841

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

842

"a_key": "A String",

843

},

844

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

"A String",

],

},

},

"status": "A String", # [Output Only] The status of resource policy creation.

850

"vmMaintenancePolicy": { # Resource policy applicable to VMs for infrastructure maintenance.

851

"concurrencyControlGroup": { # A concurrency control configuration. Defines a group config that, when attached to an instance, recognizes that instance as part of a group of instances where only up the concurrency_limit of instances in that group can undergo simultaneous maintenance. For more information: go/concurrency-control-design-doc

852

"concurrencyLimit": 42,

853

},

854

"maintenanceWindow": { # A maintenance window for VMs. When set, we restrict our maintenance operations to this window. # Maintenance windows that are applied to VMs covered by this policy.

855

"dailyMaintenanceWindow": { # Time window specified for daily operations.

856

"daysInCycle": 42, # Defines a schedule with units measured in months. The value determines how many months pass between the start of each cycle.

857

"duration": "A String", # [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.

858

"startTime": "A String", # Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.

},

},

},

},

Bu Sun Kim

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

[diff] [blame]

863

],

Bu Sun Kim

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

[diff] [blame]

864

"kind": "compute#resourcePolicyList", # [Output Only] Type of resource.Always compute#resourcePoliciesList for listsof resourcePolicies

865

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

866

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

867

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

868

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

869

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

870

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

Bu Sun Kim

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

[diff] [blame]

871

{

Bu Sun Kim

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

[diff] [blame]

872

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

873

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

874

},

875

],

Bu Sun Kim

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

[diff] [blame]

876

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

877

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

883

<pre>Retrieves the next page of results.

884

885

Args:

886

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

887

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

888

889

Returns:

Bu Sun Kim

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

[diff] [blame]

890

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

Bu Sun Kim

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

[diff] [blame]

891

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

</pre>

</div>

Dan O'Meara

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

[diff] [blame]

896

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

Bu Sun Kim

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

[diff] [blame]

897

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

898

899

Args:

900

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

901

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

902

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

Dan O'Meara

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

[diff] [blame]

903

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

904

The object takes the form of:

905

906

{

Bu Sun Kim

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

[diff] [blame]

907

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

908

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

909

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

910

#

911

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

912

#

913

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

914

#

915

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

916

#

917

# Example (Comparison):

918

#

919

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

920

#

921

# Example (Equality):

922

#

923

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

928

#

929

# Example (Data Manipulation):

930

#

931

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

932

#

933

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

934

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

935

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

936

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

937

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

938

},

939

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

940

#

941

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

942

#

943

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

944

#

945

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

950

#

951

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

952

#

953

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

954

#

955

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

956

#

957

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

962

"A String",

963

],

964

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

965

},

966

],

967

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

968

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

969

#

970

#

971

#

Dan O'Meara

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

[diff] [blame]

972

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

973

#

Bu Sun Kim

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

[diff] [blame]

974

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

975

#

Dan O'Meara

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

[diff] [blame]

976

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

977

#

Bu Sun Kim

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

[diff] [blame]

978

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

979

#

Dan O'Meara

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

[diff] [blame]

980

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

981

#

Bu Sun Kim

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

[diff] [blame]

982

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

983

#

Dan O'Meara

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

[diff] [blame]

984

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

985

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

Bu Sun Kim

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

[diff] [blame]

986

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

987

#

988

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

989

#

990

# Example Policy with multiple AuditConfigs:

991

#

Bu Sun Kim

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

[diff] [blame]

992

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

993

#

Dan O'Meara

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

[diff] [blame]

994

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

995

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

Bu Sun Kim

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

[diff] [blame]

996

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

997

#

Bu Sun Kim

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

[diff] [blame]

998

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

999

#

Bu Sun Kim

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

[diff] [blame]

1000

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

1001

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

1002

"A String",

Bu Sun Kim

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

[diff] [blame]

1003

],

Bu Sun Kim

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

[diff] [blame]

1004

"ignoreChildExemptions": True or False,

1005

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

Bu Sun Kim

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

[diff] [blame]

1006

},

1007

],

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]

1012

},

1013

],

Bu Sun Kim

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

[diff] [blame]

1014

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

1015

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

Bu Sun Kim

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

[diff] [blame]

1016

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

1017

#

1018

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

1019

#

1020

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

1021

#

1022

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

1023

#

1024

# Example (Comparison):

1025

#

1026

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

1027

#

1028

# Example (Equality):

1029

#

1030

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

1035

#

1036

# Example (Data Manipulation):

1037

#

1038

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

1039

#

1040

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

1041

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

1042

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

1043

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

1044

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

1045

},

1046

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

1047

#

1048

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

1049

#

1050

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

1051

#

Dan O'Meara

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

[diff] [blame]

1052

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

1057

#

1058

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

1059

#

Dan O'Meara

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

[diff] [blame]

1060

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

1061

#

1062

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

1063

#

1064

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

1065

#

Bu Sun Kim

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

[diff] [blame]

1066

#

1067

#

1068

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

1069

"A String",

Bu Sun Kim

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

[diff] [blame]

1070

],

Bu Sun Kim

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

[diff] [blame]

1071

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

1072

},

1073

],

Bu Sun Kim

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

[diff] [blame]

1074

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

1075

#

1076

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

1077

"iamOwned": True or False,

1078

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

1079

{ # A rule to be applied in a Policy.

1080

"action": "A String", # Required

1081

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

1082

{ # A condition to be met.

1083

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

1084

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

1085

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

1086

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

1087

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

"A String",

],

},

],

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

1093

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

1094

"A String",

1095

],

1096

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

1097

{ # Specifies what kind of log the caller must write

1098

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

1099

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

1100

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

1101

},

1102

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

1103

},

1104

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

1105

#

1106

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

1107

#

1108

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

1109

#

1110

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

1111

#

1112

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

1113

"customFields": [ # Custom fields.

1114

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

1115

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

1116

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

1117

},

1118

],

1119

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

1120

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

1121

},

1122

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

1123

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

1128

"A String",

1129

],

1130

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

1131

"A String",

1132

],

Bu Sun Kim

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

[diff] [blame]

1133

},

Bu Sun Kim

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

[diff] [blame]

1134

],

1135

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

1136

#

1137

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

1138

#

1139

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

1140

#

1141

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

1142

#

1143

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

1144

#

1145

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

1146

#

1147

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

1148

},

Bu Sun Kim

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

[diff] [blame]

}

Returns:

An object of the form:

1154

Dan O'Meara

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

[diff] [blame]

1155

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

1156

#

1157

#

1158

#

Dan O'Meara

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

[diff] [blame]

1159

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

1160

#

Bu Sun Kim

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

[diff] [blame]

1161

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

1162

#

Dan O'Meara

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

[diff] [blame]

1163

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

1164

#

Bu Sun Kim

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

[diff] [blame]

1165

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

1166

#

Dan O'Meara

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

[diff] [blame]

1167

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

1168

#

Bu Sun Kim

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

[diff] [blame]

1169

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

1170

#

Dan O'Meara

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

[diff] [blame]

1171

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

1172

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

Bu Sun Kim

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

[diff] [blame]

1173

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

1174

#

1175

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

1176

#

1177

# Example Policy with multiple AuditConfigs:

1178

#

Bu Sun Kim

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

[diff] [blame]

1179

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

1180

#

Dan O'Meara

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

[diff] [blame]

1181

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

1182

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

Bu Sun Kim

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

[diff] [blame]

1183

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

1184

#

Bu Sun Kim

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

[diff] [blame]

1185

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

1186

#

Bu Sun Kim

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

[diff] [blame]

1187

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

1188

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

1189

"A String",

Bu Sun Kim

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

[diff] [blame]

1190

],

Bu Sun Kim

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

[diff] [blame]

1191

"ignoreChildExemptions": True or False,

1192

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

Bu Sun Kim

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

[diff] [blame]

1193

},

1194

],

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]

1199

},

1200

],

Bu Sun Kim

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

[diff] [blame]

1201

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

1202

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

Bu Sun Kim

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

[diff] [blame]

1203

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

1204

#

1205

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

1206

#

1207

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

1208

#

1209

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

1210

#

1211

# Example (Comparison):

1212

#

1213

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

1214

#

1215

# Example (Equality):

1216

#

1217

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

1222

#

1223

# Example (Data Manipulation):

1224

#

1225

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

1226

#

1227

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

1228

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

1229

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

1230

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

1231

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

1232

},

1233

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

1234

#

1235

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

1236

#

1237

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

1238

#

Dan O'Meara

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

[diff] [blame]

1239

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

1244

#

1245

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

1246

#

Dan O'Meara

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

[diff] [blame]

1247

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

1248

#

1249

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

1250

#

1251

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

1252

#

Bu Sun Kim

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

[diff] [blame]

1253

#

1254

#

1255

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

1256

"A String",

Bu Sun Kim

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

[diff] [blame]

1257

],

Bu Sun Kim

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

[diff] [blame]

1258

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

1259

},

1260

],

Bu Sun Kim

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

[diff] [blame]

1261

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

1262

#

1263

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

1264

"iamOwned": True or False,

1265

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

1266

{ # A rule to be applied in a Policy.

1267

"action": "A String", # Required

1268

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

1269

{ # A condition to be met.

1270

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

1271

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

1272

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

1273

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

1274

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

"A String",

],

},

],

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

1280

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

1281

"A String",

1282

],

1283

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

1284

{ # Specifies what kind of log the caller must write

1285

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

1286

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

1287

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

1288

},

1289

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

1290

},

1291

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

1292

#

1293

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

1294

#

1295

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

1296

#

1297

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

1298

#

1299

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

1300

"customFields": [ # Custom fields.

1301

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

1302

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

1303

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

1304

},

1305

],

1306

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

1307

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

1308

},

1309

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

1310

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

1315

"A String",

1316

],

1317

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

1323

#

1324

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

1325

#

1326

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

1327

#

1328

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

1329

#

1330

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

1331

#

1332

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

1333

#

1334

# 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