Blame - docs/dyn/compute_v1.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

Dmitry Frenkel

3e17f89

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

[diff] [blame]

84

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

85

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

86

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

87

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

Bu Sun Kim

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

[diff] [blame]

88

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

89

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

90

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

Bu Sun Kim

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

[diff] [blame]

91

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

92

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

93

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

Dan O'Meara

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

[diff] [blame]

94

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

95

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

96

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

Bu Sun Kim

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

[diff] [blame]

97

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

98

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

99

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

Bu Sun Kim

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

[diff] [blame]

100

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

101

102

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

103

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

104

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

105

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

Dan O'Meara

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

[diff] [blame]

106

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

107

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

108

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

Bu Sun Kim

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

[diff] [blame]

109

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

110

<h3>Method Details</h3>

111

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

112

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

Bu Sun Kim

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

[diff] [blame]

113

<pre>Retrieves an aggregated list of resource policies.

114

115

Args:

116

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

117

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. 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. 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]

118

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]

119

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

120

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported.

Bu Sun Kim

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

[diff] [blame]

121

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

yoshi-code-bot

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

[diff] [blame]

122

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

123

x__xgafv: string, V1 error format.

124

Allowed values

125

1 - v1 error format

126

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

127

128

Returns:

129

An object of the form:

130

131

{ # Contains a list of resourcePolicies.

Yoshi Automation Bot

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

[diff] [blame]

132

"etag": "A String",

133

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

134

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

135

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

136

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

137

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

Yoshi Automation Bot

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

[diff] [blame]

138

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

139

"description": "A String",

140

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

141

"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

142

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

143

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

144

},

145

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

yoshi-code-bot

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

[diff] [blame]

146

"instanceSchedulePolicy": { # An InstanceSchedulePolicy specifies when and how frequent certain operations are performed on the instance. # Resource policy for scheduling instance operations.

147

"expirationTime": "A String", # The expiration time of the schedule. The timestamp is an RFC3339 string.

148

"startTime": "A String", # The start time of the schedule. The timestamp is an RFC3339 string.

149

"timeZone": "A String", # Specifies the time zone to be used in interpreting Schedule.schedule. The value of this field must be a time zone name from the tz database: http://en.wikipedia.org/wiki/Tz_database.

150

"vmStartSchedule": { # Schedule for an instance operation. # Specifies the schedule for starting instances.

151

"schedule": "A String", # Specifies the frequency for the operation, using the unix-cron format.

152

},

153

"vmStopSchedule": { # Schedule for an instance operation. # Specifies the schedule for stopping instances.

154

"schedule": "A String", # Specifies the frequency for the operation, using the unix-cron format.

155

},

156

},

Yoshi Automation Bot

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

[diff] [blame]

157

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

158

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

159

"region": "A String",

yoshi-code-bot

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

[diff] [blame]

160

"resourceStatus": { # Contains output only fields. Use this sub-message for all output fields set on ResourcePolicy. The internal structure of this "status" field should mimic the structure of ResourcePolicy proto specification. # [Output Only] The system status of the resource policy.

161

"instanceSchedulePolicy": { # [Output Only] Specifies a set of output values reffering to the instance_schedule_policy system status. This field should have the same name as corresponding policy field.

162

"lastRunStartTime": "A String", # [Output Only] The last time the schedule successfully ran. The timestamp is an RFC3339 string.

163

"nextRunStartTime": "A String", # [Output Only] The next time the schedule is planned to run. The actual time might be slightly different. The timestamp is an RFC3339 string.

164

},

165

},

Yoshi Automation Bot

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

[diff] [blame]

166

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

167

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

168

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

169

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

170

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

171

},

Yoshi Automation Bot

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

[diff] [blame]

172

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

173

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

174

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

175

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

176

"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

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

[diff] [blame]

177

},

Yoshi Automation Bot

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

[diff] [blame]

178

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

179

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

180

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

181

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

Bu Sun Kim

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

[diff] [blame]

182

},

Yoshi Automation Bot

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

[diff] [blame]

183

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

184

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

185

{

186

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

187

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

188

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

189

},

Bu Sun Kim

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

[diff] [blame]

190

],

191

},

192

},

Yoshi Automation Bot

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

[diff] [blame]

193

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

194

"chainName": "A String", # Chain name that the snapshot is created in.

195

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

196

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

