Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 692617a6eea5e47e71e221c9e73f5f2d5534e3bf / . / docs / dyn / pubsub_v1.projects.snapshots.html
blob: b872bebd337e935eef511fbc8b47147e67620772 [file] [log] [blame]
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -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="pubsub_v1.html">Google Cloud Pub/Sub API</a> . <a href="pubsub_v1.projects.html">projects</a> . <a href="pubsub_v1.projects.snapshots.html">snapshots</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]78 <code><a href="#getIamPolicy">getIamPolicy(resource=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Gets the access control policy for a resource.</p>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]80<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]81 <code><a href="#setIamPolicy">setIamPolicy(resource=None, body, x__xgafv=None)</a></code></p>
82<p class="firstline">Sets the access control policy on the specified resource. Replaces any</p>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]83<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]84 <code><a href="#testIamPermissions">testIamPermissions(resource=None, body, x__xgafv=None)</a></code></p>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]85<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
86<h3>Method Details</h3>
87<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]88 <code class="details" id="getIamPolicy">getIamPolicy(resource=None, x__xgafv=None)</code>
89 <pre>Gets the access control policy for a resource.
90Returns an empty policy if the resource exists and does not have a policy
91set.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]92
93Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]94 resource: string, REQUIRED: The resource for which the policy is being requested.
95`resource` is usually specified as a path. For example, a Project
96resource is specified as `projects/{project}`. (required)
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]97 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]98 Allowed values
99 1 - v1 error format
100 2 - v2 error format
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]101
102Returns:
103 An object of the form:
104
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]105 { # Defines an Identity and Access Management (IAM) policy. It is used to
106 # specify access control policies for Cloud Platform resources.
107 #
108 #
109 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
110 # `members` to a `role`, where the members can be user accounts, Google groups,
111 # Google domains, and service accounts. A `role` is a named list of permissions
112 # defined by IAM.
113 #
114 # **Example**
115 #
116 # {
117 # "bindings": [
118 # {
119 # "role": "roles/owner",
120 # "members": [
121 # "user:mike@example.com",
122 # "group:admins@example.com",
123 # "domain:google.com",
124 # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
125 # ]
126 # },
127 # {
128 # "role": "roles/viewer",
129 # "members": ["user:sean@example.com"]
130 # }
131 # ]
132 # }
133 #
134 # For a description of IAM and its features, see the
135 # [IAM developer's guide](https://cloud.google.com/iam).
136 "bindings": [ # Associates a list of `members` to a `role`.
137 # Multiple `bindings` must not be specified for the same `role`.
138 # `bindings` with no members will result in an error.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]139 { # Associates `members` with a `role`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]140 "role": "A String", # Role that is assigned to `members`.
141 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
142 # Required
143 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
144 # `members` can have the following values:
145 #
146 # * `allUsers`: A special identifier that represents anyone who is
147 # on the internet; with or without a Google account.
148 #
149 # * `allAuthenticatedUsers`: A special identifier that represents anyone
150 # who is authenticated with a Google account or a service account.
151 #
152 # * `user:{emailid}`: An email address that represents a specific Google
153 # account. For example, `alice@gmail.com` or `joe@example.com`.
154 #
155 #
156 # * `serviceAccount:{emailid}`: An email address that represents a service
157 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
158 #
159 # * `group:{emailid}`: An email address that represents a Google group.
160 # For example, `admins@example.com`.
161 #
162 # * `domain:{domain}`: A Google Apps domain name that represents all the
163 # users of that domain. For example, `google.com` or `example.com`.
164 #
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]165 "A String",
166 ],
167 },
168 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]169 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
170 # prevent simultaneous updates of a policy from overwriting each other.
171 # It is strongly suggested that systems make use of the `etag` in the
172 # read-modify-write cycle to perform policy updates in order to avoid race
173 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
174 # systems are expected to put that etag in the request to `setIamPolicy` to
175 # ensure that their change will be applied to the same version of the policy.
176 #
177 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
178 # policy is overwritten blindly.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]179 "version": 42, # Version of the `Policy`. The default version is 0.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]180 }</pre>
181</div>
182
183<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]184 <code class="details" id="setIamPolicy">setIamPolicy(resource=None, body, x__xgafv=None)</code>
185 <pre>Sets the access control policy on the specified resource. Replaces any
186existing policy.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]187
188Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]189 resource: string, REQUIRED: The resource for which the policy is being specified.
190`resource` is usually specified as a path. For example, a Project
191resource is specified as `projects/{project}`. (required)
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]192 body: object, The request body. (required)
193 The object takes the form of:
194
195{ # Request message for `SetIamPolicy` method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]196 "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to # REQUIRED: The complete policy to be applied to the `resource`. The size of
197 # the policy is limited to a few 10s of KB. An empty policy is a
198 # valid policy but certain Cloud Platform services (such as Projects)
199 # might reject them.
200 # specify access control policies for Cloud Platform resources.
201 #
202 #
203 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
204 # `members` to a `role`, where the members can be user accounts, Google groups,
205 # Google domains, and service accounts. A `role` is a named list of permissions
206 # defined by IAM.
207 #
208 # **Example**
209 #
210 # {
211 # "bindings": [
212 # {
213 # "role": "roles/owner",
214 # "members": [
215 # "user:mike@example.com",
216 # "group:admins@example.com",
217 # "domain:google.com",
218 # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
219 # ]
220 # },
221 # {
222 # "role": "roles/viewer",
223 # "members": ["user:sean@example.com"]
224 # }
225 # ]
226 # }
227 #
228 # For a description of IAM and its features, see the
229 # [IAM developer's guide](https://cloud.google.com/iam).
230 "bindings": [ # Associates a list of `members` to a `role`.
231 # Multiple `bindings` must not be specified for the same `role`.
232 # `bindings` with no members will result in an error.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]233 { # Associates `members` with a `role`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]234 "role": "A String", # Role that is assigned to `members`.
235 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
236 # Required
237 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
238 # `members` can have the following values:
239 #
240 # * `allUsers`: A special identifier that represents anyone who is
241 # on the internet; with or without a Google account.
242 #
243 # * `allAuthenticatedUsers`: A special identifier that represents anyone
244 # who is authenticated with a Google account or a service account.
245 #
246 # * `user:{emailid}`: An email address that represents a specific Google
247 # account. For example, `alice@gmail.com` or `joe@example.com`.
248 #
249 #
250 # * `serviceAccount:{emailid}`: An email address that represents a service
251 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
252 #
253 # * `group:{emailid}`: An email address that represents a Google group.
254 # For example, `admins@example.com`.
255 #
256 # * `domain:{domain}`: A Google Apps domain name that represents all the
257 # users of that domain. For example, `google.com` or `example.com`.
258 #
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]259 "A String",
260 ],
261 },
262 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]263 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
264 # prevent simultaneous updates of a policy from overwriting each other.
265 # It is strongly suggested that systems make use of the `etag` in the
266 # read-modify-write cycle to perform policy updates in order to avoid race
267 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
268 # systems are expected to put that etag in the request to `setIamPolicy` to
269 # ensure that their change will be applied to the same version of the policy.
270 #
271 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
272 # policy is overwritten blindly.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]273 "version": 42, # Version of the `Policy`. The default version is 0.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]274 },
275 }
276
277 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]278 Allowed values
279 1 - v1 error format
280 2 - v2 error format
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]281
282Returns:
283 An object of the form:
284
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]285 { # Defines an Identity and Access Management (IAM) policy. It is used to
286 # specify access control policies for Cloud Platform resources.
287 #
288 #
289 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
290 # `members` to a `role`, where the members can be user accounts, Google groups,
291 # Google domains, and service accounts. A `role` is a named list of permissions
292 # defined by IAM.
293 #
294 # **Example**
295 #
296 # {
297 # "bindings": [
298 # {
299 # "role": "roles/owner",
300 # "members": [
301 # "user:mike@example.com",
302 # "group:admins@example.com",
303 # "domain:google.com",
304 # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
305 # ]
306 # },
307 # {
308 # "role": "roles/viewer",
309 # "members": ["user:sean@example.com"]
310 # }
311 # ]
312 # }
313 #
314 # For a description of IAM and its features, see the
315 # [IAM developer's guide](https://cloud.google.com/iam).
316 "bindings": [ # Associates a list of `members` to a `role`.
317 # Multiple `bindings` must not be specified for the same `role`.
318 # `bindings` with no members will result in an error.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]319 { # Associates `members` with a `role`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]320 "role": "A String", # Role that is assigned to `members`.
321 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
322 # Required
323 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
324 # `members` can have the following values:
325 #
326 # * `allUsers`: A special identifier that represents anyone who is
327 # on the internet; with or without a Google account.
328 #
329 # * `allAuthenticatedUsers`: A special identifier that represents anyone
330 # who is authenticated with a Google account or a service account.
331 #
332 # * `user:{emailid}`: An email address that represents a specific Google
333 # account. For example, `alice@gmail.com` or `joe@example.com`.
334 #
335 #
336 # * `serviceAccount:{emailid}`: An email address that represents a service
337 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
338 #
339 # * `group:{emailid}`: An email address that represents a Google group.
340 # For example, `admins@example.com`.
341 #
342 # * `domain:{domain}`: A Google Apps domain name that represents all the
343 # users of that domain. For example, `google.com` or `example.com`.
344 #
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]345 "A String",
346 ],
347 },
348 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]349 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
350 # prevent simultaneous updates of a policy from overwriting each other.
351 # It is strongly suggested that systems make use of the `etag` in the
352 # read-modify-write cycle to perform policy updates in order to avoid race
353 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
354 # systems are expected to put that etag in the request to `setIamPolicy` to
355 # ensure that their change will be applied to the same version of the policy.
356 #
357 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
358 # policy is overwritten blindly.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]359 "version": 42, # Version of the `Policy`. The default version is 0.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]360 }</pre>
361</div>
362
363<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]364 <code class="details" id="testIamPermissions">testIamPermissions(resource=None, body, x__xgafv=None)</code>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]365 <pre>Returns permissions that a caller has on the specified resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]366If the resource does not exist, this will return an empty set of
367permissions, not a NOT_FOUND error.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]368
369Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]370 resource: string, REQUIRED: The resource for which the policy detail is being requested.
371`resource` is usually specified as a path. For example, a Project
372resource is specified as `projects/{project}`. (required)
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]373 body: object, The request body. (required)
374 The object takes the form of:
375
376{ # Request message for `TestIamPermissions` method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]377 "permissions": [ # The set of permissions to check for the `resource`. Permissions with
378 # wildcards (such as '*' or 'storage.*') are not allowed. For more
379 # information see
380 # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]381 "A String",
382 ],
383 }
384
385 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]386 Allowed values
387 1 - v1 error format
388 2 - v2 error format
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]389
390Returns:
391 An object of the form:
392
393 { # Response message for `TestIamPermissions` method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]394 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
395 # allowed.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]396 "A String",
397 ],
398 }</pre>
399</div>
400
401</body></html>