gcp_bigquery_dataset_info – Сбор информации о наборе данных GCP

Новое в версии 2.8.

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Описание

Сбор информации о наборе данных GCP
Этот модуль назывался gcp_bigquery_dataset_facts до Ansible 2.9. Способ использования не изменился.

Псевдонимы: gcp_bigquery_dataset_facts

Требования

Ниже приведены требования к хосту, на котором выполняется этот модуль.

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
env_type строка		Указывает, в какой среде Ansible вы выполняете этот модуль. Это не следует устанавливать, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов к API.
project строка		Проект Google Cloud Platform для использования.
scopes список		Массив используемых областей.
service_account_contents jsonarg		Содержимое файла JSON учетной записи службы, либо в виде словаря, либо как строка JSON, которая его представляет.
service_account_email строка		Дополнительный адрес электронной почты учетной записи службы, если выбрано machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь		Путь к файлу JSON учетной записи службы, если тип serviceaccount выбран.

Примечания

Примечание

для аутентификации вы можете установить service_account_file, используя переменную среды c(gcp_service_account_file).
для аутентификации вы можете установить service_account_contents, используя переменную среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
для аутентификации вы можете установить service_account_email, используя переменную среды GCP_SERVICE_ACCOUNT_EMAIL.
для аутентификации вы можете установить auth_kind, используя переменную среды GCP_AUTH_KIND.
для аутентификации вы можете установить scopes, используя переменную среды GCP_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 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) или символы подчеркивания. Максимальная длина — 1024 символа.
	creationTime integer			успех	Время создания набора данных в миллисекундах с начала эпохи.
	datasetReference complex			успех	Ссылка, идентифицирующая набор данных.
		datasetId string		успех	Уникальный идентификатор этого набора данных без названия проекта. Идентификатор должен содержать только буквы (a-z, A-Z), цифры (0-9) или символы подчеркивания. Максимальная длина — 1024 символа.
		projectId string		успех	Идентификатор проекта, содержащего этот набор данных.
	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). Существует два типа местоположений: региональные и многорегиональные. Региональное местоположение — это определенное географическое место, такое как Токио, а многорегиональное местоположение — это большая географическая зона, такая как США, которая содержит как минимум два географических места. Возможные региональные значения включают: `asia-east1`, `asia-northeast1`, `asia-southeast1`, `australia-southeast1`, `europe-north1`, `europe-west2` и `us-east4`. Возможные многорегиональные значения: `EU` и `US`. Значение по умолчанию — многорегиональное местоположение `US`. Изменение этого значения приводит к созданию нового ресурса.
	name string			успех	Название набора данных.

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом 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.9/modules/gcp_bigquery_dataset_info_module.html