Модуль google.cloud.gcp_bigquery_dataset_info — сбор сведений о наборе данных GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: google.cloud.gcp_bigquery_dataset_info.
Обзор
- Сбор сведений о наборе данных GCP
Требования
Следующие требования должны быть выполнены на узле, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
auth_kind string / обязательный | Тип используемых учетных данных. Варианты:
|
env_type string | Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте это значение, если не знаете, что делаете. Это влияет только на строку User Agent во всех запросах к API. |
project string | Проект Google Cloud Platform, который следует использовать. |
scopes list / элементы=string | Массив областей доступа для использования |
service_account_contents jsonarg | Содержимое файла JSON учетной записи службы: словарь или строка JSON, представляющая его. |
service_account_email string | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес электронной почты по умолчанию. |
service_account_file path | Путь к файлу JSON учетной записи службы, если в качестве типа выбрано serviceaccount. |
Примечания
Примечание
- Для аутентификации можно задать service_account_file с помощью переменной среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно задать service_account_contents с помощью переменной среды
GCP_SERVICE_ACCOUNT_CONTENTS. - Для аутентификации можно задать service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно задать access_token с помощью переменной среды
GCP_ACCESS_TOKEN. - Для аутентификации можно задать auth_kind с помощью переменной среды
GCP_AUTH_KIND. - Для аутентификации можно задать scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды используются только в том случае, если значения в плейбуке не заданы.
- Параметры 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 complex | Список ресурсов Возвращается: всегда |
|
access complex |
Массив объектов, определяющих доступ к набору данных для одной или нескольких сущностей. Возвращается: при успешном выполнении |
|
domain string |
Домен, которому предоставляется доступ. Всем пользователям, вошедшим в систему с указанным доменом, будет предоставлен указанный доступ. Возвращается: при успешном выполнении |
|
groupByEmail string |
Адрес электронной почты группы Google, которой предоставляется доступ. Возвращается: при успешном выполнении |
|
role string |
Описывает права, предоставленные пользователю, указанному в другом поле объекта доступа. Поддерживаются базовые, предопределенные и пользовательские роли. Предопределенные роли, эквивалентные базовым, API заменяет соответствующими базовыми ролями. См. [официальную документацию](https://cloud.google.com/bigquery/docs/access-control). Возвращается: при успешном выполнении |
|
specialGroup string |
Специальная группа, которой предоставляется доступ. Возможные значения: * `projectOwners`: владельцы родительского проекта. * `projectReaders`: читатели родительского проекта. * `projectWriters`: авторы родительского проекта. * `allAuthenticatedUsers`: все аутентифицированные пользователи BigQuery. Возвращается: при успешном выполнении |
|
userByEmail string |
Адрес электронной почты пользователя, которому предоставляется доступ. Например: fred@example.com. Возвращается: при успешном выполнении |
|
view complex |
Представление из другого набора данных, которому предоставляется доступ. Запросы к этому представлению получат доступ на чтение таблиц в этом наборе данных. Если задано это поле, указывать поле role не требуется. Если любой пользователь обновит это представление, доступ к нему нужно будет предоставить повторно с помощью операции обновления. Возвращается: при успешном выполнении |
|
datasetId string |
Идентификатор набора данных, содержащего эту таблицу. Возвращается: при успешном выполнении |
|
projectId string |
Идентификатор проекта, содержащего эту таблицу. Возвращается: при успешном выполнении |
|
tableId string |
Идентификатор таблицы. Он может содержать только буквы (a-z, A-Z), цифры (0-9) или символы подчеркивания. Максимальная длина — 1 024 символа. Возвращается: при успешном выполнении |
|
creationTime integer |
Время создания этого набора данных в миллисекундах с начала эпохи. Возвращается: при успешном выполнении |
|
datasetReference complex |
Ссылка, идентифицирующая набор данных. Возвращается: при успешном выполнении |
|
datasetId string |
Уникальный идентификатор этого набора данных без имени проекта. Он может содержать только буквы (a-z, A-Z), цифры (0-9) или символы подчеркивания. Максимальная длина — 1 024 символа. Возвращается: при успешном выполнении |
|
projectId string |
Идентификатор проекта, содержащего этот набор данных. Возвращается: при успешном выполнении |
|
defaultEncryptionConfiguration complex |
Ключ шифрования по умолчанию для всех таблиц в наборе данных. После установки этого свойства все вновь создаваемые секционированные таблицы в наборе данных будут использовать этот ключ шифрования, если только запрос на создание таблицы (или запрос) не переопределит его. Возвращается: при успешном выполнении |
|
kmsKeyName string |
Задает ключ шифрования Cloud KMS, который будет использоваться для защиты целевой таблицы BigQuery. Учетной записи службы BigQuery, связанной с вашим проектом, необходим доступ к этому ключу шифрования. Возвращается: при успешном выполнении |
|
defaultPartitionExpirationMs integer |
Срок действия секций по умолчанию для всех секционированных таблиц в наборе данных, в миллисекундах. После установки этого свойства для всех вновь создаваемых секционированных таблиц в наборе данных свойство `expirationMs` в настройках `timePartitioning` будет установлено в это значение. Изменение значения повлияет только на новые таблицы, но не на существующие. Срок действия данных в секции истечет по истечении этого значения после времени секционирования. Установка этого свойства переопределяет использование `defaultTableExpirationMs` для секционированных таблиц: для любой новой секционированной таблицы будет использоваться только одно из значений — `defaultTableExpirationMs` или `defaultPartitionExpirationMs`. Если при создании или обновлении секционированной таблицы явно указать `timePartitioning.expirationMs`, это значение будет иметь приоритет над сроком действия секции по умолчанию, заданным этим свойством. Возвращается: при успешном выполнении |
|
defaultTableExpirationMs integer |
Срок хранения по умолчанию для всех таблиц в наборе данных, в миллисекундах. Минимальное значение — 3600000 миллисекунд (один час). После установки этого свойства для всех вновь создаваемых таблиц в наборе данных свойство `expirationTime` будет установлено в значение, равное времени создания плюс значение этого свойства. Изменение значения повлияет только на новые таблицы, но не на существующие. По достижении значения `expirationTime` данная таблица будет удалена автоматически. Если значение `expirationTime` таблицы изменить или удалить до истечения срока действия либо при создании таблицы явно указать `expirationTime`, это значение будет иметь приоритет над сроком действия по умолчанию, заданным этим свойством. Возвращается: при успешном выполнении |
|
description string |
Удобное для пользователя описание набора данных. Возвращается: при успешном выполнении |
|
etag string |
Хеш ресурса. Возвращается: при успешном выполнении |
|
friendlyName string |
Понятное имя набора данных. Возвращается: при успешном выполнении |
|
id string | Полное уникальное имя набора данных в формате projectId:datasetId. Имя набора данных без имени проекта указано в поле datasetId. Возвращается: при успешном выполнении |
|
labels dictionary |
Метки, связанные с этим набором данных. Их можно использовать для упорядочивания и группировки наборов данных. Возвращается: при успешном выполнении |
|
lastModifiedTime integer |
Дата последнего изменения этого набора данных или любой из его таблиц, в миллисекундах с начала эпохи. Возвращается: при успешном выполнении |
|
location string |
Географическое расположение набора данных. См. [официальную документацию](https://cloud.google.com/bigquery/docs/dataset-locations). Существуют два типа расположения: региональное и мультирегиональное. Региональное расположение — это конкретное географическое место, например Токио, а мультирегиональное — большая географическая область, например США, включающая как минимум два географических места. По умолчанию используется мультирегиональное расположение `US`. Изменение этого значения приведет к созданию нового ресурса. Возвращается: при успешном выполнении |
|
name string |
Имя набора данных. Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_bigquery_dataset_info_module.html