google.cloud.gcp_bigquery_dataset_info 模块 – 收集 GCP 数据集信息

注意

此模块是 google.cloud 集合 (版本 1.4.1) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install google.cloud。您需要其他要求才能使用此模块，有关详细信息，请参阅要求。

要在 playbook 中使用它，请指定： google.cloud.gcp_bigquery_dataset_info。

注意

由于违反了 Ansible 包含要求，google.cloud 集合将在 Ansible 12 中移除。该集合存在未解决的完整性测试失败。有关更多信息，请参阅讨论主题。

概要 

收集 GCP 数据集信息

要求 

执行此模块的主机需要以下要求。

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

参数 

参数	注释
access_token 字符串	如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。
auth_kind 字符串 / 必需	使用的凭据类型。选项 `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
env_type 字符串	指定您在此模块中运行的 Ansible 环境。除非您知道自己在做什么，否则不应设置此项。这只会更改任何 API 请求的用户代理字符串。
project 字符串	要使用的 Google Cloud Platform 项目。
scopes 列表 / 元素=字符串	要使用的作用域数组
service_account_contents jsonarg	服务帐户 JSON 文件的内容，可以是字典或表示它的 JSON 字符串。
service_account_email 字符串	如果选择 machineaccount 并且用户不希望使用默认电子邮件，则为可选的服务帐户电子邮件地址。
service_account_file 路径	如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。

备注 

注意

对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_FILE 环境变量设置 service_account_file。
对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_CONTENTS 环境变量设置 service_account_contents。
对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_EMAIL 环境变量设置 service_account_email。
对于身份验证，您可以使用 GCP_ACCESS_TOKEN 环境变量设置 access_token。
对于身份验证，您可以使用 GCP_AUTH_KIND 环境变量设置 auth_kind。
对于身份验证，您可以使用 GCP_SCOPES 环境变量设置 scopes。
仅当未设置 playbook 值时，才会使用环境变量值。
service_account_email 和 service_account_file 选项是互斥的。

示例 

- name: get info on a dataset
  gcp_bigquery_dataset_info:
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值 

常用返回值已在此处记录此处，以下是此模块特有的字段

键	描述
resources 复杂类型	资源列表返回：始终
access 复杂类型	一个对象数组，定义一个或多个实体的数据集访问权限。返回：成功
domain 字符串	要授予访问权限的域。使用指定的域登录的任何用户都将被授予指定的访问权限。返回：成功
groupByEmail 字符串	要授予访问权限的 Google 群组的电子邮件地址。返回：成功
role 字符串	描述授予访问对象其他成员指定的用户的权限。支持基本、预定义和自定义角色。API 会将具有等效基本角色的预定义角色替换为其基本角色。请参阅 [官方文档](https://cloud.google.com/bigquery/docs/access-control)。返回：成功
specialGroup 字符串	要授予访问权限的特殊组。可能的值包括：* `projectOwners`：封闭项目的拥有者。 * `projectReaders`：封闭项目的阅读者。 * `projectWriters`：封闭项目的写入者。 * `allAuthenticatedUsers`：所有经过身份验证的 BigQuery 用户。返回：成功
userByEmail 字符串	要授予访问权限的用户电子邮件地址。例如：fred@example.com。返回：成功
视图复杂类型	要授予访问权限的不同数据集中的视图。针对该视图执行的查询将对该数据集中的表具有读取访问权限。设置此字段时，不需要 role 字段。如果该视图被任何用户更新，则需要通过更新操作再次授予对该视图的访问权限。返回：成功
datasetId 字符串	包含此表的dataset的ID。返回：成功
projectId 字符串	包含此表的项目的ID。返回：成功
tableId 字符串	表的ID。ID 只能包含字母（a-z、A-Z）、数字（0-9）或下划线。最大长度为 1,024 个字符。返回：成功
creationTime 整数	创建此数据集的时间（自纪元以来的毫秒数）。返回：成功
datasetReference 复杂类型	标识数据集的引用。返回：成功
datasetId 字符串	此数据集的唯一 ID，不包含项目名称。ID 只能包含字母（a-z、A-Z）、数字（0-9）或下划线。最大长度为 1,024 个字符。返回：成功
projectId 字符串	包含此数据集的项目的ID。返回：成功
defaultEncryptionConfiguration 复杂类型	数据集所有表的默认加密密钥。设置此属性后，数据集中的所有新创建的分区表都将使用此值设置加密密钥，除非表创建请求（或查询）覆盖了密钥。返回：成功
kmsKeyName 字符串	描述将用于保护目标 BigQuery 表的 Cloud KMS 加密密钥。与您的项目关联的 BigQuery 服务帐号需要访问此加密密钥。返回：成功
defaultPartitionExpirationMs 整数	数据集所有分区表的默认分区过期时间（毫秒）。设置此属性后，数据集中的所有新创建的分区表都将在 `timePartitioning` 设置中具有设置为此值的 `expirationMs` 属性，并且更改该值只会影响新表，而不会影响现有表。分区中的存储将具有分区时间加上此值的过期时间。设置此属性会覆盖对分区表使用 `defaultTableExpirationMs`：对于任何新的分区表，只会使用 `defaultTableExpirationMs` 或 `defaultPartitionExpirationMs` 中的一个。如果在创建或更新分区表时提供显式的 `timePartitioning.expirationMs`，则该值优先于此属性指示的默认分区过期时间。返回：成功
defaultTableExpirationMs 整数	数据集所有表的默认生命周期（毫秒）。最小值为 3600000 毫秒（一小时）。设置此属性后，数据集中的所有新创建的表都将具有设置为创建时间加上此属性中值的 `expirationTime` 属性，并且更改该值只会影响新表，而不会影响现有表。当给定表的 `expirationTime` 到达时，该表将自动删除。如果表的 `expirationTime` 在表过期前被修改或删除，或者如果在创建表时提供显式的 `expirationTime`，则该值优先于此属性指示的默认过期时间。返回：成功
description 字符串	数据集的用户友好型描述。返回：成功
etag 字符串	资源的哈希值。返回：成功
friendlyName 字符串	数据集的描述性名称。返回：成功
id 字符串	数据集的完整限定唯一名称，格式为 projectId:datasetId。数据集名称（不包含项目名称）在 datasetId 字段中给出。返回：成功
labels 字典	与此数据集关联的标签。您可以使用这些标签来组织和分组您的数据集。返回：成功
lastModifiedTime 整数	上次修改此数据集或其任何表的时间（自纪元以来的毫秒数）。返回：成功
location 字符串	数据集应驻留的地理位置。参见[官方文档](https://cloud.google.com/bigquery/docs/dataset-locations)。位置分为两种类型：区域位置和多区域位置。区域位置是指特定地理位置，例如东京；多区域位置是指包含至少两个地理位置的大型地理区域，例如美国。默认值为多区域位置 `US`。更改此设置将强制创建一个新的资源。返回：成功
name 字符串	数据集名称。返回：成功

作者

Google Inc. (@googlecloudplatform)