Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию google.cloud (версия 1.4.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

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

Параметры

Параметр

Комментарии

access_token

строка

Токен доступа OAuth2, если тип учетных данных — accesstoken.

auth_kind

строка / обязательный

Тип учетных данных, используемых для аутентификации.

Варианты:

  • "application"
  • "machineaccount"
  • "serviceaccount"
  • "accesstoken"

env_type

строка

Указывает, в какой среде Ansible выполняется этот модуль.

Не следует устанавливать это значение, если вы не знаете, что делаете.

Это влияет только на строку User Agent для всех запросов к API.

project

строка

Проект Google Cloud Platform, который необходимо использовать.

scopes

список / элементы=строка

Массив используемых областей
... ...

Примечания

Примечание

  • для аутентификации можно установить service_account_file, используя переменную среды GCP_SERVICE_ACCOUNT_FILE.
  • для аутентификации можно установить service_account_contents, используя переменную среды GCP_SERVICE_ACCOUNT_CONTENTS.
  • для аутентификации можно установить service_account_email, используя переменную среды GCP_SERVICE_ACCOUNT_EMAIL.
  • для аутентификации можно установить access_token, используя переменную среды GCP_ACCESS_TOKEN.
  • для аутентификации можно установить 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

целое число

Значение по умолчанию для срока хранения всех разделяемых по времени таблиц в наборе данных, в миллисекундах.

После установки этого свойства все вновь созданные разделяемые по времени таблицы в наборе данных будут иметь свойство `expirationMs` в настройках `timePartitioning`, установленное в это значение, и изменение значения повлияет только на новые таблицы, а не на существующие. Хранилище в разбиении будет иметь срок хранения, равный времени разбиения плюс это значение.

Указание этого свойства переопределяет использование `defaultTableExpirationMs` для разделяемых по времени таблиц: для любой новой разделяемой по времени таблицы будет использоваться только одно из `defaultTableExpirationMs` и `defaultPartitionExpirationMs`. Если вы явно укажете `timePartitioning.expirationMs` при создании или обновлении разделяемой по времени таблицы, это значение будет иметь приоритет над значением по умолчанию для срока хранения разбиения, указанным этим свойством.

Возвращаемое значение: успех

defaultTableExpirationMs

целое число

Срок хранения по умолчанию для всех таблиц в наборе данных, в миллисекундах.

Минимальное значение составляет 3600000 миллисекунд (один час).

После установки этого свойства все вновь созданные таблицы в наборе данных будут иметь свойство `expirationTime`, установленное в время создания плюс значение в этом свойстве, и изменение значения повлияет только на новые таблицы, а не на существующие. По достижении `expirationTime` для данной таблицы, она будет автоматически удалена.

Если свойство `expirationTime` таблицы изменяется или удаляется до истечения срока её хранения, или если вы явно указываете `expirationTime` при создании таблицы, это значение имеет приоритет над значением по умолчанию, указанным этим свойством.

Возвращаемое значение: успех

description

строка

Пользовательское описание набора данных.

Возвращаемое значение: успех

etag

строка

Хеш ресурса.

Возвращаемое значение: успех

friendlyName

строка

Дескриптивное имя набора данных.

Возвращаемое значение: успех

id

строка

Полное, уникальное имя набора данных в формате projectId:datasetId. Имя набора данных без имени проекта приводится в поле datasetId.

Возвращаемое значение: успех

labels

словарь

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

Возвращаемое значение: успех

lastModifiedTime

целое число

Дата последнего изменения этого набора данных или любой из его таблиц, в миллисекундах с начала эпохи.

Возвращаемое значение: успех

location

строка

Географическое расположение, где должен храниться набор данных.

См. [официальную документацию](https://cloud.google.com/bigquery/docs/dataset-locations).

Существуют два типа расположений: региональные и многорегиональные. Региональное расположение — это конкретное географическое место, например, Токио, а многорегиональное расположение — это большая географическая область, например, США, содержащая как минимум два географических места.

Значение по умолчанию — многорегиональное расположение `US`.

Изменение этого свойства приводит к созданию нового ресурса.

Возвращаемое значение: успех

name

строка

Имя набора данных.

Возвращаемое значение: успех

Авторы

  • Google Inc. (@googlecloudplatform)

Ссылки на сборки

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API