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

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

[diff] [blame]

81

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

82

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

83

yoshi-code-bot

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

[diff] [blame^]

84

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

Bu Sun Kim

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

[diff] [blame]

85

<p class="firstline">Creates a snapshot of this regional disk.</p>

86

yoshi-code-bot

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

[diff] [blame^]

87

<code><a href="#delete">delete(project, region, disk, 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 regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.</p>

89

yoshi-code-bot

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

[diff] [blame^]

90

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

Bu Sun Kim

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

[diff] [blame]

91

<p class="firstline">Returns a specified regional persistent disk.</p>

92

yoshi-code-bot

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

[diff] [blame^]

93

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

Bu Sun Kim

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

[diff] [blame]

94

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

95

yoshi-code-bot

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

[diff] [blame^]

96

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

Bu Sun Kim

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

[diff] [blame]

97

<p class="firstline">Creates a persistent regional disk in the specified project using the data included in the request.</p>

98

yoshi-code-bot

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

[diff] [blame^]

99

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

Bu Sun Kim

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

[diff] [blame]

100

<p class="firstline">Retrieves the list of persistent disks contained within the specified region.</p>

101

102

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

103

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

104

yoshi-code-bot

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

[diff] [blame^]

105

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

Bu Sun Kim

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

[diff] [blame]

106

<p class="firstline">Removes resource policies from a regional disk.</p>

107

yoshi-code-bot

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

[diff] [blame^]

108

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

Bu Sun Kim

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

[diff] [blame]

109

<p class="firstline">Resizes the specified regional persistent disk.</p>

110

yoshi-code-bot

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

[diff] [blame^]

111

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

Bu Sun Kim

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

[diff] [blame]

112

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

113

yoshi-code-bot

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

[diff] [blame^]

114

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

Bu Sun Kim

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

[diff] [blame]

115

<p class="firstline">Sets the labels on the target regional disk.</p>

116

yoshi-code-bot

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

[diff] [blame^]

117

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

Bu Sun Kim

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

[diff] [blame]

118

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

119

<h3>Method Details</h3>

120

yoshi-code-bot

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

[diff] [blame^]

121

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

Bu Sun Kim

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

[diff] [blame]

122

<pre>Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.

123

124

Args:

125

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

126

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

127

disk: string, The disk name for this request. (required)

Dan O'Meara

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

[diff] [blame]

128

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

129

The object takes the form of:

130

131

{

Yoshi Automation Bot

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

[diff] [blame]

132

"resourcePolicies": [ # Resource policies to be added to this disk.

133

"A String",

134

],

135

}

Bu Sun Kim

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

[diff] [blame]

136

yoshi-code-bot

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

[diff] [blame^]

137

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

138

x__xgafv: string, V1 error format.

139

Allowed values

140

1 - v1 error format

141

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

142

143

Returns:

144

An object of the form:

145

yoshi-code-bot

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

[diff] [blame^]

146

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

Yoshi Automation Bot

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

[diff] [blame]

147

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

148

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

149

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

150

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

151

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

152

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

Bu Sun Kim

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

[diff] [blame]

153

{

Yoshi Automation Bot

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

[diff] [blame]

154

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

155

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

156

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

Bu Sun Kim

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

[diff] [blame]

157

},

158

],

Yoshi Automation Bot

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

[diff] [blame]

159

},

160

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

161

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

162

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

163

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

164

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

165

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

yoshi-code-bot

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

[diff] [blame]

166

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

167

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

168

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

169

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

170

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

171

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

172

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

173

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

174

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

175

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

176

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

177

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

178

{

179

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

180

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

181

{

182

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

183

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

184

},

185

],

186

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

187

},

188

],

189

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

190

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dmitry Frenkel

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

[diff] [blame]

194

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

195

<pre>Close httplib2 connections.</pre>

</div>

yoshi-code-bot

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

[diff] [blame^]

199

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

Bu Sun Kim

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

[diff] [blame]

200

<pre>Creates a snapshot of this regional disk.

201

202

Args:

203

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

204

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

205

disk: string, Name of the regional persistent disk to snapshot. (required)

Dan O'Meara

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

[diff] [blame]

