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

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

[diff] [blame]

83

yoshi-code-bot

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

[diff] [blame]

84

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

Bu Sun Kim

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

[diff] [blame]

85

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

86

yoshi-code-bot

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

[diff] [blame]

87

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

Bu Sun Kim

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

[diff] [blame]

88

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

89

yoshi-code-bot

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

[diff] [blame]

90

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

Bu Sun Kim

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

[diff] [blame]

91

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

92

yoshi-code-bot

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

[diff] [blame]

93

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

Bu Sun Kim

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

[diff] [blame]

94

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

95

96

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

97

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

98

yoshi-code-bot

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

[diff] [blame]

99

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

Bu Sun Kim

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

[diff] [blame]

100

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

101

yoshi-code-bot

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

[diff] [blame]

102

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

Bu Sun Kim

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

[diff] [blame]

103

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

104

yoshi-code-bot

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

[diff] [blame]

105

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

Bu Sun Kim

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

[diff] [blame]

106

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

107

<h3>Method Details</h3>

108

Dmitry Frenkel

3e17f89

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

[diff] [blame]

109

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

110

<pre>Close httplib2 connections.</pre>

</div>

yoshi-code-bot

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

[diff] [blame]

114

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

115

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

Bu Sun Kim

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

[diff] [blame]

116

117

Args:

118

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

119

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

120

inPlaceSnapshot: string, Name of the InPlaceSnapshot resource to delete. (required)

yoshi-code-bot

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

[diff] [blame]

121

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

122

x__xgafv: string, V1 error format.

123

Allowed values

124

1 - v1 error format

125

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

126

127

Returns:

128

An object of the form:

129

yoshi-code-bot

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

[diff] [blame]

130

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

Yoshi Automation Bot

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

[diff] [blame]

131

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

132

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

133

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

134

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

135

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

136

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

Bu Sun Kim

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

[diff] [blame]

137

{

Yoshi Automation Bot

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

[diff] [blame]

138

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

139

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

140

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

Bu Sun Kim

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

[diff] [blame]

141

},

142

],

Yoshi Automation Bot

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

[diff] [blame]

143

},

144

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

145

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

146

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

147

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

148

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

149

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

yoshi-code-bot

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

[diff] [blame]

150

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

Yoshi Automation Bot

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

[diff] [blame]

151

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

152

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

153

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

154

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

155

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

156

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

157

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

158

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

159

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

160

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

161

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

162

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

163

{

164

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

yoshi-code-bot

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

[diff] [blame]

165

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

Yoshi Automation Bot

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

[diff] [blame]

166

{

167

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

168

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

169

},

170

],

171

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

172

},

173

],

174

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

175

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

yoshi-code-bot

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

[diff] [blame]

179

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

Bu Sun Kim

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

[diff] [blame]

180

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

181

182

Args:

183

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

184

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

185

inPlaceSnapshot: string, Name of the InPlaceSnapshot resource to return. (required)

yoshi-code-bot

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

[diff] [blame]

186

x__xgafv: string, V1 error format.

187

Allowed values

188

1 - v1 error format

189

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

190

191

Returns:

192

An object of the form:

193

yoshi-code-bot

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

[diff] [blame]

194

{ # Represents a InPlaceSnapshot resource. You can use in-place snapshots to create disk rollback points quickly..

Yoshi Automation Bot

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

[diff] [blame]

195

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

196

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

197

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

198

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

199

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

200

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

yoshi-code-bot

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

[diff] [blame]

201

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

Yoshi Automation Bot

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

[diff] [blame]

202

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

203

"a_key": "A String",

204

},

205

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

206

"region": "A String", # [Output Only] URL of the region where the in-place 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.

207

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

208

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

yoshi-code-bot

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

[diff] [blame]

209

"sourceDisk": "A String", # URL of the source disk used to create this in-place snapshot. Note that the source disk must be in the same zone/region as the in-place 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 - projects/project/zones/zone/disks/disk - zones/zone/disks/disk

Yoshi Automation Bot

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

[diff] [blame]

210

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

211

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

212

"zone": "A String", # [Output Only] URL of the zone where the in-place 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.

