Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / compute_beta.snapshots.html
blob: 526f6cdd76b378a31ba0a23f76a61f3bb8e99bcd [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.snapshots.html">snapshots</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]78 <code><a href="#delete">delete(project, snapshot, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]79<p class="firstline">Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot.</p>
80<p class="toc_element">
81 <code><a href="#get">get(project, snapshot)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request.</p>
83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]84 <code><a href="#getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]85<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]86<p class="toc_element">
87 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
88<p class="firstline">Retrieves the list of Snapshot resources contained within the specified project.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]93 <code><a href="#setIamPolicy">setIamPolicy(project, resource, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]96 <code><a href="#setLabels">setLabels(project, resource, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97<p class="firstline">Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]99 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]100<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
101<h3>Method Details</h3>
102<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103 <code class="details" id="delete">delete(project, snapshot, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]104 <pre>Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot.
105
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106For more information, see Deleting snapshots.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]107
108Args:
109 project: string, Project ID for this request. (required)
110 snapshot: string, Name of the Snapshot resource to delete. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]111 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.
112
113For 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.
114
115The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]116
117Returns:
118 An object of the form:
119
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]120 { # Represents an Operation resource.
121 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]122 # Google Compute Engine has three Operation resources:
123 #
124 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
125 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]126 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
127 #
128 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]129 # - For global operations, use the `globalOperations` resource.
130 # - For regional operations, use the `regionOperations` resource.
131 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]132 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]133 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]134 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]135 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]136 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]137 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]138 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]139 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]140 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
141 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]142 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]143 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]144 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]145 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]146 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
147 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
148 {
149 "message": "A String", # [Output Only] A human-readable description of the warning code.
150 "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.
151 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
152 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
153 {
154 "value": "A String", # [Output Only] A warning data value corresponding to the key.
155 "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).
156 },
157 ],
158 },
159 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]160 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]161 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]162 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
163 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]164 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]165 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
166 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
167 {
168 "message": "A String", # [Output Only] An optional, human-readable error message.
169 "code": "A String", # [Output Only] The error type identifier for this error.
170 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
171 },
172 ],
173 },
174 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
175 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]176 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]177 }</pre>
178</div>
179
180<div class="method">
181 <code class="details" id="get">get(project, snapshot)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]182 <pre>Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]183
184Args:
185 project: string, Project ID for this request. (required)
186 snapshot: string, Name of the Snapshot resource to return. (required)
187
188Returns:
189 An object of the form:
190
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]191 { # Represents a Persistent Disk Snapshot resource.
192 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]193 # You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. (== resource_for {$api_version}.snapshots ==)
194 "autoCreated": True or False, # [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]195 "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
196 "kind": "compute#snapshot", # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
197 "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
198 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]199 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]200 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
201 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
202 #
203 # The key must meet the following requirements before you can provide it to Compute Engine:
204 # - The key is wrapped using a RSA public key certificate provided by Google.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]205 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]206 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]207 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]208 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]209 "storageBytes": "A String", # [Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]210 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
211 "sourceDisk": "A String", # [Output Only] The source disk used to create this snapshot.
212 "snapshotEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the snapshot using a customer-supplied encryption key.
213 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]214 # After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]215 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]216 # Customer-supplied encryption keys do not protect access to metadata of the snapshot.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]217 #
218 # If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.
219 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]220 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]221 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
222 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
223 #
224 # The key must meet the following requirements before you can provide it to Compute Engine:
225 # - The key is wrapped using a RSA public key certificate provided by Google.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]226 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]227 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]228 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]229 },
230 "storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]231 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]232 #
233 # To see the latest fingerprint, make a get() request to retrieve a snapshot.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]234 "labels": { # Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]235 "a_key": "A String",
236 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]237 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]238 "diskSizeGb": "A String", # [Output Only] Size of the source disk, specified in GB.
239 "downloadBytes": "A String", # [Output Only] Number of bytes downloaded to restore a snapshot to a disk.
240 "storageLocations": [ # Cloud Storage bucket storage location of the snapshot (regional or multi-regional).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]241 "A String",
242 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]243 "licenses": [ # [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).
244 "A String",
245 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]246 "sourceDiskId": "A String", # [Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]247 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
248 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
249 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]250 "licenseCodes": [ # [Output Only] Integer license codes indicating which licenses are attached to this snapshot.
251 "A String",
252 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]253 }</pre>
254</div>
255
256<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]257 <code class="details" id="getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]258 <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.
259
260Args:
261 project: string, Project ID for this request. (required)
262 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]263 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]264
265Returns:
266 An object of the form:
267
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]268 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]269 #
270 #
271 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]272 # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]273 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]274 # Optionally, a `binding` can 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]275 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]276 # **JSON example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]277 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]278 # { "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 &lt; timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]279 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]280 # **YAML example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]281 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]282 # 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 &lt; timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]283 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]284 # For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]285 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
286 { # 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.
287 #
288 # 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.
289 #
290 # Example Policy with multiple AuditConfigs:
291 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]292 # { "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" ] } ] } ] }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]293 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]294 # 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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]295 "exemptedMembers": [
296 "A String",
297 ],
298 "auditLogConfigs": [ # The configuration for logging of each type of permission.
299 { # Provides the configuration for logging a type of permissions. Example:
300 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]301 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]302 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]303 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]304 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].
305 "A String",
306 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]307 "ignoreChildExemptions": True or False,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]308 "logType": "A String", # The log type that this config enables.
309 },
310 ],
311 "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.
312 },
313 ],
314 "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
315 { # A rule to be applied in a Policy.
316 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
317 { # Specifies what kind of log the caller must write
318 "counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.
319 #
320 # Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended.
321 #
322 # Field names correspond to IAM request parameters and field values are their respective values.
323 #
324 # Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields.
325 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]326 # Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==&gt; increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]327 "field": "A String", # The field value to attribute.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]328 "customFields": [ # Custom fields.
329 { # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.
330 "name": "A String", # Name is the field name.
331 "value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.
332 },
333 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]334 "metric": "A String", # The metric to update.
335 },
336 "dataAccess": { # Write a Data Access (Gin) log # Data access options.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]337 "logMode": "A String", # Whether Gin logging should happen in a fail-closed manner at the caller. This is currently supported in the LocalIAM implementation, Stubby C++, and Stubby Java. For Apps Framework, see go/af-audit-logging#failclosed. TODO(b/77591626): Add support for Stubby Go. TODO(b/129671387): Add support for Scaffolding.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]338 },
339 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
340 "logName": "A String", # The log_name to populate in the Cloud Audit Record.
341 "authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.
342 "permissionType": "A String", # The type of the permission that was checked.
343 },
344 },
345 },
346 ],
347 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
348 "A String",
349 ],
350 "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
351 "A String",
352 ],
353 "action": "A String", # Required
354 "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
355 "A String",
356 ],
357 "conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.
358 { # A condition to be met.
359 "iam": "A String", # Trusted attributes supplied by the IAM system.
360 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
361 "values": [ # The objects of the condition.
362 "A String",
363 ],
364 "svc": "A String", # Trusted attributes discharged by the service.
365 "op": "A String", # An operator to apply the subject with.
366 },
367 ],
368 "description": "A String", # Human-readable description of the rule.
369 },
370 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]371 "version": 42, # Specifies the format of the policy.
372 #
373 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.
374 #
375 # Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:
376 #
377 # * 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
378 #
379 # **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.
380 #
381 # If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]382 "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.
383 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]384 # **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.
385 "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]386 { # Associates `members` with a `role`.
387 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
388 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
389 #
390 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
391 #
392 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
393 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]394 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]395 #
396 #
397 #
398 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
399 #
400 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
401 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]402 # * `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.
403 #
404 # * `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.
405 #
406 # * `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.
407 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]408 #
409 #
410 # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
411 "A String",
412 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]413 "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. # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]414 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]415 # Example (Comparison):
416 #
417 # title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() &lt; 100"
418 #
419 # Example (Equality):
420 #
421 # title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"
422 #
423 # Example (Logic):
424 #
425 # title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
426 #
427 # Example (Data Manipulation):
428 #
429 # title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"
430 #
431 # 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.
432 "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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]433 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]434 "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.
435 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]436 },
437 },
438 ],
439 "iamOwned": True or False,
440 }</pre>
441</div>
442
443<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]444 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
445 <pre>Retrieves the list of Snapshot resources contained within the specified project.
446
447Args:
448 project: string, Project ID for this request. (required)
449 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
450
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]451You 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]452
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]453Currently, only sorting by `name` or `creationTimestamp desc` is supported.
454 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`)
455 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.
456 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 `=`, `!=`, `&gt;`, or `&lt;`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]457
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]458For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]459
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]460You 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]461
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]462To 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) ```
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]463
464Returns:
465 An object of the form:
466
467 { # Contains a list of Snapshot resources.
468 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]469 "kind": "compute#snapshotList", # Type of resource.
470 "items": [ # A list of Snapshot resources.
471 { # Represents a Persistent Disk Snapshot resource.
472 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]473 # You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. (== resource_for {$api_version}.snapshots ==)
474 "autoCreated": True or False, # [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]475 "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
476 "kind": "compute#snapshot", # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
477 "sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
478 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]479 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]480 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
481 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
482 #
483 # The key must meet the following requirements before you can provide it to Compute Engine:
484 # - The key is wrapped using a RSA public key certificate provided by Google.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]485 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]486 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]487 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]488 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]489 "storageBytes": "A String", # [Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]490 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
491 "sourceDisk": "A String", # [Output Only] The source disk used to create this snapshot.
492 "snapshotEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the snapshot using a customer-supplied encryption key.
493 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]494 # After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]495 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]496 # Customer-supplied encryption keys do not protect access to metadata of the snapshot.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]497 #
498 # If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.
499 "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]500 "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]501 "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
502 "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
503 #
504 # The key must meet the following requirements before you can provide it to Compute Engine:
505 # - The key is wrapped using a RSA public key certificate provided by Google.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]506 # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]507 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]508 "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]509 },
510 "storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]511 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]512 #
513 # To see the latest fingerprint, make a get() request to retrieve a snapshot.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]514 "labels": { # Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]515 "a_key": "A String",
516 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]517 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]518 "diskSizeGb": "A String", # [Output Only] Size of the source disk, specified in GB.
519 "downloadBytes": "A String", # [Output Only] Number of bytes downloaded to restore a snapshot to a disk.
520 "storageLocations": [ # Cloud Storage bucket storage location of the snapshot (regional or multi-regional).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]521 "A String",
522 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]523 "licenses": [ # [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).
524 "A String",
525 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]526 "sourceDiskId": "A String", # [Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]527 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
528 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
529 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]530 "licenseCodes": [ # [Output Only] Integer license codes indicating which licenses are attached to this snapshot.
531 "A String",
532 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]533 },
534 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]535 "warning": { # [Output Only] Informational warning message.
536 "message": "A String", # [Output Only] A human-readable description of the warning code.
537 "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.
538 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
539 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
540 {
541 "value": "A String", # [Output Only] A warning data value corresponding to the key.
542 "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).
543 },
544 ],
545 },
546 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]547 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
548 }</pre>
549</div>
550
551<div class="method">
552 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
553 <pre>Retrieves the next page of results.
554
555Args:
556 previous_request: The request for the previous page. (required)
557 previous_response: The response from the request for the previous page. (required)
558
559Returns:
560 A request object that you can call 'execute()' on to request the next
561 page. Returns None if there are no more items in the collection.
562 </pre>
563</div>
564
565<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]566 <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]567 <pre>Sets the access control policy on the specified resource. Replaces any existing policy.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]568
569Args:
570 project: string, Project ID for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]571 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]572 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]573 The object takes the form of:
574
575{
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]576 "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. # 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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]577 #
578 #
579 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]580 # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]581 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]582 # Optionally, a `binding` can 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]583 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]584 # **JSON example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]585 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]586 # { "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 &lt; timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]587 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]588 # **YAML example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]589 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]590 # 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 &lt; timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]591 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]592 # For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]593 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
594 { # 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.
595 #
596 # 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.
597 #
598 # Example Policy with multiple AuditConfigs:
599 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]600 # { "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" ] } ] } ] }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]601 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]602 # 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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]603 "exemptedMembers": [
604 "A String",
605 ],
606 "auditLogConfigs": [ # The configuration for logging of each type of permission.
607 { # Provides the configuration for logging a type of permissions. Example:
608 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]609 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]610 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]611 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]612 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].
613 "A String",
614 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]615 "ignoreChildExemptions": True or False,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]616 "logType": "A String", # The log type that this config enables.
617 },
618 ],
619 "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.
620 },
621 ],
622 "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
623 { # A rule to be applied in a Policy.
624 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
625 { # Specifies what kind of log the caller must write
626 "counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.
627 #
628 # Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended.
629 #
630 # Field names correspond to IAM request parameters and field values are their respective values.
631 #
632 # Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields.
633 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]634 # Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==&gt; increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]635 "field": "A String", # The field value to attribute.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]636 "customFields": [ # Custom fields.
637 { # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.
638 "name": "A String", # Name is the field name.
639 "value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.
640 },
641 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]642 "metric": "A String", # The metric to update.
643 },
644 "dataAccess": { # Write a Data Access (Gin) log # Data access options.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]645 "logMode": "A String", # Whether Gin logging should happen in a fail-closed manner at the caller. This is currently supported in the LocalIAM implementation, Stubby C++, and Stubby Java. For Apps Framework, see go/af-audit-logging#failclosed. TODO(b/77591626): Add support for Stubby Go. TODO(b/129671387): Add support for Scaffolding.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]646 },
647 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
648 "logName": "A String", # The log_name to populate in the Cloud Audit Record.
649 "authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.
650 "permissionType": "A String", # The type of the permission that was checked.
651 },
652 },
653 },
654 ],
655 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
656 "A String",
657 ],
658 "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
659 "A String",
660 ],
661 "action": "A String", # Required
662 "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
663 "A String",
664 ],
665 "conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.
666 { # A condition to be met.
667 "iam": "A String", # Trusted attributes supplied by the IAM system.
668 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
669 "values": [ # The objects of the condition.
670 "A String",
671 ],
672 "svc": "A String", # Trusted attributes discharged by the service.
673 "op": "A String", # An operator to apply the subject with.
674 },
675 ],
676 "description": "A String", # Human-readable description of the rule.
677 },
678 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]679 "version": 42, # Specifies the format of the policy.
680 #
681 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.
682 #
683 # Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:
684 #
685 # * 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
686 #
687 # **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.
688 #
689 # If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]690 "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.
691 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]692 # **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.
693 "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]694 { # Associates `members` with a `role`.
695 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
696 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
697 #
698 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
699 #
700 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
701 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]702 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]703 #
704 #
705 #
706 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
707 #
708 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
709 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]710 # * `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.
711 #
712 # * `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.
713 #
714 # * `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.
715 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]716 #
717 #
718 # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
719 "A String",
720 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]721 "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. # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]722 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]723 # Example (Comparison):
724 #
725 # title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() &lt; 100"
726 #
727 # Example (Equality):
728 #
729 # title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"
730 #
731 # Example (Logic):
732 #
733 # title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
734 #
735 # Example (Data Manipulation):
736 #
737 # title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"
738 #
739 # 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.
740 "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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]741 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]742 "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.
743 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]744 },
745 },
746 ],
747 "iamOwned": True or False,
748 },
749 "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings.
750 { # Associates `members` with a `role`.
751 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
752 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
753 #
754 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
755 #
756 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
757 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]758 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]759 #
760 #
761 #
762 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
763 #
764 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
765 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]766 # * `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.
767 #
768 # * `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.
769 #
770 # * `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.
771 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]772 #
773 #
774 # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
775 "A String",
776 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]777 "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. # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]778 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]779 # Example (Comparison):
780 #
781 # title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() &lt; 100"
782 #
783 # Example (Equality):
784 #
785 # title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"
786 #
787 # Example (Logic):
788 #
789 # title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
790 #
791 # Example (Data Manipulation):
792 #
793 # title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"
794 #
795 # 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.
796 "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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]797 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]798 "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.
799 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]800 },
801 },
802 ],
803 "etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.
804 }
805
806
807Returns:
808 An object of the form:
809
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]810 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]811 #
812 #
813 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]814 # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]815 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]816 # Optionally, a `binding` can 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]817 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]818 # **JSON example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]819 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]820 # { "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 &lt; timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]821 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]822 # **YAML example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]823 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]824 # 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 &lt; timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]825 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]826 # For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]827 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
828 { # 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.
829 #
830 # 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.
831 #
832 # Example Policy with multiple AuditConfigs:
833 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]834 # { "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" ] } ] } ] }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]835 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]836 # 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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]837 "exemptedMembers": [
838 "A String",
839 ],
840 "auditLogConfigs": [ # The configuration for logging of each type of permission.
841 { # Provides the configuration for logging a type of permissions. Example:
842 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]843 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]844 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]845 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]846 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].
847 "A String",
848 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]849 "ignoreChildExemptions": True or False,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]850 "logType": "A String", # The log type that this config enables.
851 },
852 ],
853 "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.
854 },
855 ],
856 "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
857 { # A rule to be applied in a Policy.
858 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
859 { # Specifies what kind of log the caller must write
860 "counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.
861 #
862 # Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended.
863 #
864 # Field names correspond to IAM request parameters and field values are their respective values.
865 #
866 # Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields.
867 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]868 # Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==&gt; increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]869 "field": "A String", # The field value to attribute.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]870 "customFields": [ # Custom fields.
871 { # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.
872 "name": "A String", # Name is the field name.
873 "value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.
874 },
875 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]876 "metric": "A String", # The metric to update.
877 },
878 "dataAccess": { # Write a Data Access (Gin) log # Data access options.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]879 "logMode": "A String", # Whether Gin logging should happen in a fail-closed manner at the caller. This is currently supported in the LocalIAM implementation, Stubby C++, and Stubby Java. For Apps Framework, see go/af-audit-logging#failclosed. TODO(b/77591626): Add support for Stubby Go. TODO(b/129671387): Add support for Scaffolding.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]880 },
881 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
882 "logName": "A String", # The log_name to populate in the Cloud Audit Record.
883 "authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.
884 "permissionType": "A String", # The type of the permission that was checked.
885 },
886 },
887 },
888 ],
889 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
890 "A String",
891 ],
892 "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
893 "A String",
894 ],
895 "action": "A String", # Required
896 "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
897 "A String",
898 ],
899 "conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.
900 { # A condition to be met.
901 "iam": "A String", # Trusted attributes supplied by the IAM system.
902 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
903 "values": [ # The objects of the condition.
904 "A String",
905 ],
906 "svc": "A String", # Trusted attributes discharged by the service.
907 "op": "A String", # An operator to apply the subject with.
908 },
909 ],
910 "description": "A String", # Human-readable description of the rule.
911 },
912 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]913 "version": 42, # Specifies the format of the policy.
914 #
915 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.
916 #
917 # Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:
918 #
919 # * 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
920 #
921 # **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.
922 #
923 # If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]924 "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.
925 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]926 # **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.
927 "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]928 { # Associates `members` with a `role`.
929 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
930 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
931 #
932 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
933 #
934 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
935 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]936 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]937 #
938 #
939 #
940 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
941 #
942 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
943 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]944 # * `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.
945 #
946 # * `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.
947 #
948 # * `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.
949 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]950 #
951 #
952 # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
953 "A String",
954 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]955 "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. # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]956 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]957 # Example (Comparison):
958 #
959 # title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() &lt; 100"
960 #
961 # Example (Equality):
962 #
963 # title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"
964 #
965 # Example (Logic):
966 #
967 # title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
968 #
969 # Example (Data Manipulation):
970 #
971 # title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"
972 #
973 # 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.
974 "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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]975 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]976 "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.
977 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]978 },
979 },
980 ],
981 "iamOwned": True or False,
982 }</pre>
983</div>
984
985<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]986 <code class="details" id="setLabels">setLabels(project, resource, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]987 <pre>Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation.
988
989Args:
990 project: string, Project ID for this request. (required)
991 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]992 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]993 The object takes the form of:
994
995{
996 "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 when updating or changing labels, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]997 "labels": { # A list of labels to apply for this resource. Each label key &amp; value must 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. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": "").
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]998 "a_key": "A String",
999 },
1000 }
1001
1002
1003Returns:
1004 An object of the form:
1005
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1006 { # Represents an Operation resource.
1007 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1008 # Google Compute Engine has three Operation resources:
1009 #
1010 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
1011 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1012 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
1013 #
1014 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1015 # - For global operations, use the `globalOperations` resource.
1016 # - For regional operations, use the `regionOperations` resource.
1017 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1018 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1019 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1020 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1021 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1022 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1023 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1024 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1025 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1026 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
1027 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1028 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1029 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1030 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1031 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1032 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
1033 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1034 {
1035 "message": "A String", # [Output Only] A human-readable description of the warning code.
1036 "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.
1037 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
1038 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
1039 {
1040 "value": "A String", # [Output Only] A warning data value corresponding to the key.
1041 "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).
1042 },
1043 ],
1044 },
1045 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1046 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1047 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1048 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
1049 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1050 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1051 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1052 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
1053 {
1054 "message": "A String", # [Output Only] An optional, human-readable error message.
1055 "code": "A String", # [Output Only] The error type identifier for this error.
1056 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
1057 },
1058 ],
1059 },
1060 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1061 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1062 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1063 }</pre>
1064</div>
1065
1066<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1067 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1068 <pre>Returns permissions that a caller has on the specified resource.
1069
1070Args:
1071 project: string, Project ID for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1072 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1073 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1074 The object takes the form of:
1075
1076{
1077 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
1078 "A String",
1079 ],
1080 }
1081
1082
1083Returns:
1084 An object of the form:
1085
1086 {
1087 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
1088 "A String",
1089 ],
1090 }</pre>
1091</div>
1092
1093</body></html>