206

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

207

The object takes the form of:

208

yoshi-code-bot

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

[diff] [blame^]

209

{ # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.

Yoshi Automation Bot

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

[diff] [blame]

210

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

211

"chainName": "A String", # Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.

212

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

213

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

214

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

215

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

216

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

217

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

yoshi-code-bot

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

[diff] [blame^]

218

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

Yoshi Automation Bot

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

[diff] [blame]

219

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

220

"a_key": "A String",

221

},

222

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

223

"A String",

224

],

225

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

226

"A String",

227

],

yoshi-code-bot

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

[diff] [blame]

228

"locationHint": "A String", # An opaque location hint used to place the snapshot 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]

229

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

yoshi-code-bot

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

[diff] [blame]

230

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

Yoshi Automation Bot

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

[diff] [blame]

231

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

yoshi-code-bot

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

[diff] [blame^]

232

"snapshotEncryptionKey": { # Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the snapshot. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.

Yoshi Automation Bot

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

[diff] [blame]

233

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

234

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

235

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

236

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

237

},

238

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

239

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

240

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

241

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

242

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

243

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

244

},

245

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

246

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

247

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

248

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

249

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

250

"A String",

251

],

252

}

Bu Sun Kim

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

[diff] [blame]

253

yoshi-code-bot

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

[diff] [blame^]

254

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

255

x__xgafv: string, V1 error format.

256

Allowed values

257

1 - v1 error format

258

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

259

260

Returns:

261

An object of the form:

262

yoshi-code-bot

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

[diff] [blame^]

263

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

Yoshi Automation Bot

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

[diff] [blame]

264

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

265

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

266

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

267

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

268

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

269

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

Bu Sun Kim

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

[diff] [blame]

270

{

Yoshi Automation Bot

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

[diff] [blame]

271

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

272

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

273

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

Bu Sun Kim

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

[diff] [blame]

274

},

275

],

Yoshi Automation Bot

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

[diff] [blame]

276

},

277

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

278

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

279

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

280

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

281

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

282

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

yoshi-code-bot

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

[diff] [blame]

283

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

284

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

285

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

286

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

287

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

288

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

289

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

290

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

291

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

292

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

293

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

294

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

295

{

296

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

297

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

298

{

299

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

300

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

301

},

302

],

303

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

304

},

305

],

306

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

307

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

311

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

Bu Sun Kim

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

[diff] [blame]

312

<pre>Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.

313

314

Args:

315

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

316

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

317

disk: string, Name of the regional persistent disk to delete. (required)

yoshi-code-bot

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

[diff] [blame^]

318

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

319

x__xgafv: string, V1 error format.

320

Allowed values

321

1 - v1 error format

322

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

323

324

Returns:

325

An object of the form:

326

yoshi-code-bot

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

[diff] [blame^]

327

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

Yoshi Automation Bot

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

[diff] [blame]

328

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

329

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

330

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

331

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

332

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

333

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

Bu Sun Kim

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

[diff] [blame]

334

{

Yoshi Automation Bot

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

[diff] [blame]

335

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

336

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

337

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

Bu Sun Kim

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

[diff] [blame]

338

},

339

],

Yoshi Automation Bot

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

[diff] [blame]

340

},

341

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

342

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

343

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

344

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

345

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

346

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

yoshi-code-bot

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

[diff] [blame]

347

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

348

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

349

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

350

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

351

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

352

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

353

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

354

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

355

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

356

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

357

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

358

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

359

{

360

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

361

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

362

{

363

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

364

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

365

},

366

],

367

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

368

},

369

],

370

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

371

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

375

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

Bu Sun Kim

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

[diff] [blame]

376

<pre>Returns a specified regional persistent disk.

377

378

Args:

379

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

380

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

381

disk: string, Name of the regional persistent disk to return. (required)

yoshi-code-bot

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

[diff] [blame^]

382

x__xgafv: string, V1 error format.

383

Allowed values

384

1 - v1 error format

385

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

386

387

Returns:

388

An object of the form:

389

yoshi-code-bot

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

[diff] [blame^]

390