197

"a_key": "A String",

198

},

199

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

200

"A String",

201

],

Bu Sun Kim

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

[diff] [blame]

202

},

Yoshi Automation Bot

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

[diff] [blame]

203

},

204

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

Bu Sun Kim

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

[diff] [blame]

205

},

206

],

Yoshi Automation Bot

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

[diff] [blame]

207

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

208

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

209

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

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

[diff] [blame]

210

{

211

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

212

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

213

},

214

],

215

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

216

},

Bu Sun Kim

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

[diff] [blame]

217

},

Yoshi Automation Bot

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

[diff] [blame]

218

},

219

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

220

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

221

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

222

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

223

"A String",

224

],

225

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

226

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

227

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

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

[diff] [blame]

228

{

229

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

230

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

231

},

232

],

233

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

234

},

235

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

240

<pre>Retrieves the next page of results.

241

242

Args:

243

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

244

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

245

246

Returns:

Bu Sun Kim

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

[diff] [blame]

247

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]

248

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

</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

253

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

254

<pre>Close httplib2 connections.</pre>

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

258

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

Bu Sun Kim

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

[diff] [blame]

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)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

266

x__xgafv: string, V1 error format.

267

Allowed values

268

1 - v1 error format

269

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

270

271

Returns:

272

An object of the form:

273

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

274

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

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

[diff] [blame]

275

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

276

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

277

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

278

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

279

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

280

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

Bu Sun Kim

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

[diff] [blame]

281

{

Yoshi Automation Bot

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

[diff] [blame]

282

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

283

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

284

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

Bu Sun Kim

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

[diff] [blame]

285

},

286

],

Yoshi Automation Bot

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

[diff] [blame]

287

},

288

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

289

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

290

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

291

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

292

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

293

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

yoshi-code-bot

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

[diff] [blame]

294

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

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

[diff] [blame]

295

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

296

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

297

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

298

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

299

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

300

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

301

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

302

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

303

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

304

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

305

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

306

{

307

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

308

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

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

[diff] [blame]

309

{

310

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

311

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

312

},

313

],

314

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

315

},

316

],

317

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

318

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

322

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

Bu Sun Kim

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

[diff] [blame]

323

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

324

325

Args:

326

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

327

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

328

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

329

x__xgafv: string, V1 error format.

330

Allowed values

331

1 - v1 error format

332

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

333

334

Returns:

335

An object of the form:

336

Dan O'Meara

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

[diff] [blame]

337

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

Yoshi Automation Bot

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

[diff] [blame]

338

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

339

"description": "A String",

340

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

341

"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

342

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

343

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

344

},

345

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

yoshi-code-bot

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

[diff] [blame]

346

"instanceSchedulePolicy": { # An InstanceSchedulePolicy specifies when and how frequent certain operations are performed on the instance. # Resource policy for scheduling instance operations.

347

"expirationTime": "A String", # The expiration time of the schedule. The timestamp is an RFC3339 string.

348

"startTime": "A String", # The start time of the schedule. The timestamp is an RFC3339 string.

349

"timeZone": "A String", # Specifies the time zone to be used in interpreting Schedule.schedule. The value of this field must be a time zone name from the tz database: http://en.wikipedia.org/wiki/Tz_database.

350

"vmStartSchedule": { # Schedule for an instance operation. # Specifies the schedule for starting instances.

351

"schedule": "A String", # Specifies the frequency for the operation, using the unix-cron format.

352

},

353

"vmStopSchedule": { # Schedule for an instance operation. # Specifies the schedule for stopping instances.

354

"schedule": "A String", # Specifies the frequency for the operation, using the unix-cron format.

355

},

356

},

Yoshi Automation Bot

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

[diff] [blame]

357

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

358

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

359

"region": "A String",

yoshi-code-bot

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

[diff] [blame]

360

"resourceStatus": { # Contains output only fields. Use this sub-message for all output fields set on ResourcePolicy. The internal structure of this "status" field should mimic the structure of ResourcePolicy proto specification. # [Output Only] The system status of the resource policy.

361

"instanceSchedulePolicy": { # [Output Only] Specifies a set of output values reffering to the instance_schedule_policy system status. This field should have the same name as corresponding policy field.

362

"lastRunStartTime": "A String", # [Output Only] The last time the schedule successfully ran. The timestamp is an RFC3339 string.

363

"nextRunStartTime": "A String", # [Output Only] The next time the schedule is planned to run. The actual time might be slightly different. The timestamp is an RFC3339 string.

364

},

365

},

