gcp_bigquery_dataset_facts – Сбор фактов о наборе данных GCP
Новая версия с 2.8.
Обзор
- Сбор фактов о наборе данных GCP
Требования
Ниже перечислены требования, необходимые на хосте, на котором будет выполняться этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| project строка | Проект Google Cloud Platform для использования. | |
| scopes список | Массив используемых областей. | |
| service_account_contents строка | Строка, представляющая содержимое файла JSON учетной записи сервиса. Это не должно передаваться как словарь, а как строка с точным содержимым файла json учетной записи сервиса (валидный JSON) | |
| service_account_email строка | Дополнительный адрес электронной почты учетной записи сервиса, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи сервиса, если в качестве типа выбран serviceaccount. |
Примечания
Примечание
- Для аутентификации вы можете установить service_account_file с помощью переменной среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации вы можете установить service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации вы можете установить service_account_contents с помощью переменной среды
GCP_SERVICE_ACCOUNT_CONTENTS. - Для аутентификации вы можете установить auth_kind с помощью переменной среды
GCP_AUTH_KIND. - Для аутентификации вы можете установить scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в книге сценариев не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: " a dataset facts"
gcp_bigquery_dataset_facts:
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: facts
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |||
|---|---|---|---|---|---|
| items сложный тип | всегда | Список элементов | |||
| access сложный тип | успех | Управление доступом к ведру. | |||
| domain строка | успех | Домен, которому предоставляется доступ. Любой пользователь, авторизованный с указанным доменом, получит указанный доступ. | |||
| groupByEmail строка | успех | Адрес электронной почты группы Google, которой предоставляется доступ. | |||
| role строка | успех | Описывает права, предоставленные пользователю, указанному в другом члене объекта доступа. | |||
| specialGroup строка | успех | Специальная группа, которой предоставляется доступ. | |||
| userByEmail строка | успех | Адрес электронной почты пользователя, которому предоставляется доступ. Например: fred@example.com. | |||
| view сложный тип | успех | Вид из другого набора данных, которому предоставляется доступ. Запросы, выполняемые на этом виде, будут иметь права чтения к таблицам в этом наборе данных. Поле role не требуется, когда задано это поле. Если этот вид обновляется любым пользователем, доступ к виду необходимо предоставить снова с помощью операции обновления. | |||
| datasetId строка | успех | Идентификатор набора данных, содержащего эту таблицу. | |||
| projectId строка | успех | Идентификатор проекта, содержащего эту таблицу. | |||
| tableId строка | успех | Идентификатор таблицы. Идентификатор должен содержать только буквы (a-z, A-Z), цифры (0-9) или символы подчеркивания. Максимальная длина составляет 1024 символа. | |||
| creationTime целое число | успех | Время создания этого набора данных в миллисекундах с начала эпохи. | |||
| datasetReference сложный тип | успех | Ссылка, идентифицирующая набор данных. | |||
| datasetId строка | успех | Уникальный идентификатор этого набора данных без имени проекта. Имя набора данных без имени проекта приведено в поле datasetId. | |||
| projectId строка | успех | Идентификатор проекта, содержащего этот набор данных. | |||
| defaultTableExpirationMs целое число | успех | Срок действия всех таблиц в наборе данных по умолчанию в миллисекундах. | |||
| description строка | успех | Наглядное описание набора данных. | |||
| friendlyName строка | успех | Дескриптивное имя набора данных. | |||
| id строка | успех | Полное уникальное имя набора данных в формате projectId:datasetId. Имя набора данных без имени проекта указано в поле datasetId. | |||
| labels словарь | успех | Метки, связанные с этим набором данных. Вы можете использовать их для организации и группирования наборов данных. | |||
| lastModifiedTime целое число | успех | Дата последнего изменения этого набора данных или любой из его таблиц в миллисекундах с начала эпохи. | |||
| location строка | успех | Географическое расположение, где должен находиться набор данных. Возможные значения: EU и US. Значение по умолчанию - US. | |||
| name строка | успех | Имя набора данных. | |||
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [предварительная версия]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Google Inc. (@googlecloudplatform)
Подсказка
Если вы заметили какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/gcp_bigquery_dataset_facts_module.html