• 主页
• airflow.providers.google
• airflow.providers.google.cloud
• airflow.providers.google.cloud.hooks
• airflow.providers.google.cloud.hooks.datacatalog

airflow.providers.google.cloud.hooks.datacatalog

模块内容

类

CloudDataCatalogHook

用于 Google Cloud Data Catalog 服务的 Hook。

class airflow.providers.google.cloud.hooks.datacatalog.CloudDataCatalogHook(gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)

基类： airflow.providers.google.common.hooks.base_google.GoogleBaseHook

用于 Google Cloud Data Catalog 服务的 Hook。

参数

• gcp_conn_id (str) – 获取连接信息时使用的连接 ID。

• impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务帐户，使用短期凭据模拟，或获取列表中最后一个帐户的 access_token 所需的帐户链表，该帐户将在请求中模拟。如果设置为字符串，则该帐户必须授予原始帐户“服务帐户令牌创建者”IAM 角色。如果设置为序列，则列表中的身份必须将“服务帐户令牌创建者”IAM 角色授予直接前面的身份，列表中的第一个帐户将此角色授予原始帐户。

get_conn()

检索允许访问 Cloud Data Catalog 服务的客户端库对象。

create_entry(location, entry_group, entry_id, entry, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())

创建一个条目。

当前仅可以创建“FILESET”类型的条目。

参数

• location (str) – 必需。要创建的条目的位置。

• entry_group (str) – 必需。在其中创建条目的条目组 ID。

• entry_id (str) – 必需。要创建的条目的 ID。

• entry (dict | google.cloud.datacatalog.Entry) – 必需。要创建的条目。如果提供了 dict，则其格式必须与 protobuf 消息 Entry 相同

• project_id (str) – 拥有该条目的 Google Cloud 项目的 ID。如果设置为 None 或缺失，则使用 Google Cloud 连接中的默认 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用于重试请求的重试对象。如果设置为 None 或缺失，则将使用默认配置重试请求。

• timeout (float | None) – 等待请求完成的时间（以秒为单位）。请注意，如果指定了 retry，则超时适用于每次尝试。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的其他元数据。

create_entry_group(location, entry_group_id, entry_group, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())

创建一个 EntryGroup。

参数

• location (str) – 必需。要创建的条目组的位置。

• entry_group_id (str) – 必需。要创建的条目组的 ID。该 ID 必须以字母或下划线开头，仅包含英文字母、数字和下划线，且最多 64 个字符。

• entry_group (dict | google.cloud.datacatalog.EntryGroup) –

  要创建的条目组。默认为空条目组。

  如果提供了 dict，则其格式必须与 protobuf 消息 EntryGroup 相同

• project_id (str) – 拥有该条目组的 Google Cloud 项目的 ID。如果设置为 None 或缺失，则使用 Google Cloud 连接中的默认 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用于重试请求的重试对象。如果指定了 None，则将使用默认配置重试请求。

• timeout (float | None) – 等待请求完成的时间（以秒为单位）。请注意，如果指定了 retry，则超时适用于每次尝试。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的其他元数据。

create_tag(location, entry_group, entry, tag, project_id=PROVIDE_PROJECT_ID, template_id=None, retry=DEFAULT, timeout=None, metadata=())

在条目上创建一个标记。

参数

• location (str) – 必需。要创建的标记的位置。

• entry_group (str) – 必需。在其中创建标记的条目组 ID。

• entry (str) – 必需。在其中创建标记的条目组 ID。

• tag (dict | google.cloud.datacatalog.Tag) – 必需。要创建的标记。如果提供了 dict，则其格式必须与 protobuf 消息 Tag 相同

• template_id ( str | None ) – 必需。用于创建标签的模板 ID。

• project_id ( str ) – 拥有该标签的 Google Cloud 项目的 ID。如果设置为 None 或缺失，则使用来自 Google Cloud 连接的默认 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用于重试请求的重试对象。如果指定了 None，则将使用默认配置重试请求。