Yoshi Automation Bot

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

[diff] [blame]

366

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

367

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

368

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

369

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

370

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

Bu Sun Kim

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

[diff] [blame]

371

},

Yoshi Automation Bot

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

[diff] [blame]

372

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

373

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

374

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

375

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

376

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

Dan O'Meara

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

[diff] [blame]

377

},

Yoshi Automation Bot

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

[diff] [blame]

378

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

379

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

380

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

381

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

Bu Sun Kim

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

[diff] [blame]

382

},

Yoshi Automation Bot

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

[diff] [blame]

383

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

384

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

385

{

386

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

387

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

388

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

389

},

Bu Sun Kim

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

[diff] [blame]

390

],

391

},

392

},

Yoshi Automation Bot

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

[diff] [blame]

393

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

394

"chainName": "A String", # Chain name that the snapshot is created in.

395

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

396

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

397

"a_key": "A String",

398

},

399

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

405

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

409

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

Dan O'Meara

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

[diff] [blame]

410

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

411

412

Args:

413

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

414

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

415

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

Dmitry Frenkel

3e17f89

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

[diff] [blame]

416

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

417

x__xgafv: string, V1 error format.

418

Allowed values

419

1 - v1 error format

420

2 - v2 error format

Dan O'Meara

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

[diff] [blame]

421

422

Returns:

423

An object of the form:

424

yoshi-code-bot

8bb904c

2021-08-31 00:28:27 -0700

[diff] [blame]

425

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Yoshi Automation Bot

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

[diff] [blame]

426

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

427

{ # 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. 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. Example Policy with multiple AuditConfigs: { "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" ] } ] } ] } 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.

Yoshi Automation Bot

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

[diff] [blame]

428

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

429

{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

430

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

Yoshi Automation Bot

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

[diff] [blame]

431

"A String",

432

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

433

"ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

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

[diff] [blame]

434

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

Bu Sun Kim

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

[diff] [blame]

435

},

Yoshi Automation Bot

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

[diff] [blame]

436

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

437

"exemptedMembers": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

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

[diff] [blame]

438

"A String",

439

],

440

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

441

},

442

],

443

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

444

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

445

"bindingId": "A String", # This is deprecated and has no effect. Do not use.

446

"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. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): 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'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. 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. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Yoshi Automation Bot

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

[diff] [blame]

447

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

448

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

449

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

450

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

Dan O'Meara

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

[diff] [blame]

451

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

452

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `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`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `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. * `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. * `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`.

Yoshi Automation Bot

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

[diff] [blame]

453

"A String",

454

],

455

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

456

},

457

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

458

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

459

"iamOwned": True or False, # This is deprecated and has no effect. Do not use.

460

"rules": [ # This is deprecated and has no effect. Do not use.

461

{ # This is deprecated and has no effect. Do not use.

462

"action": "A String", # This is deprecated and has no effect. Do not use.

463

"conditions": [ # This is deprecated and has no effect. Do not use.

464

{ # This is deprecated and has no effect. Do not use.

465

"iam": "A String", # This is deprecated and has no effect. Do not use.

466

"op": "A String", # This is deprecated and has no effect. Do not use.

467

"svc": "A String", # This is deprecated and has no effect. Do not use.

468

"sys": "A String", # This is deprecated and has no effect. Do not use.

469

"values": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

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

[diff] [blame]

"A String",

],

},

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

474

"description": "A String", # This is deprecated and has no effect. Do not use.

475

"ins": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

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

[diff] [blame]

476

"A String",

477

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

478

"logConfigs": [ # This is deprecated and has no effect. Do not use.

479

{ # This is deprecated and has no effect. Do not use.

480

"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

481

"authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

482

"permissionType": "A String", # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

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

[diff] [blame]

483

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

484

"logName": "A String", # This is deprecated and has no effect. Do not use.

Bu Sun Kim

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

[diff] [blame]

485

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

486

"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

487

"customFields": [ # This is deprecated and has no effect. Do not use.

488

{ # This is deprecated and has no effect. Do not use.

489

"name": "A String", # This is deprecated and has no effect. Do not use.

490

"value": "A String", # This is deprecated and has no effect. Do not use.

Bu Sun Kim

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

[diff] [blame]

491

},

Yoshi Automation Bot

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

[diff] [blame]

492

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

493

"field": "A String", # This is deprecated and has no effect. Do not use.

494

"metric": "A String", # This is deprecated and has no effect. Do not use.

Bu Sun Kim

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

[diff] [blame]

495

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

496

"dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

497

"logMode": "A String", # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

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

[diff] [blame]

498

},

499

},

500

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

501

"notIns": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

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

[diff] [blame]

502

"A String",

503

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

504

"permissions": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

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

[diff] [blame]

"A String",

],

},

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

509

"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * 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 **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. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Yoshi Automation Bot

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

[diff] [blame]

510

}</pre>

