Blame - docs/dyn/compute_beta.reservations.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 reservations.</p>

80

81

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

82

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

83

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, zone, reservation, 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 reservation.</p>

89

yoshi-code-bot

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

[diff] [blame^]

90

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

Dan O'Meara

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

[diff] [blame]

91

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

Bu Sun Kim

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

[diff] [blame]

92

yoshi-code-bot

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

[diff] [blame^]

93

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

Bu Sun Kim

2019-06-14 16:50:42 -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, zone, body=None, requestId=None, x__xgafv=None)</a></code></p>

Dan O'Meara

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

[diff] [blame]

97

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

Bu Sun Kim

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

[diff] [blame]

98

yoshi-code-bot

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

[diff] [blame^]

99

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

Dan O'Meara

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

[diff] [blame]

100

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

Bu Sun Kim

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

[diff] [blame]

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="#resize">resize(project, zone, reservation, body=None, requestId=None, x__xgafv=None)</a></code></p>

Dan O'Meara

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

[diff] [blame]

106

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

Bu Sun Kim

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

[diff] [blame]

107

yoshi-code-bot

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

[diff] [blame^]

108

<code><a href="#setIamPolicy">setIamPolicy(project, zone, 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">Sets the access control policy on the specified resource. Replaces any existing policy.</p>

110

yoshi-code-bot

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

[diff] [blame^]

111

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

Bu Sun Kim

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

[diff] [blame]

112

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

113

<h3>Method Details</h3>

114

yoshi-code-bot

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

[diff] [blame^]

115

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

116

<pre>Retrieves an aggregated list of reservations.

117

118

Args:

119

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

yoshi-code-bot

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

[diff] [blame^]

120

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]

121

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

Bu Sun Kim

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

[diff] [blame]

122

maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)

yoshi-code-bot

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

[diff] [blame^]

123

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]

124

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]

125

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

126

x__xgafv: string, V1 error format.

127

Allowed values

128

1 - v1 error format

129

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

130

131

Returns:

132

An object of the form:

133

134

{ # Contains a list of reservations.

Yoshi Automation Bot

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

[diff] [blame]

135

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

136

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

137

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

138

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

yoshi-code-bot

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

[diff] [blame^]

139

{ # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources.

Yoshi Automation Bot

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

[diff] [blame]

140

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

141

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

142

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

143

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

144

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

145

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

yoshi-code-bot

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

[diff] [blame]

146

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

Yoshi Automation Bot

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

[diff] [blame]

147

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

148

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

149

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

150

"inUseCount": "A String", # [Output Only] Indicates how many instances are in use.

151

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

152

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

153

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

154

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

155

"acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.

156

},

157

],

158

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

159

{

160

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

161

"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.

162

},

163

],

yoshi-code-bot

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

[diff] [blame]

164

"locationHint": "A String", # An opaque location hint used to place the allocation close to other resources. This field is for use by internal tools that use the public API.

Yoshi Automation Bot

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

[diff] [blame]

165

"machineType": "A String", # Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

166

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance.

167

"maintenanceInterval": "A String", # For more information about maintenance intervals, see Setting maintenance intervals.

Yoshi Automation Bot

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

[diff] [blame]

168

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

Bu Sun Kim

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

[diff] [blame]

169

},

Bu Sun Kim

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

[diff] [blame]

170

},

Yoshi Automation Bot

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

[diff] [blame]

171

"specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.

172

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

173

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

Bu Sun Kim

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

[diff] [blame]

174

},

175

],

Yoshi Automation Bot

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

[diff] [blame]

176

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

177

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

178

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

179

{

180

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

181

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

182

},

183

],

184

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

185

},

Bu Sun Kim

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

[diff] [blame]

186

},

Yoshi Automation Bot

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

[diff] [blame]

187

},

188

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

189

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

190

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

191

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

192

"A String",

193

],

194

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

195

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

196

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

197

{

198

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

199

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

200

},

201

],

202

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

203

},

204

}</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>

209

<pre>Retrieves the next page of results.

210

211

Args:

212

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

213

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

214

215

Returns:

Bu Sun Kim

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

[diff] [blame]

216

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]

217

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]

222

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

223

<pre>Close httplib2 connections.</pre>

