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

Примечание

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

Для его установки используйте: 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). Существуют два типа расположений: региональные и многорегиональные. Региональное расположение — это конкретное географическое место, например, Токио, а многорегиональное расположение — это большая географическая область, например, Соединённые Штаты, которая включает в себя по крайней мере два географических места. Значение по умолчанию — многорегиональное расположение `US`. Изменение этого значения приводит к созданию нового ресурса.
	name string			успех	Имя набора данных.

Авторы

Google Inc. (@googlecloudplatform)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_bigquery_dataset_info_module.html