{ # Represents a Persistent Disk resource. Google Compute Engine has two Disk resources: * [Zonal](/compute/docs/reference/rest/v1/disks) * [Regional](/compute/docs/reference/rest/v1/regionDisks) Persistent disks are required for running your VM instances. Create both boot and non-boot (data) persistent disks. For more information, read Persistent Disks. For more storage options, read Storage options. The disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks. The regionDisks resource represents a regional persistent disk. For more information, read Regional resources.

Yoshi Automation Bot

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

[diff] [blame]

391

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

392

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

yoshi-code-bot

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

[diff] [blame^]

393

"diskEncryptionKey": { # Encrypts the disk using a customer-supplied encryption key. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.

Yoshi Automation Bot

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

[diff] [blame]

394

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

395

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

396

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

397

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

398

},

yoshi-code-bot

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

[diff] [blame^]

399

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

Yoshi Automation Bot

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

[diff] [blame]

400

{ # Guest OS features.

yoshi-code-bot

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

[diff] [blame^]

401

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

Bu Sun Kim

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

[diff] [blame]

402

},

Yoshi Automation Bot

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

[diff] [blame]

403

],

404

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

405

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

yoshi-code-bot

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

[diff] [blame^]

406

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

Yoshi Automation Bot

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

[diff] [blame]

407

"labels": { # Labels to apply to this disk. These can be later modified by the setLabels method.

408

"a_key": "A String",

409

},

410

"lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.

411

"lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.

412

"licenseCodes": [ # Integer license codes indicating which licenses are attached to this disk.

413

"A String",

414

],

415

"licenses": [ # A list of publicly visible licenses. Reserved for Google's use.

416

"A String",

417

],

yoshi-code-bot

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

[diff] [blame]

418

"locationHint": "A String", # An opaque location hint used to place the disk 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]

419

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

420

"options": "A String", # Internal use only.

421

"physicalBlockSizeBytes": "A String", # Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project.

yoshi-code-bot

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

[diff] [blame]

422

"provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.

Yoshi Automation Bot

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

[diff] [blame]

423

"region": "A String", # [Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

424

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

425

"A String",

426

],

427

"resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.

428

"A String",

429

],

yoshi-code-bot

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

[diff] [blame]

430

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

Yoshi Automation Bot

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

[diff] [blame]

431

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

yoshi-code-bot

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

[diff] [blame^]

432

"sizeGb": "A String", # Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are 1 to 65536, inclusive.

433

"sourceDisk": "A String", # The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk

Yoshi Automation Bot

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

[diff] [blame]

434

"sourceDiskId": "A String", # [Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used.

yoshi-code-bot

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

[diff] [blame^]

435

"sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family

Yoshi Automation Bot

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

[diff] [blame]

436

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

437

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

438

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

439

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

440

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

441

},

442

"sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.

yoshi-code-bot

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

[diff] [blame^]

443

"sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project /global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot

Yoshi Automation Bot

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

[diff] [blame]

444

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

445

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

446

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

447

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

448

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

449

},

450

"sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.

yoshi-code-bot

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

[diff] [blame]

451

"sourceStorageObject": "A String", # The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead.

yoshi-code-bot

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

[diff] [blame^]

452

"status": "A String", # [Output Only] The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting.

453

"type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-standard or pd-ssd

Yoshi Automation Bot

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

[diff] [blame]

454

"users": [ # [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance

455

"A String",

456

],

457

"zone": "A String", # [Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

458

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

yoshi-code-bot

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

[diff] [blame^]

462

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

Bu Sun Kim

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

[diff] [blame]

463

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

464

465

Args:

466

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

467

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

468

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

Dmitry Frenkel

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

[diff] [blame]

469

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

yoshi-code-bot

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

[diff] [blame^]

470

x__xgafv: string, V1 error format.

471

Allowed values

472

1 - v1 error format

473

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

474

475

Returns:

476

An object of the form:

477

yoshi-code-bot

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

[diff] [blame^]

478

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

479

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

yoshi-code-bot

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

[diff] [blame^]

480

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

481

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

yoshi-code-bot

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

[diff] [blame^]

482

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

483

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

484

"A String",

485

],

yoshi-code-bot

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

[diff] [blame^]