</div>

yoshi-code-bot

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

[diff] [blame^]

227

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

Bu Sun Kim

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

[diff] [blame]

228

<pre>Deletes the specified reservation.

229

230

Args:

231

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

232

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

233

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

yoshi-code-bot

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

[diff] [blame^]

234

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

235

x__xgafv: string, V1 error format.

236

Allowed values

237

1 - v1 error format

238

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

239

240

Returns:

241

An object of the form:

242

yoshi-code-bot

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

[diff] [blame^]

243

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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]

244

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

245

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

246

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

247

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

248

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

249

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

Bu Sun Kim

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

[diff] [blame]

250

{

Yoshi Automation Bot

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

[diff] [blame]

251

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

252

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

253

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

Bu Sun Kim

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

[diff] [blame]

254

},

255

],

Yoshi Automation Bot

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

[diff] [blame]

256

},

257

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

258

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

259

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

260

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

261

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

262

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

yoshi-code-bot

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

[diff] [blame]

263

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

264

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

265

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

266

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

267

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

268

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

269

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

270

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

271

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

272

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

273

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

274

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

275

{

276

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

277

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

278

{

279

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

280

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

281

},

282

],

283

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

284

},

285

],

286

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

287

}</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^]

291

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

Dan O'Meara

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

[diff] [blame]

292

<pre>Retrieves information about the specified reservation.

Bu Sun Kim

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

[diff] [blame]

293

294

Args:

295

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

296

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

297

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

yoshi-code-bot

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

[diff] [blame^]

298

x__xgafv: string, V1 error format.

299

Allowed values

300

1 - v1 error format

301

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

302

303

Returns:

304

An object of the form:

305

yoshi-code-bot

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

[diff] [blame^]

306

{ # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources.

Yoshi Automation Bot

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

[diff] [blame]

307

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

308

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

309

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

310

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

311

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

312

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

yoshi-code-bot

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

[diff] [blame]

313

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

Yoshi Automation Bot

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

[diff] [blame]

314

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

315

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

316

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

317

"inUseCount": "A String", # [Output Only] Indicates how many instances are in use.

318

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

319

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

320

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

321

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

322

"acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.

323

},

324

],

325

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

326

{

327

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

328

"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.

329

},

330

],

yoshi-code-bot

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

[diff] [blame]

331

"locationHint": "A String", # An opaque location hint used to place the allocation close to other resources. This field is for use by internal tools that use the public API.

Yoshi Automation Bot

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

[diff] [blame]

332

"machineType": "A String", # Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

333

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance.

334

"maintenanceInterval": "A String", # For more information about maintenance intervals, see Setting maintenance intervals.

Yoshi Automation Bot

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

[diff] [blame]

335

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

Bu Sun Kim

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

[diff] [blame]

336

},

Yoshi Automation Bot

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

[diff] [blame]

337

},

338

"specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.

339

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

340

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

341

}</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^]

345

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

Bu Sun Kim

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

[diff] [blame]

346

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

347

348

Args:

349

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

350

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

351

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

Dan O'Meara

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

[diff] [blame]

352

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

yoshi-code-bot

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

[diff] [blame^]

353

x__xgafv: string, V1 error format.

354

Allowed values

355

1 - v1 error format

356

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

357

358

Returns:

359

An object of the form:

360

yoshi-code-bot

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

[diff] [blame^]

361

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

362

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

yoshi-code-bot

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

[diff] [blame^]

363

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

364

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

yoshi-code-bot

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

[diff] [blame^]

365

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

366

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

367

"A String",

368

],

yoshi-code-bot

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

[diff] [blame^]

369

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

370

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

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

],

yoshi-code-bot

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

[diff] [blame^]

373

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

Yoshi Automation Bot

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

[diff] [blame]

374

"A String",

375

],

376

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

377

},

378

],

379

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

380

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

yoshi-code-bot

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

[diff] [blame^]

381

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

382

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

383

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

384

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

385

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

386

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

Bu Sun Kim

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

[diff] [blame]

387

},

yoshi-code-bot

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

[diff] [blame^]

388

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

389

"A String",

390

],

391

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

392

},

393

],

yoshi-code-bot

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

[diff] [blame^]