Dan O'Meara

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

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

514

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

Bu Sun Kim

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

[diff] [blame]

515

<pre>Creates a new resource policy.

516

517

Args:

518

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

519

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

Dan O'Meara

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

[diff] [blame]

520

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

521

The object takes the form of:

522

Dan O'Meara

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

[diff] [blame]

523

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

524

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

525

"description": "A String",

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

526

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

Bu Sun Kim

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

[diff] [blame]

527

"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

528

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

529

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

530

},

531

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

yoshi-code-bot

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

[diff] [blame]

532

"instanceSchedulePolicy": { # An InstanceSchedulePolicy specifies when and how frequent certain operations are performed on the instance. # Resource policy for scheduling instance operations.

533

"expirationTime": "A String", # The expiration time of the schedule. The timestamp is an RFC3339 string.

534

"startTime": "A String", # The start time of the schedule. The timestamp is an RFC3339 string.

535

"timeZone": "A String", # Specifies the time zone to be used in interpreting Schedule.schedule. The value of this field must be a time zone name from the tz database: http://en.wikipedia.org/wiki/Tz_database.

536

"vmStartSchedule": { # Schedule for an instance operation. # Specifies the schedule for starting instances.

537

"schedule": "A String", # Specifies the frequency for the operation, using the unix-cron format.

538

},

539

"vmStopSchedule": { # Schedule for an instance operation. # Specifies the schedule for stopping instances.

540

"schedule": "A String", # Specifies the frequency for the operation, using the unix-cron format.

541

},

542

},

Bu Sun Kim

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

[diff] [blame]

543

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

544

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

545

"region": "A String",

yoshi-code-bot

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

[diff] [blame]

546

"resourceStatus": { # Contains output only fields. Use this sub-message for all output fields set on ResourcePolicy. The internal structure of this "status" field should mimic the structure of ResourcePolicy proto specification. # [Output Only] The system status of the resource policy.

547

"instanceSchedulePolicy": { # [Output Only] Specifies a set of output values reffering to the instance_schedule_policy system status. This field should have the same name as corresponding policy field.

548

"lastRunStartTime": "A String", # [Output Only] The last time the schedule successfully ran. The timestamp is an RFC3339 string.

549

"nextRunStartTime": "A String", # [Output Only] The next time the schedule is planned to run. The actual time might be slightly different. The timestamp is an RFC3339 string.

550

},

551

},

Bu Sun Kim

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

[diff] [blame]

552

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

553

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

554

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

555

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

556

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

Dan O'Meara

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

[diff] [blame]

557

},

Bu Sun Kim

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

[diff] [blame]

558

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

559

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

560

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

561

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

562

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

563

},

564

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

565

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

566

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

567

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

568

},

569

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

570

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

571

{

572

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

573

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

574

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

575

},

Bu Sun Kim

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

[diff] [blame]

576

],

Bu Sun Kim

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

[diff] [blame]

577

},

578

},

Bu Sun Kim

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

[diff] [blame]

579

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

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

580

"chainName": "A String", # Chain name that the snapshot is created in.

Bu Sun Kim

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

[diff] [blame]

581

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

582

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

583

"a_key": "A String",

584

},

585

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

591

}

Bu Sun Kim

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

[diff] [blame]

592

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

593

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

594

x__xgafv: string, V1 error format.

595

Allowed values

596

1 - v1 error format

597

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

598

599

Returns:

600

An object of the form:

601

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

602

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

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

[diff] [blame]

603

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

604

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

605

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

606

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

607

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

608

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

Bu Sun Kim

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

[diff] [blame]

609