• timeout (float | None) – 等待请求完成的时间（以秒为单位）。请注意，如果指定了 retry，则超时适用于每次尝试。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的其他元数据。

create_tag_template(location, tag_template_id, tag_template, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())

创建标签模板。

参数

• location – 必需。要创建的标签模板的位置。

• tag_template_id ( str ) – 必需。要创建的标签模板的 ID。

• tag_template ( dict | google.cloud.datacatalog.TagTemplate ) –

  必需。要创建的标签模板。

  如果提供 dict，则它必须与 protobuf 消息 TagTemplate 具有相同的形式。

• project_id ( str ) – 拥有该标签模板的 Google Cloud 项目的 ID。如果设置为 None 或缺失，则使用来自 Google Cloud 连接的默认 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用于重试请求的重试对象。如果指定了 None，则将使用默认配置重试请求。

• timeout (float | None) – 等待请求完成的时间（以秒为单位）。请注意，如果指定了 retry，则超时适用于每次尝试。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的其他元数据。

create_tag_template_field(location, tag_template, tag_template_field_id, tag_template_field, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())

在标签模板中创建一个字段。

参数

• location ( str ) – 必需。要创建的标签模板字段的位置。

• tag_template ( str ) – 必需。要创建的标签模板的 ID。

• tag_template_field_id ( str ) – 必需。要创建的标签模板字段的 ID。字段 ID 可以包含字母（大写和小写）、数字 (0-9)、下划线 (_) 和破折号 (-)。字段 ID 的长度必须至少为 1 个字符，最多为 128 个字符。字段 ID 在其模板中也必须是唯一的。

• tag_template_field ( dict | google.cloud.datacatalog.TagTemplateField ) –

  必需。要创建的标签模板字段。

  如果提供 dict，则它必须与 protobuf 消息 TagTemplateField 具有相同的形式。

• project_id ( str ) – 拥有该标签模板字段的 Google Cloud 项目的 ID。如果设置为 None 或缺失，则使用来自 Google Cloud 连接的默认 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用于重试请求的重试对象。如果指定了 None，则将使用默认配置重试请求。

• timeout (float | None) – 等待请求完成的时间（以秒为单位）。请注意，如果指定了 retry，则超时适用于每次尝试。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的其他元数据。

delete_entry(location, entry_group, entry, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())

删除现有条目。

参数

• location ( str ) – 必需。要删除的条目的位置。

• entry_group ( str ) – 必需。要删除的条目的条目组 ID。

• entry ( str ) – 要删除的条目 ID。

• project_id (str) – 拥有该条目组的 Google Cloud 项目的 ID。如果设置为 None 或缺失，则使用 Google Cloud 连接中的默认 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用于重试请求的重试对象。如果指定了 None，则将使用默认配置重试请求。

• timeout (float | None) – 等待请求完成的时间（以秒为单位）。请注意，如果指定了 retry，则超时适用于每次尝试。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的其他元数据。

delete_entry_group(location, entry_group, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())

删除一个 EntryGroup。

只能删除不包含条目的条目组。

参数

• location – 必需。要删除的条目组的位置。

• entry_group – 要删除的条目组 ID。

• project_id (str) – 拥有该条目组的 Google Cloud 项目的 ID。如果设置为 None 或缺失，则使用 Google Cloud 连接中的默认 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用于重试请求的重试对象。如果指定了 None，则将使用默认配置重试请求。

• timeout (float | None) – 等待请求完成的时间（以秒为单位）。请注意，如果指定了 retry，则超时适用于每次尝试。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的其他元数据。

delete_tag(location, entry_group, entry, tag, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())

删除一个标签。

参数

• location ( str ) – 必需。要删除的标签的位置。

• entry_group ( str ) – 要删除的标签的条目组 ID。

• entry ( str ) – 要删除的标签的条目 ID。