213

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

yoshi-code-bot

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

[diff] [blame]

217

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

Bu Sun Kim

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

[diff] [blame]

218

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

219

220

Args:

221

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

222

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

223

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

224

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

yoshi-code-bot

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

[diff] [blame]

225

x__xgafv: string, V1 error format.

226

Allowed values

227

1 - v1 error format

228

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

229

230

Returns:

231

An object of the form:

232

yoshi-code-bot

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

[diff] [blame]

233

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

Yoshi Automation Bot

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

[diff] [blame]

234

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

yoshi-code-bot

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

[diff] [blame]

235

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

Yoshi Automation Bot

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

[diff] [blame]

236

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

yoshi-code-bot

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

[diff] [blame]

237

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

238

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

Yoshi Automation Bot

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

[diff] [blame]

239

"A String",

240

],

yoshi-code-bot

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

[diff] [blame]

241

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

Yoshi Automation Bot

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

[diff] [blame]

242

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

Bu Sun Kim

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

[diff] [blame]

243

},

Yoshi Automation Bot

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

[diff] [blame]

244

],

yoshi-code-bot

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

[diff] [blame]

245

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

Yoshi Automation Bot

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

[diff] [blame]

246

"A String",

247

],

248

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

249

},

250

],

251

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

252

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

yoshi-code-bot

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

[diff] [blame]

253

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

254

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

Yoshi Automation Bot

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

[diff] [blame]

255

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

256

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

257

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

258

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

Bu Sun Kim

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

[diff] [blame]

259

},

yoshi-code-bot

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

[diff] [blame]

260

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

Yoshi Automation Bot

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

[diff] [blame]

261

"A String",

262

],

263

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

264

},

265

],

yoshi-code-bot

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

[diff] [blame]

266

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

267

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

268

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

269

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

270

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

271

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

272

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

273

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

274

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

275

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

276

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

277

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

Yoshi Automation Bot

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

[diff] [blame]

"A String",

],

},

],

yoshi-code-bot

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

[diff] [blame]

282

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

283

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

Yoshi Automation Bot

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

[diff] [blame]

284

"A String",

285

],

yoshi-code-bot

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

[diff] [blame]

286

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

287

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

288

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

289

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

290

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

Yoshi Automation Bot

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

[diff] [blame]

291

},

yoshi-code-bot

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

[diff] [blame]

292

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

Bu Sun Kim

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

[diff] [blame]

293

},

yoshi-code-bot

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

[diff] [blame]

294

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

295

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

296

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

297

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

298

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

Bu Sun Kim

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

[diff] [blame]

299

},

Yoshi Automation Bot

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

[diff] [blame]

300

],

yoshi-code-bot

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

[diff] [blame]

301

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

302

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

Bu Sun Kim

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

[diff] [blame]

303

},

yoshi-code-bot

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

[diff] [blame]

304

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

305

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

Yoshi Automation Bot

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

[diff] [blame]

306

},

307

},

308

],

yoshi-code-bot

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

[diff] [blame]

309

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

Yoshi Automation Bot

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

[diff] [blame]

310

"A String",

311

],

yoshi-code-bot

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

[diff] [blame]

312

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

Yoshi Automation Bot

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

[diff] [blame]

"A String",

],

},

],

yoshi-code-bot

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

[diff] [blame]

317

"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Yoshi Automation Bot

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

[diff] [blame]

318

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

yoshi-code-bot

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

[diff] [blame]

322

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

Bu Sun Kim

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

[diff] [blame]

323

<pre>Creates an in-place snapshot in the specified zone.

324

325

Args:

326

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

327

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

328

body: object, The request body.

329

The object takes the form of:

330

yoshi-code-bot

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

[diff] [blame]

331

{ # Represents a InPlaceSnapshot resource. You can use in-place snapshots to create disk rollback points quickly..

Bu Sun Kim

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

[diff] [blame]

332

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

333

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

334

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

335

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

336

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

337

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

yoshi-code-bot

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

[diff] [blame]

338

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

Bu Sun Kim

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

[diff] [blame]

339

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

340

"a_key": "A String",

341

},