{

Yoshi Automation Bot

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

[diff] [blame]

610

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

611

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

612

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

Bu Sun Kim

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

[diff] [blame]

613

},

614

],

Yoshi Automation Bot

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

[diff] [blame]

615

},

616

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

617

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

618

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

619

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

620

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

621

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

yoshi-code-bot

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

[diff] [blame]

622

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

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

[diff] [blame]

623

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

624

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

625

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

626

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

627

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

628

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

629

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

630

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

631

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

632

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

633

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

634

{

635

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

636

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

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

[diff] [blame]

637

{

638

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

639

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

640

},

641

],

642

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

643

},

644

],

645

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

646

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

650

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

Bu Sun Kim

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

[diff] [blame]

651

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

652

653

Args:

654

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

655

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

656

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 `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. 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. 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) ```

Bu Sun Kim

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

[diff] [blame]

657

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

658

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported.

Bu Sun Kim

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

[diff] [blame]

659

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

yoshi-code-bot

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

[diff] [blame]

660

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

661

x__xgafv: string, V1 error format.

662

Allowed values

663

1 - v1 error format

664

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

665

666

Returns:

667

An object of the form:

668

669

{

Yoshi Automation Bot

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

[diff] [blame]

670

"etag": "A String",

671

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

672

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

673

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

Yoshi Automation Bot

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

[diff] [blame]

674

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

675

"description": "A String",

676

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

677

"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

678

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

679

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

680

},

681

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

yoshi-code-bot

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

[diff] [blame]

682

"instanceSchedulePolicy": { # An InstanceSchedulePolicy specifies when and how frequent certain operations are performed on the instance. # Resource policy for scheduling instance operations.

683

"expirationTime": "A String", # The expiration time of the schedule. The timestamp is an RFC3339 string.

684

"startTime": "A String", # The start time of the schedule. The timestamp is an RFC3339 string.

685

"timeZone": "A String", # Specifies the time zone to be used in interpreting Schedule.schedule. The value of this field must be a time zone name from the tz database: http://en.wikipedia.org/wiki/Tz_database.

686

"vmStartSchedule": { # Schedule for an instance operation. # Specifies the schedule for starting instances.

687

"schedule": "A String", # Specifies the frequency for the operation, using the unix-cron format.

688

},

689

"vmStopSchedule": { # Schedule for an instance operation. # Specifies the schedule for stopping instances.

690

"schedule": "A String", # Specifies the frequency for the operation, using the unix-cron format.

691

},

692

},

Yoshi Automation Bot

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

[diff] [blame]

693

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

694

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

695

"region": "A String",

yoshi-code-bot

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

[diff] [blame]

696

"resourceStatus": { # Contains output only fields. Use this sub-message for all output fields set on ResourcePolicy. The internal structure of this "status" field should mimic the structure of ResourcePolicy proto specification. # [Output Only] The system status of the resource policy.

697

"instanceSchedulePolicy": { # [Output Only] Specifies a set of output values reffering to the instance_schedule_policy system status. This field should have the same name as corresponding policy field.

698

"lastRunStartTime": "A String", # [Output Only] The last time the schedule successfully ran. The timestamp is an RFC3339 string.

699

"nextRunStartTime": "A String", # [Output Only] The next time the schedule is planned to run. The actual time might be slightly different. The timestamp is an RFC3339 string.

700

},

701

},

Yoshi Automation Bot

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

[diff] [blame]

702

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

703

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

704

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

705

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

706

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

707

},

Yoshi Automation Bot

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

[diff] [blame]

708

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

709

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

710

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

711

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

712

"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

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

[diff] [blame]

713

},

Yoshi Automation Bot

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

[diff] [blame]

714

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

715

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

716

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

717

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

Bu Sun Kim

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

[diff] [blame]

718

},

Yoshi Automation Bot

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

[diff] [blame]

719

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

720

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

721

{

722

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

723

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

724

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

725

},

Bu Sun Kim

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

[diff] [blame]

726

],

727

},

728

},

Yoshi Automation Bot

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

[diff] [blame]

729

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

730

"chainName": "A String", # Chain name that the snapshot is created in.

731

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

732

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

733

"a_key": "A String",

734

},

735

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

741

},

742

],

743

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

744

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

745

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

746

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

747

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

748

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

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

[diff] [blame]

749

{

750

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

751

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

Bu Sun Kim

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

[diff] [blame]

752

},

