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

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

79

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

80

81

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

82

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

83

yoshi-code-bot

2da5ed1

2021-09-07 00:20:27 -0700

[diff] [blame]

84

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

85

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

86

87

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

88

<p class="firstline">Deletes the specified InstantSnapshot resource. Keep in mind that deleting a single instantSnapshot might not necessarily delete all the data on that instantSnapshot. If any data on the instantSnapshot that is marked for deletion is needed for subsequent instantSnapshots, the data will be moved to the next corresponding instantSnapshot. For more information, see Deleting instantSnapshots.</p>

89

90

<code><a href="#export">export(project, zone, instantSnapshot, body=None, requestId=None, x__xgafv=None)</a></code></p>

91

<p class="firstline">Export the changed blocks between two instant snapshots to a customer's bucket in the user specified format.</p>

92

93

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

94

<p class="firstline">Returns the specified InstantSnapshot resource in the specified zone.</p>

95

96

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

97

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

98

99

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

100

<p class="firstline">Creates an instant snapshot in the specified zone.</p>

101

102

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

103

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

104

105

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

106

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

107

108

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

109

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

110

111

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

112

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

113

114

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

115

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

116

<h3>Method Details</h3>

117

yoshi-code-bot

a41c7b9

2021-11-02 00:26:17 -0700

[diff] [blame^]

118

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

119

<pre>Retrieves an aggregated list of instantSnapshots.

120

121

Args:

122

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

123

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

124

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

125

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

126

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.

127

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.

128

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

129

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

136

137

{

138

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

139

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

140

"a_key": { # [Output Only] Name of the scope containing this set of instantSnapshots.

141

"instantSnapshots": [ # [Output Only] A list of instantSnapshots contained in this scope.

142

{ # Represents a InstantSnapshot resource. You can use instant snapshots to create disk rollback points quickly..

143

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

144

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

145

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

146

"guestFlush": True or False, # Whether to attempt an application consistent instant snapshot by informing the OS to prepare for the snapshot process. Currently only supported on Windows instances using the Volume Shadow Copy Service (VSS).

147

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

148

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

149

"labelFingerprint": "A String", # A fingerprint for the labels being applied to this InstantSnapshot, 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 InstantSnapshot.

150

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

151

"a_key": "A String",

152

},

153

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

154

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

155

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

156

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

157

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

158

"sourceDisk": "A String", # URL of the source disk used to create this instant snapshot. Note that the source disk must be in the same zone/region as the instant snapshot to be created. This can be a full or valid partial URL. 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

159

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

160

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

161

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

162

},

163

],

164

"warning": { # [Output Only] Informational warning which replaces the list of instantSnapshots when the list is empty.

165

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

166

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

167

{

168

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

169

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

170

},

171

],

172

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

},

},

},

"kind": "compute#instantSnapshotAggregatedList", # [Output Only] Type of resource. Always compute#instantSnapshotAggregatedList for aggregated lists of instantSnapshots.

177

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

178

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

179

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

180

"A String",

181

],

182

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

183

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

184

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

185

{

186

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

187

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

188

},

189

],

190

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

},

}</pre>

</div>

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

197

<pre>Retrieves the next page of results.

198

199

Args:

200

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

201

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

202

203

Returns:

204

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

205

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

</pre>

</div>

yoshi-code-bot

2021-09-07 00:20:27 -0700

[diff] [blame]

210

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

211

<pre>Close httplib2 connections.</pre>

</div>

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

216

<pre>Deletes the specified InstantSnapshot resource. Keep in mind that deleting a single instantSnapshot might not necessarily delete all the data on that instantSnapshot. If any data on the instantSnapshot that is marked for deletion is needed for subsequent instantSnapshots, the data will be moved to the next corresponding instantSnapshot. For more information, see Deleting instantSnapshots.

217

218

Args:

219

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

220

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

221

instantSnapshot: string, Name of the InstantSnapshot resource to delete. (required)

222

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

223

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

230

231

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

232

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

233

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

234

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

235

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

236

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

237

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

238

{

239

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

240

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

241

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

},

],

},

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

246

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

247

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

248

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

249

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

yoshi-code-bot

a41c7b9

2021-11-02 00:26:17 -0700

[diff] [blame^]

250

"metadata": { # [Output Only] Service-specific metadata attached to this operation.

251

"a_key": "", # Properties of the object. Contains field @type with type URL.

252

},

yoshi-code-bot

2da5ed1

2021-09-07 00:20:27 -0700

[diff] [blame]

253

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

254

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

255

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

256

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

257

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

258

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

259

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

260

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

261

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

262

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

263

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

264

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

265

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

266

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

267

{

268

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

269

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

270

{

271

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

272

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

273

},

274

],

275

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

276

},

277

],

278

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

}</pre>

</div>

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

284

<pre>Export the changed blocks between two instant snapshots to a customer's bucket in the user specified format.

285

286

Args:

287

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

288

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

289

instantSnapshot: string, Name of the instant snapshot to export. (required)

290

body: object, The request body.

291

The object takes the form of:

292

293

