CloudDataCatalogUpdateTagTemplateFieldOperator

Google

Updates a field in a tag template. This method cannot be used to update the field type.

View Source

Last Updated: Mar. 22, 2021

Access Instructions

Install the Google provider package into your Airflow environment.

Import the module into your DAG file and instantiate it with your desired params.

Parameters

tag_template_fieldUnion[Dict, google.cloud.datacatalog_v1beta1.types.TagTemplateField]Required. The template to update.If a dict is provided, it must be of the same form as the protobuf message :class:`~google.cloud.datacatalog_v1beta1.types.TagTemplateField`No role entry for "class" in module "docutils.parsers.rst.languages.en". Trying "class" as canonical role name.Unknown interpreted text role "class".
update_maskUnion[Dict, google.cloud.datacatalog_v1beta1.types.FieldMask]The field mask specifies the parts of the template to be updated. Allowed fields:display_nametype.enum_typeIf update_mask is not set or empty, all of the allowed fields above will be updated.When updating an enum type, the provided values will be merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted nor renamed.If a dict is provided, it must be of the same form as the protobuf message :class:`~google.cloud.datacatalog_v1beta1.types.FieldMask`No role entry for "class" in module "docutils.parsers.rst.languages.en". Trying "class" as canonical role name.Unknown interpreted text role "class".
tag_template_field_namestrOptional. The name of the tag template field to rename.
locationstrOptional. The location of the tag to rename.
tag_templatestrOptional. The tag template ID for tag template field to rename.
tag_template_field_idstrOptional. The ID of tag template field to rename.
project_idOptional[str]The ID of the Google Cloud project that owns the entry group. If set to None or missing, the default project_id from the Google Cloud connection is used.
retrygoogle.api_core.retry.RetryA retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeoutfloatThe amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadataSequence[Tuple[str, str]]Additional metadata that is provided to the method.
gcp_conn_idstrOptional, The connection ID used to connect to Google Cloud. Defaults to 'google_cloud_default'.
impersonation_chainUnion[str, Sequence[str]]Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

Documentation

Updates a field in a tag template. This method cannot be used to update the field type.

See also

For more information on how to use this operator, take a look at the guide: Updating a field

Was this page helpful?