gcp_bigquery_dataset – Создание набора данных GCP
Новое в версии 2.8.
Обзор
- Наборы данных позволяют организовать и контролировать доступ к вашим таблицам.
Требования
Ниже приведены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| access - | Управление доступом к ведру. | |||
| domain - | Домен, которому предоставляется доступ. Все пользователи, вошедшие в систему с указанным доменом, получат указанный доступ. | |||
| group_by_email - | Адрес электронной почты группы Google, которой предоставляется доступ. | |||
| role - |
| Описывает права, предоставляемые пользователю, указанному в другом элементе доступа. | ||
| special_group - | Специальная группа, которой предоставляется доступ. | |||
| user_by_email - | Адрес электронной почты пользователя, которому предоставляется доступ. Например: fred@example.com. | |||
| view - | Просмотр из другого набора данных, которому предоставляется доступ. Запросы, выполняемые для этого представления, будут иметь права чтения для таблиц в этом наборе данных. Поле role не требуется, когда установлено это поле. Если это представление обновляется любым пользователем, доступ к представлению необходимо предоставить заново с помощью операции обновления. | |||
| dataset_id - / обязательно | Идентификатор набора данных, содержащего эту таблицу. | |||
| project_id - / обязательно | Идентификатор проекта, содержащего эту таблицу. | |||
| table_id - / обязательно | Идентификатор таблицы. Идентификатор должен содержать только буквы (a-z, A-Z), цифры (0-9) или символы подчеркивания. Максимальная длина — 1024 символа. | |||
| auth_kind строка / обязательно |
| Тип используемых учетных данных. | ||
| dataset_reference - / обязательно | Ссылка, идентифицирующая набор данных. | |||
| dataset_id - / обязательно | Уникальный идентификатор этого набора данных без имени проекта. Идентификатор должен содержать только буквы (a-z, A-Z), цифры (0-9) или символы подчеркивания. Максимальная длина — 1024 символа. | |||
| project_id - | Идентификатор проекта, содержащего этот набор данных. | |||
| default_table_expiration_ms - | Срок действия всех таблиц в наборе данных по умолчанию в миллисекундах. | |||
| description - | Понятное описание набора данных. | |||
| friendly_name - | Дескриптивное имя для набора данных. | |||
| labels - | Метки, связанные с этим набором данных. Их можно использовать для организации и группировки наборов данных. | |||
| location - | По умолчанию: "US" | Географическое местоположение, где должен находиться набор данных. Возможные значения: EU и US. Значение по умолчанию — US. | ||
| name - | Имя набора данных. | |||
| project строка | Проект Google Cloud Platform, который нужно использовать. | |||
| scopes список | Массив используемых областей. | |||
| service_account_contents строка | Строка, представляющая содержимое файла JSON учетной записи службы. Это не должно передаваться как словарь, а строка, содержащая точное содержимое файла json учетной записи службы (действительный JSON). | |||
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |||
| service_account_file путь | Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount. | |||
| state - |
| Нужно ли создать данный объект в GCP | ||
Примечания
Примечание
- Для аутентификации можно установить 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. - Значения переменных среды будут использоваться только в том случае, если значения в playbook не установлены.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: create a dataset
gcp_bigquery_dataset:
name: my_example_dataset
dataset_reference:
dataset_id: my_example_dataset
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| access complex | success | Управление доступом к ведру. | ||
| domain string | success | Домен, которому предоставляется доступ. Любой пользователь, авторизованный с указанным доменом, получит указанный доступ. | ||
| groupByEmail string | success | Адрес электронной почты группы Google, которой предоставляется доступ. | ||
| role string | success | Описывает права, предоставленные пользователю, указанному в другом элементе доступа. | ||
| specialGroup string | success | Специальная группа, которой предоставляется доступ. | ||
| userByEmail string | success | Адрес электронной почты пользователя, которому предоставляется доступ. Например: fred@example.com. | ||
| view complex | success | Вид из другого набора данных, которому предоставляется доступ. Запросы, выполненные к этому виду, будут иметь доступ для чтения к таблицам в этом наборе данных. Поле role не требуется, когда установлено это поле. Если этот вид обновляется любым пользователем, доступ к виду необходимо снова предоставить с помощью операции обновления. | ||
| datasetId string | success | Идентификатор набора данных, содержащего эту таблицу. | ||
| projectId string | success | Идентификатор проекта, содержащего эту таблицу. | ||
| tableId string | success | Идентификатор таблицы. Идентификатор должен содержать только буквы (a-z, A-Z), цифры (0-9) или символы подчеркивания. Максимальная длина — 1024 символа. | ||
| creationTime integer | success | Время создания этого набора данных в миллисекундах с начала эпохи. | ||
| datasetReference complex | success | Ссылка, идентифицирующая набор данных. | ||
| datasetId string | success | Уникальный идентификатор этого набора данных без имени проекта. Идентификатор должен содержать только буквы (a-z, A-Z), цифры (0-9) или символы подчеркивания. Максимальная длина — 1024 символа. | ||
| projectId string | success | Идентификатор проекта, содержащего этот набор данных. | ||
| defaultTableExpirationMs integer | success | Срок действия всех таблиц в наборе данных по умолчанию в миллисекундах. | ||
| description string | success | Пользовательское описание набора данных. | ||
| friendlyName string | success | Дескриптивное имя для набора данных. | ||
| id string | success | Полное уникальное имя набора данных в формате projectId:datasetId. Имя набора данных без имени проекта приведено в поле datasetId. | ||
| labels dictionary | success | Метки, связанные с этим набором данных. Вы можете использовать их для организации и группировки наборов данных. | ||
| lastModifiedTime integer | success | Дата последнего изменения этого набора данных или любой из его таблиц в миллисекундах с начала эпохи. | ||
| location string | success | Географическое местоположение, где должен находиться набор данных. Возможные значения: EU и US. Значение по умолчанию — US. | ||
| name string | success | Имя набора данных. | ||
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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_module.html