342

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

343

"region": "A String", # [Output Only] URL of the region where the in-place 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.

344

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

345

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

yoshi-code-bot

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

[diff] [blame]

346

"sourceDisk": "A String", # URL of the source disk used to create this in-place snapshot. Note that the source disk must be in the same zone/region as the in-place 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 - projects/project/zones/zone/disks/disk - zones/zone/disks/disk

Bu Sun Kim

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

[diff] [blame]

347

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

348

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

349

"zone": "A String", # [Output Only] URL of the zone where the in-place 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.

350

}

351

yoshi-code-bot

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

[diff] [blame]

352

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

353

x__xgafv: string, V1 error format.

354

Allowed values

355

1 - v1 error format

356

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

357

358

Returns:

359

An object of the form:

360

yoshi-code-bot

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

[diff] [blame]

361

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

Yoshi Automation Bot

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

[diff] [blame]

362

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

363

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

364

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

365

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

366

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

367

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

Bu Sun Kim

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

[diff] [blame]

368

{

Yoshi Automation Bot

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

[diff] [blame]

369

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

370

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

371

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

Bu Sun Kim

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

[diff] [blame]

372

},

373

],

Yoshi Automation Bot

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

[diff] [blame]

374

},

375

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

376

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

377

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

378

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

379

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

380

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

yoshi-code-bot

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

[diff] [blame]

381

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

Yoshi Automation Bot

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

[diff] [blame]

382

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

383

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

384

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

385

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

386

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

387

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

388

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

389

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

390

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

391

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

392

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

393

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

394

{

395

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

yoshi-code-bot

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

[diff] [blame]

396

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

Yoshi Automation Bot

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

[diff] [blame]

397

{

398

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

399

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

400

},

401

],

402

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

403

},

404

],

405

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

406

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

yoshi-code-bot

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

[diff] [blame]

410

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

Bu Sun Kim

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

[diff] [blame]

411

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

412

413

Args:

414

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

415

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

yoshi-code-bot

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

[diff] [blame]

416

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

Bu Sun Kim

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

[diff] [blame]

417

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

yoshi-code-bot

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

[diff] [blame]

418

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.

Bu Sun Kim

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

[diff] [blame]

419

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

yoshi-code-bot

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

[diff] [blame]

420

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

yoshi-code-bot

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

[diff] [blame]

421

x__xgafv: string, V1 error format.

422

Allowed values

423

1 - v1 error format

424

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

425

426

Returns:

427

An object of the form:

428

429

{ # Contains a list of InPlaceSnapshot resources.

Yoshi Automation Bot

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

[diff] [blame]

430

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

431

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

yoshi-code-bot

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

[diff] [blame]

432

{ # Represents a InPlaceSnapshot resource. You can use in-place snapshots to create disk rollback points quickly..

Yoshi Automation Bot

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

[diff] [blame]

433

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

434

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

435

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

436

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

437

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

438

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

yoshi-code-bot

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

[diff] [blame]

439

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

Yoshi Automation Bot

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

[diff] [blame]

440

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

441

"a_key": "A String",

442

},

443

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

444

"region": "A String", # [Output Only] URL of the region where the in-place 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.

445

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

446

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

yoshi-code-bot

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

[diff] [blame]

447

"sourceDisk": "A String", # URL of the source disk used to create this in-place snapshot. Note that the source disk must be in the same zone/region as the in-place 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 - projects/project/zones/zone/disks/disk - zones/zone/disks/disk

Yoshi Automation Bot

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

[diff] [blame]

448

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

449

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

450

"zone": "A String", # [Output Only] URL of the zone where the in-place 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.

451

},

452

],

453

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

454

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

455

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

456

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

457

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

yoshi-code-bot

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

[diff] [blame]

458

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

Yoshi Automation Bot

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

[diff] [blame]

459

{

460

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

461

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

Bu Sun Kim

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

[diff] [blame]

462

},

463

],

Yoshi Automation Bot

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

[diff] [blame]

464

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

465

},

466

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

471

<pre>Retrieves the next page of results.