394

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

395

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

396

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

397

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

398

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

399

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

400

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

401

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

402

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

403

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

404

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

405

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

410

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

411

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

Yoshi Automation Bot

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

[diff] [blame]

412

"A String",

413

],

yoshi-code-bot

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

[diff] [blame^]

414

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

415

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

416

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

417

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

418

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

419

},

yoshi-code-bot

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

[diff] [blame^]

420

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

421

},

yoshi-code-bot

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

[diff] [blame^]

422

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

423

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

424

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

425

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

426

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

427

},

Yoshi Automation Bot

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

[diff] [blame]

428

],

yoshi-code-bot

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

[diff] [blame^]

429

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

430

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

431

},

yoshi-code-bot

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

[diff] [blame^]

432

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

433

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

434

},

435

},

436

],

yoshi-code-bot

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

[diff] [blame^]

437

"notIns": [ # 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

],

yoshi-code-bot

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

[diff] [blame^]

440

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

445

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

446

}</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^]

450

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

Dan O'Meara

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

[diff] [blame]

451

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

Bu Sun Kim

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

[diff] [blame]

452

453

Args:

454

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

455

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

Dan O'Meara

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

[diff] [blame]

456

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

457

The object takes the form of:

458

yoshi-code-bot

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

[diff] [blame^]

459

{ # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources.

Bu Sun Kim

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

[diff] [blame]

460

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

461

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

462

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

463

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

464

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

465

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

yoshi-code-bot

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

[diff] [blame]

466

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

Bu Sun Kim

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

[diff] [blame]

467

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

468

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

469

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

470

"inUseCount": "A String", # [Output Only] Indicates how many instances are in use.

Bu Sun Kim

d059ad8

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

[diff] [blame]

471

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

Bu Sun Kim

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

[diff] [blame]

472

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

Bu Sun Kim

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

[diff] [blame]

473

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

Bu Sun Kim

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

[diff] [blame]

474

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

475

"acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.

Bu Sun Kim

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

[diff] [blame]

476

},

477

],

Bu Sun Kim

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

[diff] [blame]

478

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

Bu Sun Kim

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

[diff] [blame]

479

{

Bu Sun Kim

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

[diff] [blame]

480

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

481

"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.

Bu Sun Kim

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

[diff] [blame]

482

},

483

],

yoshi-code-bot

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

[diff] [blame]

484

"locationHint": "A String", # An opaque location hint used to place the allocation close to other resources. This field is for use by internal tools that use the public API.

Bu Sun Kim

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

[diff] [blame]

485

"machineType": "A String", # Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

486

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance.

487

"maintenanceInterval": "A String", # For more information about maintenance intervals, see Setting maintenance intervals.

Bu Sun Kim

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

[diff] [blame]

488

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

Bu Sun Kim

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

[diff] [blame]

489

},

Bu Sun Kim

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

[diff] [blame]

490

},

Bu Sun Kim

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

[diff] [blame]

491

"specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.

492

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

493

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

Bu Sun Kim

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

[diff] [blame]

494

}

495

yoshi-code-bot

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

[diff] [blame^]

496

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

497

x__xgafv: string, V1 error format.

498

Allowed values

499

1 - v1 error format

500

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

501

502

Returns:

503

An object of the form:

504

yoshi-code-bot

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

[diff] [blame^]

505

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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]

506

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

507

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

508

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

509

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

510

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

511

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

Bu Sun Kim

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

[diff] [blame]

512

{

Yoshi Automation Bot

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

[diff] [blame]

513

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

514

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

515

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

Bu Sun Kim

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

[diff] [blame]

516

},

517

],

Yoshi Automation Bot

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

[diff] [blame]

518

},

519

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

520

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

521

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

522

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

523

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

524

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

yoshi-code-bot

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

[diff] [blame]

525

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

526

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

527

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

528

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

529

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

530

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

531

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

532

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

533

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

534

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

535

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

536

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

537

{

538

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

539

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

540

{

541

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

542

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

543

},

544

],

545

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

546

},

547

],

548

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

549

}</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^]

553

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

Dan O'Meara

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

[diff] [blame]

554

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

Bu Sun Kim

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

[diff] [blame]

555

556

Args:

557

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

