Returns the fields Resource.
create(parent, body=None, tagTemplateId=None, x__xgafv=None)
Creates a tag template. The user should enable the Data Catalog API in
delete(name, force=None, x__xgafv=None)
Deletes a tag template and all tags using the template.
Gets a tag template.
getIamPolicy(resource, body=None, x__xgafv=None)
Gets the access control policy for a resource. A `NOT_FOUND` error
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a tag template. This method cannot be used to update the fields of
setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy for a resource. Replaces any existing
testIamPermissions(resource, body=None, x__xgafv=None)
Returns the caller's permissions on a resource.
create(parent, body=None, tagTemplateId=None, x__xgafv=None)
Creates a tag template. The user should enable the Data Catalog API in
the project identified by the `parent` parameter (see [Data Catalog
Resource
Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project)
for more information).
Args:
parent: string, Required. The name of the project and the template location
[region](https://cloud.google.com/data-catalog/docs/concepts/regions.
Example:
* projects/{project_id}/locations/us-central1 (required)
body: object, The request body.
The object takes the form of:
{ # A tag template defines a tag, which can have one or more typed fields.
# The template is used to create and attach the tag to GCP resources.
# [Tag template
# roles](https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles)
# provide permissions to create, edit, and use the template. See, for example,
# the [TagTemplate
# User](https://cloud.google.com/data-catalog/docs/how-to/template-user) role,
# which includes permission to use the tag template to tag resources.
"fields": { # Required. Map of tag template field IDs to the settings for the field.
# This map is an exhaustive list of the allowed fields. This map must contain
# at least one field and at most 500 fields.
#
# The keys to this map are tag template field IDs. Field IDs can contain
# letters (both uppercase and lowercase), numbers (0-9) and underscores (_).
# Field IDs must be at least 1 character long and at most
# 64 characters long. Field IDs must start with a letter or underscore.
"a_key": { # The template for an individual field within a tag template.
"type": { # Required. The type of value this tag field can contain.
"enumType": { # Represents an enum type.
"allowedValues": [ # Required on create; optional on update. The set of allowed values for
# this enum. This set must not be empty, the display names of the values in
# this set must not be empty and the display names of the values must be
# case-insensitively unique within this set. Currently, enum values can
# only be added to the list of allowed values. Deletion and renaming of
# enum values are not supported. Can have up to 500 allowed values.
{
"displayName": "A String", # Required. The display name of the enum value. Must not be an empty string.
},
],
},
"primitiveType": "A String", # Represents primitive types - string, bool etc.
},
"order": 42, # The order of this field with respect to other fields in this tag
# template. A higher value indicates a more important field. The value can
# be negative. Multiple fields can have the same order, and field orders
# within a tag do not have to be sequential.
"isRequired": True or False, # Whether this is a required field. Defaults to false.
"name": "A String", # Output only. The resource name of the tag template field in URL format. Example:
#
# * projects/{project_id}/locations/{location}/tagTemplates/{tag_template}/fields/{field}
#
# Note that this TagTemplateField may not actually be stored in the location
# in this name.
"displayName": "A String", # The display name for this field. Defaults to an empty string.
},
},
"name": "A String", # The resource name of the tag template in URL format. Example:
#
# * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}
#
# Note that this TagTemplate and its child resources may not actually be
# stored in the location in this name.
"displayName": "A String", # The display name for this template. Defaults to an empty string.
}
tagTemplateId: string, Required. The id of the tag template to create.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A tag template defines a tag, which can have one or more typed fields.
# The template is used to create and attach the tag to GCP resources.
# [Tag template
# roles](https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles)
# provide permissions to create, edit, and use the template. See, for example,
# the [TagTemplate
# User](https://cloud.google.com/data-catalog/docs/how-to/template-user) role,
# which includes permission to use the tag template to tag resources.
"fields": { # Required. Map of tag template field IDs to the settings for the field.
# This map is an exhaustive list of the allowed fields. This map must contain
# at least one field and at most 500 fields.
#
# The keys to this map are tag template field IDs. Field IDs can contain
# letters (both uppercase and lowercase), numbers (0-9) and underscores (_).
# Field IDs must be at least 1 character long and at most
# 64 characters long. Field IDs must start with a letter or underscore.
"a_key": { # The template for an individual field within a tag template.
"type": { # Required. The type of value this tag field can contain.
"enumType": { # Represents an enum type.
"allowedValues": [ # Required on create; optional on update. The set of allowed values for
# this enum. This set must not be empty, the display names of the values in
# this set must not be empty and the display names of the values must be
# case-insensitively unique within this set. Currently, enum values can
# only be added to the list of allowed values. Deletion and renaming of
# enum values are not supported. Can have up to 500 allowed values.
{
"displayName": "A String", # Required. The display name of the enum value. Must not be an empty string.
},
],
},
"primitiveType": "A String", # Represents primitive types - string, bool etc.
},
"order": 42, # The order of this field with respect to other fields in this tag
# template. A higher value indicates a more important field. The value can
# be negative. Multiple fields can have the same order, and field orders
# within a tag do not have to be sequential.
"isRequired": True or False, # Whether this is a required field. Defaults to false.
"name": "A String", # Output only. The resource name of the tag template field in URL format. Example:
#
# * projects/{project_id}/locations/{location}/tagTemplates/{tag_template}/fields/{field}
#
# Note that this TagTemplateField may not actually be stored in the location
# in this name.
"displayName": "A String", # The display name for this field. Defaults to an empty string.
},
},
"name": "A String", # The resource name of the tag template in URL format. Example:
#
# * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}
#
# Note that this TagTemplate and its child resources may not actually be
# stored in the location in this name.
"displayName": "A String", # The display name for this template. Defaults to an empty string.
}
delete(name, force=None, x__xgafv=None)
Deletes a tag template and all tags using the template.
Users should enable the Data Catalog API in the project identified by
the `name` parameter (see [Data Catalog Resource Project]
(https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
more information).
Args:
name: string, Required. The name of the tag template to delete. Example:
* projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id} (required)
force: boolean, Required. Currently, this field must always be set to `true`.
This confirms the deletion of any possible tags using this template.
`force = false` will be supported in the future.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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 `{}`.
}
get(name, x__xgafv=None)
Gets a tag template.
Args:
name: string, Required. The name of the tag template. Example:
* projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A tag template defines a tag, which can have one or more typed fields.
# The template is used to create and attach the tag to GCP resources.
# [Tag template
# roles](https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles)
# provide permissions to create, edit, and use the template. See, for example,
# the [TagTemplate
# User](https://cloud.google.com/data-catalog/docs/how-to/template-user) role,
# which includes permission to use the tag template to tag resources.
"fields": { # Required. Map of tag template field IDs to the settings for the field.
# This map is an exhaustive list of the allowed fields. This map must contain
# at least one field and at most 500 fields.
#
# The keys to this map are tag template field IDs. Field IDs can contain
# letters (both uppercase and lowercase), numbers (0-9) and underscores (_).
# Field IDs must be at least 1 character long and at most
# 64 characters long. Field IDs must start with a letter or underscore.
"a_key": { # The template for an individual field within a tag template.
"type": { # Required. The type of value this tag field can contain.
"enumType": { # Represents an enum type.
"allowedValues": [ # Required on create; optional on update. The set of allowed values for
# this enum. This set must not be empty, the display names of the values in
# this set must not be empty and the display names of the values must be
# case-insensitively unique within this set. Currently, enum values can
# only be added to the list of allowed values. Deletion and renaming of
# enum values are not supported. Can have up to 500 allowed values.
{
"displayName": "A String", # Required. The display name of the enum value. Must not be an empty string.
},
],
},
"primitiveType": "A String", # Represents primitive types - string, bool etc.
},
"order": 42, # The order of this field with respect to other fields in this tag
# template. A higher value indicates a more important field. The value can
# be negative. Multiple fields can have the same order, and field orders
# within a tag do not have to be sequential.
"isRequired": True or False, # Whether this is a required field. Defaults to false.
"name": "A String", # Output only. The resource name of the tag template field in URL format. Example:
#
# * projects/{project_id}/locations/{location}/tagTemplates/{tag_template}/fields/{field}
#
# Note that this TagTemplateField may not actually be stored in the location
# in this name.
"displayName": "A String", # The display name for this field. Defaults to an empty string.
},
},
"name": "A String", # The resource name of the tag template in URL format. Example:
#
# * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}
#
# Note that this TagTemplate and its child resources may not actually be
# stored in the location in this name.
"displayName": "A String", # The display name for this template. Defaults to an empty string.
}
getIamPolicy(resource, body=None, x__xgafv=None)
Gets the access control policy for a resource. A `NOT_FOUND` error
is returned if the resource does not exist. An empty policy is returned
if the resource exists but does not have a policy set on it.
Supported resources are:
- Tag templates.
- Entries.
- Entry groups.
Note, this method cannot be used to manage policies for BigQuery, Pub/Sub
and any external Google Cloud Platform resources synced to Data Catalog.
Callers must have following Google IAM permission
- `datacatalog.tagTemplates.getIamPolicy` to get policies on tag
templates.
- `datacatalog.entries.getIamPolicy` to get policies on entries.
- `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
Args:
resource: string, REQUIRED: The resource for which the policy is being requested.
See the operation documentation for the appropriate value for this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `GetIamPolicy` method.
"options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to
# `GetIamPolicy`.
"requestedPolicyVersion": 42, # Optional. The policy format version to be returned.
#
# Valid values are 0, 1, and 3. Requests specifying an invalid value will be
# rejected.
#
# Requests for policies with any conditional bindings must specify version 3.
# Policies without any conditional bindings may specify any valid value 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).
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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` to a single `role`. Members 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:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
# "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
# "role": "roles/resourcemanager.organizationViewer",
# "members": [
# "user:eve@example.com"
# ],
# "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:mike@example.com
# - group:admins@example.com
# - domain:google.com
# - serviceAccount:my-project-id@appspot.gserviceaccount.com
# role: roles/resourcemanager.organizationAdmin
# - members:
# - user:eve@example.com
# 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/).
"bindings": [ # Associates a list of `members` to 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 member.
{ # Associates `members` with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) # 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 members 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).
# 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.
"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.
"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.
"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.
"expression": "A String", # Textual representation of an expression in Common Expression Language
# syntax.
},
"members": [ # Specifies the identities 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, `alice@example.com` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a service
# account. For example, `my-other-app@appspot.gserviceaccount.com`.
#
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `admins@example.com`.
#
# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
# identifier) representing a user that has been recently deleted. For
# example, `alice@example.com?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,
# `my-other-app@appspot.gserviceaccount.com?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, `admins@example.com?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`.
#
"A String",
],
"role": "A String", # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
"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.
"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).
}
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a tag template. This method cannot be used to update the fields of
a template. The tag template fields are represented as separate resources
and should be updated using their own create/update/delete methods.
Users should enable the Data Catalog API in the project identified by
the `tag_template.name` parameter (see [Data Catalog Resource Project]
(https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
more information).
Args:
name: string, The resource name of the tag template in URL format. Example:
* projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}
Note that this TagTemplate and its child resources may not actually be
stored in the location in this name. (required)
body: object, The request body.
The object takes the form of:
{ # A tag template defines a tag, which can have one or more typed fields.
# The template is used to create and attach the tag to GCP resources.
# [Tag template
# roles](https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles)
# provide permissions to create, edit, and use the template. See, for example,
# the [TagTemplate
# User](https://cloud.google.com/data-catalog/docs/how-to/template-user) role,
# which includes permission to use the tag template to tag resources.
"fields": { # Required. Map of tag template field IDs to the settings for the field.
# This map is an exhaustive list of the allowed fields. This map must contain
# at least one field and at most 500 fields.
#
# The keys to this map are tag template field IDs. Field IDs can contain
# letters (both uppercase and lowercase), numbers (0-9) and underscores (_).
# Field IDs must be at least 1 character long and at most
# 64 characters long. Field IDs must start with a letter or underscore.
"a_key": { # The template for an individual field within a tag template.
"type": { # Required. The type of value this tag field can contain.
"enumType": { # Represents an enum type.
"allowedValues": [ # Required on create; optional on update. The set of allowed values for
# this enum. This set must not be empty, the display names of the values in
# this set must not be empty and the display names of the values must be
# case-insensitively unique within this set. Currently, enum values can
# only be added to the list of allowed values. Deletion and renaming of
# enum values are not supported. Can have up to 500 allowed values.
{
"displayName": "A String", # Required. The display name of the enum value. Must not be an empty string.
},
],
},
"primitiveType": "A String", # Represents primitive types - string, bool etc.
},
"order": 42, # The order of this field with respect to other fields in this tag
# template. A higher value indicates a more important field. The value can
# be negative. Multiple fields can have the same order, and field orders
# within a tag do not have to be sequential.
"isRequired": True or False, # Whether this is a required field. Defaults to false.
"name": "A String", # Output only. The resource name of the tag template field in URL format. Example:
#
# * projects/{project_id}/locations/{location}/tagTemplates/{tag_template}/fields/{field}
#
# Note that this TagTemplateField may not actually be stored in the location
# in this name.
"displayName": "A String", # The display name for this field. Defaults to an empty string.
},
},
"name": "A String", # The resource name of the tag template in URL format. Example:
#
# * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}
#
# Note that this TagTemplate and its child resources may not actually be
# stored in the location in this name.
"displayName": "A String", # The display name for this template. Defaults to an empty string.
}
updateMask: string, The field mask specifies the parts of the template to overwrite.
Allowed fields:
* `display_name`
If absent or empty, all of the allowed fields above will be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A tag template defines a tag, which can have one or more typed fields.
# The template is used to create and attach the tag to GCP resources.
# [Tag template
# roles](https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles)
# provide permissions to create, edit, and use the template. See, for example,
# the [TagTemplate
# User](https://cloud.google.com/data-catalog/docs/how-to/template-user) role,
# which includes permission to use the tag template to tag resources.
"fields": { # Required. Map of tag template field IDs to the settings for the field.
# This map is an exhaustive list of the allowed fields. This map must contain
# at least one field and at most 500 fields.
#
# The keys to this map are tag template field IDs. Field IDs can contain
# letters (both uppercase and lowercase), numbers (0-9) and underscores (_).
# Field IDs must be at least 1 character long and at most
# 64 characters long. Field IDs must start with a letter or underscore.
"a_key": { # The template for an individual field within a tag template.
"type": { # Required. The type of value this tag field can contain.
"enumType": { # Represents an enum type.
"allowedValues": [ # Required on create; optional on update. The set of allowed values for
# this enum. This set must not be empty, the display names of the values in
# this set must not be empty and the display names of the values must be
# case-insensitively unique within this set. Currently, enum values can
# only be added to the list of allowed values. Deletion and renaming of
# enum values are not supported. Can have up to 500 allowed values.
{
"displayName": "A String", # Required. The display name of the enum value. Must not be an empty string.
},
],
},
"primitiveType": "A String", # Represents primitive types - string, bool etc.
},
"order": 42, # The order of this field with respect to other fields in this tag
# template. A higher value indicates a more important field. The value can
# be negative. Multiple fields can have the same order, and field orders
# within a tag do not have to be sequential.
"isRequired": True or False, # Whether this is a required field. Defaults to false.
"name": "A String", # Output only. The resource name of the tag template field in URL format. Example:
#
# * projects/{project_id}/locations/{location}/tagTemplates/{tag_template}/fields/{field}
#
# Note that this TagTemplateField may not actually be stored in the location
# in this name.
"displayName": "A String", # The display name for this field. Defaults to an empty string.
},
},
"name": "A String", # The resource name of the tag template in URL format. Example:
#
# * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}
#
# Note that this TagTemplate and its child resources may not actually be
# stored in the location in this name.
"displayName": "A String", # The display name for this template. Defaults to an empty string.
}
setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy for a resource. Replaces any existing
policy.
Supported resources are:
- Tag templates.
- Entries.
- Entry groups.
Note, this method cannot be used to manage policies for BigQuery, Pub/Sub
and any external Google Cloud Platform resources synced to Data Catalog.
Callers must have following Google IAM permission
- `datacatalog.tagTemplates.setIamPolicy` to set policies on tag
templates.
- `datacatalog.entries.setIamPolicy` to set policies on entries.
- `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
Args:
resource: string, REQUIRED: The resource for which the policy is being specified.
See the operation documentation for the appropriate value for this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
"policy": { # An Identity and Access Management (IAM) policy, which specifies access # 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.
# controls for Google Cloud resources.
#
#
# A `Policy` is a collection of `bindings`. A `binding` binds one or more
# `members` to a single `role`. Members 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:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
# "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
# "role": "roles/resourcemanager.organizationViewer",
# "members": [
# "user:eve@example.com"
# ],
# "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:mike@example.com
# - group:admins@example.com
# - domain:google.com
# - serviceAccount:my-project-id@appspot.gserviceaccount.com
# role: roles/resourcemanager.organizationAdmin
# - members:
# - user:eve@example.com
# 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/).
"bindings": [ # Associates a list of `members` to 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 member.
{ # Associates `members` with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) # 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 members 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).
# 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.
"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.
"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.
"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.
"expression": "A String", # Textual representation of an expression in Common Expression Language
# syntax.
},
"members": [ # Specifies the identities 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, `alice@example.com` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a service
# account. For example, `my-other-app@appspot.gserviceaccount.com`.
#
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `admins@example.com`.
#
# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
# identifier) representing a user that has been recently deleted. For
# example, `alice@example.com?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,
# `my-other-app@appspot.gserviceaccount.com?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, `admins@example.com?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`.
#
"A String",
],
"role": "A String", # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
"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.
"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).
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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` to a single `role`. Members 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:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
# "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
# "role": "roles/resourcemanager.organizationViewer",
# "members": [
# "user:eve@example.com"
# ],
# "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:mike@example.com
# - group:admins@example.com
# - domain:google.com
# - serviceAccount:my-project-id@appspot.gserviceaccount.com
# role: roles/resourcemanager.organizationAdmin
# - members:
# - user:eve@example.com
# 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/).
"bindings": [ # Associates a list of `members` to 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 member.
{ # Associates `members` with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) # 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 members 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).
# 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.
"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.
"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.
"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.
"expression": "A String", # Textual representation of an expression in Common Expression Language
# syntax.
},
"members": [ # Specifies the identities 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, `alice@example.com` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a service
# account. For example, `my-other-app@appspot.gserviceaccount.com`.
#
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `admins@example.com`.
#
# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
# identifier) representing a user that has been recently deleted. For
# example, `alice@example.com?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,
# `my-other-app@appspot.gserviceaccount.com?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, `admins@example.com?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`.
#
"A String",
],
"role": "A String", # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
"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.
"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).
}
testIamPermissions(resource, body=None, x__xgafv=None)
Returns the caller's permissions on a resource.
If the resource does not exist, an empty set of permissions is returned
(We don't return a `NOT_FOUND` error).
Supported resources are:
- Tag templates.
- Entries.
- Entry groups.
Note, this method cannot be used to manage policies for BigQuery, Pub/Sub
and any external Google Cloud Platform resources synced to Data Catalog.
A caller is not required to have Google IAM permission to make this
request.
Args:
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)
body: object, The request body.
The object takes the form of:
{ # Request message for `TestIamPermissions` method.
"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).
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for `TestIamPermissions` method.
"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
# allowed.
"A String",
],
}