blob: 971bb3c94a1191e85d526d457632f09cef26ac1d [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.backendBuckets.html">backendBuckets</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -040078 <code><a href="#addSignedUrlKey">addSignedUrlKey(project, backendBucket, body, requestId=None)</a></code></p>
79<p class="firstline">Adds the given Signed URL Key to the backend bucket.</p>
80<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040081 <code><a href="#delete">delete(project, backendBucket, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -070082<p class="firstline">Deletes the specified BackendBucket resource.</p>
83<p class="toc_element">
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -040084 <code><a href="#deleteSignedUrlKey">deleteSignedUrlKey(project, backendBucket, keyName, requestId=None)</a></code></p>
85<p class="firstline">Deletes the given Signed URL Key from the backend bucket.</p>
86<p class="toc_element">
Sai Cheemalapatidf613972016-10-21 13:59:49 -070087 <code><a href="#get">get(project, backendBucket)</a></code></p>
88<p class="firstline">Returns the specified BackendBucket resource. Get a list of available backend buckets by making a list() request.</p>
89<p class="toc_element">
90 <code><a href="#getIamPolicy">getIamPolicy(project, resource)</a></code></p>
91<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p>
92<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040093 <code><a href="#insert">insert(project, body, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -070094<p class="firstline">Creates a BackendBucket resource in the specified project using the data included in the request.</p>
95<p class="toc_element">
96 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
97<p class="firstline">Retrieves the list of BackendBucket resources available to the specified project.</p>
98<p class="toc_element">
99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400102 <code><a href="#patch">patch(project, backendBucket, body, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700103<p class="firstline">Updates the specified BackendBucket resource with the data included in the request. This method supports patch semantics.</p>
104<p class="toc_element">
105 <code><a href="#setIamPolicy">setIamPolicy(project, resource, body)</a></code></p>
106<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>
107<p class="toc_element">
108 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
109<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
110<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400111 <code><a href="#update">update(project, backendBucket, body, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700112<p class="firstline">Updates the specified BackendBucket resource with the data included in the request.</p>
113<h3>Method Details</h3>
114<div class="method">
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400115 <code class="details" id="addSignedUrlKey">addSignedUrlKey(project, backendBucket, body, requestId=None)</code>
116 <pre>Adds the given Signed URL Key to the backend bucket.
117
118Args:
119 project: string, Project ID for this request. (required)
120 backendBucket: string, Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035. (required)
121 body: object, The request body. (required)
122 The object takes the form of:
123
124{ # Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs
125 "keyName": "A String", # Name of the key. 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.
126 "keyValue": "A String", # 128-bit key value used for signing the URL. The key value must be a valid RFC 4648 Section 5 base64url encoded string.
127 }
128
129 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
130
131Returns:
132 An object of the form:
133
134 { # An Operation resource, used to manage asynchronous API requests.
135 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
136 "clientOperationId": "A String", # [Output Only] Reserved for future use.
137 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
138 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
139 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
140 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
141 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
142 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
143 "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.
144 "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.
145 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
146 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
147 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
148 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
149 {
150 "message": "A String", # [Output Only] A human-readable description of the warning code.
151 "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.
152 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
153 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
154 {
155 "value": "A String", # [Output Only] A warning data value corresponding to the key.
156 "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).
157 },
158 ],
159 },
160 ],
161 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
162 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
163 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
164 "name": "A String", # [Output Only] Name of the resource.
165 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
166 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
167 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
168 {
169 "message": "A String", # [Output Only] An optional, human-readable error message.
170 "code": "A String", # [Output Only] The error type identifier for this error.
171 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
172 },
173 ],
174 },
175 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
176 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
177 "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.
178 }</pre>
179</div>
180
181<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400182 <code class="details" id="delete">delete(project, backendBucket, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700183 <pre>Deletes the specified BackendBucket resource.
184
185Args:
186 project: string, Project ID for this request. (required)
187 backendBucket: string, Name of the BackendBucket resource to delete. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400188 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700189
190Returns:
191 An object of the form:
192
193 { # An Operation resource, used to manage asynchronous API requests.
194 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
195 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400196 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700197 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
198 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
199 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
200 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
201 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
202 "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.
203 "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.
204 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
205 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
206 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
207 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
208 {
209 "message": "A String", # [Output Only] A human-readable description of the warning code.
210 "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.
211 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
212 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
213 {
214 "value": "A String", # [Output Only] A warning data value corresponding to the key.
215 "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).
216 },
217 ],
218 },
219 ],
220 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
221 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
222 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
223 "name": "A String", # [Output Only] Name of the resource.
224 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
225 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
226 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
227 {
228 "message": "A String", # [Output Only] An optional, human-readable error message.
229 "code": "A String", # [Output Only] The error type identifier for this error.
230 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
231 },
232 ],
233 },
234 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
235 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800236 "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 -0700237 }</pre>
238</div>
239
240<div class="method">
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400241 <code class="details" id="deleteSignedUrlKey">deleteSignedUrlKey(project, backendBucket, keyName, requestId=None)</code>
242 <pre>Deletes the given Signed URL Key from the backend bucket.
243
244Args:
245 project: string, Project ID for this request. (required)
246 backendBucket: string, Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035. (required)
247 keyName: string, The name of the Signed URL Key to delete. (required)
248 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
249
250Returns:
251 An object of the form:
252
253 { # An Operation resource, used to manage asynchronous API requests.
254 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
255 "clientOperationId": "A String", # [Output Only] Reserved for future use.
256 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
257 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
258 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
259 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
260 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
261 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
262 "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.
263 "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.
264 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
265 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
266 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
267 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
268 {
269 "message": "A String", # [Output Only] A human-readable description of the warning code.
270 "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.
271 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
272 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
273 {
274 "value": "A String", # [Output Only] A warning data value corresponding to the key.
275 "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).
276 },
277 ],
278 },
279 ],
280 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
281 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
282 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
283 "name": "A String", # [Output Only] Name of the resource.
284 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
285 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
286 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
287 {
288 "message": "A String", # [Output Only] An optional, human-readable error message.
289 "code": "A String", # [Output Only] The error type identifier for this error.
290 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
291 },
292 ],
293 },
294 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
295 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
296 "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.
297 }</pre>
298</div>
299
300<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700301 <code class="details" id="get">get(project, backendBucket)</code>
302 <pre>Returns the specified BackendBucket resource. Get a list of available backend buckets by making a list() request.
303
304Args:
305 project: string, Project ID for this request. (required)
306 backendBucket: string, Name of the BackendBucket resource to return. (required)
307
308Returns:
309 An object of the form:
310
311 { # A BackendBucket resource. This resource defines a Cloud Storage bucket.
312 "kind": "compute#backendBucket", # Type of the resource.
313 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400314 "cdnPolicy": { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN Coniguration for this BackendBucket.
315 "signedUrlKeyNames": [ # [Output Only] Names of the keys currently configured for Cloud CDN Signed URL on this backend bucket.
316 "A String",
317 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400318 "signedUrlCacheMaxAgeSec": "A String", # Number of seconds up to which the response to a signed URL request will be cached in the CDN. After this time period, the Signed URL will be revalidated before being served. Defaults to 1hr (3600s). If this field is set, Cloud CDN will internally act as though all responses from this bucket had a ?Cache-Control: public, max-age=[TTL]? header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400319 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700320 "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket.
321 "bucketName": "A String", # Cloud Storage bucket name.
322 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
323 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
324 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
325 "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.
326 }</pre>
327</div>
328
329<div class="method">
330 <code class="details" id="getIamPolicy">getIamPolicy(project, resource)</code>
331 <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.
332
333Args:
334 project: string, Project ID for this request. (required)
335 resource: string, Name of the resource for this request. (required)
336
337Returns:
338 An object of the form:
339
340 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
341 #
342 #
343 #
344 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
345 #
346 # **Example**
347 #
348 # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
349 #
350 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400351 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400352 { # 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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400353 #
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400354 # 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 AuditConfig are exempted.
355 #
356 # Example Policy with multiple AuditConfigs:
357 #
358 # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] }
359 #
360 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400361 "exemptedMembers": [
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700362 "A String",
363 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400364 "auditLogConfigs": [ # The configuration for logging of each type of permission.
365 { # Provides the configuration for logging a type of permissions. Example:
366 #
367 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] }
368 #
369 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging.
370 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800371 "A String",
372 ],
373 "logType": "A String", # The log type that this config enables.
374 },
375 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400376 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700377 },
378 ],
379 "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.
380 { # A rule to be applied in a Policy.
381 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
382 { # Specifies what kind of log the caller must write
383 "counter": { # Options for counters # Counter options.
384 "field": "A String", # The field value to attribute.
385 "metric": "A String", # The metric to update.
386 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400387 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
388 "logName": "A String", # The log_name to populate in the Cloud Audit Record.
389 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700390 },
391 ],
392 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
393 "A String",
394 ],
395 "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.
396 "A String",
397 ],
398 "action": "A String", # Required
399 "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.
400 "A String",
401 ],
402 "conditions": [ # Additional restrictions that must be met
403 { # A condition to be met.
404 "iam": "A String", # Trusted attributes supplied by the IAM system.
405 "svc": "A String", # Trusted attributes discharged by the service.
406 "value": "A String", # DEPRECATED. Use 'values' instead.
407 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
408 "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
409 "A String",
410 ],
411 "op": "A String", # An operator to apply the subject with.
412 },
413 ],
414 "description": "A String", # Human-readable description of the rule.
415 },
416 ],
417 "version": 42, # Version of the `Policy`. The default version is 0.
418 "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.
419 #
420 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
421 "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
422 { # Associates `members` with a `role`.
423 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
424 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
425 #
426 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
427 #
428 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
429 #
430 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
431 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800432 #
433 #
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700434 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
435 #
436 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
437 #
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400438 #
439 #
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700440 # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
441 "A String",
442 ],
443 },
444 ],
445 "iamOwned": True or False,
446 }</pre>
447</div>
448
449<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400450 <code class="details" id="insert">insert(project, body, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700451 <pre>Creates a BackendBucket resource in the specified project using the data included in the request.
452
453Args:
454 project: string, Project ID for this request. (required)
455 body: object, The request body. (required)
456 The object takes the form of:
457
458{ # A BackendBucket resource. This resource defines a Cloud Storage bucket.
459 "kind": "compute#backendBucket", # Type of the resource.
460 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400461 "cdnPolicy": { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN Coniguration for this BackendBucket.
462 "signedUrlKeyNames": [ # [Output Only] Names of the keys currently configured for Cloud CDN Signed URL on this backend bucket.
463 "A String",
464 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400465 "signedUrlCacheMaxAgeSec": "A String", # Number of seconds up to which the response to a signed URL request will be cached in the CDN. After this time period, the Signed URL will be revalidated before being served. Defaults to 1hr (3600s). If this field is set, Cloud CDN will internally act as though all responses from this bucket had a ?Cache-Control: public, max-age=[TTL]? header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400466 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700467 "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket.
468 "bucketName": "A String", # Cloud Storage bucket name.
469 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
470 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
471 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
472 "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.
473 }
474
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400475 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700476
477Returns:
478 An object of the form:
479
480 { # An Operation resource, used to manage asynchronous API requests.
481 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
482 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400483 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700484 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
485 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
486 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
487 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
488 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
489 "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.
490 "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.
491 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
492 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
493 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
494 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
495 {
496 "message": "A String", # [Output Only] A human-readable description of the warning code.
497 "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.
498 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
499 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
500 {
501 "value": "A String", # [Output Only] A warning data value corresponding to the key.
502 "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).
503 },
504 ],
505 },
506 ],
507 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
508 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
509 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
510 "name": "A String", # [Output Only] Name of the resource.
511 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
512 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
513 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
514 {
515 "message": "A String", # [Output Only] An optional, human-readable error message.
516 "code": "A String", # [Output Only] The error type identifier for this error.
517 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
518 },
519 ],
520 },
521 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
522 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800523 "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 -0700524 }</pre>
525</div>
526
527<div class="method">
528 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
529 <pre>Retrieves the list of BackendBucket resources available to the specified project.
530
531Args:
532 project: string, Project ID for this request. (required)
533 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
534
535You 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.
536
537Currently, only sorting by name or creationTimestamp desc is supported.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400538 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)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700539 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.
540 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
541
542The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
543
544For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
545
546You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
547
548To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
549
550Returns:
551 An object of the form:
552
553 { # Contains a list of BackendBucket resources.
554 "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
555 "items": [ # A list of BackendBucket resources.
556 { # A BackendBucket resource. This resource defines a Cloud Storage bucket.
557 "kind": "compute#backendBucket", # Type of the resource.
558 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400559 "cdnPolicy": { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN Coniguration for this BackendBucket.
560 "signedUrlKeyNames": [ # [Output Only] Names of the keys currently configured for Cloud CDN Signed URL on this backend bucket.
561 "A String",
562 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400563 "signedUrlCacheMaxAgeSec": "A String", # Number of seconds up to which the response to a signed URL request will be cached in the CDN. After this time period, the Signed URL will be revalidated before being served. Defaults to 1hr (3600s). If this field is set, Cloud CDN will internally act as though all responses from this bucket had a ?Cache-Control: public, max-age=[TTL]? header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400564 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700565 "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket.
566 "bucketName": "A String", # Cloud Storage bucket name.
567 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
568 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
569 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
570 "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.
571 },
572 ],
573 "kind": "compute#backendBucketList", # Type of resource.
574 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
575 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
576 }</pre>
577</div>
578
579<div class="method">
580 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
581 <pre>Retrieves the next page of results.
582
583Args:
584 previous_request: The request for the previous page. (required)
585 previous_response: The response from the request for the previous page. (required)
586
587Returns:
588 A request object that you can call 'execute()' on to request the next
589 page. Returns None if there are no more items in the collection.
590 </pre>
591</div>
592
593<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400594 <code class="details" id="patch">patch(project, backendBucket, body, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700595 <pre>Updates the specified BackendBucket resource with the data included in the request. This method supports patch semantics.
596
597Args:
598 project: string, Project ID for this request. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400599 backendBucket: string, Name of the BackendBucket resource to patch. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700600 body: object, The request body. (required)
601 The object takes the form of:
602
603{ # A BackendBucket resource. This resource defines a Cloud Storage bucket.
604 "kind": "compute#backendBucket", # Type of the resource.
605 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400606 "cdnPolicy": { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN Coniguration for this BackendBucket.
607 "signedUrlKeyNames": [ # [Output Only] Names of the keys currently configured for Cloud CDN Signed URL on this backend bucket.
608 "A String",
609 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400610 "signedUrlCacheMaxAgeSec": "A String", # Number of seconds up to which the response to a signed URL request will be cached in the CDN. After this time period, the Signed URL will be revalidated before being served. Defaults to 1hr (3600s). If this field is set, Cloud CDN will internally act as though all responses from this bucket had a ?Cache-Control: public, max-age=[TTL]? header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400611 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700612 "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket.
613 "bucketName": "A String", # Cloud Storage bucket name.
614 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
615 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
616 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
617 "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.
618 }
619
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400620 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700621
622Returns:
623 An object of the form:
624
625 { # An Operation resource, used to manage asynchronous API requests.
626 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
627 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400628 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700629 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
630 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
631 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
632 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
633 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
634 "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.
635 "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.
636 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
637 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
638 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
639 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
640 {
641 "message": "A String", # [Output Only] A human-readable description of the warning code.
642 "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.
643 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
644 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
645 {
646 "value": "A String", # [Output Only] A warning data value corresponding to the key.
647 "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).
648 },
649 ],
650 },
651 ],
652 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
653 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
654 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
655 "name": "A String", # [Output Only] Name of the resource.
656 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
657 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
658 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
659 {
660 "message": "A String", # [Output Only] An optional, human-readable error message.
661 "code": "A String", # [Output Only] The error type identifier for this error.
662 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
663 },
664 ],
665 },
666 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
667 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800668 "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 -0700669 }</pre>
670</div>
671
672<div class="method">
673 <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body)</code>
674 <pre>Sets the access control policy on the specified resource. Replaces any existing policy.
675
676Args:
677 project: string, Project ID for this request. (required)
678 resource: string, Name of the resource for this request. (required)
679 body: object, The request body. (required)
680 The object takes the form of:
681
682{ # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
683 #
684 #
685 #
686 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
687 #
688 # **Example**
689 #
690 # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
691 #
692 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400693 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400694 { # 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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400695 #
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400696 # 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 AuditConfig are exempted.
697 #
698 # Example Policy with multiple AuditConfigs:
699 #
700 # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] }
701 #
702 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400703 "exemptedMembers": [
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700704 "A String",
705 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400706 "auditLogConfigs": [ # The configuration for logging of each type of permission.
707 { # Provides the configuration for logging a type of permissions. Example:
708 #
709 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] }
710 #
711 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging.
712 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800713 "A String",
714 ],
715 "logType": "A String", # The log type that this config enables.
716 },
717 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400718 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700719 },
720 ],
721 "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.
722 { # A rule to be applied in a Policy.
723 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
724 { # Specifies what kind of log the caller must write
725 "counter": { # Options for counters # Counter options.
726 "field": "A String", # The field value to attribute.
727 "metric": "A String", # The metric to update.
728 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400729 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
730 "logName": "A String", # The log_name to populate in the Cloud Audit Record.
731 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700732 },
733 ],
734 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
735 "A String",
736 ],
737 "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.
738 "A String",
739 ],
740 "action": "A String", # Required
741 "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.
742 "A String",
743 ],
744 "conditions": [ # Additional restrictions that must be met
745 { # A condition to be met.
746 "iam": "A String", # Trusted attributes supplied by the IAM system.
747 "svc": "A String", # Trusted attributes discharged by the service.
748 "value": "A String", # DEPRECATED. Use 'values' instead.
749 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
750 "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
751 "A String",
752 ],
753 "op": "A String", # An operator to apply the subject with.
754 },
755 ],
756 "description": "A String", # Human-readable description of the rule.
757 },
758 ],
759 "version": 42, # Version of the `Policy`. The default version is 0.
760 "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.
761 #
762 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
763 "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
764 { # Associates `members` with a `role`.
765 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
766 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
767 #
768 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
769 #
770 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
771 #
772 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
773 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800774 #
775 #
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700776 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
777 #
778 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
779 #
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400780 #
781 #
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700782 # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
783 "A String",
784 ],
785 },
786 ],
787 "iamOwned": True or False,
788}
789
790
791Returns:
792 An object of the form:
793
794 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
795 #
796 #
797 #
798 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.
799 #
800 # **Example**
801 #
802 # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
803 #
804 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400805 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400806 { # 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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400807 #
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400808 # 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 AuditConfig are exempted.
809 #
810 # Example Policy with multiple AuditConfigs:
811 #
812 # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] }
813 #
814 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400815 "exemptedMembers": [
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700816 "A String",
817 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400818 "auditLogConfigs": [ # The configuration for logging of each type of permission.
819 { # Provides the configuration for logging a type of permissions. Example:
820 #
821 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] }
822 #
823 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging.
824 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800825 "A String",
826 ],
827 "logType": "A String", # The log type that this config enables.
828 },
829 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400830 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700831 },
832 ],
833 "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.
834 { # A rule to be applied in a Policy.
835 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
836 { # Specifies what kind of log the caller must write
837 "counter": { # Options for counters # Counter options.
838 "field": "A String", # The field value to attribute.
839 "metric": "A String", # The metric to update.
840 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400841 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
842 "logName": "A String", # The log_name to populate in the Cloud Audit Record.
843 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700844 },
845 ],
846 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
847 "A String",
848 ],
849 "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.
850 "A String",
851 ],
852 "action": "A String", # Required
853 "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.
854 "A String",
855 ],
856 "conditions": [ # Additional restrictions that must be met
857 { # A condition to be met.
858 "iam": "A String", # Trusted attributes supplied by the IAM system.
859 "svc": "A String", # Trusted attributes discharged by the service.
860 "value": "A String", # DEPRECATED. Use 'values' instead.
861 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
862 "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
863 "A String",
864 ],
865 "op": "A String", # An operator to apply the subject with.
866 },
867 ],
868 "description": "A String", # Human-readable description of the rule.
869 },
870 ],
871 "version": 42, # Version of the `Policy`. The default version is 0.
872 "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.
873 #
874 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
875 "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
876 { # Associates `members` with a `role`.
877 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
878 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
879 #
880 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
881 #
882 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
883 #
884 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
885 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800886 #
887 #
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700888 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
889 #
890 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
891 #
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400892 #
893 #
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700894 # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
895 "A String",
896 ],
897 },
898 ],
899 "iamOwned": True or False,
900 }</pre>
901</div>
902
903<div class="method">
904 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
905 <pre>Returns permissions that a caller has on the specified resource.
906
907Args:
908 project: string, Project ID for this request. (required)
909 resource: string, Name of the resource for this request. (required)
910 body: object, The request body. (required)
911 The object takes the form of:
912
913{
914 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
915 "A String",
916 ],
917 }
918
919
920Returns:
921 An object of the form:
922
923 {
924 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
925 "A String",
926 ],
927 }</pre>
928</div>
929
930<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400931 <code class="details" id="update">update(project, backendBucket, body, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700932 <pre>Updates the specified BackendBucket resource with the data included in the request.
933
934Args:
935 project: string, Project ID for this request. (required)
936 backendBucket: string, Name of the BackendBucket resource to update. (required)
937 body: object, The request body. (required)
938 The object takes the form of:
939
940{ # A BackendBucket resource. This resource defines a Cloud Storage bucket.
941 "kind": "compute#backendBucket", # Type of the resource.
942 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400943 "cdnPolicy": { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN Coniguration for this BackendBucket.
944 "signedUrlKeyNames": [ # [Output Only] Names of the keys currently configured for Cloud CDN Signed URL on this backend bucket.
945 "A String",
946 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400947 "signedUrlCacheMaxAgeSec": "A String", # Number of seconds up to which the response to a signed URL request will be cached in the CDN. After this time period, the Signed URL will be revalidated before being served. Defaults to 1hr (3600s). If this field is set, Cloud CDN will internally act as though all responses from this bucket had a ?Cache-Control: public, max-age=[TTL]? header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400948 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700949 "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket.
950 "bucketName": "A String", # Cloud Storage bucket name.
951 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
952 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
953 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
954 "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.
955 }
956
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400957 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700958
959Returns:
960 An object of the form:
961
962 { # An Operation resource, used to manage asynchronous API requests.
963 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
964 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400965 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700966 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
967 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
968 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
969 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
970 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
971 "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.
972 "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.
973 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
974 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
975 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
976 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
977 {
978 "message": "A String", # [Output Only] A human-readable description of the warning code.
979 "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.
980 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
981 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
982 {
983 "value": "A String", # [Output Only] A warning data value corresponding to the key.
984 "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).
985 },
986 ],
987 },
988 ],
989 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
990 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
991 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
992 "name": "A String", # [Output Only] Name of the resource.
993 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
994 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
995 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
996 {
997 "message": "A String", # [Output Only] An optional, human-readable error message.
998 "code": "A String", # [Output Only] The error type identifier for this error.
999 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
1000 },
1001 ],
1002 },
1003 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1004 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001005 "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 -07001006 }</pre>
1007</div>
1008
1009</body></html>