1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="datacatalog_v1.html">Google Cloud Data Catalog API</a> . <a href="datacatalog_v1.projects.html">projects</a> . <a href="datacatalog_v1.projects.locations.html">locations</a> . <a href="datacatalog_v1.projects.locations.taxonomies.html">taxonomies</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="datacatalog_v1.projects.locations.taxonomies.policyTags.html">policyTags()</a></code> 79</p> 80<p class="firstline">Returns the policyTags Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#close">close()</a></code></p> 84<p class="firstline">Close httplib2 connections.</p> 85<p class="toc_element"> 86 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 87<p class="firstline">Creates a taxonomy in a specified project. The taxonomy is initially empty, that is, it doesn't contain policy tags.</p> 88<p class="toc_element"> 89 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 90<p class="firstline">Deletes a taxonomy, including all policy tags in this taxonomy, their associated policies, and the policy tags references from BigQuery columns.</p> 91<p class="toc_element"> 92 <code><a href="#export">export(parent, serializedTaxonomies=None, taxonomies=None, x__xgafv=None)</a></code></p> 93<p class="firstline">Exports taxonomies in the requested type and returns them, including their policy tags. The requested taxonomies must belong to the same project. This method generates `SerializedTaxonomy` protocol buffers with nested policy tags that can be used as input for `ImportTaxonomies` calls.</p> 94<p class="toc_element"> 95 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 96<p class="firstline">Gets a taxonomy.</p> 97<p class="toc_element"> 98 <code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p> 99<p class="firstline">Gets the IAM policy for a policy tag or a taxonomy.</p> 100<p class="toc_element"> 101 <code><a href="#import_">import_(parent, body=None, x__xgafv=None)</a></code></p> 102<p class="firstline">Creates new taxonomies (including their policy tags) in a given project by importing from inlined or cross-regional sources. For a cross-regional source, new taxonomies are created by copying from a source in another region. For an inlined source, taxonomies and policy tags are created in bulk using nested protocol buffer structures.</p> 103<p class="toc_element"> 104 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 105<p class="firstline">Lists all taxonomies in a project in a particular location that you have a permission to view.</p> 106<p class="toc_element"> 107 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 108<p class="firstline">Retrieves the next page of results.</p> 109<p class="toc_element"> 110 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 111<p class="firstline">Updates a taxonomy, including its display name, description, and activated policy types.</p> 112<p class="toc_element"> 113 <code><a href="#replace">replace(name, body=None, x__xgafv=None)</a></code></p> 114<p class="firstline">Replaces (updates) a taxonomy and all its policy tags. The taxonomy and its entire hierarchy of policy tags must be represented literally by `SerializedTaxonomy` and the nested `SerializedPolicyTag` messages. This operation automatically does the following: - Deletes the existing policy tags that are missing from the `SerializedPolicyTag`. - Creates policy tags that don't have resource names. They are considered new. - Updates policy tags with valid resources names accordingly.</p> 115<p class="toc_element"> 116 <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p> 117<p class="firstline">Sets the IAM policy for a policy tag or a taxonomy.</p> 118<p class="toc_element"> 119 <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p> 120<p class="firstline">Returns your permissions on a specified policy tag or taxonomy.</p> 121<h3>Method Details</h3> 122<div class="method"> 123 <code class="details" id="close">close()</code> 124 <pre>Close httplib2 connections.</pre> 125</div> 126 127<div class="method"> 128 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 129 <pre>Creates a taxonomy in a specified project. The taxonomy is initially empty, that is, it doesn't contain policy tags. 130 131Args: 132 parent: string, Required. Resource name of the project that the taxonomy will belong to. (required) 133 body: object, The request body. 134 The object takes the form of: 135 136{ # A taxonomy is a collection of hierarchical policy tags that classify data along a common axis. For example, a "data sensitivity" taxonomy might contain the following policy tags: ``` + PII + Account number + Age + SSN + Zipcode + Financials + Revenue ``` A "data origin" taxonomy might contain the following policy tags: ``` + User data + Employee data + Partner data + Public data ``` 137 "activatedPolicyTypes": [ # Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list. 138 "A String", 139 ], 140 "description": "A String", # Optional. Description of this taxonomy. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns, and page breaks, and be at most 2000 bytes long when encoded in UTF-8. 141 "displayName": "A String", # Required. User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and spaces, and be at most 200 bytes long when encoded in UTF-8. 142 "name": "A String", # Output only. Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs. 143 "policyTagCount": 42, # Output only. Number of policy tags in this taxonomy. 144 "taxonomyTimestamps": { # Timestamps associated with this resource in a particular system. # Output only. Creation and modification timestamps of this taxonomy. 145 "createTime": "A String", # Creation timestamp of the resource within the given system. 146 "expireTime": "A String", # Output only. Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources. 147 "updateTime": "A String", # Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes. 148 }, 149} 150 151 x__xgafv: string, V1 error format. 152 Allowed values 153 1 - v1 error format 154 2 - v2 error format 155 156Returns: 157 An object of the form: 158 159 { # A taxonomy is a collection of hierarchical policy tags that classify data along a common axis. For example, a "data sensitivity" taxonomy might contain the following policy tags: ``` + PII + Account number + Age + SSN + Zipcode + Financials + Revenue ``` A "data origin" taxonomy might contain the following policy tags: ``` + User data + Employee data + Partner data + Public data ``` 160 "activatedPolicyTypes": [ # Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list. 161 "A String", 162 ], 163 "description": "A String", # Optional. Description of this taxonomy. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns, and page breaks, and be at most 2000 bytes long when encoded in UTF-8. 164 "displayName": "A String", # Required. User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and spaces, and be at most 200 bytes long when encoded in UTF-8. 165 "name": "A String", # Output only. Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs. 166 "policyTagCount": 42, # Output only. Number of policy tags in this taxonomy. 167 "taxonomyTimestamps": { # Timestamps associated with this resource in a particular system. # Output only. Creation and modification timestamps of this taxonomy. 168 "createTime": "A String", # Creation timestamp of the resource within the given system. 169 "expireTime": "A String", # Output only. Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources. 170 "updateTime": "A String", # Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes. 171 }, 172}</pre> 173</div> 174 175<div class="method"> 176 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 177 <pre>Deletes a taxonomy, including all policy tags in this taxonomy, their associated policies, and the policy tags references from BigQuery columns. 178 179Args: 180 name: string, Required. Resource name of the taxonomy to delete. Note: All policy tags in this taxonomy are also deleted. (required) 181 x__xgafv: string, V1 error format. 182 Allowed values 183 1 - v1 error format 184 2 - v2 error format 185 186Returns: 187 An object of the form: 188 189 { # 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); } The JSON representation for `Empty` is empty JSON object `{}`. 190}</pre> 191</div> 192 193<div class="method"> 194 <code class="details" id="export">export(parent, serializedTaxonomies=None, taxonomies=None, x__xgafv=None)</code> 195 <pre>Exports taxonomies in the requested type and returns them, including their policy tags. The requested taxonomies must belong to the same project. This method generates `SerializedTaxonomy` protocol buffers with nested policy tags that can be used as input for `ImportTaxonomies` calls. 196 197Args: 198 parent: string, Required. Resource name of the project that the exported taxonomies belong to. (required) 199 serializedTaxonomies: boolean, Serialized export taxonomies that contain all the policy tags as nested protocol buffers. 200 taxonomies: string, Required. Resource names of the taxonomies to export. (repeated) 201 x__xgafv: string, V1 error format. 202 Allowed values 203 1 - v1 error format 204 2 - v2 error format 205 206Returns: 207 An object of the form: 208 209 { # Response message for ExportTaxonomies. 210 "taxonomies": [ # List of taxonomies and policy tags as nested protocol buffers. 211 { # A nested protocol buffer that represents a taxonomy and the hierarchy of its policy tags. Used for taxonomy replacement, import, and export. 212 "activatedPolicyTypes": [ # A list of policy types that are activated per taxonomy. 213 "A String", 214 ], 215 "description": "A String", # Description of the serialized taxonomy. At most 2000 bytes when encoded in UTF-8. If not set, defaults to an empty description. 216 "displayName": "A String", # Required. Display name of the taxonomy. At most 200 bytes when encoded in UTF-8. 217 "policyTags": [ # Top level policy tags associated with the taxonomy, if any. 218 { # A nested protocol buffer that represents a policy tag and all its descendants. 219 "childPolicyTags": [ # Children of the policy tag, if any. 220 # Object with schema name: GoogleCloudDatacatalogV1SerializedPolicyTag 221 ], 222 "description": "A String", # Description of the serialized policy tag. At most 2000 bytes when encoded in UTF-8. If not set, defaults to an empty description. 223 "displayName": "A String", # Required. Display name of the policy tag. At most 200 bytes when encoded in UTF-8. 224 "policyTag": "A String", # Resource name of the policy tag. This field is ignored when calling `ImportTaxonomies`. 225 }, 226 ], 227 }, 228 ], 229}</pre> 230</div> 231 232<div class="method"> 233 <code class="details" id="get">get(name, x__xgafv=None)</code> 234 <pre>Gets a taxonomy. 235 236Args: 237 name: string, Required. Resource name of the taxonomy to get. (required) 238 x__xgafv: string, V1 error format. 239 Allowed values 240 1 - v1 error format 241 2 - v2 error format 242 243Returns: 244 An object of the form: 245 246 { # A taxonomy is a collection of hierarchical policy tags that classify data along a common axis. For example, a "data sensitivity" taxonomy might contain the following policy tags: ``` + PII + Account number + Age + SSN + Zipcode + Financials + Revenue ``` A "data origin" taxonomy might contain the following policy tags: ``` + User data + Employee data + Partner data + Public data ``` 247 "activatedPolicyTypes": [ # Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list. 248 "A String", 249 ], 250 "description": "A String", # Optional. Description of this taxonomy. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns, and page breaks, and be at most 2000 bytes long when encoded in UTF-8. 251 "displayName": "A String", # Required. User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and spaces, and be at most 200 bytes long when encoded in UTF-8. 252 "name": "A String", # Output only. Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs. 253 "policyTagCount": 42, # Output only. Number of policy tags in this taxonomy. 254 "taxonomyTimestamps": { # Timestamps associated with this resource in a particular system. # Output only. Creation and modification timestamps of this taxonomy. 255 "createTime": "A String", # Creation timestamp of the resource within the given system. 256 "expireTime": "A String", # Output only. Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources. 257 "updateTime": "A String", # Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes. 258 }, 259}</pre> 260</div> 261 262<div class="method"> 263 <code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code> 264 <pre>Gets the IAM policy for a policy tag or a taxonomy. 265 266Args: 267 resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) 268 body: object, The request body. 269 The object takes the form of: 270 271{ # Request message for `GetIamPolicy` method. 272 "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. 273 "requestedPolicyVersion": 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). 274 }, 275} 276 277 x__xgafv: string, V1 error format. 278 Allowed values 279 1 - v1 error format 280 2 - v2 error format 281 282Returns: 283 An object of the form: 284 285 { # 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:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 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 < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). 286 "bindings": [ # 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`. 287 { # Associates `members`, or principals, with a `role`. 288 "condition": { # 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: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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). 289 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 290 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 291 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 292 "title": "A String", # 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. 293 }, 294 "members": [ # Specifies the principals requesting access for a Cloud Platform 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. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 295 "A String", 296 ], 297 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 298 }, 299 ], 300 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **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. 301 "version": 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). 302}</pre> 303</div> 304 305<div class="method"> 306 <code class="details" id="import_">import_(parent, body=None, x__xgafv=None)</code> 307 <pre>Creates new taxonomies (including their policy tags) in a given project by importing from inlined or cross-regional sources. For a cross-regional source, new taxonomies are created by copying from a source in another region. For an inlined source, taxonomies and policy tags are created in bulk using nested protocol buffer structures. 308 309Args: 310 parent: string, Required. Resource name of project that the imported taxonomies will belong to. (required) 311 body: object, The request body. 312 The object takes the form of: 313 314{ # Request message for ImportTaxonomies. 315 "crossRegionalSource": { # Cross-regional source used to import an existing taxonomy into a different region. # Cross-regional source taxonomy to import. 316 "taxonomy": "A String", # Required. The resource name of the source taxonomy to import. 317 }, 318 "inlineSource": { # Inline source containing taxonomies to import. # Inline source taxonomy to import. 319 "taxonomies": [ # Required. Taxonomies to import. 320 { # A nested protocol buffer that represents a taxonomy and the hierarchy of its policy tags. Used for taxonomy replacement, import, and export. 321 "activatedPolicyTypes": [ # A list of policy types that are activated per taxonomy. 322 "A String", 323 ], 324 "description": "A String", # Description of the serialized taxonomy. At most 2000 bytes when encoded in UTF-8. If not set, defaults to an empty description. 325 "displayName": "A String", # Required. Display name of the taxonomy. At most 200 bytes when encoded in UTF-8. 326 "policyTags": [ # Top level policy tags associated with the taxonomy, if any. 327 { # A nested protocol buffer that represents a policy tag and all its descendants. 328 "childPolicyTags": [ # Children of the policy tag, if any. 329 # Object with schema name: GoogleCloudDatacatalogV1SerializedPolicyTag 330 ], 331 "description": "A String", # Description of the serialized policy tag. At most 2000 bytes when encoded in UTF-8. If not set, defaults to an empty description. 332 "displayName": "A String", # Required. Display name of the policy tag. At most 200 bytes when encoded in UTF-8. 333 "policyTag": "A String", # Resource name of the policy tag. This field is ignored when calling `ImportTaxonomies`. 334 }, 335 ], 336 }, 337 ], 338 }, 339} 340 341 x__xgafv: string, V1 error format. 342 Allowed values 343 1 - v1 error format 344 2 - v2 error format 345 346Returns: 347 An object of the form: 348 349 { # Response message for ImportTaxonomies. 350 "taxonomies": [ # Imported taxonomies. 351 { # A taxonomy is a collection of hierarchical policy tags that classify data along a common axis. For example, a "data sensitivity" taxonomy might contain the following policy tags: ``` + PII + Account number + Age + SSN + Zipcode + Financials + Revenue ``` A "data origin" taxonomy might contain the following policy tags: ``` + User data + Employee data + Partner data + Public data ``` 352 "activatedPolicyTypes": [ # Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list. 353 "A String", 354 ], 355 "description": "A String", # Optional. Description of this taxonomy. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns, and page breaks, and be at most 2000 bytes long when encoded in UTF-8. 356 "displayName": "A String", # Required. User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and spaces, and be at most 200 bytes long when encoded in UTF-8. 357 "name": "A String", # Output only. Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs. 358 "policyTagCount": 42, # Output only. Number of policy tags in this taxonomy. 359 "taxonomyTimestamps": { # Timestamps associated with this resource in a particular system. # Output only. Creation and modification timestamps of this taxonomy. 360 "createTime": "A String", # Creation timestamp of the resource within the given system. 361 "expireTime": "A String", # Output only. Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources. 362 "updateTime": "A String", # Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes. 363 }, 364 }, 365 ], 366}</pre> 367</div> 368 369<div class="method"> 370 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 371 <pre>Lists all taxonomies in a project in a particular location that you have a permission to view. 372 373Args: 374 parent: string, Required. Resource name of the project to list the taxonomies of. (required) 375 pageSize: integer, The maximum number of items to return. Must be a value between 1 and 1000 inclusively. If not set, defaults to 50. 376 pageToken: string, The pagination token of the next results page. If not set, the first page is returned. The token is returned in the response to a previous list request. 377 x__xgafv: string, V1 error format. 378 Allowed values 379 1 - v1 error format 380 2 - v2 error format 381 382Returns: 383 An object of the form: 384 385 { # Response message for ListTaxonomies. 386 "nextPageToken": "A String", # Pagination token of the next results page. Empty if there are no more results in the list. 387 "taxonomies": [ # Taxonomies that the project contains. 388 { # A taxonomy is a collection of hierarchical policy tags that classify data along a common axis. For example, a "data sensitivity" taxonomy might contain the following policy tags: ``` + PII + Account number + Age + SSN + Zipcode + Financials + Revenue ``` A "data origin" taxonomy might contain the following policy tags: ``` + User data + Employee data + Partner data + Public data ``` 389 "activatedPolicyTypes": [ # Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list. 390 "A String", 391 ], 392 "description": "A String", # Optional. Description of this taxonomy. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns, and page breaks, and be at most 2000 bytes long when encoded in UTF-8. 393 "displayName": "A String", # Required. User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and spaces, and be at most 200 bytes long when encoded in UTF-8. 394 "name": "A String", # Output only. Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs. 395 "policyTagCount": 42, # Output only. Number of policy tags in this taxonomy. 396 "taxonomyTimestamps": { # Timestamps associated with this resource in a particular system. # Output only. Creation and modification timestamps of this taxonomy. 397 "createTime": "A String", # Creation timestamp of the resource within the given system. 398 "expireTime": "A String", # Output only. Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources. 399 "updateTime": "A String", # Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes. 400 }, 401 }, 402 ], 403}</pre> 404</div> 405 406<div class="method"> 407 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 408 <pre>Retrieves the next page of results. 409 410Args: 411 previous_request: The request for the previous page. (required) 412 previous_response: The response from the request for the previous page. (required) 413 414Returns: 415 A request object that you can call 'execute()' on to request the next 416 page. Returns None if there are no more items in the collection. 417 </pre> 418</div> 419 420<div class="method"> 421 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 422 <pre>Updates a taxonomy, including its display name, description, and activated policy types. 423 424Args: 425 name: string, Output only. Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs. (required) 426 body: object, The request body. 427 The object takes the form of: 428 429{ # A taxonomy is a collection of hierarchical policy tags that classify data along a common axis. For example, a "data sensitivity" taxonomy might contain the following policy tags: ``` + PII + Account number + Age + SSN + Zipcode + Financials + Revenue ``` A "data origin" taxonomy might contain the following policy tags: ``` + User data + Employee data + Partner data + Public data ``` 430 "activatedPolicyTypes": [ # Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list. 431 "A String", 432 ], 433 "description": "A String", # Optional. Description of this taxonomy. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns, and page breaks, and be at most 2000 bytes long when encoded in UTF-8. 434 "displayName": "A String", # Required. User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and spaces, and be at most 200 bytes long when encoded in UTF-8. 435 "name": "A String", # Output only. Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs. 436 "policyTagCount": 42, # Output only. Number of policy tags in this taxonomy. 437 "taxonomyTimestamps": { # Timestamps associated with this resource in a particular system. # Output only. Creation and modification timestamps of this taxonomy. 438 "createTime": "A String", # Creation timestamp of the resource within the given system. 439 "expireTime": "A String", # Output only. Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources. 440 "updateTime": "A String", # Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes. 441 }, 442} 443 444 updateMask: string, Specifies fields to update. If not set, defaults to all fields you can update. For more information, see [FieldMask] (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask). 445 x__xgafv: string, V1 error format. 446 Allowed values 447 1 - v1 error format 448 2 - v2 error format 449 450Returns: 451 An object of the form: 452 453 { # A taxonomy is a collection of hierarchical policy tags that classify data along a common axis. For example, a "data sensitivity" taxonomy might contain the following policy tags: ``` + PII + Account number + Age + SSN + Zipcode + Financials + Revenue ``` A "data origin" taxonomy might contain the following policy tags: ``` + User data + Employee data + Partner data + Public data ``` 454 "activatedPolicyTypes": [ # Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list. 455 "A String", 456 ], 457 "description": "A String", # Optional. Description of this taxonomy. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns, and page breaks, and be at most 2000 bytes long when encoded in UTF-8. 458 "displayName": "A String", # Required. User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and spaces, and be at most 200 bytes long when encoded in UTF-8. 459 "name": "A String", # Output only. Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs. 460 "policyTagCount": 42, # Output only. Number of policy tags in this taxonomy. 461 "taxonomyTimestamps": { # Timestamps associated with this resource in a particular system. # Output only. Creation and modification timestamps of this taxonomy. 462 "createTime": "A String", # Creation timestamp of the resource within the given system. 463 "expireTime": "A String", # Output only. Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources. 464 "updateTime": "A String", # Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes. 465 }, 466}</pre> 467</div> 468 469<div class="method"> 470 <code class="details" id="replace">replace(name, body=None, x__xgafv=None)</code> 471 <pre>Replaces (updates) a taxonomy and all its policy tags. The taxonomy and its entire hierarchy of policy tags must be represented literally by `SerializedTaxonomy` and the nested `SerializedPolicyTag` messages. This operation automatically does the following: - Deletes the existing policy tags that are missing from the `SerializedPolicyTag`. - Creates policy tags that don't have resource names. They are considered new. - Updates policy tags with valid resources names accordingly. 472 473Args: 474 name: string, Required. Resource name of the taxonomy to update. (required) 475 body: object, The request body. 476 The object takes the form of: 477 478{ # Request message for ReplaceTaxonomy. 479 "serializedTaxonomy": { # A nested protocol buffer that represents a taxonomy and the hierarchy of its policy tags. Used for taxonomy replacement, import, and export. # Required. Taxonomy to update along with its child policy tags. 480 "activatedPolicyTypes": [ # A list of policy types that are activated per taxonomy. 481 "A String", 482 ], 483 "description": "A String", # Description of the serialized taxonomy. At most 2000 bytes when encoded in UTF-8. If not set, defaults to an empty description. 484 "displayName": "A String", # Required. Display name of the taxonomy. At most 200 bytes when encoded in UTF-8. 485 "policyTags": [ # Top level policy tags associated with the taxonomy, if any. 486 { # A nested protocol buffer that represents a policy tag and all its descendants. 487 "childPolicyTags": [ # Children of the policy tag, if any. 488 # Object with schema name: GoogleCloudDatacatalogV1SerializedPolicyTag 489 ], 490 "description": "A String", # Description of the serialized policy tag. At most 2000 bytes when encoded in UTF-8. If not set, defaults to an empty description. 491 "displayName": "A String", # Required. Display name of the policy tag. At most 200 bytes when encoded in UTF-8. 492 "policyTag": "A String", # Resource name of the policy tag. This field is ignored when calling `ImportTaxonomies`. 493 }, 494 ], 495 }, 496} 497 498 x__xgafv: string, V1 error format. 499 Allowed values 500 1 - v1 error format 501 2 - v2 error format 502 503Returns: 504 An object of the form: 505 506 { # A taxonomy is a collection of hierarchical policy tags that classify data along a common axis. For example, a "data sensitivity" taxonomy might contain the following policy tags: ``` + PII + Account number + Age + SSN + Zipcode + Financials + Revenue ``` A "data origin" taxonomy might contain the following policy tags: ``` + User data + Employee data + Partner data + Public data ``` 507 "activatedPolicyTypes": [ # Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list. 508 "A String", 509 ], 510 "description": "A String", # Optional. Description of this taxonomy. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns, and page breaks, and be at most 2000 bytes long when encoded in UTF-8. 511 "displayName": "A String", # Required. User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and spaces, and be at most 200 bytes long when encoded in UTF-8. 512 "name": "A String", # Output only. Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs. 513 "policyTagCount": 42, # Output only. Number of policy tags in this taxonomy. 514 "taxonomyTimestamps": { # Timestamps associated with this resource in a particular system. # Output only. Creation and modification timestamps of this taxonomy. 515 "createTime": "A String", # Creation timestamp of the resource within the given system. 516 "expireTime": "A String", # Output only. Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources. 517 "updateTime": "A String", # Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes. 518 }, 519}</pre> 520</div> 521 522<div class="method"> 523 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code> 524 <pre>Sets the IAM policy for a policy tag or a taxonomy. 525 526Args: 527 resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required) 528 body: object, The request body. 529 The object takes the form of: 530 531{ # Request message for `SetIamPolicy` method. 532 "policy": { # 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:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 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 < timestamp('2020-10-01T00:00:00.000Z') 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 Cloud Platform services (such as Projects) might reject them. 533 "bindings": [ # 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`. 534 { # Associates `members`, or principals, with a `role`. 535 "condition": { # 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: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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). 536 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 537 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 538 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 539 "title": "A String", # 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. 540 }, 541 "members": [ # Specifies the principals requesting access for a Cloud Platform 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. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 542 "A String", 543 ], 544 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 545 }, 546 ], 547 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **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. 548 "version": 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). 549 }, 550} 551 552 x__xgafv: string, V1 error format. 553 Allowed values 554 1 - v1 error format 555 2 - v2 error format 556 557Returns: 558 An object of the form: 559 560 { # 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:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 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 < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). 561 "bindings": [ # 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`. 562 { # Associates `members`, or principals, with a `role`. 563 "condition": { # 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: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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). 564 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 565 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 566 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 567 "title": "A String", # 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. 568 }, 569 "members": [ # Specifies the principals requesting access for a Cloud Platform 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. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 570 "A String", 571 ], 572 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 573 }, 574 ], 575 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **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. 576 "version": 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). 577}</pre> 578</div> 579 580<div class="method"> 581 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code> 582 <pre>Returns your permissions on a specified policy tag or taxonomy. 583 584Args: 585 resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required) 586 body: object, The request body. 587 The object takes the form of: 588 589{ # Request message for `TestIamPermissions` method. 590 "permissions": [ # 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). 591 "A String", 592 ], 593} 594 595 x__xgafv: string, V1 error format. 596 Allowed values 597 1 - v1 error format 598 2 - v2 error format 599 600Returns: 601 An object of the form: 602 603 { # Response message for `TestIamPermissions` method. 604 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 605 "A String", 606 ], 607}</pre> 608</div> 609 610</body></html>