{

294

"exportParams": { # Parameters to export the changed blocks.

295

"baseInstantSnapshot": "A String", # An optional base instant snapshot that this resource is compared against. If not specified, all blocks of this resource are exported. The base instant snapshot and this resource must be created from the same disk. The base instant snapshot must be created earlier in time than this resource.

296

"bucketName": "A String", # The name of an existing bucket in Cloud Storage where the changed blocks will be stored. The Google Service Account must have read and write access to this bucket. The bucket has to be in the same region as this resource.

297

"encryptionKey": { # Encryption key used to encrypt the instant snapshot.

yoshi-code-bot

9d63883

2021-10-05 00:20:14 -0700

[diff] [blame]

298

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

299

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

300

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

301

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

yoshi-code-bot

2da5ed1

2021-09-07 00:20:27 -0700

[diff] [blame]

302

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

303

},

304

"objectName": "A String", # Name of the output Bigstore object storing the changed blocks. Object name must be less than 1024 bytes in length.

305

"outputType": "A String", # The format of the output file.

},

}

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

310

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

317

318

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

319

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

320

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

321

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

322

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

323

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

324

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

325

{

326

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

327

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

328

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

},

],

},

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

333

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

334

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

335

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

336

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

yoshi-code-bot

a41c7b9

2021-11-02 00:26:17 -0700

[diff] [blame^]

337

"metadata": { # [Output Only] Service-specific metadata attached to this operation.

338

"a_key": "", # Properties of the object. Contains field @type with type URL.

339

},

yoshi-code-bot

2da5ed1

2021-09-07 00:20:27 -0700

[diff] [blame]

340

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

341

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

342

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

343

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

344

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

345

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

346

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

347

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

348

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

349

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

350

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

351

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

352

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

353

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

354

{

355

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

356

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

357

{

358

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

359

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

360

},

361

],

362

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

363

},

364

],

365

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

}</pre>

</div>

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

371

<pre>Returns the specified InstantSnapshot resource in the specified zone.

372

373

Args:

374

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

375

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

376

instantSnapshot: string, Name of the InstantSnapshot resource to return. (required)

377

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

384

385

{ # Represents a InstantSnapshot resource. You can use instant snapshots to create disk rollback points quickly..

386

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

387

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

388

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

389

"guestFlush": True or False, # Whether to attempt an application consistent instant snapshot by informing the OS to prepare for the snapshot process. Currently only supported on Windows instances using the Volume Shadow Copy Service (VSS).

390

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

391

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

392

"labelFingerprint": "A String", # A fingerprint for the labels being applied to this InstantSnapshot, 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 InstantSnapshot.

393

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

394

"a_key": "A String",

395

},

396

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

397

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

398

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

399

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

400

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

401

"sourceDisk": "A String", # URL of the source disk used to create this instant snapshot. Note that the source disk must be in the same zone/region as the instant snapshot to be created. This can be a full or valid partial URL. 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

402

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

403

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

404

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

}</pre>

</div>

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

410

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

411

412

Args:

413

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

414

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

415

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

416

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

417

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

424

425

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

426

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

427

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

428

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

429

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

430

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

431

"A String",

432

],

433

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

434

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

435

},

436

],

437

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

438

"A String",

439

],

440

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

441

},

442

],

443

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

444

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

445

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

446

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

447

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

448

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

449

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

450

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

451

},

452

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

453

"A String",

454

],

455

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

456

},

457

],

458

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

459

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

460

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

461

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

462

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

463

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

464

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

465

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

466

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

467

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

468

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

469

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

"A String",

],

},

],

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

475

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

476

"A String",

477

],

478

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

479

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

480

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

481

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

482

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

483

},

484

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

485

},

486

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

487

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

488

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

489

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

490

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

491

},

492

],

493

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

494

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

495

},

496

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

497

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

},

},

],

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

502

"A String",

503

],

504

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

"A String",

],

},

],

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

}</pre>

</div>

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

515

<pre>Creates an instant snapshot in the specified zone.

516

517

Args:

518

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

519

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

520

body: object, The request body.

521

The object takes the form of:

522

523

{ # Represents a InstantSnapshot resource. You can use instant snapshots to create disk rollback points quickly..

524

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

525

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

526

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

527

"guestFlush": True or False, # Whether to attempt an application consistent instant snapshot by informing the OS to prepare for the snapshot process. Currently only supported on Windows instances using the Volume Shadow Copy Service (VSS).

528

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

529

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

530

"labelFingerprint": "A String", # A fingerprint for the labels being applied to this InstantSnapshot, 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 InstantSnapshot.

531

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

532

"a_key": "A String",

533

},

534

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

535

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

536

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

537

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

538

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

539

"sourceDisk": "A String", # URL of the source disk used to create this instant snapshot. Note that the source disk must be in the same zone/region as the instant snapshot to be created. This can be a full or valid partial URL. 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

540

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

541

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

542

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

543

}

544

545

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

546

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

553

554

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

555

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

556

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

557

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

558

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

559

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

560

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

561

{

562

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

563

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

564

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

},

],

},

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

569

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

570

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

571

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

572

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

yoshi-code-bot