486

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

487

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

Bu Sun Kim

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

[diff] [blame]

488

},

Yoshi Automation Bot

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

[diff] [blame]

489

],

yoshi-code-bot

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

[diff] [blame^]

490

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

Yoshi Automation Bot

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

[diff] [blame]

491

"A String",

492

],

493

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

494

},

495

],

496

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

497

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

yoshi-code-bot

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

[diff] [blame^]

498

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

499

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

500

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

501

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

502

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

503

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

504

},

yoshi-code-bot

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

[diff] [blame^]

505

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

506

"A String",

507

],

508

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

509

},

510

],

yoshi-code-bot

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

[diff] [blame^]

511

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

512

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

513

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

514

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

515

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

516

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

517

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

518

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

519

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

520

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

521

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

522

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

527

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

528

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

Yoshi Automation Bot

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

[diff] [blame]

529

"A String",

530

],

yoshi-code-bot

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

[diff] [blame^]

531

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

532

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

533

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

534

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

535

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

536

},

yoshi-code-bot

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

[diff] [blame^]

537

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

538

},

yoshi-code-bot

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

[diff] [blame^]

539

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

540

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

541

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

542

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

543

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

544

},

Yoshi Automation Bot

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

[diff] [blame]

545

],

yoshi-code-bot

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

[diff] [blame^]

546

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

547

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

548

},

yoshi-code-bot

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

[diff] [blame^]

549

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

550

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

551

},

552

},

553

],

yoshi-code-bot

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

[diff] [blame^]

554

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

Yoshi Automation Bot

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

[diff] [blame]

555

"A String",

556

],

yoshi-code-bot

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

[diff] [blame^]

557

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

562

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

563

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

567

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

Bu Sun Kim

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

[diff] [blame]

568

<pre>Creates a persistent regional disk in the specified project using the data included in the request.

569

570

Args:

571

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

572

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

Dan O'Meara

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

[diff] [blame]

573

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

574

The object takes the form of:

575

yoshi-code-bot

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

[diff] [blame^]

576

{ # Represents a Persistent Disk resource. Google Compute Engine has two Disk resources: * [Zonal](/compute/docs/reference/rest/v1/disks) * [Regional](/compute/docs/reference/rest/v1/regionDisks) Persistent disks are required for running your VM instances. Create both boot and non-boot (data) persistent disks. For more information, read Persistent Disks. For more storage options, read Storage options. The disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks. The regionDisks resource represents a regional persistent disk. For more information, read Regional resources.

Bu Sun Kim

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

[diff] [blame]

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.

yoshi-code-bot

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

[diff] [blame^]

579

"diskEncryptionKey": { # Encrypts the disk using a customer-supplied encryption key. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.

Bu Sun Kim

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

[diff] [blame]

580

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

581

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

582

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

583

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

584

},

yoshi-code-bot

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

[diff] [blame^]

585

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

Bu Sun Kim

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

[diff] [blame]

586

{ # Guest OS features.

yoshi-code-bot

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

[diff] [blame^]

587

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

Bu Sun Kim

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

[diff] [blame]

588

},

Bu Sun Kim

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

[diff] [blame]

589

],

590

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

591

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

yoshi-code-bot

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

[diff] [blame^]

592

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

Bu Sun Kim

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

[diff] [blame]

593

"labels": { # Labels to apply to this disk. These can be later modified by the setLabels method.

594

"a_key": "A String",

595

},

596

"lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.

597

"lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.

598

"licenseCodes": [ # Integer license codes indicating which licenses are attached to this disk.

599

"A String",

600

],

601

"licenses": [ # A list of publicly visible licenses. Reserved for Google's use.

602

"A String",

603

],

yoshi-code-bot

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

[diff] [blame]

604

"locationHint": "A String", # An opaque location hint used to place the disk 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]

605

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

606

"options": "A String", # Internal use only.

Bu Sun Kim

d059ad8

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

[diff] [blame]

607

"physicalBlockSizeBytes": "A String", # Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project.

yoshi-code-bot

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

[diff] [blame]

608

"provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.

Bu Sun Kim

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

[diff] [blame]

609

"region": "A String", # [Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