Bu Sun Kim

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

[diff] [blame]

753

],

Yoshi Automation Bot

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

[diff] [blame]

754

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

755

},

756

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

761

<pre>Retrieves the next page of results.

762

763

Args:

764

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

765

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

766

767

Returns:

Bu Sun Kim

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

[diff] [blame]

768

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]

769

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

</pre>

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

774

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

Dan O'Meara

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

[diff] [blame]

775

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

776

777

Args:

778

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

779

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

780

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

781

body: object, The request body.

782

The object takes the form of:

783

784

{

Yoshi Automation Bot

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

[diff] [blame]

785

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

786

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

787

"bindingId": "A String", # This is deprecated and has no effect. Do not use.

788

"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. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): 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'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. 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. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Yoshi Automation Bot

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

[diff] [blame]

789

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

790

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

791

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

792

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

793

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

794

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `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`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `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. * `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. * `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`.

Yoshi Automation Bot

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

[diff] [blame]

795

"A String",

796

],

797

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

Bu Sun Kim

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

[diff] [blame]

798

},

Yoshi Automation Bot

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

[diff] [blame]

799

],

800

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

yoshi-code-bot

8bb904c

2021-08-31 00:28:27 -0700

[diff] [blame]

801

"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # 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

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

[diff] [blame]

802

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

803

{ # 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. 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. Example Policy with multiple AuditConfigs: { "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" ] } ] } ] } 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]

804

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

805

{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

806

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

Bu Sun Kim

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

[diff] [blame]

807

"A String",

Dan O'Meara

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

[diff] [blame]

808

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

809

"ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use.

Bu Sun Kim

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

[diff] [blame]

810

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

Dan O'Meara

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

[diff] [blame]

811

},

812

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

813

"exemptedMembers": [ # This is deprecated and has no effect. Do not use.

Bu Sun Kim

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

[diff] [blame]

814

"A String",

815

],

816

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

Dan O'Meara

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

[diff] [blame]

817

},

818

],

Bu Sun Kim

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

[diff] [blame]

819

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

Dan O'Meara

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

[diff] [blame]

820

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

821

"bindingId": "A String", # This is deprecated and has no effect. Do not use.

822

"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. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): 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'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. 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. 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

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

[diff] [blame]

823

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

824

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

825

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

826

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

827

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

828

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `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`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `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. * `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. * `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`.

Bu Sun Kim

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

[diff] [blame]

829

"A String",

Dan O'Meara

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

[diff] [blame]

830

],

Bu Sun Kim

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

[diff] [blame]

831

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

Dan O'Meara

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

[diff] [blame]

832

},

833

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

834

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

835

"iamOwned": True or False, # This is deprecated and has no effect. Do not use.

836