472

473

Args:

474

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

475

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

476

477

Returns:

478

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

479

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

</pre>

</div>

yoshi-code-bot

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

[diff] [blame]

484

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

Bu Sun Kim

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

[diff] [blame]

485

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

486

487

Args:

488

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

489

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

490

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

491

body: object, The request body.

492

The object takes the form of:

493

494

{

Yoshi Automation Bot

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

[diff] [blame]

495

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

496

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

yoshi-code-bot

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

[diff] [blame]

497

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

498

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

Yoshi Automation Bot

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

[diff] [blame]

499

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

500

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

501

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

502

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

503

},

yoshi-code-bot

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

[diff] [blame]

504

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

Yoshi Automation Bot

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

[diff] [blame]

505

"A String",

506

],

507

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

Bu Sun Kim

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

[diff] [blame]

508

},

Yoshi Automation Bot

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

[diff] [blame]

509

],

510

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

yoshi-code-bot

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

[diff] [blame]

511

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

Bu Sun Kim

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

[diff] [blame]

512

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

yoshi-code-bot

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

[diff] [blame]

513

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

Bu Sun Kim

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

[diff] [blame]

514

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

yoshi-code-bot

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

[diff] [blame]

515

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

516

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

Bu Sun Kim

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

[diff] [blame]

517

"A String",

518

],

yoshi-code-bot

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

[diff] [blame]

519

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

Bu Sun Kim

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

[diff] [blame]

520

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

521

},

522

],

yoshi-code-bot

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

[diff] [blame]

523

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

Bu Sun Kim

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

[diff] [blame]

524

"A String",

525

],

526

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

527

},

528

],

529

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

530

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

yoshi-code-bot

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

[diff] [blame]

531

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

532

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

Bu Sun Kim

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

[diff] [blame]

533

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

534

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

535

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

536

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

537

},

yoshi-code-bot

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

[diff] [blame]

538

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

Bu Sun Kim

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

[diff] [blame]

539

"A String",

540

],

541

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

542

},

543

],

yoshi-code-bot

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

[diff] [blame]

544

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

545

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

546

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

547

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

548

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

549

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

550

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

551

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

552

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

553

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

554

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

555

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

Bu Sun Kim

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

[diff] [blame]

"A String",

],

},

],

yoshi-code-bot

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

[diff] [blame]

560

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

561

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

Bu Sun Kim

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

[diff] [blame]

562

"A String",

563

],

yoshi-code-bot

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

[diff] [blame]

564

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

565

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

566

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

567

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

568

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

Bu Sun Kim

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

[diff] [blame]

569

},

yoshi-code-bot

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

[diff] [blame]

570

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

Bu Sun Kim

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

[diff] [blame]

571

},

yoshi-code-bot

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

[diff] [blame]

572

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

573

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

574

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

575

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

576

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

Bu Sun Kim

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

[diff] [blame]

577

},

578

],

yoshi-code-bot

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

[diff] [blame]

579

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

580

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

Bu Sun Kim

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

[diff] [blame]

581

},

yoshi-code-bot

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

[diff] [blame]

582

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

583

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

Bu Sun Kim

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

[diff] [blame]

584

},

585

},

586

],

yoshi-code-bot

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

[diff] [blame]

587

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

Bu Sun Kim

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

[diff] [blame]

588

"A String",

589

],

yoshi-code-bot

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

[diff] [blame]

590

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

Bu Sun Kim

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

[diff] [blame]

"A String",

],

},

],

yoshi-code-bot

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

[diff] [blame]

595

"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Yoshi Automation Bot

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

[diff] [blame]

},

}

yoshi-code-bot

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

[diff] [blame]

599

x__xgafv: string, V1 error format.

600

Allowed values

601

1 - v1 error format

602

2 - v2 error format

Yoshi Automation Bot

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

[diff] [blame]

603

604

Returns:

605

An object of the form:

606

yoshi-code-bot

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

[diff] [blame]

607

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

Yoshi Automation Bot

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

[diff] [blame]

608

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

yoshi-code-bot

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

[diff] [blame]

609

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

Yoshi Automation Bot

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