• tag ( str ) – 要删除的标签的标识符。

• project_id (str) – 拥有该条目组的 Google Cloud 项目的 ID。如果设置为 None 或缺失，则使用 Google Cloud 连接中的默认 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用于重试请求的重试对象。如果指定了 None，则将使用默认配置重试请求。

• timeout (float | None) – 等待请求完成的时间（以秒为单位）。请注意，如果指定了 retry，则超时适用于每次尝试。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的其他元数据。

delete_tag_template(location, tag_template, force, project_id, retry=DEFAULT, timeout=None, metadata=())

删除标签模板和所有使用该模板的标签。

参数

• location – 必需。要删除的标签模板的位置。

• tag_template – 要删除的标签模板的 ID。

• project_id (str) – 拥有该条目组的 Google Cloud 项目的 ID。如果设置为 None 或缺失，则使用 Google Cloud 连接中的默认 project_id。

• force ( bool ) – 必需。目前，此字段必须始终设置为 true。这确认删除了任何可能使用此模板的标签。未来将支持 force = false。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用于重试请求的重试对象。如果指定了 None，则将使用默认配置重试请求。

• timeout (float | None) – 等待请求完成的时间（以秒为单位）。请注意，如果指定了 retry，则超时适用于每次尝试。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的其他元数据。

delete_tag_template_field(location, tag_template, field, force, project_id, retry=DEFAULT, timeout=None, metadata=())

删除标签模板中的字段以及该字段的所有用法。

参数

• location (str) – 必需。要删除的标签模板的位置。

• tag_template (str) – 要删除的标签模板字段的标签模板 ID。

• field (str) – 要删除的字段的名称。

• force (bool) – 必需。这将确认从此字段使用的任何标签中删除此字段。

• project_id (str) – 拥有该条目组的 Google Cloud 项目的 ID。如果设置为 None 或缺失，则使用 Google Cloud 连接中的默认 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用于重试请求的重试对象。如果指定了 None，则将使用默认配置重试请求。

• timeout (float | None) – 等待请求完成的时间（以秒为单位）。请注意，如果指定了 retry，则超时适用于每次尝试。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的其他元数据。

get_entry(location, entry_group, entry, project_id, retry=DEFAULT, timeout=None, metadata=())

获取条目。

参数

• location (str) – 必需。要获取的条目的位置。

• entry_group (str) – 必需。要获取的条目的条目组。

• entry (str) – 要获取的条目的 ID。

• project_id (str) – 拥有该条目组的 Google Cloud 项目的 ID。如果设置为 None 或缺失，则使用 Google Cloud 连接中的默认 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用于重试请求的重试对象。如果指定了 None，则将使用默认配置重试请求。

• timeout (float | None) – 等待请求完成的时间（以秒为单位）。请注意，如果指定了 retry，则超时适用于每次尝试。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的其他元数据。

get_entry_group(location, entry_group, project_id, read_mask=None, retry=DEFAULT, timeout=None, metadata=())

获取条目组。

参数

• location (str) – 必需。要获取的条目组的位置。

• entry_group (str) – 要获取的条目组的 ID。

• read_mask (google.protobuf.field_mask_pb2.FieldMask | None) –

  要返回的字段。如果未设置或为空，则返回所有字段。

  如果提供了字典，则其格式必须与protobuf消息 FieldMask 相同

• project_id (str) – 拥有该条目组的 Google Cloud 项目的 ID。如果设置为 None 或缺失，则使用 Google Cloud 连接中的默认 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用于重试请求的重试对象。如果指定了 None，则将使用默认配置重试请求。

• timeout (float | None) – 等待请求完成的时间（以秒为单位）。请注意，如果指定了 retry，则超时适用于每次尝试。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的其他元数据。

get_tag_template(location, tag_template, project_id, retry=DEFAULT, timeout=None, metadata=())

获取标签模板。

参数

