Модуль google.cloud.gcp_vertexai_dataset — создание ресурса GCP VertexAI.Dataset

Примечание

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

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

Для установки используйте: ansible-galaxy collection install google.cloud. Для работы с этим модулем необходимы дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: google.cloud.gcp_vertexai_dataset.

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

Краткое описание

Набор объектов DataItem и связанных с ними аннотаций.

Требования

Следующие требования должны быть соблюдены на узле, где выполняется этот модуль.

python >= 3.8
requests >= 2.18.4
google-auth >= 2.25.1

Параметры

Параметр	Комментарии
access_token string	Токен доступа, используемый для аутентификации.
auth_kind string / обязательный	Тип используемых учетных данных. Варианты: `"accesstoken"` `"application"` `"machineaccount"` `"serviceaccount"`
display_name string / обязательный	Задаваемое пользователем имя набора данных. Имя может содержать до 128 символов и любые символы UTF-8.
encryption_spec dictionary	Спецификация ключа шифрования, управляемого клиентом, для набора данных. Если указано это значение, данный набор данных и все его подресурсы будут защищены этим ключом.
kms_key_name string	Идентификатор ресурса Cloud KMS для управляемого клиентом ключа шифрования, используемого для защиты ресурса. Формат: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. Ключ должен находиться в том же регионе, где создается ресурс.
env_type string	Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте это значение, если не знаете, что делаете. Это значение изменяет только строку User Agent для всех запросов API.
labels dictionary	Набор пар метка/значение, назначаемых этому рабочему процессу.
metadata_schema_uri string / обязательный	Указывает на YAML-файл в Google Cloud Storage с дополнительной информацией о наборе данных. Схема определяется как объект Schema в OpenAPI 3.0.2. Файлы схем, которые можно использовать здесь, находятся в gs://google-cloud-aiplatform/schema/dataset/metadata/.
project string	Проект Google Cloud Platform, который следует использовать.
region string	Регион набора данных. Например, us-central1.
scopes list / элементы=string	Массив используемых областей доступа.
service_account_contents jsonarg	Содержимое JSON-файла учетной записи службы: в виде словаря или JSON-строки, представляющей его.
service_account_email string	Необязательный адрес электронной почты учетной записи службы, если выбрано machineaccount и пользователь не хочет использовать адрес электронной почты по умолчанию.
service_account_file path	Путь к JSON-файлу учетной записи службы, если в качестве типа выбрано serviceaccount.
state string	Должен ли ресурс существовать в GCP. Варианты: `"present"` ← (по умолчанию) `"absent"`

Примечания

Примечание

Справочник API: https://cloud.google.com/vertex-ai/docs/reference/rest/v1/projects.locations.datasets
Официальное руководство по документации: https://cloud.google.com/vertex-ai/docs
Для аутентификации можно задать auth_kind с помощью переменной окружения GCP_AUTH_KIND.
Для аутентификации можно задать 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.
Для аутентификации можно задать scopes с помощью переменной окружения GCP_SCOPES.
Значения переменных окружения используются только в том случае, если значения не заданы в плейбуке.
Параметры service_account_email, service_account_file, service_account_file и access_token являются взаимоисключающими.

Примеры

- name: Create dataset
  google.cloud.gcp_vertexai_dataset:
    state: present
    display_name: "{{ resource_name }}"
    metadata_schema_uri: "gs://google-cloud-aiplatform/schema/dataset/metadata/image_1.0.0.yaml"
    region: us-central1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
  register: _myds

- name: Run assertions
  ansible.builtin.assert:
    that:
      - _myds.changed == true

- name: Update dataset
  google.cloud.gcp_vertexai_dataset:
    state: present
    display_name: "{{ resource_name }}"
    metadata_schema_uri: "gs://google-cloud-aiplatform/schema/dataset/metadata/image_1.0.0.yaml"
    labels:
      env: test
    region: us-central1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
  register: _myds

- name: Run assertions
  ansible.builtin.assert:
    that:
      - _myds.changed == true
      - _myds.labels | length > 0
      - _myds.labels.env == "test"

- name: Destroy dataset
  google.cloud.gcp_vertexai_dataset:
    state: absent
    display_name: "{{ resource_name }}"
    metadata_schema_uri: "gs://google-cloud-aiplatform/schema/dataset/metadata/image_1.0.0.yaml"
    region: us-central1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
changed boolean	Был ли изменен ресурс. Возвращается: всегда
createTime string	Время создания набора данных в формате RFC3339 UTC «Zulu», с наносекундной точностью и максимум девятью дробными разрядами. Возвращается: при успехе
name string	Имя ресурса набора данных. Это значение задается Google. Возвращается: при успехе
state string	Текущее состояние ресурса. Возвращается: всегда
updateTime string	Время последнего обновления набора данных в формате RFC3339 UTC «Zulu», с наносекундной точностью и максимум девятью дробными разрядами. Возвращается: при успехе

Авторы

Google Inc. (@googlecloudplatform)

Ссылки на коллекцию

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