Debian Codegraph @

docs/dyn/analyticshub_v1.projects.locations.dataExchanges.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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="analyticshub_v1.html">Analytics Hub API</a> . <a href="analyticshub_v1.projects.html">projects</a> . <a href="analyticshub_v1.projects.locations.html">locations</a> . <a href="analyticshub_v1.projects.locations.dataExchanges.html">dataExchanges</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="analyticshub_v1.projects.locations.dataExchanges.listings.html">listings()</a></code>
79 </p>
80 <p class="firstline">Returns the listings Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="analyticshub_v1.projects.locations.dataExchanges.queryTemplates.html">queryTemplates()</a></code>
84 </p>
85 <p class="firstline">Returns the queryTemplates Resource.</p>
86
87 <p class="toc_element">
88 <code><a href="#close">close()</a></code></p>
89 <p class="firstline">Close httplib2 connections.</p>
90 <p class="toc_element">
91 <code><a href="#create">create(parent, body=None, dataExchangeId=None, x__xgafv=None)</a></code></p>
92 <p class="firstline">Creates a new data exchange.</p>
93 <p class="toc_element">
94 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
95 <p class="firstline">Deletes an existing data exchange.</p>
96 <p class="toc_element">
97 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
98 <p class="firstline">Gets the details of a data exchange.</p>
99 <p class="toc_element">
100 <code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
101 <p class="firstline">Gets the IAM policy.</p>
102 <p class="toc_element">
103 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
104 <p class="firstline">Lists all data exchanges in a given project and location.</p>
105 <p class="toc_element">
106 <code><a href="#listSubscriptions">listSubscriptions(resource, includeDeletedSubscriptions=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
107 <p class="firstline">Lists all subscriptions on a given Data Exchange or Listing.</p>
108 <p class="toc_element">
109 <code><a href="#listSubscriptions_next">listSubscriptions_next()</a></code></p>
110 <p class="firstline">Retrieves the next page of results.</p>
111 <p class="toc_element">
112 <code><a href="#list_next">list_next()</a></code></p>
113 <p class="firstline">Retrieves the next page of results.</p>
114 <p class="toc_element">
115 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
116 <p class="firstline">Updates an existing data exchange.</p>
117 <p class="toc_element">
118 <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
119 <p class="firstline">Sets the IAM policy.</p>
120 <p class="toc_element">
121 <code><a href="#subscribe">subscribe(name, body=None, x__xgafv=None)</a></code></p>
122 <p class="firstline">Creates a Subscription to a Data Clean Room. This is a long-running operation as it will create one or more linked datasets. Throws a Bad Request error if the Data Exchange does not contain any listings.</p>
123 <p class="toc_element">
124 <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
125 <p class="firstline">Returns the permissions that a caller has.</p>
126 <h3>Method Details</h3>
127 <div class="method">
128 <code class="details" id="close">close()</code>
129 <pre>Close httplib2 connections.</pre>
130 </div>
131
132 <div class="method">
133 <code class="details" id="create">create(parent, body=None, dataExchangeId=None, x__xgafv=None)</code>
134 <pre>Creates a new data exchange.
135
136 Args:
137 parent: string, Required. The parent resource path of the data exchange. e.g. `projects/myproject/locations/us`. (required)
138 body: object, The request body.
139 The object takes the form of:
140
141 { # A data exchange is a container that lets you share data. Along with the descriptive information about the data exchange, it contains listings that reference shared datasets.
142 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the data exchange. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
143 &quot;discoveryType&quot;: &quot;A String&quot;, # Optional. Type of discovery on the discovery page for all the listings under this exchange. Updating this field also updates (overwrites) the discovery_type field for all the listings under this exchange.
144 &quot;displayName&quot;: &quot;A String&quot;, # Required. Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&amp;) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes.
145 &quot;documentation&quot;: &quot;A String&quot;, # Optional. Documentation describing the data exchange.
146 &quot;icon&quot;: &quot;A String&quot;, # Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
147 &quot;listingCount&quot;: 42, # Output only. Number of listings contained in the data exchange.
148 &quot;logLinkedDatasetQueryUserEmail&quot;: True or False, # Optional. By default, false. If true, the DataExchange has an email sharing mandate enabled.
149 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`.
150 &quot;primaryContact&quot;: &quot;A String&quot;, # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
151 &quot;sharingEnvironmentConfig&quot;: { # Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. # Optional. Configurable data sharing environment option for a data exchange.
152 &quot;dcrExchangeConfig&quot;: { # Data Clean Room (DCR), used for privacy-safe and secured data sharing. # Data Clean Room (DCR), used for privacy-safe and secured data sharing.
153 &quot;singleLinkedDatasetPerCleanroom&quot;: True or False, # Output only. If True, when subscribing to this DCR, it will create only one linked dataset containing all resources shared within the cleanroom. If False, when subscribing to this DCR, it will create 1 linked dataset per listing. This is not configurable, and by default, all new DCRs will have the restriction set to True.
154 &quot;singleSelectedResourceSharingRestriction&quot;: True or False, # Output only. If True, this DCR restricts the contributors to sharing only a single resource in a Listing. And no two resources should have the same IDs. So if a contributor adds a view with a conflicting name, the CreateListing API will reject the request. if False, the data contributor can publish an entire dataset (as before). This is not configurable, and by default, all new DCRs will have the restriction set to True.
155 },
156 &quot;defaultExchangeConfig&quot;: { # Default Analytics Hub data exchange, used for secured data sharing. # Default Analytics Hub data exchange, used for secured data sharing.
157 },
158 },
159 }
160
161 dataExchangeId: string, Required. The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Max length: 100 bytes.
162 x__xgafv: string, V1 error format.
163 Allowed values
164 1 - v1 error format
165 2 - v2 error format
166
167 Returns:
168 An object of the form:
169
170 { # A data exchange is a container that lets you share data. Along with the descriptive information about the data exchange, it contains listings that reference shared datasets.
171 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the data exchange. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
172 &quot;discoveryType&quot;: &quot;A String&quot;, # Optional. Type of discovery on the discovery page for all the listings under this exchange. Updating this field also updates (overwrites) the discovery_type field for all the listings under this exchange.
173 &quot;displayName&quot;: &quot;A String&quot;, # Required. Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&amp;) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes.
174 &quot;documentation&quot;: &quot;A String&quot;, # Optional. Documentation describing the data exchange.
175 &quot;icon&quot;: &quot;A String&quot;, # Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
176 &quot;listingCount&quot;: 42, # Output only. Number of listings contained in the data exchange.
177 &quot;logLinkedDatasetQueryUserEmail&quot;: True or False, # Optional. By default, false. If true, the DataExchange has an email sharing mandate enabled.
178 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`.
179 &quot;primaryContact&quot;: &quot;A String&quot;, # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
180 &quot;sharingEnvironmentConfig&quot;: { # Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. # Optional. Configurable data sharing environment option for a data exchange.
181 &quot;dcrExchangeConfig&quot;: { # Data Clean Room (DCR), used for privacy-safe and secured data sharing. # Data Clean Room (DCR), used for privacy-safe and secured data sharing.
182 &quot;singleLinkedDatasetPerCleanroom&quot;: True or False, # Output only. If True, when subscribing to this DCR, it will create only one linked dataset containing all resources shared within the cleanroom. If False, when subscribing to this DCR, it will create 1 linked dataset per listing. This is not configurable, and by default, all new DCRs will have the restriction set to True.
183 &quot;singleSelectedResourceSharingRestriction&quot;: True or False, # Output only. If True, this DCR restricts the contributors to sharing only a single resource in a Listing. And no two resources should have the same IDs. So if a contributor adds a view with a conflicting name, the CreateListing API will reject the request. if False, the data contributor can publish an entire dataset (as before). This is not configurable, and by default, all new DCRs will have the restriction set to True.
184 },
185 &quot;defaultExchangeConfig&quot;: { # Default Analytics Hub data exchange, used for secured data sharing. # Default Analytics Hub data exchange, used for secured data sharing.
186 },
187 },
188 }</pre>
189 </div>
190
191 <div class="method">
192 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
193 <pre>Deletes an existing data exchange.
194
195 Args:
196 name: string, Required. The full name of the data exchange resource that you want to delete. For example, `projects/myproject/locations/us/dataExchanges/123`. (required)
197 x__xgafv: string, V1 error format.
198 Allowed values
199 1 - v1 error format
200 2 - v2 error format
201
202 Returns:
203 An object of the form:
204
205 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
206 }</pre>
207 </div>
208
209 <div class="method">
210 <code class="details" id="get">get(name, x__xgafv=None)</code>
211 <pre>Gets the details of a data exchange.
212
213 Args:
214 name: string, Required. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`. (required)
215 x__xgafv: string, V1 error format.
216 Allowed values
217 1 - v1 error format
218 2 - v2 error format
219
220 Returns:
221 An object of the form:
222
223 { # A data exchange is a container that lets you share data. Along with the descriptive information about the data exchange, it contains listings that reference shared datasets.
224 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the data exchange. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
225 &quot;discoveryType&quot;: &quot;A String&quot;, # Optional. Type of discovery on the discovery page for all the listings under this exchange. Updating this field also updates (overwrites) the discovery_type field for all the listings under this exchange.
226 &quot;displayName&quot;: &quot;A String&quot;, # Required. Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&amp;) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes.
227 &quot;documentation&quot;: &quot;A String&quot;, # Optional. Documentation describing the data exchange.
228 &quot;icon&quot;: &quot;A String&quot;, # Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
229 &quot;listingCount&quot;: 42, # Output only. Number of listings contained in the data exchange.
230 &quot;logLinkedDatasetQueryUserEmail&quot;: True or False, # Optional. By default, false. If true, the DataExchange has an email sharing mandate enabled.
231 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`.
232 &quot;primaryContact&quot;: &quot;A String&quot;, # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
233 &quot;sharingEnvironmentConfig&quot;: { # Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. # Optional. Configurable data sharing environment option for a data exchange.
234 &quot;dcrExchangeConfig&quot;: { # Data Clean Room (DCR), used for privacy-safe and secured data sharing. # Data Clean Room (DCR), used for privacy-safe and secured data sharing.
235 &quot;singleLinkedDatasetPerCleanroom&quot;: True or False, # Output only. If True, when subscribing to this DCR, it will create only one linked dataset containing all resources shared within the cleanroom. If False, when subscribing to this DCR, it will create 1 linked dataset per listing. This is not configurable, and by default, all new DCRs will have the restriction set to True.
236 &quot;singleSelectedResourceSharingRestriction&quot;: True or False, # Output only. If True, this DCR restricts the contributors to sharing only a single resource in a Listing. And no two resources should have the same IDs. So if a contributor adds a view with a conflicting name, the CreateListing API will reject the request. if False, the data contributor can publish an entire dataset (as before). This is not configurable, and by default, all new DCRs will have the restriction set to True.
237 },
238 &quot;defaultExchangeConfig&quot;: { # Default Analytics Hub data exchange, used for secured data sharing. # Default Analytics Hub data exchange, used for secured data sharing.
239 },
240 },
241 }</pre>
242 </div>
243
244 <div class="method">
245 <code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code>
246 <pre>Gets the IAM policy.
247
248 Args:
249 resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
250 body: object, The request body.
251 The object takes the form of:
252
253 { # Request message for `GetIamPolicy` method.
254 &quot;options&quot;: { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
255 &quot;requestedPolicyVersion&quot;: 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
256 },
257 }
258
259 x__xgafv: string, V1 error format.
260 Allowed values
261 1 - v1 error format
262 2 - v2 error format
263
264 Returns:
265 An object of the form:
266
267 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:[email protected]&quot;, &quot;group:[email protected]&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:[email protected]&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:[email protected]&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 3 } ``` **YAML example:** ``` bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
268 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
269 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { &quot;audit_configs&quot;: [ { &quot;service&quot;: &quot;allServices&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:[email protected]&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; }, { &quot;log_type&quot;: &quot;ADMIN_READ&quot; } ] }, { &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot; }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot;, &quot;exempted_members&quot;: [ &quot;user:[email protected]&quot; ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `[email protected]` from DATA_READ logging, and `[email protected]` from DATA_WRITE logging.
270 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
271 { # Provides the configuration for logging a type of permissions. Example: { &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:[email protected]&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; } ] } This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting [email protected] from DATA_READ logging.
272 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
273 &quot;A String&quot;,
274 ],
275 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
276 },
277 ],
278 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
279 },
280 ],
281 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
282 { # Associates `members`, or principals, with a `role`.
283 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
284 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
285 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
286 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
287 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
288 },
289 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `[email protected]`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
290 &quot;A String&quot;,
291 ],
292 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
293 },
294 ],
295 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
296 &quot;version&quot;: 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
297 }</pre>
298 </div>
299
300 <div class="method">
301 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
302 <pre>Lists all data exchanges in a given project and location.
303
304 Args:
305 parent: string, Required. The parent resource path of the data exchanges. e.g. `projects/myproject/locations/us`. (required)
306 pageSize: integer, The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
307 pageToken: string, Page token, returned by a previous call, to request the next page of results.
308 x__xgafv: string, V1 error format.
309 Allowed values
310 1 - v1 error format
311 2 - v2 error format
312
313 Returns:
314 An object of the form:
315
316 { # Message for response to the list of data exchanges.
317 &quot;dataExchanges&quot;: [ # The list of data exchanges.
318 { # A data exchange is a container that lets you share data. Along with the descriptive information about the data exchange, it contains listings that reference shared datasets.
319 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the data exchange. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
320 &quot;discoveryType&quot;: &quot;A String&quot;, # Optional. Type of discovery on the discovery page for all the listings under this exchange. Updating this field also updates (overwrites) the discovery_type field for all the listings under this exchange.
321 &quot;displayName&quot;: &quot;A String&quot;, # Required. Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&amp;) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes.
322 &quot;documentation&quot;: &quot;A String&quot;, # Optional. Documentation describing the data exchange.
323 &quot;icon&quot;: &quot;A String&quot;, # Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
324 &quot;listingCount&quot;: 42, # Output only. Number of listings contained in the data exchange.
325 &quot;logLinkedDatasetQueryUserEmail&quot;: True or False, # Optional. By default, false. If true, the DataExchange has an email sharing mandate enabled.
326 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`.
327 &quot;primaryContact&quot;: &quot;A String&quot;, # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
328 &quot;sharingEnvironmentConfig&quot;: { # Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. # Optional. Configurable data sharing environment option for a data exchange.
329 &quot;dcrExchangeConfig&quot;: { # Data Clean Room (DCR), used for privacy-safe and secured data sharing. # Data Clean Room (DCR), used for privacy-safe and secured data sharing.
330 &quot;singleLinkedDatasetPerCleanroom&quot;: True or False, # Output only. If True, when subscribing to this DCR, it will create only one linked dataset containing all resources shared within the cleanroom. If False, when subscribing to this DCR, it will create 1 linked dataset per listing. This is not configurable, and by default, all new DCRs will have the restriction set to True.
331 &quot;singleSelectedResourceSharingRestriction&quot;: True or False, # Output only. If True, this DCR restricts the contributors to sharing only a single resource in a Listing. And no two resources should have the same IDs. So if a contributor adds a view with a conflicting name, the CreateListing API will reject the request. if False, the data contributor can publish an entire dataset (as before). This is not configurable, and by default, all new DCRs will have the restriction set to True.
332 },
333 &quot;defaultExchangeConfig&quot;: { # Default Analytics Hub data exchange, used for secured data sharing. # Default Analytics Hub data exchange, used for secured data sharing.
334 },
335 },
336 },
337 ],
338 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to request the next page of results.
339 }</pre>
340 </div>
341
342 <div class="method">
343 <code class="details" id="listSubscriptions">listSubscriptions(resource, includeDeletedSubscriptions=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
344 <pre>Lists all subscriptions on a given Data Exchange or Listing.
345
346 Args:
347 resource: string, Required. Resource name of the requested target. This resource may be either a Listing or a DataExchange. e.g. projects/123/locations/us/dataExchanges/456 OR e.g. projects/123/locations/us/dataExchanges/456/listings/789 (required)
348 includeDeletedSubscriptions: boolean, If selected, includes deleted subscriptions in the response (up to 63 days after deletion).
349 pageSize: integer, The maximum number of results to return in a single response page.
350 pageToken: string, Page token, returned by a previous call.
351 x__xgafv: string, V1 error format.
352 Allowed values
353 1 - v1 error format
354 2 - v2 error format
355
356 Returns:
357 An object of the form:
358
359 { # Message for response to the listing of shared resource subscriptions.
360 &quot;nextPageToken&quot;: &quot;A String&quot;, # Next page token.
361 &quot;sharedResourceSubscriptions&quot;: [ # The list of subscriptions.
362 { # A subscription represents a subscribers&#x27; access to a particular set of published data. It contains references to associated listings, data exchanges, and linked datasets.
363 &quot;commercialInfo&quot;: { # Commercial info metadata for this subscription. # Output only. This is set if this is a commercial subscription i.e. if this subscription was created from subscribing to a commercial listing.
364 &quot;cloudMarketplace&quot;: { # Cloud Marketplace commercial metadata for this subscription. # Output only. This is set when the subscription is commercialised via Cloud Marketplace.
365 &quot;order&quot;: &quot;A String&quot;, # Resource name of the Marketplace Order.
366 },
367 },
368 &quot;creationTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the subscription was created.
369 &quot;dataExchange&quot;: &quot;A String&quot;, # Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/us/dataExchanges/456
370 &quot;destinationDataset&quot;: { # Defines the destination bigquery dataset. # Optional. BigQuery destination dataset to create for the subscriber.
371 &quot;datasetReference&quot;: { # Required. A reference that identifies the destination dataset.
372 &quot;datasetId&quot;: &quot;A String&quot;, # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
373 &quot;projectId&quot;: &quot;A String&quot;, # Required. The ID of the project containing this dataset.
374 },
375 &quot;description&quot;: &quot;A String&quot;, # Optional. A user-friendly description of the dataset.
376 &quot;friendlyName&quot;: &quot;A String&quot;, # Optional. A descriptive name for the dataset.
377 &quot;labels&quot;: { # Optional. The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See https://cloud.google.com/resource-manager/docs/creating-managing-labels for more information.
378 &quot;a_key&quot;: &quot;A String&quot;,
379 },
380 &quot;location&quot;: &quot;A String&quot;, # Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
381 &quot;replicaLocations&quot;: [ # Optional. The geographic locations where the dataset should be replicated. See [BigQuery locations](https://cloud.google.com/bigquery/docs/locations) for supported locations.
382 &quot;A String&quot;,
383 ],
384 },
385 &quot;lastModifyTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the subscription was last modified.
386 &quot;linkedDatasetMap&quot;: { # Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 -&gt; projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.
387 &quot;a_key&quot;: { # Reference to a linked resource tracked by this Subscription.
388 &quot;linkedDataset&quot;: &quot;A String&quot;, # Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linked_dataset
389 &quot;linkedPubsubSubscription&quot;: &quot;A String&quot;, # Output only. Name of the Pub/Sub subscription, e.g. projects/subscriberproject/subscriptions/subscriptions/sub_id
390 &quot;listing&quot;: &quot;A String&quot;, # Output only. Listing for which linked resource is created.
391 },
392 },
393 &quot;linkedResources&quot;: [ # Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE.
394 { # Reference to a linked resource tracked by this Subscription.
395 &quot;linkedDataset&quot;: &quot;A String&quot;, # Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linked_dataset
396 &quot;linkedPubsubSubscription&quot;: &quot;A String&quot;, # Output only. Name of the Pub/Sub subscription, e.g. projects/subscriberproject/subscriptions/subscriptions/sub_id
397 &quot;listing&quot;: &quot;A String&quot;, # Output only. Listing for which linked resource is created.
398 },
399 ],
400 &quot;listing&quot;: &quot;A String&quot;, # Output only. Resource name of the source Listing. e.g. projects/123/locations/us/dataExchanges/456/listings/789
401 &quot;logLinkedDatasetQueryUserEmail&quot;: True or False, # Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.
402 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the subscription. e.g. `projects/myproject/locations/us/subscriptions/123`.
403 &quot;organizationDisplayName&quot;: &quot;A String&quot;, # Output only. Display name of the project of this subscription.
404 &quot;organizationId&quot;: &quot;A String&quot;, # Output only. Organization of the project this subscription belongs to.
405 &quot;resourceType&quot;: &quot;A String&quot;, # Output only. Listing shared asset type.
406 &quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the subscription.
407 &quot;subscriberContact&quot;: &quot;A String&quot;, # Output only. Email of the subscriber.
408 },
409 ],
410 }</pre>
411 </div>
412
413 <div class="method">
414 <code class="details" id="listSubscriptions_next">listSubscriptions_next()</code>
415 <pre>Retrieves the next page of results.
416
417 Args:
418 previous_request: The request for the previous page. (required)
419 previous_response: The response from the request for the previous page. (required)
420
421 Returns:
422 A request object that you can call &#x27;execute()&#x27; on to request the next
423 page. Returns None if there are no more items in the collection.
424 </pre>
425 </div>
426
427 <div class="method">
428 <code class="details" id="list_next">list_next()</code>
429 <pre>Retrieves the next page of results.
430
431 Args:
432 previous_request: The request for the previous page. (required)
433 previous_response: The response from the request for the previous page. (required)
434
435 Returns:
436 A request object that you can call &#x27;execute()&#x27; on to request the next
437 page. Returns None if there are no more items in the collection.
438 </pre>
439 </div>
440
441 <div class="method">
442 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
443 <pre>Updates an existing data exchange.
444
445 Args:
446 name: string, Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`. (required)
447 body: object, The request body.
448 The object takes the form of:
449
450 { # A data exchange is a container that lets you share data. Along with the descriptive information about the data exchange, it contains listings that reference shared datasets.
451 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the data exchange. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
452 &quot;discoveryType&quot;: &quot;A String&quot;, # Optional. Type of discovery on the discovery page for all the listings under this exchange. Updating this field also updates (overwrites) the discovery_type field for all the listings under this exchange.
453 &quot;displayName&quot;: &quot;A String&quot;, # Required. Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&amp;) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes.
454 &quot;documentation&quot;: &quot;A String&quot;, # Optional. Documentation describing the data exchange.
455 &quot;icon&quot;: &quot;A String&quot;, # Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
456 &quot;listingCount&quot;: 42, # Output only. Number of listings contained in the data exchange.
457 &quot;logLinkedDatasetQueryUserEmail&quot;: True or False, # Optional. By default, false. If true, the DataExchange has an email sharing mandate enabled.
458 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`.
459 &quot;primaryContact&quot;: &quot;A String&quot;, # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
460 &quot;sharingEnvironmentConfig&quot;: { # Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. # Optional. Configurable data sharing environment option for a data exchange.
461 &quot;dcrExchangeConfig&quot;: { # Data Clean Room (DCR), used for privacy-safe and secured data sharing. # Data Clean Room (DCR), used for privacy-safe and secured data sharing.
462 &quot;singleLinkedDatasetPerCleanroom&quot;: True or False, # Output only. If True, when subscribing to this DCR, it will create only one linked dataset containing all resources shared within the cleanroom. If False, when subscribing to this DCR, it will create 1 linked dataset per listing. This is not configurable, and by default, all new DCRs will have the restriction set to True.
463 &quot;singleSelectedResourceSharingRestriction&quot;: True or False, # Output only. If True, this DCR restricts the contributors to sharing only a single resource in a Listing. And no two resources should have the same IDs. So if a contributor adds a view with a conflicting name, the CreateListing API will reject the request. if False, the data contributor can publish an entire dataset (as before). This is not configurable, and by default, all new DCRs will have the restriction set to True.
464 },
465 &quot;defaultExchangeConfig&quot;: { # Default Analytics Hub data exchange, used for secured data sharing. # Default Analytics Hub data exchange, used for secured data sharing.
466 },
467 },
468 }
469
470 updateMask: string, Required. Field mask specifies the fields to update in the data exchange resource. The fields specified in the `updateMask` are relative to the resource and are not a full request.
471 x__xgafv: string, V1 error format.
472 Allowed values
473 1 - v1 error format
474 2 - v2 error format
475
476 Returns:
477 An object of the form:
478
479 { # A data exchange is a container that lets you share data. Along with the descriptive information about the data exchange, it contains listings that reference shared datasets.
480 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the data exchange. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
481 &quot;discoveryType&quot;: &quot;A String&quot;, # Optional. Type of discovery on the discovery page for all the listings under this exchange. Updating this field also updates (overwrites) the discovery_type field for all the listings under this exchange.
482 &quot;displayName&quot;: &quot;A String&quot;, # Required. Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&amp;) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes.
483 &quot;documentation&quot;: &quot;A String&quot;, # Optional. Documentation describing the data exchange.
484 &quot;icon&quot;: &quot;A String&quot;, # Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
485 &quot;listingCount&quot;: 42, # Output only. Number of listings contained in the data exchange.
486 &quot;logLinkedDatasetQueryUserEmail&quot;: True or False, # Optional. By default, false. If true, the DataExchange has an email sharing mandate enabled.
487 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`.
488 &quot;primaryContact&quot;: &quot;A String&quot;, # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
489 &quot;sharingEnvironmentConfig&quot;: { # Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. # Optional. Configurable data sharing environment option for a data exchange.
490 &quot;dcrExchangeConfig&quot;: { # Data Clean Room (DCR), used for privacy-safe and secured data sharing. # Data Clean Room (DCR), used for privacy-safe and secured data sharing.
491 &quot;singleLinkedDatasetPerCleanroom&quot;: True or False, # Output only. If True, when subscribing to this DCR, it will create only one linked dataset containing all resources shared within the cleanroom. If False, when subscribing to this DCR, it will create 1 linked dataset per listing. This is not configurable, and by default, all new DCRs will have the restriction set to True.
492 &quot;singleSelectedResourceSharingRestriction&quot;: True or False, # Output only. If True, this DCR restricts the contributors to sharing only a single resource in a Listing. And no two resources should have the same IDs. So if a contributor adds a view with a conflicting name, the CreateListing API will reject the request. if False, the data contributor can publish an entire dataset (as before). This is not configurable, and by default, all new DCRs will have the restriction set to True.
493 },
494 &quot;defaultExchangeConfig&quot;: { # Default Analytics Hub data exchange, used for secured data sharing. # Default Analytics Hub data exchange, used for secured data sharing.
495 },
496 },
497 }</pre>
498 </div>
499
500 <div class="method">
501 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
502 <pre>Sets the IAM policy.
503
504 Args:
505 resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
506 body: object, The request body.
507 The object takes the form of:
508
509 { # Request message for `SetIamPolicy` method.
510 &quot;policy&quot;: { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:[email protected]&quot;, &quot;group:[email protected]&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:[email protected]&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:[email protected]&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 3 } ``` **YAML example:** ``` bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
511 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
512 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { &quot;audit_configs&quot;: [ { &quot;service&quot;: &quot;allServices&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:[email protected]&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; }, { &quot;log_type&quot;: &quot;ADMIN_READ&quot; } ] }, { &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot; }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot;, &quot;exempted_members&quot;: [ &quot;user:[email protected]&quot; ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `[email protected]` from DATA_READ logging, and `[email protected]` from DATA_WRITE logging.
513 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
514 { # Provides the configuration for logging a type of permissions. Example: { &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:[email protected]&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; } ] } This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting [email protected] from DATA_READ logging.
515 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
516 &quot;A String&quot;,
517 ],
518 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
519 },
520 ],
521 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
522 },
523 ],
524 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
525 { # Associates `members`, or principals, with a `role`.
526 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
527 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
528 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
529 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
530 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
531 },
532 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `[email protected]`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
533 &quot;A String&quot;,
534 ],
535 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
536 },
537 ],
538 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
539 &quot;version&quot;: 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
540 },
541 &quot;updateMask&quot;: &quot;A String&quot;, # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: &quot;bindings, etag&quot;`
542 }
543
544 x__xgafv: string, V1 error format.
545 Allowed values
546 1 - v1 error format
547 2 - v2 error format
548
549 Returns:
550 An object of the form:
551
552 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:[email protected]&quot;, &quot;group:[email protected]&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:[email protected]&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:[email protected]&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 3 } ``` **YAML example:** ``` bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
553 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
554 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { &quot;audit_configs&quot;: [ { &quot;service&quot;: &quot;allServices&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:[email protected]&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; }, { &quot;log_type&quot;: &quot;ADMIN_READ&quot; } ] }, { &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot; }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot;, &quot;exempted_members&quot;: [ &quot;user:[email protected]&quot; ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `[email protected]` from DATA_READ logging, and `[email protected]` from DATA_WRITE logging.
555 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
556 { # Provides the configuration for logging a type of permissions. Example: { &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:[email protected]&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; } ] } This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting [email protected] from DATA_READ logging.
557 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
558 &quot;A String&quot;,
559 ],
560 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
561 },
562 ],
563 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
564 },
565 ],
566 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
567 { # Associates `members`, or principals, with a `role`.
568 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
569 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
570 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
571 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
572 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
573 },
574 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `[email protected]`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
575 &quot;A String&quot;,
576 ],
577 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
578 },
579 ],
580 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
581 &quot;version&quot;: 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
582 }</pre>
583 </div>
584
585 <div class="method">
586 <code class="details" id="subscribe">subscribe(name, body=None, x__xgafv=None)</code>
587 <pre>Creates a Subscription to a Data Clean Room. This is a long-running operation as it will create one or more linked datasets. Throws a Bad Request error if the Data Exchange does not contain any listings.
588
589 Args:
590 name: string, Required. Resource name of the Data Exchange. e.g. `projects/publisherproject/locations/us/dataExchanges/123` (required)
591 body: object, The request body.
592 The object takes the form of:
593
594 { # Message for subscribing to a Data Exchange.
595 &quot;destination&quot;: &quot;A String&quot;, # Required. The parent resource path of the Subscription. e.g. `projects/subscriberproject/locations/us`
596 &quot;destinationDataset&quot;: { # Defines the destination bigquery dataset. # Optional. BigQuery destination dataset to create for the subscriber.
597 &quot;datasetReference&quot;: { # Required. A reference that identifies the destination dataset.
598 &quot;datasetId&quot;: &quot;A String&quot;, # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
599 &quot;projectId&quot;: &quot;A String&quot;, # Required. The ID of the project containing this dataset.
600 },
601 &quot;description&quot;: &quot;A String&quot;, # Optional. A user-friendly description of the dataset.
602 &quot;friendlyName&quot;: &quot;A String&quot;, # Optional. A descriptive name for the dataset.
603 &quot;labels&quot;: { # Optional. The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See https://cloud.google.com/resource-manager/docs/creating-managing-labels for more information.
604 &quot;a_key&quot;: &quot;A String&quot;,
605 },
606 &quot;location&quot;: &quot;A String&quot;, # Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
607 &quot;replicaLocations&quot;: [ # Optional. The geographic locations where the dataset should be replicated. See [BigQuery locations](https://cloud.google.com/bigquery/docs/locations) for supported locations.
608 &quot;A String&quot;,
609 ],
610 },
611 &quot;subscriberContact&quot;: &quot;A String&quot;, # Email of the subscriber.
612 &quot;subscription&quot;: &quot;A String&quot;, # Required. Name of the subscription to create. e.g. `subscription1`
613 }
614
615 x__xgafv: string, V1 error format.
616 Allowed values
617 1 - v1 error format
618 2 - v2 error format
619
620 Returns:
621 An object of the form:
622
623 { # This resource represents a long-running operation that is the result of a network API call.
624 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
625 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
626 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
627 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
628 {
629 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
630 },
631 ],
632 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
633 },
634 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
635 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
636 },
637 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
638 &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
639 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
640 },
641 }</pre>
642 </div>
643
644 <div class="method">
645 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
646 <pre>Returns the permissions that a caller has.
647
648 Args:
649 resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
650 body: object, The request body.
651 The object takes the form of:
652
653 { # Request message for `TestIamPermissions` method.
654 &quot;permissions&quot;: [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
655 &quot;A String&quot;,
656 ],
657 }
658
659 x__xgafv: string, V1 error format.
660 Allowed values
661 1 - v1 error format
662 2 - v2 error format
663
664 Returns:
665 An object of the form:
666
667 { # Response message for `TestIamPermissions` method.
668 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
669 &quot;A String&quot;,
670 ],
671 }</pre>
672 </div>
673
674 </body></html>