• location (str) – 必需。要获取的标签模板的位置。

• tag_template (str) – 必需。要获取的标签模板的 ID。

• project_id (str) – 拥有该条目组的 Google Cloud 项目的 ID。如果设置为 None 或缺失，则使用 Google Cloud 连接中的默认 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用于重试请求的重试对象。如果指定了 None，则将使用默认配置重试请求。

• timeout (float | None) – 等待请求完成的时间（以秒为单位）。请注意，如果指定了 retry，则超时适用于每次尝试。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的其他元数据。

list_tags(location, entry_group, entry, project_id, page_size=100, retry=DEFAULT, timeout=None, metadata=())

列出条目上的标签。

参数

• location (str) – 必需。要获取的标签的位置。

• entry_group (str) – 必需。要获取的标签的条目组。

• entry_group – 必需。要获取的标签的条目。

• page_size (int) – 底层 API 响应中包含的最大资源数。 如果按资源执行页面流式传输，则此参数不影响返回值。 如果按页面执行页面流式传输，则此参数确定页面中的最大资源数。

• project_id (str) – 拥有该条目组的 Google Cloud 项目的 ID。如果设置为 None 或缺失，则使用 Google Cloud 连接中的默认 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用于重试请求的重试对象。如果指定了 None，则将使用默认配置重试请求。

• timeout (float | None) – 等待请求完成的时间（以秒为单位）。请注意，如果指定了 retry，则超时适用于每次尝试。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的其他元数据。

get_tag_for_template_name(location, entry_group, entry, template_name, project_id, retry=DEFAULT, timeout=None, metadata=())

获取具有特定条目的特定模板的标签。

参数

• location (str) – 必需。包含要搜索的条目的位置。

• entry_group (str) – 包含要搜索的条目的条目组 ID。

• entry (str) – 要搜索的条目的名称。

• template_name (str) – 将作为搜索条件的模板的名称。

• project_id (str) – 拥有该条目组的 Google Cloud 项目的 ID。如果设置为 None 或缺失，则使用 Google Cloud 连接中的默认 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用于重试请求的重试对象。如果指定了 None，则将使用默认配置重试请求。

• timeout (float | None) – 等待请求完成的时间（以秒为单位）。请注意，如果指定了 retry，则超时适用于每次尝试。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的其他元数据。

lookup_entry(linked_resource=None, sql_resource=None, retry=DEFAULT, timeout=None, metadata=())

按目标资源名称获取条目。

此方法允许客户端使用来自源 Google Cloud 服务的资源名称来获取 Data Catalog 条目。

参数

• linked_resource (str | None) – Data Catalog 条目表示的 Google Cloud 资源的完整名称。 请参阅：https://cloud.google.com/apis/design/resource_names#full_resource_name。 完整名称区分大小写。

• sql_resource (str | None) – 条目的 SQL 名称。 SQL 名称区分大小写。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用于重试请求的重试对象。如果指定了 None，则将使用默认配置重试请求。

• timeout (float | None) – 等待请求完成的时间（以秒为单位）。请注意，如果指定了 retry，则超时适用于每次尝试。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的其他元数据。

rename_tag_template_field(location, tag_template, field, new_tag_template_field_id, project_id, retry=DEFAULT, timeout=None, metadata=())

重命名标签模板中的字段。

参数

• location (str) – 必需。要重命名的标签模板字段的位置。

• tag_template (str) – 要重命名的字段的标签模板 ID。

• field (str) – 必需。此标签模板字段的旧 ID。例如，my_old_field。

• new_tag_template_field_id (str) – 必需。此标签模板字段的新 ID。例如，my_new_field。

• project_id (str) – 拥有该条目组的 Google Cloud 项目的 ID。如果设置为 None 或缺失，则使用 Google Cloud 连接中的默认 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用于重试请求的重试对象。如果指定了 None，则将使用默认配置重试请求。