"rules": [ # This is deprecated and has no effect. Do not use.

837

{ # This is deprecated and has no effect. Do not use.

838

"action": "A String", # This is deprecated and has no effect. Do not use.

839

"conditions": [ # This is deprecated and has no effect. Do not use.

840

{ # This is deprecated and has no effect. Do not use.

841

"iam": "A String", # This is deprecated and has no effect. Do not use.

842

"op": "A String", # This is deprecated and has no effect. Do not use.

843

"svc": "A String", # This is deprecated and has no effect. Do not use.

844

"sys": "A String", # This is deprecated and has no effect. Do not use.

845

"values": [ # This is deprecated and has no effect. Do not use.

Bu Sun Kim

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

[diff] [blame]

"A String",

],

},

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

850

"description": "A String", # This is deprecated and has no effect. Do not use.

851

"ins": [ # This is deprecated and has no effect. Do not use.

Bu Sun Kim

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

[diff] [blame]

852

"A String",

853

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

854

"logConfigs": [ # This is deprecated and has no effect. Do not use.

855

{ # This is deprecated and has no effect. Do not use.

856

"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

857

"authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

858

"permissionType": "A String", # This is deprecated and has no effect. Do not use.

Bu Sun Kim

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

[diff] [blame]

859

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

860

"logName": "A String", # This is deprecated and has no effect. Do not use.

Bu Sun Kim

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

[diff] [blame]

861

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

862

"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

863

"customFields": [ # This is deprecated and has no effect. Do not use.

864

{ # This is deprecated and has no effect. Do not use.

865

"name": "A String", # This is deprecated and has no effect. Do not use.

866

"value": "A String", # This is deprecated and has no effect. Do not use.

Bu Sun Kim

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

[diff] [blame]

867

},

868

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

869

"field": "A String", # This is deprecated and has no effect. Do not use.

870

"metric": "A String", # This is deprecated and has no effect. Do not use.

Bu Sun Kim

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

[diff] [blame]

871

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

872

"dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

873

"logMode": "A String", # This is deprecated and has no effect. Do not use.

Bu Sun Kim

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

[diff] [blame]

874

},

875

},

876

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

877

"notIns": [ # This is deprecated and has no effect. Do not use.

Bu Sun Kim

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

[diff] [blame]

878

"A String",

879

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

880

"permissions": [ # This is deprecated and has no effect. Do not use.

Bu Sun Kim

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

[diff] [blame]

"A String",

],

},

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

885

"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * 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 **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. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Yoshi Automation Bot

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

[diff] [blame]

},

}

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

889

x__xgafv: string, V1 error format.

890

Allowed values

891

1 - v1 error format

892

2 - v2 error format

Yoshi Automation Bot

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

[diff] [blame]

893

894

Returns:

895

An object of the form:

896

yoshi-code-bot

8bb904c

2021-08-31 00:28:27 -0700

[diff] [blame]

897

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Yoshi Automation Bot

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

[diff] [blame]

898

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

899

{ # 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. 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. Example Policy with multiple AuditConfigs: { "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" ] } ] } ] } 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.

Yoshi Automation Bot

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

[diff] [blame]

900

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

901

{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

902

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

Yoshi Automation Bot

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

[diff] [blame]

903

"A String",

904

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

905

"ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

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

[diff] [blame]

906

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

907

},

908

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

909

"exemptedMembers": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

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

[diff] [blame]

910

"A String",

911

],

912

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

913

},

914

],

915

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

916

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

917

"bindingId": "A String", # This is deprecated and has no effect. Do not use.

918

"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. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): 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'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. 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. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Yoshi Automation Bot

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

[diff] [blame]

919

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

920

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

921

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

922

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

923

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

924

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `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`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `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. * `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. * `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`.

Yoshi Automation Bot

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

[diff] [blame]

925

"A String",

926

],

927

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

928

},

929

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

930

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

931

"iamOwned": True or False, # This is deprecated and has no effect. Do not use.

932

"rules": [ # This is deprecated and has no effect. Do not use.

933

{ # This is deprecated and has no effect. Do not use.

934

"action": "A String", # This is deprecated and has no effect. Do not use.

935

"conditions": [ # This is deprecated and has no effect. Do not use.

936

{ # This is deprecated and has no effect. Do not use.

937

"iam": "A String", # This is deprecated and has no effect. Do not use.

938

"op": "A String", # This is deprecated and has no effect. Do not use.

939

"svc": "A String", # This is deprecated and has no effect. Do not use.

940

"sys": "A String", # This is deprecated and has no effect. Do not use.

941

"values": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

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

[diff] [blame]

"A String",

],

},

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

946

"description": "A String", # This is deprecated and has no effect. Do not use.

947

"ins": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

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

[diff] [blame]

948

"A String",

949

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

950

"logConfigs": [ # This is deprecated and has no effect. Do not use.

951

{ # This is deprecated and has no effect. Do not use.

952

"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

953

"authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

954

"permissionType": "A String", # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

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

[diff] [blame]

955

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

956

"logName": "A String", # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

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

[diff] [blame]

957

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

958

"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

959

"customFields": [ # This is deprecated and has no effect. Do not use.

960

{ # This is deprecated and has no effect. Do not use.

961

"name": "A String", # This is deprecated and has no effect. Do not use.

962

"value": "A String", # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

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

[diff] [blame]

963

},

964

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

965

"field": "A String", # This is deprecated and has no effect. Do not use.

966

"metric": "A String", # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

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

[diff] [blame]

967

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

968

"dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

969

"logMode": "A String", # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

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

[diff] [blame]

970

},

971

},

972

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

973

"notIns": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

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

[diff] [blame]

974

"A String",

975

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

976

"permissions": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

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

[diff] [blame]

"A String",

],

},

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

981

"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * 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 **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. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Yoshi Automation Bot

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

[diff] [blame]

982

}</pre>

Dan O'Meara