[diff] [blame]

610

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

yoshi-code-bot

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

[diff] [blame]

611

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

612

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

Yoshi Automation Bot

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

[diff] [blame]

613

"A String",

614

],

yoshi-code-bot

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

[diff] [blame]

615

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

Yoshi Automation Bot

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

[diff] [blame]

616

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

617

},

618

],

yoshi-code-bot

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

[diff] [blame]

619

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

Yoshi Automation Bot

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

[diff] [blame]

620

"A String",

621

],

622

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

623

},

624

],

625

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

626

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

yoshi-code-bot

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

[diff] [blame]

627

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

628

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

Yoshi Automation Bot

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

[diff] [blame]

629

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

630

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

631

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

632

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

633

},

yoshi-code-bot

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

[diff] [blame]

634

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

Yoshi Automation Bot

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

[diff] [blame]

635

"A String",

636

],

637

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

638

},

639

],

yoshi-code-bot

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

[diff] [blame]

640

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

641

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

642

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

643

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

644

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

645

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

646

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

647

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

648

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

649

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

650

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

651

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

Yoshi Automation Bot

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

[diff] [blame]

"A String",

],

},

],

yoshi-code-bot

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

[diff] [blame]

656

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

657

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

Yoshi Automation Bot

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

[diff] [blame]

658

"A String",

659

],

yoshi-code-bot

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

[diff] [blame]

660

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

661

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

662

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

663

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

664

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

Yoshi Automation Bot

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

[diff] [blame]

665

},

yoshi-code-bot

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

[diff] [blame]

666

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

Yoshi Automation Bot

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

[diff] [blame]

667

},

yoshi-code-bot

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

[diff] [blame]

668

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

669

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

670

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

671

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

672

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

Yoshi Automation Bot

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

[diff] [blame]

673

},

674

],

yoshi-code-bot

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

[diff] [blame]

675

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

676

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

Yoshi Automation Bot

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

[diff] [blame]

677

},

yoshi-code-bot

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

[diff] [blame]

678

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

679

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

Yoshi Automation Bot

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

[diff] [blame]

680

},

681

},

682

],

yoshi-code-bot

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

[diff] [blame]

683

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

Yoshi Automation Bot

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

[diff] [blame]

684

"A String",

685

],

yoshi-code-bot

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

[diff] [blame]

686

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

Yoshi Automation Bot

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

[diff] [blame]

"A String",

],

},

],

yoshi-code-bot

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

[diff] [blame]

691

"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Yoshi Automation Bot

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

[diff] [blame]

692

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

yoshi-code-bot

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

[diff] [blame]

696

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

Bu Sun Kim

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

[diff] [blame]

697

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

698

699

Args:

700

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

701

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

702

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

703

body: object, The request body.

704

The object takes the form of:

705

706

{

Yoshi Automation Bot

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

[diff] [blame]

707

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

708

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

709

"a_key": "A String",

710

},

711

}

Bu Sun Kim

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

[diff] [blame]

712

yoshi-code-bot

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

[diff] [blame]

713

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

714

x__xgafv: string, V1 error format.

715

Allowed values

716

1 - v1 error format

717

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

718

719

Returns:

720

An object of the form:

721

yoshi-code-bot

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

[diff] [blame]

722

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

Yoshi Automation Bot

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

[diff] [blame]

723

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

724

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

725

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

726

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

727

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

728

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

Bu Sun Kim

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

[diff] [blame]

729

{

Yoshi Automation Bot

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

[diff] [blame]

730

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

731

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

732

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

Bu Sun Kim

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

[diff] [blame]

733

},

734

],

Yoshi Automation Bot

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

[diff] [blame]

735

},

736

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

737

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

738

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

739

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

740

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

741

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

yoshi-code-bot

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

[diff] [blame]

742

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

Yoshi Automation Bot

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

[diff] [blame]

743

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

744

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

745

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

746

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

747

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

748

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

749

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

750

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

751

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

752

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

753

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

754

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

755

{

756

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

yoshi-code-bot

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

[diff] [blame]

757

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

Yoshi Automation Bot