• timeout (float | None) – 等待请求完成的时间（以秒为单位）。请注意，如果指定了 retry，则超时适用于每次尝试。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的其他元数据。

search_catalog(scope, query, page_size=100, order_by=None, retry=DEFAULT, timeout=None, metadata=())

在数据目录中搜索与查询匹配的多个资源，例如条目、标签。

这不会返回完整的资源，仅返回资源标识符和高级字段。客户端可以随后调用 Get 方法。

请注意，搜索并不完全召回。即使在后续的结果页面中，也可能存在与您的查询匹配但未返回的结果。这些缺失的结果在重复调用搜索时可能会有所不同。如果您需要保证完全召回，请不要依赖此方法。

参数

• scope (dict | google.cloud.datacatalog.SearchCatalogRequest.Scope) –

  必需。此搜索请求的范围。

  如果提供字典，则其形式必须与protobuf消息 Scope 相同

• query (str) –

  必需。搜索查询语法中的查询字符串。查询必须非空。

  查询字符串可以像“x”一样简单，也可以更限定为

  • name:x

  • column:x

  • description:y

  注意：查询令牌需要至少 3 个字符才能使子字符串匹配正确工作。有关更多信息，请参阅 数据目录搜索语法。

• page_size (int) – 底层 API 响应中包含的最大资源数。如果按资源执行页面流，则此参数不会影响返回值。如果按页面执行页面流，则此参数确定页面中的最大资源数。

• order_by (str | None) –

  指定结果的排序，目前支持区分大小写的选择为

  • relevance，仅支持降序

  • last_access_timestamp [asc|desc]，如果未指定，则默认为降序

  • last_modified_timestamp [asc|desc]，如果未指定，则默认为降序

  如果未指定，则默认为 relevance 降序。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用于重试请求的重试对象。如果指定了 None，则将使用默认配置重试请求。

• timeout (float | None) – 等待请求完成的时间（以秒为单位）。请注意，如果指定了 retry，则超时适用于每次尝试。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的其他元数据。

update_entry(entry, update_mask, project_id, location=None, entry_group=None, entry_id=None, retry=DEFAULT, timeout=None, metadata=())

更新现有条目。

参数

• entry (dict | google.cloud.datacatalog.Entry) –

  必需。更新后的条目。必须设置“name”字段。

  如果提供字典，则其形式必须与protobuf消息 Entry 相同

• update_mask (dict | google.protobuf.field_mask_pb2.FieldMask) –

  要在条目上更新的字段。如果不存在或为空，则更新所有可修改的字段。

  如果提供了字典，则其格式必须与protobuf消息 FieldMask 相同

• location (str | None) – 必需。要更新的条目的位置。

• entry_group (str | None) – 要更新的条目的条目组 ID。

• entry_id (str | None) – 要更新的条目 ID。

• project_id (str) – 拥有该条目组的 Google Cloud 项目的 ID。如果设置为 None 或缺失，则使用 Google Cloud 连接中的默认 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用于重试请求的重试对象。如果指定了 None，则将使用默认配置重试请求。

• timeout (float | None) – 等待请求完成的时间（以秒为单位）。请注意，如果指定了 retry，则超时适用于每次尝试。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的其他元数据。

update_tag(tag, update_mask, project_id, location=None, entry_group=None, entry=None, tag_id=None, retry=DEFAULT, timeout=None, metadata=())

更新现有标签。

参数

• tag (dict | google.cloud.datacatalog.Tag) –

  必需。更新后的标签。必须设置“name”字段。

  如果提供字典，则其形式必须与protobuf消息 Tag 相同

• update_mask (dict | google.protobuf.field_mask_pb2.FieldMask) –

  要在标签上更新的字段。如果不存在或为空，则更新所有可修改的字段。目前，唯一可修改的字段是字段 fields。

  如果提供了字典，则其格式必须与protobuf消息 FieldMask 相同

