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

列表 / elements=字符串

要使用的作用域数组

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

字符串

包含此表的 Project 的 ID。

返回：成功

tableId

字符串

表的 ID。ID 只能包含字母 (a-z, A-Z)、数字 (0-9) 或下划线。最大长度为 1,024 个字符。

返回：成功

creationTime

整数

此数据集的创建时间，以自 Unix 纪元以来的毫秒数表示。

返回：成功

datasetReference

复杂

标识数据集的引用。

返回：成功

datasetId

字符串

此数据集的唯一 ID，不包含项目名称。ID 只能包含字母 (a-z, A-Z)、数字 (0-9) 或下划线。最大长度为 1,024 个字符。

返回：成功

projectId

字符串

包含此数据集的 Project 的 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

整数

上次修改此数据集或其任何表的时间，以自 Unix 纪元以来的毫秒数表示。

返回：成功

location

字符串

数据集应所在的地理位置。

请参阅 [官方文档](https://cloud.google.com/bigquery/docs/dataset-locations)。

有两种类型的位置，区域位置或多区域位置。区域位置是特定的地理位置，例如东京，而多区域位置是较大的地理区域，例如美国，其中至少包含两个地理位置。

默认值是多区域位置 `US`。

更改此设置会强制创建新的资源。

返回：成功

name

字符串

数据集名称。

返回：成功

作者

  • Google Inc. (@googlecloudplatform)