610

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

611

"A String",

612

],

613

"resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.

614

"A String",

615

],

yoshi-code-bot

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

[diff] [blame]

616

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

Bu Sun Kim

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

[diff] [blame]

617

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

yoshi-code-bot

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

[diff] [blame^]

618

"sizeGb": "A String", # Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are 1 to 65536, inclusive.

619

"sourceDisk": "A String", # The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk

Bu Sun Kim

d059ad8

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

[diff] [blame]

620

"sourceDiskId": "A String", # [Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used.

yoshi-code-bot

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

[diff] [blame^]

621

"sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family

Dmitry Frenkel

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

[diff] [blame]

622

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

Bu Sun Kim

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

[diff] [blame]

623

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

624

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

625

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

626

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

627

},

628

"sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.

yoshi-code-bot

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

[diff] [blame^]

629

"sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project /global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot

Dmitry Frenkel

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

[diff] [blame]

630

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

Bu Sun Kim

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

[diff] [blame]

631

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

632

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

633

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

634

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

635

},

636

"sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.

yoshi-code-bot

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

[diff] [blame]

637

"sourceStorageObject": "A String", # The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead.

yoshi-code-bot

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

[diff] [blame^]

638

"status": "A String", # [Output Only] The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting.

639

"type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-standard or pd-ssd

Bu Sun Kim

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

[diff] [blame]

640

"users": [ # [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance

641

"A String",

642

],

643

"zone": "A String", # [Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

644

}

Bu Sun Kim

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

[diff] [blame]

645

yoshi-code-bot

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

[diff] [blame^]

646

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

yoshi-code-bot

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

[diff] [blame]

647

sourceImage: string, Source image to restore onto a disk. This field is optional.

yoshi-code-bot

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

[diff] [blame^]

648

x__xgafv: string, V1 error format.

649

Allowed values

650

1 - v1 error format

651

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

652

653

Returns:

654

An object of the form:

655

yoshi-code-bot

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

[diff] [blame^]

656

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

Yoshi Automation Bot

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

[diff] [blame]

657

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

658

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

659

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

660

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

661

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

662

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

Bu Sun Kim

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

[diff] [blame]

663

{

Yoshi Automation Bot

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

[diff] [blame]

664

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

665

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

666

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

Bu Sun Kim

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

[diff] [blame]

667

},

668

],

Yoshi Automation Bot

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

[diff] [blame]

669

},

670

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

671

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

672

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

673

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

674

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

675

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

yoshi-code-bot

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

[diff] [blame]

676

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

677

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

678

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

679

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

680

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

681

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

682

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

683

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

684

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

685

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

686

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

687

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

688

{

689

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

690

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

691

{

692

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

693

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

694

},

695

],

696

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

697

},

698

],

699

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

700

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

704

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

Bu Sun Kim

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

[diff] [blame]

705

<pre>Retrieves the list of persistent disks contained within the specified region.

706

707

Args:

708

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

709

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

yoshi-code-bot

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

[diff] [blame^]

710

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]

711

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

712

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]

713

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]

714

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

715

x__xgafv: string, V1 error format.

716

Allowed values

717

1 - v1 error format

718

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

719

720

Returns:

721

An object of the form:

722

723