558

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

yoshi-code-bot

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

[diff] [blame^]

559

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]

560

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

561

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]

562

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]

563

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

564

x__xgafv: string, V1 error format.

565

Allowed values

566

1 - v1 error format

567

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

568

569

Returns:

570

An object of the form:

571

572

{

Yoshi Automation Bot

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

[diff] [blame]

573

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

574

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

yoshi-code-bot

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

[diff] [blame^]

575

{ # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources.

Yoshi Automation Bot

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

[diff] [blame]

576

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

577

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

578

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

579

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

580

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

581

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

yoshi-code-bot

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

[diff] [blame]

582

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

Yoshi Automation Bot

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

[diff] [blame]

583

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

584

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

585

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

586

"inUseCount": "A String", # [Output Only] Indicates how many instances are in use.

587

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

588

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

589

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

590

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

591

"acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.

592

},

593

],

594

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

595

{

596

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

597

"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.

598

},

599

],

yoshi-code-bot

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

[diff] [blame]

600

"locationHint": "A String", # An opaque location hint used to place the allocation close to other resources. This field is for use by internal tools that use the public API.

Yoshi Automation Bot

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

[diff] [blame]

601

"machineType": "A String", # Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

602

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance.

603

"maintenanceInterval": "A String", # For more information about maintenance intervals, see Setting maintenance intervals.

Yoshi Automation Bot

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

[diff] [blame]

604

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

Bu Sun Kim

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

[diff] [blame]

605

},

Yoshi Automation Bot

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

[diff] [blame]

606

},

607

"specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.

608

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

609

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

610

},

611

],

612

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

613

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

614

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

615

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

616

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

617

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

618

{

619

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

620

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

Bu Sun Kim

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

[diff] [blame]

621

},

622

],

Yoshi Automation Bot

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

[diff] [blame]

623

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

624

},

625

}</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>

630

<pre>Retrieves the next page of results.

631

632

Args:

633

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

634

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

635

636

Returns:

Bu Sun Kim

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

[diff] [blame]

637

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]

638

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

643

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

Dan O'Meara

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

[diff] [blame]

644

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

Bu Sun Kim

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

[diff] [blame]

645

646

Args:

647

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

648

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

649

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

Dan O'Meara

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

[diff] [blame]

650

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

651

The object takes the form of:

652

653

{

Yoshi Automation Bot

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

[diff] [blame]

654

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

655

}

Bu Sun Kim

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

[diff] [blame]

656

yoshi-code-bot

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

[diff] [blame^]

657

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

658

x__xgafv: string, V1 error format.

659

Allowed values

660

1 - v1 error format

661

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

662

663

Returns:

664

An object of the form:

665

yoshi-code-bot

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

[diff] [blame^]

666

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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]

667

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

668

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

669

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

670

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

671

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

672

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

Bu Sun Kim

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

[diff] [blame]

673

{

Yoshi Automation Bot

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

[diff] [blame]

674

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

675

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

676

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

Bu Sun Kim

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

[diff] [blame]

677

},

678

],

Yoshi Automation Bot

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

[diff] [blame]

679

},

680

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

681

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

682

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

683

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

684

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

685

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

yoshi-code-bot

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

[diff] [blame]

686

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

687

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

688

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

689

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

690

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

691

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

692

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

693

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

694

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

695

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

696

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

697

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

698

{

699

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

700

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

701

{

702

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

703

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

704

},

705

],

706

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

707

},

708

],

709

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

710

}</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^]

714

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

Bu Sun Kim

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

[diff] [blame]

715

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

716

717

Args:

718

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

719

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

720

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

Dan O'Meara

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

[diff] [blame]

721

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

722

The object takes the form of:

723

724

{

Yoshi Automation Bot

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

[diff] [blame]

725

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

726

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

yoshi-code-bot

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

[diff] [blame^]

727

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

728

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

729

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

730

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

731

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

732

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

733

},

yoshi-code-bot

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

[diff] [blame^]

734

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

735

"A String",

736

],

737

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

738

},

Yoshi Automation Bot

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

[diff] [blame]

739

],

740

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

yoshi-code-bot

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

[diff] [blame^]

741

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

742

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

yoshi-code-bot

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