• location (str | None) – 必需。要重命名的标签的位置。

• entry_group (str | None) – 要更新的标签的条目组 ID。

• entry (str | None) – 要更新的标签的条目 ID。

• tag_id (str | None) – 要更新的标签 ID。

• project_id (str) – 拥有该条目组的 Google Cloud 项目的 ID。如果设置为 None 或缺失，则使用 Google Cloud 连接中的默认 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用于重试请求的重试对象。如果指定了 None，则将使用默认配置重试请求。

• timeout (float | None) – 等待请求完成的时间（以秒为单位）。请注意，如果指定了 retry，则超时适用于每次尝试。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的其他元数据。

update_tag_template(tag_template, update_mask, project_id, location=None, tag_template_id=None, retry=DEFAULT, timeout=None, metadata=())

更新标签模板。

此方法不能用于更新模板的字段。标签模板字段表示为单独的资源，应使用它们自己的创建/更新/删除方法进行更新。

参数

• tag_template ( dict | google.cloud.datacatalog.TagTemplate ) –

  必需。要更新的模板。“name”字段必须设置。

  如果提供 dict，则它必须与 protobuf 消息 TagTemplate 具有相同的形式。

• update_mask (dict | google.protobuf.field_mask_pb2.FieldMask) –

  字段掩码指定要覆盖的模板部分。

  如果不存在或为空，则将更新以上所有允许的字段。

  如果提供了字典，则其格式必须与protobuf消息 FieldMask 相同

• location ( str | None ) – 必需。要重命名的标签模板的位置。

• tag_template_id ( str | None ) – 可选。正在更新的条目的标签模板 ID。

• project_id (str) – 拥有该条目组的 Google Cloud 项目的 ID。如果设置为 None 或缺失，则使用 Google Cloud 连接中的默认 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用于重试请求的重试对象。如果指定了 None，则将使用默认配置重试请求。

• timeout (float | None) – 等待请求完成的时间（以秒为单位）。请注意，如果指定了 retry，则超时适用于每次尝试。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的其他元数据。

update_tag_template_field(tag_template_field, update_mask, project_id, tag_template_field_name=None, location=None, tag_template=None, tag_template_field_id=None, retry=DEFAULT, timeout=None, metadata=())

更新标签模板中的字段。此方法不能用于更新字段类型。

参数

• tag_template_field ( dict | google.cloud.datacatalog.TagTemplateField ) –

  必需。要更新的模板。

  如果提供 dict，则它必须与 protobuf 消息 TagTemplateField 具有相同的形式。

• update_mask (dict | google.protobuf.field_mask_pb2.FieldMask) –

  字段掩码指定要更新的模板部分。允许的字段

  • display_name

  • type.enum_type

  如果 update_mask 未设置或为空，则将更新以上所有允许的字段。

  更新枚举类型时，提供的值将与现有值合并。因此，只能添加枚举值，不能删除或重命名现有枚举值。

  如果提供了字典，则其格式必须与protobuf消息 FieldMask 相同

• tag_template_field_name ( str | None ) – 可选。要重命名的标签模板字段的名称。

• location ( str | None ) – 可选。要重命名的标签的位置。

• tag_template ( str | None ) – 可选。要重命名的标签模板字段的标签模板 ID。

• tag_template_field_id ( str | None ) – 可选。要重命名的标签模板字段的 ID。

• project_id (str) – 拥有该条目组的 Google Cloud 项目的 ID。如果设置为 None 或缺失，则使用 Google Cloud 连接中的默认 project_id。

• retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – 用于重试请求的重试对象。如果指定了 None，则将使用默认配置重试请求。

• timeout (float | None) – 等待请求完成的时间（以秒为单位）。请注意，如果指定了 retry，则超时适用于每次尝试。

• metadata (collections.abc.Sequence[tuple[str, str]]) – 提供给方法的其他元数据。

上一个 下一个

此条目是否有帮助？