a41c7b9

2021-11-02 00:26:17 -0700

[diff] [blame^]

573

"metadata": { # [Output Only] Service-specific metadata attached to this operation.

574

"a_key": "", # Properties of the object. Contains field @type with type URL.

575

},

yoshi-code-bot

2da5ed1

2021-09-07 00:20:27 -0700

[diff] [blame]

576

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

577

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

578

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

579

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

580

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

581

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

582

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

583

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

584

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

585

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

586

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

587

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

588

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

589

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

590

{

591

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

592

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

593

{

594

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

595

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

596

},

597

],

598

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

599

},

600

],

601

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

}</pre>

</div>

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

607

<pre>Retrieves the list of InstantSnapshot resources contained within the specified zone.

608

609

Args:

610

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

611

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

612

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

613

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

614

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.

615

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.

616

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

617

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

624

625

{ # Contains a list of InstantSnapshot resources.

626

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

627

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

628

{ # Represents a InstantSnapshot resource. You can use instant snapshots to create disk rollback points quickly..

629

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

630

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

631

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

632

"guestFlush": True or False, # Whether to attempt an application consistent instant snapshot by informing the OS to prepare for the snapshot process. Currently only supported on Windows instances using the Volume Shadow Copy Service (VSS).

633

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

634

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

635

"labelFingerprint": "A String", # A fingerprint for the labels being applied to this InstantSnapshot, 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 InstantSnapshot.

636

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

637

"a_key": "A String",

638

},

639

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

640

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

641

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

642

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

643

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

644

"sourceDisk": "A String", # URL of the source disk used to create this instant snapshot. Note that the source disk must be in the same zone/region as the instant snapshot to be created. This can be a full or valid partial URL. 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

645

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

646

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

647

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

648

},

649

],

650

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

651

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

652

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

653

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

654

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

655

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

656

{

657

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

658

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

659

},

660

],

661

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

},

}</pre>

</div>

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

668

<pre>Retrieves the next page of results.

669

670

Args:

671

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

672

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

673

674

Returns:

675

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

676

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

</pre>

</div>

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

682

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

683

684

Args:

685

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

686

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

687

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

688

body: object, The request body.

689

The object takes the form of:

690

691

{

692

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

693

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

694

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

695

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

696

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

697

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

698

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

699

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

700

},

701

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

702

"A String",

703

],

704

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

705

},

706

],

707

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

708

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

709

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

710

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

711

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

712

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

713

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

714

"A String",

715

],

716

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

717

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

718

},

719

],

720

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

721

"A String",

722

],

723

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

724

},

725

],

726

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

727

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

728

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

729

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

730

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

731

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

732

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

733

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

734

},

735

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

736

"A String",

737

],

738

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

739

},

740

],

741

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

742

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

743

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

744

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

745

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

746

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

747

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

748

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

749

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

750

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

751

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

752

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

"A String",

],

},

],

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

758

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

759

"A String",

760

],

761

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

762

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

763

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

764

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

765

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

766

},

767

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

768

},

769

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

770

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

771

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

772

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

773

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

774

},

775

],

776

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

777

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

778

},

779

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

780

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

},

},

],

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

785

"A String",

786

],

787

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

"A String",

],

},

],

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

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

803

804

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

805

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

806

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

807

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

808

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

809

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

810

"A String",

811

],

812

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

813

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

814

},

815

],

816

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

817

"A String",

818

],

819

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

820

},

821

],

822

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

823

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

824

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

825

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

826

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

827

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

828

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

829

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

830

},

831

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

832

"A String",

833

],

834

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

835

},

836

],

837

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

838

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

839

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

840

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

841

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

842

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

843

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

844

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

845

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

846

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

847

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

848

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

"A String",

],

},

],

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

854

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

855

"A String",

856

],

857

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

858

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

859

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

860

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

861

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

862

},

863

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

864

},

865

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

866

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

867

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

868

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

869

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

870

},

871

],

872

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

873

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

874

},

875

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

876

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

},

},

],

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

881

"A String",

882

],

883

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

"A String",

],

},

],

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

}</pre>

</div>

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

894

<pre>Sets the labels on a instantSnapshot in the given zone. To learn more about labels, read the Labeling Resources documentation.

895

896

Args:

897

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

898

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

899

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

900

body: object, The request body.

901

The object takes the form of:

902

903

{

904

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

905

"labels": { # The labels to set for this resource.

"a_key": "A String",

},

}

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

911

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

918

919

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

920

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

921

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

922

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

923

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

924

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

925

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

926

{

927

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

928

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

929

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

},

],

},

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

934

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

935

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

936

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

937

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

yoshi-code-bot

a41c7b9

2021-11-02 00:26:17 -0700

[diff] [blame^]

938

"metadata": { # [Output Only] Service-specific metadata attached to this operation.

939

"a_key": "", # Properties of the object. Contains field @type with type URL.

940

},

yoshi-code-bot

2da5ed1

2021-09-07 00:20:27 -0700

[diff] [blame]

941

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

942

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

943

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

944

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

945

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

946

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

947

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

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.

957

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

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

],