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

Примечание

Этот плагин входит в состав коллекции google.cloud (версия 1.0.1).

Для его установки используйте: 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

Параметры

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

Авторы

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.10/collections/google/cloud/gcp_bigquery_dataset_info_module.html