Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / pubsub_v1.projects.topics.html
blob: f0a9680405bdb770e33c6e022c60b9794c53d87f [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]75<h1><a href="pubsub_v1.html">Cloud Pub/Sub API</a> . <a href="pubsub_v1.projects.html">projects</a> . <a href="pubsub_v1.projects.topics.html">topics</a></h1>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]78 <code><a href="pubsub_v1.projects.topics.snapshots.html">snapshots()</a></code>
79</p>
80<p class="firstline">Returns the snapshots Resource.</p>
81
82<p class="toc_element">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]83 <code><a href="pubsub_v1.projects.topics.subscriptions.html">subscriptions()</a></code>
84</p>
85<p class="firstline">Returns the subscriptions Resource.</p>
86
87<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]88 <code><a href="#create">create(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]89<p class="firstline">Creates the given topic with the given name. See the [resource name rules](</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]90<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]91 <code><a href="#delete">delete(topic, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]92<p class="firstline">Deletes the topic with the given name. Returns `NOT_FOUND` if the topic</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]93<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]94 <code><a href="#get">get(topic, x__xgafv=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]95<p class="firstline">Gets the configuration of a topic.</p>
96<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]97 <code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]98<p class="firstline">Gets the access control policy for a resource.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]99<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]100 <code><a href="#list">list(project, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]101<p class="firstline">Lists matching topics.</p>
102<p class="toc_element">
103 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
104<p class="firstline">Retrieves the next page of results.</p>
105<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]106 <code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]107<p class="firstline">Updates an existing topic. Note that certain properties of a</p>
108<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]109 <code><a href="#publish">publish(topic, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]110<p class="firstline">Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]111<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]112 <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]113<p class="firstline">Sets the access control policy on the specified resource. Replaces any</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]114<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]115 <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]116<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
117<h3>Method Details</h3>
118<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]119 <code class="details" id="create">create(name, body=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]120 <pre>Creates the given topic with the given name. See the [resource name rules](
121https://cloud.google.com/pubsub/docs/admin#resource_names).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]122
123Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]124 name: string, Required. The name of the topic. It must have the format
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]125`&quot;projects/{project}/topics/{topic}&quot;`. `{topic}` must start with a letter,
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]126and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
127underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
128signs (`%`). It must be between 3 and 255 characters in length, and it
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]129must not start with `&quot;goog&quot;`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]130 body: object, The request body.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]131 The object takes the form of:
132
133{ # A topic resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]134 &quot;labels&quot;: { # See [Creating and managing labels]
135 # (https://cloud.google.com/pubsub/docs/labels).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]136 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]137 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]138 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The resource name of the Cloud KMS CryptoKey to be used to protect access
139 # to messages published on this topic.
140 #
141 # The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
142 &quot;messageStoragePolicy&quot;: { # A policy constraining the storage of messages published to the topic. # Policy constraining the set of Google Cloud Platform regions where messages
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]143 # published to the topic may be stored. If not present, then no constraints
144 # are in effect.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]145 &quot;allowedPersistenceRegions&quot;: [ # A list of IDs of GCP regions where messages that are published to the topic
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]146 # may be persisted in storage. Messages published by publishers running in
147 # non-allowed GCP regions (or running outside of GCP altogether) will be
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]148 # routed for storage in one of the allowed regions. An empty list means that
149 # no regions are allowed, and is not a valid configuration.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]150 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]151 ],
152 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]153 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the topic. It must have the format
154 # `&quot;projects/{project}/topics/{topic}&quot;`. `{topic}` must start with a letter,
155 # and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
156 # underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
157 # signs (`%`). It must be between 3 and 255 characters in length, and it
158 # must not start with `&quot;goog&quot;`.
159 }
160
161 x__xgafv: string, V1 error format.
162 Allowed values
163 1 - v1 error format
164 2 - v2 error format
165
166Returns:
167 An object of the form:
168
169 { # A topic resource.
170 &quot;labels&quot;: { # See [Creating and managing labels]
171 # (https://cloud.google.com/pubsub/docs/labels).
172 &quot;a_key&quot;: &quot;A String&quot;,
173 },
174 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The resource name of the Cloud KMS CryptoKey to be used to protect access
175 # to messages published on this topic.
176 #
177 # The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
178 &quot;messageStoragePolicy&quot;: { # A policy constraining the storage of messages published to the topic. # Policy constraining the set of Google Cloud Platform regions where messages
179 # published to the topic may be stored. If not present, then no constraints
180 # are in effect.
181 &quot;allowedPersistenceRegions&quot;: [ # A list of IDs of GCP regions where messages that are published to the topic
182 # may be persisted in storage. Messages published by publishers running in
183 # non-allowed GCP regions (or running outside of GCP altogether) will be
184 # routed for storage in one of the allowed regions. An empty list means that
185 # no regions are allowed, and is not a valid configuration.
186 &quot;A String&quot;,
187 ],
188 },
189 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the topic. It must have the format
190 # `&quot;projects/{project}/topics/{topic}&quot;`. `{topic}` must start with a letter,
191 # and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
192 # underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
193 # signs (`%`). It must be between 3 and 255 characters in length, and it
194 # must not start with `&quot;goog&quot;`.
195 }</pre>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]196</div>
197
198<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]199 <code class="details" id="delete">delete(topic, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]200 <pre>Deletes the topic with the given name. Returns `NOT_FOUND` if the topic
201does not exist. After a topic is deleted, a new topic may be created with
202the same name; this is an entirely new topic with none of the old
203configuration or subscriptions. Existing subscriptions to this topic are
204not deleted, but their `topic` field is set to `_deleted-topic_`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]205
206Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]207 topic: string, Required. Name of the topic to delete.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]208Format is `projects/{project}/topics/{topic}`. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]209 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]210 Allowed values
211 1 - v1 error format
212 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]213
214Returns:
215 An object of the form:
216
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]217 { # A generic empty message that you can re-use to avoid defining duplicated
218 # empty messages in your APIs. A typical example is to use it as the request
219 # or the response type of an API method. For instance:
220 #
221 # service Foo {
222 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
223 # }
224 #
225 # The JSON representation for `Empty` is empty JSON object `{}`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]226 }</pre>
227</div>
228
229<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]230 <code class="details" id="get">get(topic, x__xgafv=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]231 <pre>Gets the configuration of a topic.
232
233Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]234 topic: string, Required. The name of the topic to get.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]235Format is `projects/{project}/topics/{topic}`. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]236 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]237 Allowed values
238 1 - v1 error format
239 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]240
241Returns:
242 An object of the form:
243
244 { # A topic resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]245 &quot;labels&quot;: { # See [Creating and managing labels]
246 # (https://cloud.google.com/pubsub/docs/labels).
247 &quot;a_key&quot;: &quot;A String&quot;,
248 },
249 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The resource name of the Cloud KMS CryptoKey to be used to protect access
250 # to messages published on this topic.
251 #
252 # The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
253 &quot;messageStoragePolicy&quot;: { # A policy constraining the storage of messages published to the topic. # Policy constraining the set of Google Cloud Platform regions where messages
254 # published to the topic may be stored. If not present, then no constraints
255 # are in effect.
256 &quot;allowedPersistenceRegions&quot;: [ # A list of IDs of GCP regions where messages that are published to the topic
257 # may be persisted in storage. Messages published by publishers running in
258 # non-allowed GCP regions (or running outside of GCP altogether) will be
259 # routed for storage in one of the allowed regions. An empty list means that
260 # no regions are allowed, and is not a valid configuration.
261 &quot;A String&quot;,
262 ],
263 },
264 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the topic. It must have the format
265 # `&quot;projects/{project}/topics/{topic}&quot;`. `{topic}` must start with a letter,
266 # and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
267 # underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
268 # signs (`%`). It must be between 3 and 255 characters in length, and it
269 # must not start with `&quot;goog&quot;`.
270 }</pre>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]271</div>
272
273<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]274 <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]275 <pre>Gets the access control policy for a resource.
276Returns an empty policy if the resource exists and does not have a policy
277set.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]278
279Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]280 resource: string, REQUIRED: The resource for which the policy is being requested.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]281See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]282 options_requestedPolicyVersion: integer, Optional. The policy format version to be returned.
283
284Valid values are 0, 1, and 3. Requests specifying an invalid value will be
285rejected.
286
287Requests for policies with any conditional bindings must specify version 3.
288Policies without any conditional bindings may specify any valid value or
289leave the field unset.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]290
291To learn which resources support conditions in their IAM policies, see the
292[IAM
293documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]294 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]295 Allowed values
296 1 - v1 error format
297 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]298
299Returns:
300 An object of the form:
301
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]302 { # An Identity and Access Management (IAM) policy, which specifies access
303 # controls for Google Cloud resources.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]304 #
305 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]306 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
307 # `members` to a single `role`. Members can be user accounts, service accounts,
308 # Google groups, and domains (such as G Suite). A `role` is a named list of
309 # permissions; each `role` can be an IAM predefined role or a user-created
310 # custom role.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]311 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]312 # For some types of Google Cloud resources, a `binding` can also specify a
313 # `condition`, which is a logical expression that allows access to a resource
314 # only if the expression evaluates to `true`. A condition can add constraints
315 # based on attributes of the request, the resource, or both. To learn which
316 # resources support conditions in their IAM policies, see the
317 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]318 #
319 # **JSON example:**
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]320 #
321 # {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]322 # &quot;bindings&quot;: [
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]323 # {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]324 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
325 # &quot;members&quot;: [
326 # &quot;user:mike@example.com&quot;,
327 # &quot;group:admins@example.com&quot;,
328 # &quot;domain:google.com&quot;,
329 # &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot;
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]330 # ]
331 # },
332 # {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]333 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
334 # &quot;members&quot;: [
335 # &quot;user:eve@example.com&quot;
336 # ],
337 # &quot;condition&quot;: {
338 # &quot;title&quot;: &quot;expirable access&quot;,
339 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
340 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]341 # }
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]342 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]343 # ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]344 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
345 # &quot;version&quot;: 3
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]346 # }
347 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]348 # **YAML example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]349 #
350 # bindings:
351 # - members:
352 # - user:mike@example.com
353 # - group:admins@example.com
354 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]355 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
356 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]357 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]358 # - user:eve@example.com
359 # role: roles/resourcemanager.organizationViewer
360 # condition:
361 # title: expirable access
362 # description: Does not grant access after Sep 2020
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]363 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]364 # - etag: BwWWja0YfJA=
365 # - version: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]366 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]367 # For a description of IAM and its features, see the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]368 # [IAM documentation](https://cloud.google.com/iam/docs/).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]369 &quot;version&quot;: 42, # Specifies the format of the policy.
370 #
371 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
372 # are rejected.
373 #
374 # Any operation that affects conditional role bindings must specify version
375 # `3`. This requirement applies to the following operations:
376 #
377 # * Getting a policy that includes a conditional role binding
378 # * Adding a conditional role binding to a policy
379 # * Changing a conditional role binding in a policy
380 # * Removing any role binding, with or without a condition, from a policy
381 # that includes conditions
382 #
383 # **Important:** If you use IAM Conditions, you must include the `etag` field
384 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
385 # you to overwrite a version `3` policy with a version `1` policy, and all of
386 # the conditions in the version `3` policy are lost.
387 #
388 # If a policy does not include any conditions, operations on that policy may
389 # specify any valid version or leave the field unset.
390 #
391 # To learn which resources support conditions in their IAM policies, see the
392 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
393 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
394 # prevent simultaneous updates of a policy from overwriting each other.
395 # It is strongly suggested that systems make use of the `etag` in the
396 # read-modify-write cycle to perform policy updates in order to avoid race
397 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
398 # systems are expected to put that etag in the request to `setIamPolicy` to
399 # ensure that their change will be applied to the same version of the policy.
400 #
401 # **Important:** If you use IAM Conditions, you must include the `etag` field
402 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
403 # you to overwrite a version `3` policy with a version `1` policy, and all of
404 # the conditions in the version `3` policy are lost.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]405 &quot;bindings&quot;: [ # Associates a list of `members` to a `role`. Optionally, may specify a
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]406 # `condition` that determines how and when the `bindings` are applied. Each
407 # of the `bindings` must contain at least one member.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]408 { # Associates `members` with a `role`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]409 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
410 #
411 # If the condition evaluates to `true`, then this binding applies to the
412 # current request.
413 #
414 # If the condition evaluates to `false`, then this binding does not apply to
415 # the current request. However, a different role binding might grant the same
416 # role to one or more of the members in this binding.
417 #
418 # To learn which resources support conditions in their IAM policies, see the
419 # [IAM
420 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
421 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
422 # are documented at https://github.com/google/cel-spec.
423 #
424 # Example (Comparison):
425 #
426 # title: &quot;Summary size limit&quot;
427 # description: &quot;Determines if a summary is less than 100 chars&quot;
428 # expression: &quot;document.summary.size() &lt; 100&quot;
429 #
430 # Example (Equality):
431 #
432 # title: &quot;Requestor is owner&quot;
433 # description: &quot;Determines if requestor is the document owner&quot;
434 # expression: &quot;document.owner == request.auth.claims.email&quot;
435 #
436 # Example (Logic):
437 #
438 # title: &quot;Public documents&quot;
439 # description: &quot;Determine whether the document should be publicly visible&quot;
440 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
441 #
442 # Example (Data Manipulation):
443 #
444 # title: &quot;Notification string&quot;
445 # description: &quot;Create a notification string with a timestamp.&quot;
446 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
447 #
448 # The exact variables and functions that may be referenced within an expression
449 # are determined by the service that evaluates it. See the service
450 # documentation for additional information.
451 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
452 # reporting, e.g. a file name and a position in the file.
453 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
454 # its purpose. This can be used e.g. in UIs which allow to enter the
455 # expression.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]456 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
457 # syntax.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]458 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
459 # describes the expression, e.g. when hovered over it in a UI.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]460 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]461 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`.
462 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]463 &quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]464 # `members` can have the following values:
465 #
466 # * `allUsers`: A special identifier that represents anyone who is
467 # on the internet; with or without a Google account.
468 #
469 # * `allAuthenticatedUsers`: A special identifier that represents anyone
470 # who is authenticated with a Google account or a service account.
471 #
472 # * `user:{emailid}`: An email address that represents a specific Google
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]473 # account. For example, `alice@example.com` .
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]474 #
475 #
476 # * `serviceAccount:{emailid}`: An email address that represents a service
477 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
478 #
479 # * `group:{emailid}`: An email address that represents a Google group.
480 # For example, `admins@example.com`.
481 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]482 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
483 # identifier) representing a user that has been recently deleted. For
484 # example, `alice@example.com?uid=123456789012345678901`. If the user is
485 # recovered, this value reverts to `user:{emailid}` and the recovered user
486 # retains the role in the binding.
487 #
488 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
489 # unique identifier) representing a service account that has been recently
490 # deleted. For example,
491 # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
492 # If the service account is undeleted, this value reverts to
493 # `serviceAccount:{emailid}` and the undeleted service account retains the
494 # role in the binding.
495 #
496 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
497 # identifier) representing a Google group that has been recently
498 # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
499 # the group is recovered, this value reverts to `group:{emailid}` and the
500 # recovered group retains the role in the binding.
501 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]502 #
503 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]504 # users of that domain. For example, `google.com` or `example.com`.
505 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]506 &quot;A String&quot;,
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]507 ],
508 },
509 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]510 }</pre>
511</div>
512
513<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]514 <code class="details" id="list">list(project, pageToken=None, pageSize=None, x__xgafv=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]515 <pre>Lists matching topics.
516
517Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]518 project: string, Required. The name of the project in which to list topics.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]519Format is `projects/{project-id}`. (required)
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]520 pageToken: string, The value returned by the last `ListTopicsResponse`; indicates that this is
521a continuation of a prior `ListTopics` call, and that the system should
522return the next page of data.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]523 pageSize: integer, Maximum number of topics to return.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]524 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]525 Allowed values
526 1 - v1 error format
527 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]528
529Returns:
530 An object of the form:
531
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]532 { # Response for the `ListTopics` method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]533 &quot;topics&quot;: [ # The resulting topics.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]534 { # A topic resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]535 &quot;labels&quot;: { # See [Creating and managing labels]
536 # (https://cloud.google.com/pubsub/docs/labels).
537 &quot;a_key&quot;: &quot;A String&quot;,
538 },
539 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The resource name of the Cloud KMS CryptoKey to be used to protect access
540 # to messages published on this topic.
541 #
542 # The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
543 &quot;messageStoragePolicy&quot;: { # A policy constraining the storage of messages published to the topic. # Policy constraining the set of Google Cloud Platform regions where messages
544 # published to the topic may be stored. If not present, then no constraints
545 # are in effect.
546 &quot;allowedPersistenceRegions&quot;: [ # A list of IDs of GCP regions where messages that are published to the topic
547 # may be persisted in storage. Messages published by publishers running in
548 # non-allowed GCP regions (or running outside of GCP altogether) will be
549 # routed for storage in one of the allowed regions. An empty list means that
550 # no regions are allowed, and is not a valid configuration.
551 &quot;A String&quot;,
552 ],
553 },
554 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the topic. It must have the format
555 # `&quot;projects/{project}/topics/{topic}&quot;`. `{topic}` must start with a letter,
556 # and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
557 # underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
558 # signs (`%`). It must be between 3 and 255 characters in length, and it
559 # must not start with `&quot;goog&quot;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]560 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]561 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]562 &quot;nextPageToken&quot;: &quot;A String&quot;, # If not empty, indicates that there may be more topics that match the
563 # request; this value should be passed in a new `ListTopicsRequest`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]564 }</pre>
565</div>
566
567<div class="method">
568 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
569 <pre>Retrieves the next page of results.
570
571Args:
572 previous_request: The request for the previous page. (required)
573 previous_response: The response from the request for the previous page. (required)
574
575Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]576 A request object that you can call &#x27;execute()&#x27; on to request the next
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]577 page. Returns None if there are no more items in the collection.
578 </pre>
579</div>
580
581<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]582 <code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]583 <pre>Updates an existing topic. Note that certain properties of a
584topic are not modifiable.
585
586Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]587 name: string, Required. The name of the topic. It must have the format
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]588`&quot;projects/{project}/topics/{topic}&quot;`. `{topic}` must start with a letter,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]589and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
590underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
591signs (`%`). It must be between 3 and 255 characters in length, and it
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]592must not start with `&quot;goog&quot;`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]593 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]594 The object takes the form of:
595
596{ # Request for the UpdateTopic method.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]597 &quot;topic&quot;: { # A topic resource. # Required. The updated topic object.
598 &quot;labels&quot;: { # See [Creating and managing labels]
599 # (https://cloud.google.com/pubsub/docs/labels).
600 &quot;a_key&quot;: &quot;A String&quot;,
601 },
602 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The resource name of the Cloud KMS CryptoKey to be used to protect access
603 # to messages published on this topic.
604 #
605 # The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
606 &quot;messageStoragePolicy&quot;: { # A policy constraining the storage of messages published to the topic. # Policy constraining the set of Google Cloud Platform regions where messages
607 # published to the topic may be stored. If not present, then no constraints
608 # are in effect.
609 &quot;allowedPersistenceRegions&quot;: [ # A list of IDs of GCP regions where messages that are published to the topic
610 # may be persisted in storage. Messages published by publishers running in
611 # non-allowed GCP regions (or running outside of GCP altogether) will be
612 # routed for storage in one of the allowed regions. An empty list means that
613 # no regions are allowed, and is not a valid configuration.
614 &quot;A String&quot;,
615 ],
616 },
617 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the topic. It must have the format
618 # `&quot;projects/{project}/topics/{topic}&quot;`. `{topic}` must start with a letter,
619 # and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
620 # underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
621 # signs (`%`). It must be between 3 and 255 characters in length, and it
622 # must not start with `&quot;goog&quot;`.
623 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]624 &quot;updateMask&quot;: &quot;A String&quot;, # Required. Indicates which fields in the provided topic to update. Must be specified
625 # and non-empty. Note that if `update_mask` contains
626 # &quot;message_storage_policy&quot; but the `message_storage_policy` is not set in
627 # the `topic` provided above, then the updated value is determined by the
628 # policy configured at the project or organization level.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]629 }
630
631 x__xgafv: string, V1 error format.
632 Allowed values
633 1 - v1 error format
634 2 - v2 error format
635
636Returns:
637 An object of the form:
638
639 { # A topic resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]640 &quot;labels&quot;: { # See [Creating and managing labels]
641 # (https://cloud.google.com/pubsub/docs/labels).
642 &quot;a_key&quot;: &quot;A String&quot;,
643 },
644 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The resource name of the Cloud KMS CryptoKey to be used to protect access
645 # to messages published on this topic.
646 #
647 # The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
648 &quot;messageStoragePolicy&quot;: { # A policy constraining the storage of messages published to the topic. # Policy constraining the set of Google Cloud Platform regions where messages
649 # published to the topic may be stored. If not present, then no constraints
650 # are in effect.
651 &quot;allowedPersistenceRegions&quot;: [ # A list of IDs of GCP regions where messages that are published to the topic
652 # may be persisted in storage. Messages published by publishers running in
653 # non-allowed GCP regions (or running outside of GCP altogether) will be
654 # routed for storage in one of the allowed regions. An empty list means that
655 # no regions are allowed, and is not a valid configuration.
656 &quot;A String&quot;,
657 ],
658 },
659 &quot;name&quot;: &quot;A String&quot;, # Required. The name of the topic. It must have the format
660 # `&quot;projects/{project}/topics/{topic}&quot;`. `{topic}` must start with a letter,
661 # and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
662 # underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
663 # signs (`%`). It must be between 3 and 255 characters in length, and it
664 # must not start with `&quot;goog&quot;`.
665 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]666</div>
667
668<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]669 <code class="details" id="publish">publish(topic, body=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]670 <pre>Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]671does not exist.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]672
673Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]674 topic: string, Required. The messages in the request will be published on this topic.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]675Format is `projects/{project}/topics/{topic}`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]676 body: object, The request body.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]677 The object takes the form of:
678
679{ # Request for the Publish method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]680 &quot;messages&quot;: [ # Required. The messages to publish.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]681 { # A message that is published by publishers and consumed by subscribers. The
682 # message must contain either a non-empty data field or at least one attribute.
683 # Note that client libraries represent this object differently
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]684 # depending on the language. See the corresponding [client library
685 # documentation](https://cloud.google.com/pubsub/docs/reference/libraries) for
686 # more information. See [quotas and limits]
687 # (https://cloud.google.com/pubsub/quotas) for more information about message
688 # limits.
689 &quot;data&quot;: &quot;A String&quot;, # The message data field. If this field is empty, the message must contain
690 # at least one attribute.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]691 &quot;publishTime&quot;: &quot;A String&quot;, # The time at which the message was published, populated by the server when
692 # it receives the `Publish` call. It must not be populated by the
693 # publisher in a `Publish` call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]694 &quot;messageId&quot;: &quot;A String&quot;, # ID of this message, assigned by the server when the message is published.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]695 # Guaranteed to be unique within the topic. This value may be read by a
696 # subscriber that receives a `PubsubMessage` via a `Pull` call or a push
697 # delivery. It must not be populated by the publisher in a `Publish` call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]698 &quot;attributes&quot;: { # Attributes for this message. If this field is empty, the message must
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]699 # contain non-empty data. This can be used to filter messages on the
700 # subscription.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]701 &quot;a_key&quot;: &quot;A String&quot;,
702 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]703 },
704 ],
705 }
706
707 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]708 Allowed values
709 1 - v1 error format
710 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]711
712Returns:
713 An object of the form:
714
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]715 { # Response for the `Publish` method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]716 &quot;messageIds&quot;: [ # The server-assigned ID of each published message, in the same order as
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]717 # the messages in the request. IDs are guaranteed to be unique within
718 # the topic.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]719 &quot;A String&quot;,
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]720 ],
721 }</pre>
722</div>
723
724<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]725 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]726 <pre>Sets the access control policy on the specified resource. Replaces any
727existing policy.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]728
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]729Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]730
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]731Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]732 resource: string, REQUIRED: The resource for which the policy is being specified.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]733See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]734 body: object, The request body.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]735 The object takes the form of:
736
737{ # Request message for `SetIamPolicy` method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]738 &quot;policy&quot;: { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]739 # the policy is limited to a few 10s of KB. An empty policy is a
740 # valid policy but certain Cloud Platform services (such as Projects)
741 # might reject them.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]742 # controls for Google Cloud resources.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]743 #
744 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]745 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
746 # `members` to a single `role`. Members can be user accounts, service accounts,
747 # Google groups, and domains (such as G Suite). A `role` is a named list of
748 # permissions; each `role` can be an IAM predefined role or a user-created
749 # custom role.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]750 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]751 # For some types of Google Cloud resources, a `binding` can also specify a
752 # `condition`, which is a logical expression that allows access to a resource
753 # only if the expression evaluates to `true`. A condition can add constraints
754 # based on attributes of the request, the resource, or both. To learn which
755 # resources support conditions in their IAM policies, see the
756 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]757 #
758 # **JSON example:**
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]759 #
760 # {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]761 # &quot;bindings&quot;: [
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]762 # {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]763 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
764 # &quot;members&quot;: [
765 # &quot;user:mike@example.com&quot;,
766 # &quot;group:admins@example.com&quot;,
767 # &quot;domain:google.com&quot;,
768 # &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot;
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]769 # ]
770 # },
771 # {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]772 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
773 # &quot;members&quot;: [
774 # &quot;user:eve@example.com&quot;
775 # ],
776 # &quot;condition&quot;: {
777 # &quot;title&quot;: &quot;expirable access&quot;,
778 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
779 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]780 # }
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]781 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]782 # ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]783 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
784 # &quot;version&quot;: 3
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]785 # }
786 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]787 # **YAML example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]788 #
789 # bindings:
790 # - members:
791 # - user:mike@example.com
792 # - group:admins@example.com
793 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]794 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
795 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]796 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]797 # - user:eve@example.com
798 # role: roles/resourcemanager.organizationViewer
799 # condition:
800 # title: expirable access
801 # description: Does not grant access after Sep 2020
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]802 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]803 # - etag: BwWWja0YfJA=
804 # - version: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]805 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]806 # For a description of IAM and its features, see the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]807 # [IAM documentation](https://cloud.google.com/iam/docs/).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]808 &quot;version&quot;: 42, # Specifies the format of the policy.
809 #
810 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
811 # are rejected.
812 #
813 # Any operation that affects conditional role bindings must specify version
814 # `3`. This requirement applies to the following operations:
815 #
816 # * Getting a policy that includes a conditional role binding
817 # * Adding a conditional role binding to a policy
818 # * Changing a conditional role binding in a policy
819 # * Removing any role binding, with or without a condition, from a policy
820 # that includes conditions
821 #
822 # **Important:** If you use IAM Conditions, you must include the `etag` field
823 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
824 # you to overwrite a version `3` policy with a version `1` policy, and all of
825 # the conditions in the version `3` policy are lost.
826 #
827 # If a policy does not include any conditions, operations on that policy may
828 # specify any valid version or leave the field unset.
829 #
830 # To learn which resources support conditions in their IAM policies, see the
831 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
832 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
833 # prevent simultaneous updates of a policy from overwriting each other.
834 # It is strongly suggested that systems make use of the `etag` in the
835 # read-modify-write cycle to perform policy updates in order to avoid race
836 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
837 # systems are expected to put that etag in the request to `setIamPolicy` to
838 # ensure that their change will be applied to the same version of the policy.
839 #
840 # **Important:** If you use IAM Conditions, you must include the `etag` field
841 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
842 # you to overwrite a version `3` policy with a version `1` policy, and all of
843 # the conditions in the version `3` policy are lost.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]844 &quot;bindings&quot;: [ # Associates a list of `members` to a `role`. Optionally, may specify a
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]845 # `condition` that determines how and when the `bindings` are applied. Each
846 # of the `bindings` must contain at least one member.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]847 { # Associates `members` with a `role`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]848 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
849 #
850 # If the condition evaluates to `true`, then this binding applies to the
851 # current request.
852 #
853 # If the condition evaluates to `false`, then this binding does not apply to
854 # the current request. However, a different role binding might grant the same
855 # role to one or more of the members in this binding.
856 #
857 # To learn which resources support conditions in their IAM policies, see the
858 # [IAM
859 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
860 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
861 # are documented at https://github.com/google/cel-spec.
862 #
863 # Example (Comparison):
864 #
865 # title: &quot;Summary size limit&quot;
866 # description: &quot;Determines if a summary is less than 100 chars&quot;
867 # expression: &quot;document.summary.size() &lt; 100&quot;
868 #
869 # Example (Equality):
870 #
871 # title: &quot;Requestor is owner&quot;
872 # description: &quot;Determines if requestor is the document owner&quot;
873 # expression: &quot;document.owner == request.auth.claims.email&quot;
874 #
875 # Example (Logic):
876 #
877 # title: &quot;Public documents&quot;
878 # description: &quot;Determine whether the document should be publicly visible&quot;
879 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
880 #
881 # Example (Data Manipulation):
882 #
883 # title: &quot;Notification string&quot;
884 # description: &quot;Create a notification string with a timestamp.&quot;
885 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
886 #
887 # The exact variables and functions that may be referenced within an expression
888 # are determined by the service that evaluates it. See the service
889 # documentation for additional information.
890 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
891 # reporting, e.g. a file name and a position in the file.
892 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
893 # its purpose. This can be used e.g. in UIs which allow to enter the
894 # expression.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]895 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
896 # syntax.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]897 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
898 # describes the expression, e.g. when hovered over it in a UI.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]899 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]900 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`.
901 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]902 &quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]903 # `members` can have the following values:
904 #
905 # * `allUsers`: A special identifier that represents anyone who is
906 # on the internet; with or without a Google account.
907 #
908 # * `allAuthenticatedUsers`: A special identifier that represents anyone
909 # who is authenticated with a Google account or a service account.
910 #
911 # * `user:{emailid}`: An email address that represents a specific Google
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]912 # account. For example, `alice@example.com` .
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]913 #
914 #
915 # * `serviceAccount:{emailid}`: An email address that represents a service
916 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
917 #
918 # * `group:{emailid}`: An email address that represents a Google group.
919 # For example, `admins@example.com`.
920 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]921 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
922 # identifier) representing a user that has been recently deleted. For
923 # example, `alice@example.com?uid=123456789012345678901`. If the user is
924 # recovered, this value reverts to `user:{emailid}` and the recovered user
925 # retains the role in the binding.
926 #
927 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
928 # unique identifier) representing a service account that has been recently
929 # deleted. For example,
930 # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
931 # If the service account is undeleted, this value reverts to
932 # `serviceAccount:{emailid}` and the undeleted service account retains the
933 # role in the binding.
934 #
935 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
936 # identifier) representing a Google group that has been recently
937 # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
938 # the group is recovered, this value reverts to `group:{emailid}` and the
939 # recovered group retains the role in the binding.
940 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]941 #
942 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]943 # users of that domain. For example, `google.com` or `example.com`.
944 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]945 &quot;A String&quot;,
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]946 ],
947 },
948 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]949 },
950 }
951
952 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]953 Allowed values
954 1 - v1 error format
955 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]956
957Returns:
958 An object of the form:
959
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]960 { # An Identity and Access Management (IAM) policy, which specifies access
961 # controls for Google Cloud resources.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]962 #
963 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]964 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
965 # `members` to a single `role`. Members can be user accounts, service accounts,
966 # Google groups, and domains (such as G Suite). A `role` is a named list of
967 # permissions; each `role` can be an IAM predefined role or a user-created
968 # custom role.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]969 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]970 # For some types of Google Cloud resources, a `binding` can also specify a
971 # `condition`, which is a logical expression that allows access to a resource
972 # only if the expression evaluates to `true`. A condition can add constraints
973 # based on attributes of the request, the resource, or both. To learn which
974 # resources support conditions in their IAM policies, see the
975 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]976 #
977 # **JSON example:**
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]978 #
979 # {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]980 # &quot;bindings&quot;: [
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]981 # {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]982 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
983 # &quot;members&quot;: [
984 # &quot;user:mike@example.com&quot;,
985 # &quot;group:admins@example.com&quot;,
986 # &quot;domain:google.com&quot;,
987 # &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot;
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]988 # ]
989 # },
990 # {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]991 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
992 # &quot;members&quot;: [
993 # &quot;user:eve@example.com&quot;
994 # ],
995 # &quot;condition&quot;: {
996 # &quot;title&quot;: &quot;expirable access&quot;,
997 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
998 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]999 # }
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1000 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1001 # ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1002 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
1003 # &quot;version&quot;: 3
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1004 # }
1005 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1006 # **YAML example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1007 #
1008 # bindings:
1009 # - members:
1010 # - user:mike@example.com
1011 # - group:admins@example.com
1012 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1013 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
1014 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1015 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1016 # - user:eve@example.com
1017 # role: roles/resourcemanager.organizationViewer
1018 # condition:
1019 # title: expirable access
1020 # description: Does not grant access after Sep 2020
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1021 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1022 # - etag: BwWWja0YfJA=
1023 # - version: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1024 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1025 # For a description of IAM and its features, see the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1026 # [IAM documentation](https://cloud.google.com/iam/docs/).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]1027 &quot;version&quot;: 42, # Specifies the format of the policy.
1028 #
1029 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
1030 # are rejected.
1031 #
1032 # Any operation that affects conditional role bindings must specify version
1033 # `3`. This requirement applies to the following operations:
1034 #
1035 # * Getting a policy that includes a conditional role binding
1036 # * Adding a conditional role binding to a policy
1037 # * Changing a conditional role binding in a policy
1038 # * Removing any role binding, with or without a condition, from a policy
1039 # that includes conditions
1040 #
1041 # **Important:** If you use IAM Conditions, you must include the `etag` field
1042 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1043 # you to overwrite a version `3` policy with a version `1` policy, and all of
1044 # the conditions in the version `3` policy are lost.
1045 #
1046 # If a policy does not include any conditions, operations on that policy may
1047 # specify any valid version or leave the field unset.
1048 #
1049 # To learn which resources support conditions in their IAM policies, see the
1050 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1051 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
1052 # prevent simultaneous updates of a policy from overwriting each other.
1053 # It is strongly suggested that systems make use of the `etag` in the
1054 # read-modify-write cycle to perform policy updates in order to avoid race
1055 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1056 # systems are expected to put that etag in the request to `setIamPolicy` to
1057 # ensure that their change will be applied to the same version of the policy.
1058 #
1059 # **Important:** If you use IAM Conditions, you must include the `etag` field
1060 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1061 # you to overwrite a version `3` policy with a version `1` policy, and all of
1062 # the conditions in the version `3` policy are lost.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1063 &quot;bindings&quot;: [ # Associates a list of `members` to a `role`. Optionally, may specify a
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1064 # `condition` that determines how and when the `bindings` are applied. Each
1065 # of the `bindings` must contain at least one member.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1066 { # Associates `members` with a `role`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1067 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
1068 #
1069 # If the condition evaluates to `true`, then this binding applies to the
1070 # current request.
1071 #
1072 # If the condition evaluates to `false`, then this binding does not apply to
1073 # the current request. However, a different role binding might grant the same
1074 # role to one or more of the members in this binding.
1075 #
1076 # To learn which resources support conditions in their IAM policies, see the
1077 # [IAM
1078 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1079 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
1080 # are documented at https://github.com/google/cel-spec.
1081 #
1082 # Example (Comparison):
1083 #
1084 # title: &quot;Summary size limit&quot;
1085 # description: &quot;Determines if a summary is less than 100 chars&quot;
1086 # expression: &quot;document.summary.size() &lt; 100&quot;
1087 #
1088 # Example (Equality):
1089 #
1090 # title: &quot;Requestor is owner&quot;
1091 # description: &quot;Determines if requestor is the document owner&quot;
1092 # expression: &quot;document.owner == request.auth.claims.email&quot;
1093 #
1094 # Example (Logic):
1095 #
1096 # title: &quot;Public documents&quot;
1097 # description: &quot;Determine whether the document should be publicly visible&quot;
1098 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
1099 #
1100 # Example (Data Manipulation):
1101 #
1102 # title: &quot;Notification string&quot;
1103 # description: &quot;Create a notification string with a timestamp.&quot;
1104 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
1105 #
1106 # The exact variables and functions that may be referenced within an expression
1107 # are determined by the service that evaluates it. See the service
1108 # documentation for additional information.
1109 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
1110 # reporting, e.g. a file name and a position in the file.
1111 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
1112 # its purpose. This can be used e.g. in UIs which allow to enter the
1113 # expression.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1114 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
1115 # syntax.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]1116 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
1117 # describes the expression, e.g. when hovered over it in a UI.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1118 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]1119 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`.
1120 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1121 &quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1122 # `members` can have the following values:
1123 #
1124 # * `allUsers`: A special identifier that represents anyone who is
1125 # on the internet; with or without a Google account.
1126 #
1127 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1128 # who is authenticated with a Google account or a service account.
1129 #
1130 # * `user:{emailid}`: An email address that represents a specific Google
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1131 # account. For example, `alice@example.com` .
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1132 #
1133 #
1134 # * `serviceAccount:{emailid}`: An email address that represents a service
1135 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
1136 #
1137 # * `group:{emailid}`: An email address that represents a Google group.
1138 # For example, `admins@example.com`.
1139 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1140 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
1141 # identifier) representing a user that has been recently deleted. For
1142 # example, `alice@example.com?uid=123456789012345678901`. If the user is
1143 # recovered, this value reverts to `user:{emailid}` and the recovered user
1144 # retains the role in the binding.
1145 #
1146 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
1147 # unique identifier) representing a service account that has been recently
1148 # deleted. For example,
1149 # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
1150 # If the service account is undeleted, this value reverts to
1151 # `serviceAccount:{emailid}` and the undeleted service account retains the
1152 # role in the binding.
1153 #
1154 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
1155 # identifier) representing a Google group that has been recently
1156 # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
1157 # the group is recovered, this value reverts to `group:{emailid}` and the
1158 # recovered group retains the role in the binding.
1159 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1160 #
1161 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1162 # users of that domain. For example, `google.com` or `example.com`.
1163 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1164 &quot;A String&quot;,
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1165 ],
1166 },
1167 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1168 }</pre>
1169</div>
1170
1171<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1172 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1173 <pre>Returns permissions that a caller has on the specified resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1174If the resource does not exist, this will return an empty set of
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1175permissions, not a `NOT_FOUND` error.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1176
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1177Note: This operation is designed to be used for building permission-aware
1178UIs and command-line tools, not for authorization checking. This operation
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1179may &quot;fail open&quot; without warning.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1180
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1181Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1182 resource: string, REQUIRED: The resource for which the policy detail is being requested.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1183See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1184 body: object, The request body.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1185 The object takes the form of:
1186
1187{ # Request message for `TestIamPermissions` method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1188 &quot;permissions&quot;: [ # The set of permissions to check for the `resource`. Permissions with
1189 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed. For more
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1190 # information see
1191 # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1192 &quot;A String&quot;,
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1193 ],
1194 }
1195
1196 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1197 Allowed values
1198 1 - v1 error format
1199 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1200
1201Returns:
1202 An object of the form:
1203
1204 { # Response message for `TestIamPermissions` method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1205 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1206 # allowed.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1207 &quot;A String&quot;,
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1208 ],
1209 }</pre>
1210</div>
1211
1212</body></html>