{ # A list of Disk resources.

Yoshi Automation Bot

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

[diff] [blame]

724

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

725

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

yoshi-code-bot

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

[diff] [blame^]

726

{ # Represents a Persistent Disk resource. Google Compute Engine has two Disk resources: * [Zonal](/compute/docs/reference/rest/v1/disks) * [Regional](/compute/docs/reference/rest/v1/regionDisks) Persistent disks are required for running your VM instances. Create both boot and non-boot (data) persistent disks. For more information, read Persistent Disks. For more storage options, read Storage options. The disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks. The regionDisks resource represents a regional persistent disk. For more information, read Regional resources.

Yoshi Automation Bot

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

[diff] [blame]

727

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

728

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

yoshi-code-bot

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

[diff] [blame^]

729

"diskEncryptionKey": { # Encrypts the disk using a customer-supplied encryption key. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.

Yoshi Automation Bot

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

[diff] [blame]

730

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

731

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

732

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

733

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

Bu Sun Kim

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

[diff] [blame]

734

},

yoshi-code-bot

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

[diff] [blame^]

735

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

Yoshi Automation Bot

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

[diff] [blame]

736

{ # Guest OS features.

yoshi-code-bot

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

[diff] [blame^]

737

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

Bu Sun Kim

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

[diff] [blame]

738

},

739

],

Yoshi Automation Bot

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

[diff] [blame]

740

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

741

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

yoshi-code-bot

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

[diff] [blame^]

742

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

Yoshi Automation Bot

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

[diff] [blame]

743

"labels": { # Labels to apply to this disk. These can be later modified by the setLabels method.

744

"a_key": "A String",

745

},

746

"lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.

747

"lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.

748

"licenseCodes": [ # Integer license codes indicating which licenses are attached to this disk.

749

"A String",

750

],

751

"licenses": [ # A list of publicly visible licenses. Reserved for Google's use.

752

"A String",

753

],

yoshi-code-bot

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

[diff] [blame]

754

"locationHint": "A String", # An opaque location hint used to place the disk 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]

755

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

756

"options": "A String", # Internal use only.

757

"physicalBlockSizeBytes": "A String", # Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project.

yoshi-code-bot

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

[diff] [blame]

758

"provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.

Yoshi Automation Bot

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

[diff] [blame]

759

"region": "A String", # [Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

760

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

761

"A String",

762

],

763

"resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.

764

"A String",

765

],

yoshi-code-bot

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

[diff] [blame]

766

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

Yoshi Automation Bot

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

[diff] [blame]

767

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

yoshi-code-bot

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

[diff] [blame^]

768

"sizeGb": "A String", # Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are 1 to 65536, inclusive.

769

"sourceDisk": "A String", # The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk

Yoshi Automation Bot

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

[diff] [blame]

770

"sourceDiskId": "A String", # [Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used.

yoshi-code-bot

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

[diff] [blame^]

771

"sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family

Yoshi Automation Bot

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

[diff] [blame]

772

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

773

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

774

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

775

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

776

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

777

},

778

"sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.

yoshi-code-bot

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

[diff] [blame^]

779

"sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project /global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot

Yoshi Automation Bot

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

[diff] [blame]

780

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

781

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

782

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

783

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

784

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

785

},

786

"sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.

yoshi-code-bot

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

[diff] [blame]

787

"sourceStorageObject": "A String", # The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead.

yoshi-code-bot

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

[diff] [blame^]

788

"status": "A String", # [Output Only] The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting.

789

"type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-standard or pd-ssd

Yoshi Automation Bot

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

[diff] [blame]

790

"users": [ # [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance

791

"A String",

792

],

793

"zone": "A String", # [Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Bu Sun Kim

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

[diff] [blame]

794

},

Yoshi Automation Bot

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

[diff] [blame]

795

],

796

"kind": "compute#diskList", # [Output Only] Type of resource. Always compute#diskList for lists of disks.

797

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

798

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

799

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

800

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

801

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

802

{

803

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

804

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

805

},

806

],

807

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

808

},

809

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

814

<pre>Retrieves the next page of results.

815

816

Args:

817

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

818

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

819

820

Returns:

Bu Sun Kim

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

[diff] [blame]

821

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]

822

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

827

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

Bu Sun Kim

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

[diff] [blame]

828

<pre>Removes resource policies from a regional disk.

829

830

Args:

831

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

832

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

833

disk: string, The disk name for this request. (required)

Dan O'Meara

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

[diff] [blame]

834

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

835

The object takes the form of:

836

837

{

Yoshi Automation Bot

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

[diff] [blame]

838

"resourcePolicies": [ # Resource policies to be removed from this disk.

839

"A String",

840

],

841

}

Bu Sun Kim

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

[diff] [blame]

842

yoshi-code-bot

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

[diff] [blame^]

843

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

844

x__xgafv: string, V1 error format.

845

Allowed values

846

1 - v1 error format

847

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

848

849

Returns:

850

An object of the form:

851

yoshi-code-bot

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

[diff] [blame^]

852

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

Yoshi Automation Bot

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