[diff] [blame^]

743

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

744

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

yoshi-code-bot

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

[diff] [blame^]

745

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

746

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

747

"A String",

Bu Sun Kim

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

[diff] [blame]

748

],

yoshi-code-bot

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

[diff] [blame^]

749

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

750

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

Bu Sun Kim

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

[diff] [blame]

751

},

752

],

yoshi-code-bot

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

[diff] [blame^]

753

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

Bu Sun Kim

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

[diff] [blame]

754

"A String",

755

],

756

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

Bu Sun Kim

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

[diff] [blame]

757

},

758

],

Bu Sun Kim

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

[diff] [blame]

759

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

Bu Sun Kim

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

[diff] [blame]

760

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

yoshi-code-bot

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

[diff] [blame^]

761

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

762

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

763

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

764

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

765

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

766

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

767

},

yoshi-code-bot

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

[diff] [blame^]

768

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

769

"A String",

Bu Sun Kim

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

[diff] [blame]

770

],

Bu Sun Kim

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

[diff] [blame]

771

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

Bu Sun Kim

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

[diff] [blame]

772

},

773

],

yoshi-code-bot

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

[diff] [blame^]

774

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

775

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

776

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

777

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

778

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

779

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

780

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

781

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

782

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

783

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

784

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

785

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

790

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

791

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

Bu Sun Kim

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

[diff] [blame]

792

"A String",

793

],

yoshi-code-bot

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

[diff] [blame^]

794

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

795

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

796

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

797

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

798

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

799

},

yoshi-code-bot

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

[diff] [blame^]

800

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

801

},

yoshi-code-bot

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

[diff] [blame^]

802

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

803

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

804

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

805

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

806

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

807

},

808

],

yoshi-code-bot

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

[diff] [blame^]

809

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

810

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

811

},

yoshi-code-bot

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

[diff] [blame^]

812

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

813

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

814

},

815

},

816

],

yoshi-code-bot

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

[diff] [blame^]

817

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

Bu Sun Kim

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

[diff] [blame]

818

"A String",

819

],

yoshi-code-bot

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

[diff] [blame^]

820

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

825

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

829

x__xgafv: string, V1 error format.

830

Allowed values

831

1 - v1 error format

832

2 - v2 error format

Yoshi Automation Bot

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

[diff] [blame]

833

834

Returns:

835

An object of the form:

836

yoshi-code-bot

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

[diff] [blame^]

837

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

838

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

yoshi-code-bot

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

[diff] [blame^]

839

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

840

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

yoshi-code-bot

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

[diff] [blame^]

841

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

842

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

843

"A String",

844

],

yoshi-code-bot

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

[diff] [blame^]

845

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

846

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

847

},

848

],

yoshi-code-bot

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

[diff] [blame^]

849

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

Yoshi Automation Bot

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

[diff] [blame]

850

"A String",

851

],

852

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

853

},

854

],

855

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

856

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

yoshi-code-bot

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

[diff] [blame^]

857

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

858

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

859

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

860

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

861

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

862

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

863

},

yoshi-code-bot

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

[diff] [blame^]

864

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

865

"A String",

866

],

867

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

868

},

869

],

yoshi-code-bot

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

[diff] [blame^]

870

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

871

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

872

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

873

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

874

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

875

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

876

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

877

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

878

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

879

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

880

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

881

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

886

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

887

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

Yoshi Automation Bot

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

[diff] [blame]

888

"A String",

889

],

yoshi-code-bot

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

[diff] [blame^]

890

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

891

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

892

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

893

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

894

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

895

},

yoshi-code-bot

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

[diff] [blame^]

896

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

897

},

yoshi-code-bot

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

[diff] [blame^]

898

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

899

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

900

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

901

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

902

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

903

},

904

],

yoshi-code-bot

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

[diff] [blame^]

905

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

906

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

907

},

yoshi-code-bot

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

[diff] [blame^]

908

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

909

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

910

},

911

},

912

],

yoshi-code-bot

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

[diff] [blame^]

913

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

Yoshi Automation Bot

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

[diff] [blame]

914

"A String",

915

],

yoshi-code-bot

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

[diff] [blame^]

916

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

921

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

922

}</pre>

Bu Sun Kim