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_v1beta1.html">Google Cloud Data Catalog API</a> . <a href="datacatalog_v1beta1.projects.html">projects</a> . <a href="datacatalog_v1beta1.projects.locations.html">locations</a> . <a href="datacatalog_v1beta1.projects.locations.taxonomies.html">taxonomies</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="datacatalog_v1beta1.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 the specified project.</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. This operation will also delete all policy tags in this taxonomy along with their associated policies.</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 all taxonomies and their policy tags in a project. This method generates SerializedTaxonomy protos with nested policy tags that can be used as an input for future 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 taxonomy or a policy tag.</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">Imports all taxonomies and their policy tags to a project as new taxonomies. This method provides a bulk taxonomy / policy tag creation using nested proto structure.</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 the caller has 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.</p> 112<p class="toc_element"> 113 <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p> 114<p class="firstline">Sets the IAM policy for a taxonomy or a policy tag.</p> 115<p class="toc_element"> 116 <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p> 117<p class="firstline">Returns the permissions that a caller has on the specified taxonomy or policy tag.</p> 118<h3>Method Details</h3> 119<div class="method"> 120 <code class="details" id="close">close()</code> 121 <pre>Close httplib2 connections.</pre> 122</div> 123 124<div class="method"> 125 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 126 <pre>Creates a taxonomy in the specified project. 127 128Args: 129 parent: string, Required. Resource name of the project that the taxonomy will belong to. (required) 130 body: object, The request body. 131 The object takes the form of: 132 133{ # A taxonomy is a collection of policy tags that classify data along a common axis. For instance a data *sensitivity* taxonomy could contain policy tags denoting PII such as age, zipcode, and SSN. A data *origin* taxonomy could contain policy tags to distinguish user data, employee data, partner data, public data. 134 "activatedPolicyTypes": [ # Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list. 135 "A String", 136 ], 137 "description": "A String", # Optional. Description of this taxonomy. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description. 138 "displayName": "A String", # Required. User defined name of this taxonomy. It must: contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8. 139 "name": "A String", # Output only. Resource name of this taxonomy, whose format is: "projects/{project_number}/locations/{location_id}/taxonomies/{id}". 140 "policyTagCount": 42, # Output only. Number of policy tags contained in this taxonomy. 141 "taxonomyTimestamps": { # Timestamps about this resource according to a particular system. # Output only. Timestamps about this taxonomy. Only create_time and update_time are used. 142 "createTime": "A String", # The creation time of the resource within the given system. 143 "expireTime": "A String", # Output only. The expiration time of the resource within the given system. Currently only apllicable to BigQuery resources. 144 "updateTime": "A String", # The last-modified time of the resource within the given system. 145 }, 146} 147 148 x__xgafv: string, V1 error format. 149 Allowed values 150 1 - v1 error format 151 2 - v2 error format 152 153Returns: 154 An object of the form: 155 156 { # A taxonomy is a collection of policy tags that classify data along a common axis. For instance a data *sensitivity* taxonomy could contain policy tags denoting PII such as age, zipcode, and SSN. A data *origin* taxonomy could contain policy tags to distinguish user data, employee data, partner data, public data. 157 "activatedPolicyTypes": [ # Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list. 158 "A String", 159 ], 160 "description": "A String", # Optional. Description of this taxonomy. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description. 161 "displayName": "A String", # Required. User defined name of this taxonomy. It must: contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8. 162 "name": "A String", # Output only. Resource name of this taxonomy, whose format is: "projects/{project_number}/locations/{location_id}/taxonomies/{id}". 163 "policyTagCount": 42, # Output only. Number of policy tags contained in this taxonomy. 164 "taxonomyTimestamps": { # Timestamps about this resource according to a particular system. # Output only. Timestamps about this taxonomy. Only create_time and update_time are used. 165 "createTime": "A String", # The creation time of the resource within the given system. 166 "expireTime": "A String", # Output only. The expiration time of the resource within the given system. Currently only apllicable to BigQuery resources. 167 "updateTime": "A String", # The last-modified time of the resource within the given system. 168 }, 169}</pre> 170</div> 171 172<div class="method"> 173 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 174 <pre>Deletes a taxonomy. This operation will also delete all policy tags in this taxonomy along with their associated policies. 175 176Args: 177 name: string, Required. Resource name of the taxonomy to be deleted. All policy tags in this taxonomy will also be deleted. (required) 178 x__xgafv: string, V1 error format. 179 Allowed values 180 1 - v1 error format 181 2 - v2 error format 182 183Returns: 184 An object of the form: 185 186 { # 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 `{}`. 187}</pre> 188</div> 189 190<div class="method"> 191 <code class="details" id="export">export(parent, serializedTaxonomies=None, taxonomies=None, x__xgafv=None)</code> 192 <pre>Exports all taxonomies and their policy tags in a project. This method generates SerializedTaxonomy protos with nested policy tags that can be used as an input for future ImportTaxonomies calls. 193 194Args: 195 parent: string, Required. Resource name of the project that taxonomies to be exported will share. (required) 196 serializedTaxonomies: boolean, Export taxonomies as serialized taxonomies. 197 taxonomies: string, Required. Resource names of the taxonomies to be exported. (repeated) 198 x__xgafv: string, V1 error format. 199 Allowed values 200 1 - v1 error format 201 2 - v2 error format 202 203Returns: 204 An object of the form: 205 206 { # Response message for ExportTaxonomies. 207 "taxonomies": [ # List of taxonomies and policy tags in a tree structure. 208 { # Message capturing a taxonomy and its policy tag hierarchy as a nested proto. Used for taxonomy import/export and mutation. 209 "activatedPolicyTypes": [ # A list of policy types that are activated for a taxonomy. 210 "A String", 211 ], 212 "description": "A String", # Description of the serialized taxonomy. The length of the description is limited to 2000 bytes when encoded in UTF-8. If not set, defaults to an empty description. 213 "displayName": "A String", # Required. Display name of the taxonomy. Max 200 bytes when encoded in UTF-8. 214 "policyTags": [ # Top level policy tags associated with the taxonomy if any. 215 { # Message representing one policy tag when exported as a nested proto. 216 "childPolicyTags": [ # Children of the policy tag if any. 217 # Object with schema name: GoogleCloudDatacatalogV1beta1SerializedPolicyTag 218 ], 219 "description": "A String", # Description of the serialized policy tag. The length of the description is limited to 2000 bytes when encoded in UTF-8. If not set, defaults to an empty description. 220 "displayName": "A String", # Required. Display name of the policy tag. Max 200 bytes when encoded in UTF-8. 221 "policyTag": "A String", # Resource name of the policy tag. This field will be ignored when calling ImportTaxonomies. 222 }, 223 ], 224 }, 225 ], 226}</pre> 227</div> 228 229<div class="method"> 230 <code class="details" id="get">get(name, x__xgafv=None)</code> 231 <pre>Gets a taxonomy. 232 233Args: 234 name: string, Required. Resource name of the requested taxonomy. (required) 235 x__xgafv: string, V1 error format. 236 Allowed values 237 1 - v1 error format 238 2 - v2 error format 239 240Returns: 241 An object of the form: 242 243 { # A taxonomy is a collection of policy tags that classify data along a common axis. For instance a data *sensitivity* taxonomy could contain policy tags denoting PII such as age, zipcode, and SSN. A data *origin* taxonomy could contain policy tags to distinguish user data, employee data, partner data, public data. 244 "activatedPolicyTypes": [ # Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list. 245 "A String", 246 ], 247 "description": "A String", # Optional. Description of this taxonomy. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description. 248 "displayName": "A String", # Required. User defined name of this taxonomy. It must: contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8. 249 "name": "A String", # Output only. Resource name of this taxonomy, whose format is: "projects/{project_number}/locations/{location_id}/taxonomies/{id}". 250 "policyTagCount": 42, # Output only. Number of policy tags contained in this taxonomy. 251 "taxonomyTimestamps": { # Timestamps about this resource according to a particular system. # Output only. Timestamps about this taxonomy. Only create_time and update_time are used. 252 "createTime": "A String", # The creation time of the resource within the given system. 253 "expireTime": "A String", # Output only. The expiration time of the resource within the given system. Currently only apllicable to BigQuery resources. 254 "updateTime": "A String", # The last-modified time of the resource within the given system. 255 }, 256}</pre> 257</div> 258 259<div class="method"> 260 <code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code> 261 <pre>Gets the IAM policy for a taxonomy or a policy tag. 262 263Args: 264 resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) 265 body: object, The request body. 266 The object takes the form of: 267 268{ # Request message for `GetIamPolicy` method. 269 "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. 270 "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). 271 }, 272} 273 274 x__xgafv: string, V1 error format. 275 Allowed values 276 1 - v1 error format 277 2 - v2 error format 278 279Returns: 280 An object of the form: 281 282 { # 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/). 283 "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`. 284 { # Associates `members`, or principals, with a `role`. 285 "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). 286 "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. 287 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 288 "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. 289 "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. 290 }, 291 "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`. 292 "A String", 293 ], 294 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 295 }, 296 ], 297 "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. 298 "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). 299}</pre> 300</div> 301 302<div class="method"> 303 <code class="details" id="import_">import_(parent, body=None, x__xgafv=None)</code> 304 <pre>Imports all taxonomies and their policy tags to a project as new taxonomies. This method provides a bulk taxonomy / policy tag creation using nested proto structure. 305 306Args: 307 parent: string, Required. Resource name of project that the imported taxonomies will belong to. (required) 308 body: object, The request body. 309 The object takes the form of: 310 311{ # Request message for ImportTaxonomies. 312 "inlineSource": { # Inline source used for taxonomies import. # Inline source used for taxonomies to be imported. 313 "taxonomies": [ # Required. Taxonomies to be imported. 314 { # Message capturing a taxonomy and its policy tag hierarchy as a nested proto. Used for taxonomy import/export and mutation. 315 "activatedPolicyTypes": [ # A list of policy types that are activated for a taxonomy. 316 "A String", 317 ], 318 "description": "A String", # Description of the serialized taxonomy. The length of the description is limited to 2000 bytes when encoded in UTF-8. If not set, defaults to an empty description. 319 "displayName": "A String", # Required. Display name of the taxonomy. Max 200 bytes when encoded in UTF-8. 320 "policyTags": [ # Top level policy tags associated with the taxonomy if any. 321 { # Message representing one policy tag when exported as a nested proto. 322 "childPolicyTags": [ # Children of the policy tag if any. 323 # Object with schema name: GoogleCloudDatacatalogV1beta1SerializedPolicyTag 324 ], 325 "description": "A String", # Description of the serialized policy tag. The length of the description is limited to 2000 bytes when encoded in UTF-8. If not set, defaults to an empty description. 326 "displayName": "A String", # Required. Display name of the policy tag. Max 200 bytes when encoded in UTF-8. 327 "policyTag": "A String", # Resource name of the policy tag. This field will be ignored when calling ImportTaxonomies. 328 }, 329 ], 330 }, 331 ], 332 }, 333} 334 335 x__xgafv: string, V1 error format. 336 Allowed values 337 1 - v1 error format 338 2 - v2 error format 339 340Returns: 341 An object of the form: 342 343 { # Response message for ImportTaxonomies. 344 "taxonomies": [ # Taxonomies that were imported. 345 { # A taxonomy is a collection of policy tags that classify data along a common axis. For instance a data *sensitivity* taxonomy could contain policy tags denoting PII such as age, zipcode, and SSN. A data *origin* taxonomy could contain policy tags to distinguish user data, employee data, partner data, public data. 346 "activatedPolicyTypes": [ # Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list. 347 "A String", 348 ], 349 "description": "A String", # Optional. Description of this taxonomy. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description. 350 "displayName": "A String", # Required. User defined name of this taxonomy. It must: contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8. 351 "name": "A String", # Output only. Resource name of this taxonomy, whose format is: "projects/{project_number}/locations/{location_id}/taxonomies/{id}". 352 "policyTagCount": 42, # Output only. Number of policy tags contained in this taxonomy. 353 "taxonomyTimestamps": { # Timestamps about this resource according to a particular system. # Output only. Timestamps about this taxonomy. Only create_time and update_time are used. 354 "createTime": "A String", # The creation time of the resource within the given system. 355 "expireTime": "A String", # Output only. The expiration time of the resource within the given system. Currently only apllicable to BigQuery resources. 356 "updateTime": "A String", # The last-modified time of the resource within the given system. 357 }, 358 }, 359 ], 360}</pre> 361</div> 362 363<div class="method"> 364 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 365 <pre>Lists all taxonomies in a project in a particular location that the caller has permission to view. 366 367Args: 368 parent: string, Required. Resource name of the project to list the taxonomies of. (required) 369 pageSize: integer, The maximum number of items to return. Must be a value between 1 and 1000. If not set, defaults to 50. 370 pageToken: string, The next_page_token value returned from a previous list request, if any. If not set, defaults to an empty string. 371 x__xgafv: string, V1 error format. 372 Allowed values 373 1 - v1 error format 374 2 - v2 error format 375 376Returns: 377 An object of the form: 378 379 { # Response message for ListTaxonomies. 380 "nextPageToken": "A String", # Token used to retrieve the next page of results, or empty if there are no more results in the list. 381 "taxonomies": [ # Taxonomies that the project contains. 382 { # A taxonomy is a collection of policy tags that classify data along a common axis. For instance a data *sensitivity* taxonomy could contain policy tags denoting PII such as age, zipcode, and SSN. A data *origin* taxonomy could contain policy tags to distinguish user data, employee data, partner data, public data. 383 "activatedPolicyTypes": [ # Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list. 384 "A String", 385 ], 386 "description": "A String", # Optional. Description of this taxonomy. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description. 387 "displayName": "A String", # Required. User defined name of this taxonomy. It must: contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8. 388 "name": "A String", # Output only. Resource name of this taxonomy, whose format is: "projects/{project_number}/locations/{location_id}/taxonomies/{id}". 389 "policyTagCount": 42, # Output only. Number of policy tags contained in this taxonomy. 390 "taxonomyTimestamps": { # Timestamps about this resource according to a particular system. # Output only. Timestamps about this taxonomy. Only create_time and update_time are used. 391 "createTime": "A String", # The creation time of the resource within the given system. 392 "expireTime": "A String", # Output only. The expiration time of the resource within the given system. Currently only apllicable to BigQuery resources. 393 "updateTime": "A String", # The last-modified time of the resource within the given system. 394 }, 395 }, 396 ], 397}</pre> 398</div> 399 400<div class="method"> 401 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 402 <pre>Retrieves the next page of results. 403 404Args: 405 previous_request: The request for the previous page. (required) 406 previous_response: The response from the request for the previous page. (required) 407 408Returns: 409 A request object that you can call 'execute()' on to request the next 410 page. Returns None if there are no more items in the collection. 411 </pre> 412</div> 413 414<div class="method"> 415 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 416 <pre>Updates a taxonomy. 417 418Args: 419 name: string, Output only. Resource name of this taxonomy, whose format is: "projects/{project_number}/locations/{location_id}/taxonomies/{id}". (required) 420 body: object, The request body. 421 The object takes the form of: 422 423{ # A taxonomy is a collection of policy tags that classify data along a common axis. For instance a data *sensitivity* taxonomy could contain policy tags denoting PII such as age, zipcode, and SSN. A data *origin* taxonomy could contain policy tags to distinguish user data, employee data, partner data, public data. 424 "activatedPolicyTypes": [ # Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list. 425 "A String", 426 ], 427 "description": "A String", # Optional. Description of this taxonomy. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description. 428 "displayName": "A String", # Required. User defined name of this taxonomy. It must: contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8. 429 "name": "A String", # Output only. Resource name of this taxonomy, whose format is: "projects/{project_number}/locations/{location_id}/taxonomies/{id}". 430 "policyTagCount": 42, # Output only. Number of policy tags contained in this taxonomy. 431 "taxonomyTimestamps": { # Timestamps about this resource according to a particular system. # Output only. Timestamps about this taxonomy. Only create_time and update_time are used. 432 "createTime": "A String", # The creation time of the resource within the given system. 433 "expireTime": "A String", # Output only. The expiration time of the resource within the given system. Currently only apllicable to BigQuery resources. 434 "updateTime": "A String", # The last-modified time of the resource within the given system. 435 }, 436} 437 438 updateMask: string, The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If not set, defaults to all of the fields that are allowed to update. 439 x__xgafv: string, V1 error format. 440 Allowed values 441 1 - v1 error format 442 2 - v2 error format 443 444Returns: 445 An object of the form: 446 447 { # A taxonomy is a collection of policy tags that classify data along a common axis. For instance a data *sensitivity* taxonomy could contain policy tags denoting PII such as age, zipcode, and SSN. A data *origin* taxonomy could contain policy tags to distinguish user data, employee data, partner data, public data. 448 "activatedPolicyTypes": [ # Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list. 449 "A String", 450 ], 451 "description": "A String", # Optional. Description of this taxonomy. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description. 452 "displayName": "A String", # Required. User defined name of this taxonomy. It must: contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8. 453 "name": "A String", # Output only. Resource name of this taxonomy, whose format is: "projects/{project_number}/locations/{location_id}/taxonomies/{id}". 454 "policyTagCount": 42, # Output only. Number of policy tags contained in this taxonomy. 455 "taxonomyTimestamps": { # Timestamps about this resource according to a particular system. # Output only. Timestamps about this taxonomy. Only create_time and update_time are used. 456 "createTime": "A String", # The creation time of the resource within the given system. 457 "expireTime": "A String", # Output only. The expiration time of the resource within the given system. Currently only apllicable to BigQuery resources. 458 "updateTime": "A String", # The last-modified time of the resource within the given system. 459 }, 460}</pre> 461</div> 462 463<div class="method"> 464 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code> 465 <pre>Sets the IAM policy for a taxonomy or a policy tag. 466 467Args: 468 resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required) 469 body: object, The request body. 470 The object takes the form of: 471 472{ # Request message for `SetIamPolicy` method. 473 "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. 474 "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`. 475 { # Associates `members`, or principals, with a `role`. 476 "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). 477 "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. 478 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 479 "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. 480 "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. 481 }, 482 "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`. 483 "A String", 484 ], 485 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 486 }, 487 ], 488 "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. 489 "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). 490 }, 491} 492 493 x__xgafv: string, V1 error format. 494 Allowed values 495 1 - v1 error format 496 2 - v2 error format 497 498Returns: 499 An object of the form: 500 501 { # 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/). 502 "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`. 503 { # Associates `members`, or principals, with a `role`. 504 "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). 505 "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. 506 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 507 "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. 508 "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. 509 }, 510 "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`. 511 "A String", 512 ], 513 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 514 }, 515 ], 516 "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. 517 "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). 518}</pre> 519</div> 520 521<div class="method"> 522 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code> 523 <pre>Returns the permissions that a caller has on the specified taxonomy or policy tag. 524 525Args: 526 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) 527 body: object, The request body. 528 The object takes the form of: 529 530{ # Request message for `TestIamPermissions` method. 531 "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). 532 "A String", 533 ], 534} 535 536 x__xgafv: string, V1 error format. 537 Allowed values 538 1 - v1 error format 539 2 - v2 error format 540 541Returns: 542 An object of the form: 543 544 { # Response message for `TestIamPermissions` method. 545 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 546 "A String", 547 ], 548}</pre> 549</div> 550 551</body></html>