[diff] [blame]

853

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

854

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

855

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

856

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

857

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

858

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

Bu Sun Kim

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

[diff] [blame]

859

{

Yoshi Automation Bot

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

[diff] [blame]

860

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

861

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

862

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

Bu Sun Kim

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

[diff] [blame]

863

},

864

],

Yoshi Automation Bot

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

[diff] [blame]

865

},

866

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

867

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

868

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

869

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

870

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

871

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

yoshi-code-bot

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

[diff] [blame]

872

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

873

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

874

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

875

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

876

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

877

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

878

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

879

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

880

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

881

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

882

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

883

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

884

{

885

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

886

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

887

{

888

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

889

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

890

},

891

],

892

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

893

},

894

],

895

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

896

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

900

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

Bu Sun Kim

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

[diff] [blame]

901

<pre>Resizes the specified regional persistent disk.

902

903

Args:

904

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

905

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

906

disk: string, Name of the regional persistent disk. (required)

Dan O'Meara

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

[diff] [blame]

907

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

908

The object takes the form of:

909

910

{

Yoshi Automation Bot

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

[diff] [blame]

911

"sizeGb": "A String", # The new size of the regional persistent disk, which is specified in GB.

912

}

Bu Sun Kim

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

[diff] [blame]

913

yoshi-code-bot

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

[diff] [blame^]

914

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

915

x__xgafv: string, V1 error format.

916

Allowed values

917

1 - v1 error format

918

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

919

920

Returns:

921

An object of the form:

922

yoshi-code-bot

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

[diff] [blame^]

923

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

Yoshi Automation Bot

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

[diff] [blame]

924

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

925

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

926

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

927

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

928

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

929

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

Bu Sun Kim

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

[diff] [blame]

930

{

Yoshi Automation Bot

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

[diff] [blame]

931

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

932

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

933

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

Bu Sun Kim

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

[diff] [blame]

934

},

935

],

Yoshi Automation Bot

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

[diff] [blame]

936

},

937

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

938

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

939

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

940

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

941

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

942

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

yoshi-code-bot

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

[diff] [blame]

943

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

944

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

945

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

946

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

947

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

948

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

949

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

950

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

951

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

952

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

953

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

954

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

955

{

956

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

957

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

958

{

959

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

960

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

961

},

962

],

963

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

964

},

965

],

966

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

967

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

yoshi-code-bot

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

[diff] [blame^]

971

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

Bu Sun Kim

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

[diff] [blame]

972

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

973

974

Args:

975

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

976

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

977

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

978

body: object, The request body.

979

The object takes the form of:

980

981

{

Yoshi Automation Bot

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

[diff] [blame]

982

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

983

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

yoshi-code-bot

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

[diff] [blame^]

984

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

985

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

986

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

987

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

988

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

989

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

990

},

yoshi-code-bot

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

[diff] [blame^]

991

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

992

"A String",

993

],

994

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

995

},

Yoshi Automation Bot

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

[diff] [blame]

996

],

997

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

998

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

999

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

yoshi-code-bot

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

[diff] [blame^]

1000

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

1001

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

yoshi-code-bot

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

[diff] [blame^]

1002

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

1003

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

1004

"A String",

1005

],

yoshi-code-bot

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

[diff] [blame^]

1006

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

1007

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

1008

},

1009

],

yoshi-code-bot

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

[diff] [blame^]

1010

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

Bu Sun Kim

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

[diff] [blame]

1011

"A String",

1012

],

1013

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

1014

},

1015

],

1016

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

1017

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

yoshi-code-bot

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

[diff] [blame^]

1018

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

1019

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

1020

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

1021

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

1022

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

1023

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

1024

},

yoshi-code-bot

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

[diff] [blame^]

1025

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

1026

"A String",

1027

],

1028

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

1029

},

1030

],

yoshi-code-bot

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

[diff] [blame^]

1031

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

1032

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

1033

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

1034

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

1035

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

1036

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

1037

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

1038

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

1039

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

1040

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

1041

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

1042

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

1047

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

1048

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

Bu Sun Kim

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

[diff] [blame]

1049

"A String",

1050

],

yoshi-code-bot

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

