Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 85c2c6d80859c466d29946e66ccd6a1c3a2df748 / . / docs / dyn / compute_alpha.backendBuckets.html
blob: a0bba70e782c78b9be38b813505d42458f876bba [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_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">
78 <code><a href="#delete">delete(project, backendBucket)</a></code></p>
79<p class="firstline">Deletes the specified BackendBucket resource.</p>
80<p class="toc_element">
81 <code><a href="#get">get(project, backendBucket)</a></code></p>
82<p class="firstline">Returns the specified BackendBucket resource. Get a list of available backend buckets by making a list() request.</p>
83<p class="toc_element">
84 <code><a href="#getIamPolicy">getIamPolicy(project, resource)</a></code></p>
85<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p>
86<p class="toc_element">
87 <code><a href="#insert">insert(project, body)</a></code></p>
88<p class="firstline">Creates a BackendBucket resource in the specified project using the data included in the request.</p>
89<p class="toc_element">
90 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
91<p class="firstline">Retrieves the list of BackendBucket resources available to the specified project.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
96 <code><a href="#patch">patch(project, backendBucket, body)</a></code></p>
97<p class="firstline">Updates the specified BackendBucket resource with the data included in the request. This method supports patch semantics.</p>
98<p class="toc_element">
99 <code><a href="#setIamPolicy">setIamPolicy(project, resource, body)</a></code></p>
100<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>
101<p class="toc_element">
102 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
103<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
104<p class="toc_element">
105 <code><a href="#update">update(project, backendBucket, body)</a></code></p>
106<p class="firstline">Updates the specified BackendBucket resource with the data included in the request.</p>
107<h3>Method Details</h3>
108<div class="method">
109 <code class="details" id="delete">delete(project, backendBucket)</code>
110 <pre>Deletes the specified BackendBucket resource.
111
112Args:
113 project: string, Project ID for this request. (required)
114 backendBucket: string, Name of the BackendBucket resource to delete. (required)
115
116Returns:
117 An object of the form:
118
119 { # An Operation resource, used to manage asynchronous API requests.
120 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
121 "clientOperationId": "A String", # [Output Only] Reserved for future use.
122 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
123 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
124 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
125 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
126 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
127 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
128 "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.
129 "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.
130 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
131 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
132 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
133 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
134 {
135 "message": "A String", # [Output Only] A human-readable description of the warning code.
136 "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.
137 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
138 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
139 {
140 "value": "A String", # [Output Only] A warning data value corresponding to the key.
141 "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).
142 },
143 ],
144 },
145 ],
146 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
147 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
148 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
149 "name": "A String", # [Output Only] Name of the resource.
150 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
151 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
152 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
153 {
154 "message": "A String", # [Output Only] An optional, human-readable error message.
155 "code": "A String", # [Output Only] The error type identifier for this error.
156 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
157 },
158 ],
159 },
160 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
161 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
162 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
163 }</pre>
164</div>
165
166<div class="method">
167 <code class="details" id="get">get(project, backendBucket)</code>
168 <pre>Returns the specified BackendBucket resource. Get a list of available backend buckets by making a list() request.
169
170Args:
171 project: string, Project ID for this request. (required)
172 backendBucket: string, Name of the BackendBucket resource to return. (required)
173
174Returns:
175 An object of the form:
176
177 { # A BackendBucket resource. This resource defines a Cloud Storage bucket.
178 "kind": "compute#backendBucket", # Type of the resource.
179 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
180 "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket.
181 "bucketName": "A String", # Cloud Storage bucket name.
182 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
183 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
184 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
185 "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.
186 }</pre>
187</div>
188
189<div class="method">
190 <code class="details" id="getIamPolicy">getIamPolicy(project, resource)</code>
191 <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.
192
193Args:
194 project: string, Project ID for this request. (required)
195 resource: string, Name of the resource for this request. (required)
196
197Returns:
198 An object of the form:
199
200 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
201 #
202 #
203 #
204 # 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.
205 #
206 # **Example**
207 #
208 # { "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"] } ] }
209 #
210 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
211 "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
212 #
213 # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
214 { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
215 "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
216 "A String",
217 ],
218 "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
219 },
220 ],
221 "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.
222 { # A rule to be applied in a Policy.
223 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
224 { # Specifies what kind of log the caller must write
225 "counter": { # Options for counters # Counter options.
226 "field": "A String", # The field value to attribute.
227 "metric": "A String", # The metric to update.
228 },
229 },
230 ],
231 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
232 "A String",
233 ],
234 "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.
235 "A String",
236 ],
237 "action": "A String", # Required
238 "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.
239 "A String",
240 ],
241 "conditions": [ # Additional restrictions that must be met
242 { # A condition to be met.
243 "iam": "A String", # Trusted attributes supplied by the IAM system.
244 "svc": "A String", # Trusted attributes discharged by the service.
245 "value": "A String", # DEPRECATED. Use 'values' instead.
246 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
247 "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
248 "A String",
249 ],
250 "op": "A String", # An operator to apply the subject with.
251 },
252 ],
253 "description": "A String", # Human-readable description of the rule.
254 },
255 ],
256 "version": 42, # Version of the `Policy`. The default version is 0.
257 "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.
258 #
259 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
260 "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.
261 { # Associates `members` with a `role`.
262 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
263 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
264 #
265 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
266 #
267 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
268 #
269 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
270 #
271 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
272 #
273 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
274 #
275 # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
276 "A String",
277 ],
278 },
279 ],
280 "iamOwned": True or False,
281 }</pre>
282</div>
283
284<div class="method">
285 <code class="details" id="insert">insert(project, body)</code>
286 <pre>Creates a BackendBucket resource in the specified project using the data included in the request.
287
288Args:
289 project: string, Project ID for this request. (required)
290 body: object, The request body. (required)
291 The object takes the form of:
292
293{ # A BackendBucket resource. This resource defines a Cloud Storage bucket.
294 "kind": "compute#backendBucket", # Type of the resource.
295 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
296 "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket.
297 "bucketName": "A String", # Cloud Storage bucket name.
298 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
299 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
300 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
301 "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.
302 }
303
304
305Returns:
306 An object of the form:
307
308 { # An Operation resource, used to manage asynchronous API requests.
309 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
310 "clientOperationId": "A String", # [Output Only] Reserved for future use.
311 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
312 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
313 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
314 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
315 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
316 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
317 "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.
318 "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.
319 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
320 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
321 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
322 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
323 {
324 "message": "A String", # [Output Only] A human-readable description of the warning code.
325 "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.
326 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
327 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
328 {
329 "value": "A String", # [Output Only] A warning data value corresponding to the key.
330 "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).
331 },
332 ],
333 },
334 ],
335 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
336 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
337 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
338 "name": "A String", # [Output Only] Name of the resource.
339 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
340 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
341 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
342 {
343 "message": "A String", # [Output Only] An optional, human-readable error message.
344 "code": "A String", # [Output Only] The error type identifier for this error.
345 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
346 },
347 ],
348 },
349 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
350 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
351 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
352 }</pre>
353</div>
354
355<div class="method">
356 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
357 <pre>Retrieves the list of BackendBucket resources available to the specified project.
358
359Args:
360 project: string, Project ID for this request. (required)
361 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
362
363You 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.
364
365Currently, only sorting by name or creationTimestamp desc is supported.
366 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.
367 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.
368 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.
369
370The 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.
371
372For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
373
374You 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.
375
376To 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.
377
378Returns:
379 An object of the form:
380
381 { # Contains a list of BackendBucket resources.
382 "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
383 "items": [ # A list of BackendBucket resources.
384 { # A BackendBucket resource. This resource defines a Cloud Storage bucket.
385 "kind": "compute#backendBucket", # Type of the resource.
386 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
387 "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket.
388 "bucketName": "A String", # Cloud Storage bucket name.
389 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
390 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
391 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
392 "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.
393 },
394 ],
395 "kind": "compute#backendBucketList", # Type of resource.
396 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
397 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
398 }</pre>
399</div>
400
401<div class="method">
402 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
403 <pre>Retrieves the next page of results.
404
405Args:
406 previous_request: The request for the previous page. (required)
407 previous_response: The response from the request for the previous page. (required)
408
409Returns:
410 A request object that you can call 'execute()' on to request the next
411 page. Returns None if there are no more items in the collection.
412 </pre>
413</div>
414
415<div class="method">
416 <code class="details" id="patch">patch(project, backendBucket, body)</code>
417 <pre>Updates the specified BackendBucket resource with the data included in the request. This method supports patch semantics.
418
419Args:
420 project: string, Project ID for this request. (required)
421 backendBucket: string, Name of the BackendBucket resource to update. (required)
422 body: object, The request body. (required)
423 The object takes the form of:
424
425{ # A BackendBucket resource. This resource defines a Cloud Storage bucket.
426 "kind": "compute#backendBucket", # Type of the resource.
427 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
428 "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket.
429 "bucketName": "A String", # Cloud Storage bucket name.
430 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
431 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
432 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
433 "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.
434 }
435
436
437Returns:
438 An object of the form:
439
440 { # An Operation resource, used to manage asynchronous API requests.
441 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
442 "clientOperationId": "A String", # [Output Only] Reserved for future use.
443 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
444 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
445 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
446 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
447 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
448 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
449 "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.
450 "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.
451 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
452 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
453 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
454 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
455 {
456 "message": "A String", # [Output Only] A human-readable description of the warning code.
457 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
458 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
459 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
460 {
461 "value": "A String", # [Output Only] A warning data value corresponding to the key.
462 "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).
463 },
464 ],
465 },
466 ],
467 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
468 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
469 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
470 "name": "A String", # [Output Only] Name of the resource.
471 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
472 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
473 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
474 {
475 "message": "A String", # [Output Only] An optional, human-readable error message.
476 "code": "A String", # [Output Only] The error type identifier for this error.
477 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
478 },
479 ],
480 },
481 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
482 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
483 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
484 }</pre>
485</div>
486
487<div class="method">
488 <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body)</code>
489 <pre>Sets the access control policy on the specified resource. Replaces any existing policy.
490
491Args:
492 project: string, Project ID for this request. (required)
493 resource: string, Name of the resource for this request. (required)
494 body: object, The request body. (required)
495 The object takes the form of:
496
497{ # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
498 #
499 #
500 #
501 # 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.
502 #
503 # **Example**
504 #
505 # { "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"] } ] }
506 #
507 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
508 "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
509 #
510 # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
511 { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
512 "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
513 "A String",
514 ],
515 "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
516 },
517 ],
518 "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.
519 { # A rule to be applied in a Policy.
520 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
521 { # Specifies what kind of log the caller must write
522 "counter": { # Options for counters # Counter options.
523 "field": "A String", # The field value to attribute.
524 "metric": "A String", # The metric to update.
525 },
526 },
527 ],
528 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
529 "A String",
530 ],
531 "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.
532 "A String",
533 ],
534 "action": "A String", # Required
535 "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.
536 "A String",
537 ],
538 "conditions": [ # Additional restrictions that must be met
539 { # A condition to be met.
540 "iam": "A String", # Trusted attributes supplied by the IAM system.
541 "svc": "A String", # Trusted attributes discharged by the service.
542 "value": "A String", # DEPRECATED. Use 'values' instead.
543 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
544 "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
545 "A String",
546 ],
547 "op": "A String", # An operator to apply the subject with.
548 },
549 ],
550 "description": "A String", # Human-readable description of the rule.
551 },
552 ],
553 "version": 42, # Version of the `Policy`. The default version is 0.
554 "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.
555 #
556 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
557 "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.
558 { # Associates `members` with a `role`.
559 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
560 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
561 #
562 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
563 #
564 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
565 #
566 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
567 #
568 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
569 #
570 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
571 #
572 # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
573 "A String",
574 ],
575 },
576 ],
577 "iamOwned": True or False,
578}
579
580
581Returns:
582 An object of the form:
583
584 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
585 #
586 #
587 #
588 # 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.
589 #
590 # **Example**
591 #
592 # { "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"] } ] }
593 #
594 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
595 "auditConfigs": [ # Specifies audit logging configs for "data access". "data access": generally refers to data reads/writes and admin reads. "admin activity": generally refers to admin writes.
596 #
597 # Note: `AuditConfig` doesn't apply to "admin activity", which always enables audit logging.
598 { # Enables "data access" audit logging for a service and specifies a list of members that are log-exempted.
599 "exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit logging for the `service` specified above. Follows the same format of Binding.members.
600 "A String",
601 ],
602 "service": "A String", # Specifies a service that will be enabled for "data access" audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
603 },
604 ],
605 "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.
606 { # A rule to be applied in a Policy.
607 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
608 { # Specifies what kind of log the caller must write
609 "counter": { # Options for counters # Counter options.
610 "field": "A String", # The field value to attribute.
611 "metric": "A String", # The metric to update.
612 },
613 },
614 ],
615 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
616 "A String",
617 ],
618 "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.
619 "A String",
620 ],
621 "action": "A String", # Required
622 "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.
623 "A String",
624 ],
625 "conditions": [ # Additional restrictions that must be met
626 { # A condition to be met.
627 "iam": "A String", # Trusted attributes supplied by the IAM system.
628 "svc": "A String", # Trusted attributes discharged by the service.
629 "value": "A String", # DEPRECATED. Use 'values' instead.
630 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
631 "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
632 "A String",
633 ],
634 "op": "A String", # An operator to apply the subject with.
635 },
636 ],
637 "description": "A String", # Human-readable description of the rule.
638 },
639 ],
640 "version": 42, # Version of the `Policy`. The default version is 0.
641 "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.
642 #
643 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
644 "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.
645 { # Associates `members` with a `role`.
646 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
647 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
648 #
649 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
650 #
651 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
652 #
653 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`.
654 #
655 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
656 #
657 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
658 #
659 # * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
660 "A String",
661 ],
662 },
663 ],
664 "iamOwned": True or False,
665 }</pre>
666</div>
667
668<div class="method">
669 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
670 <pre>Returns permissions that a caller has on the specified resource.
671
672Args:
673 project: string, Project ID for this request. (required)
674 resource: string, Name of the resource for this request. (required)
675 body: object, The request body. (required)
676 The object takes the form of:
677
678{
679 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
680 "A String",
681 ],
682 }
683
684
685Returns:
686 An object of the form:
687
688 {
689 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
690 "A String",
691 ],
692 }</pre>
693</div>
694
695<div class="method">
696 <code class="details" id="update">update(project, backendBucket, body)</code>
697 <pre>Updates the specified BackendBucket resource with the data included in the request.
698
699Args:
700 project: string, Project ID for this request. (required)
701 backendBucket: string, Name of the BackendBucket resource to update. (required)
702 body: object, The request body. (required)
703 The object takes the form of:
704
705{ # A BackendBucket resource. This resource defines a Cloud Storage bucket.
706 "kind": "compute#backendBucket", # Type of the resource.
707 "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
708 "enableCdn": True or False, # If true, enable Cloud CDN for this BackendBucket.
709 "bucketName": "A String", # Cloud Storage bucket name.
710 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
711 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
712 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
713 "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.
714 }
715
716
717Returns:
718 An object of the form:
719
720 { # An Operation resource, used to manage asynchronous API requests.
721 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
722 "clientOperationId": "A String", # [Output Only] Reserved for future use.
723 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
724 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
725 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
726 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
727 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
728 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
729 "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.
730 "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.
731 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
732 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
733 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
734 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
735 {
736 "message": "A String", # [Output Only] A human-readable description of the warning code.
737 "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.
738 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
739 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
740 {
741 "value": "A String", # [Output Only] A warning data value corresponding to the key.
742 "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).
743 },
744 ],
745 },
746 ],
747 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
748 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
749 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
750 "name": "A String", # [Output Only] Name of the resource.
751 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
752 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
753 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
754 {
755 "message": "A String", # [Output Only] An optional, human-readable error message.
756 "code": "A String", # [Output Only] The error type identifier for this error.
757 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
758 },
759 ],
760 },
761 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
762 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
763 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
764 }</pre>
765</div>
766
767</body></html>