[diff] [blame^]

1051

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

1052

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

1053

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

1054

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

1055

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

1056

},

yoshi-code-bot

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

[diff] [blame^]

1057

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

1058

},

yoshi-code-bot

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

[diff] [blame^]

1059

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

1060

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

1061

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

1062

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

1063

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

1064

},

1065

],

yoshi-code-bot

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

[diff] [blame^]

1066

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

1067

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

1068

},

yoshi-code-bot

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

[diff] [blame^]

1069

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

1070

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

1071

},

1072

},

1073

],

yoshi-code-bot

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

[diff] [blame^]

1074

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

Bu Sun Kim

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

[diff] [blame]

1075

"A String",

1076

],

yoshi-code-bot

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

[diff] [blame^]

1077

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

1082

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

1086

x__xgafv: string, V1 error format.

1087

Allowed values

1088

1 - v1 error format

1089

2 - v2 error format

Yoshi Automation Bot

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

[diff] [blame]

1090

1091

Returns:

1092

An object of the form:

1093

yoshi-code-bot

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

[diff] [blame^]

1094

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

1095

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

yoshi-code-bot

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

[diff] [blame^]

1096

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

1097

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

yoshi-code-bot

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

[diff] [blame^]

1098

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

1099

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

1100

"A String",

1101

],

yoshi-code-bot

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

[diff] [blame^]

1102

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

1103

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

1104

},

1105

],

yoshi-code-bot

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

[diff] [blame^]

1106

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

Yoshi Automation Bot

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

[diff] [blame]

1107

"A String",

1108

],

1109

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

1110

},

1111

],

1112

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

1113

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

yoshi-code-bot

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

[diff] [blame^]

1114

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

1115

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

1116

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

1117

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

1118

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

1119

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

1120

},

yoshi-code-bot

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

[diff] [blame^]

1121

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

1122

"A String",

1123

],

1124

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

1125

},

1126

],

yoshi-code-bot

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

[diff] [blame^]

1127

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

1128

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

1129

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

1130

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

1131

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

1132

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

1133

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

1134

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

1135

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

1136

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

1137

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

1138

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

1143

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

1144

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

Yoshi Automation Bot

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

[diff] [blame]

1145

"A String",

1146

],

yoshi-code-bot

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

[diff] [blame^]

1147

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

1148

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

1149

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

1150

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

1151

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

1152

},

yoshi-code-bot

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

[diff] [blame^]

1153

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

1154

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1155

"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

1156

"customFields": [ # This is deprecated and has no effect. Do not use.

1157

{ # This is deprecated and has no effect. Do not use.

1158

"name": "A String", # This is deprecated and has no effect. Do not use.

1159

"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]

1160

},

1161

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1162

"field": "A String", # This is deprecated and has no effect. Do not use.

1163

"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]

1164

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1165

"dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

1166

"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]

1167

},

1168

},

1169

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1170

"notIns": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1171

"A String",

1172

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1173

"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^]

1178

"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]

1179

}</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^]

1183

<code class="details" id="setLabels">setLabels(project, region, resource, body=None, requestId=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1184

<pre>Sets the labels on the target regional disk.

1185

1186

Args:

1187

project: string, Project ID for this request. (required)

1188

region: string, The region for this request. (required)

1189

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1190

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1191

The object takes the form of:

1192

1193

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1194

"labelFingerprint": "A String", # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.

1195

"labels": { # The labels to set for this resource.

1196

"a_key": "A String",

1197

},

1198

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1199

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1200

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).

1201

x__xgafv: string, V1 error format.

1202

Allowed values

1203

1 - v1 error format

1204

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1205

1206

Returns:

1207

An object of the form:

1208

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1209

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1210

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1211

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1212

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1213

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1214

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1215

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1216

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1217

"code": "A String", # [Output Only] The error type identifier for this error.

1218

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1219

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1220

},

1221

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1222

},

1223

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1224

"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.

1225

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1226

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1227

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1228

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1229

"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]

1230

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1231

"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.

1232

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1233

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1234

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1235

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1236

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1237

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1238

"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.

1239

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1240

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1241

{

1242

"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^]

1243

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot