Модуль google.cloud.gcp_storage_object — создание объекта GCP

Примечание

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

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

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

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

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

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

Загрузка файла в корзину GCS или скачивание файла из неё.

Требования

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

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0
google-cloud-storage >= 1.2.0

Параметры

Параметр	Комментарии
access_token string	Токен доступа OAuth2, если тип учётных данных — accesstoken.
action string	Действия, которые нужно выполнить с этим объектом. Можно скачать или загрузить объект либо удалить его. Варианты: `"download"` `"upload"` `"delete"`
auth_kind string / обязательный	Тип используемых учётных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
bucket string	Имя корзины.
dest path	Место назначения файла (локальный компьютер или облако — в зависимости от действия). Путь в облаке должен быть закодирован для URL, включая косые черты. Обязательный параметр для загрузки и скачивания.
env_type string	Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте это значение, если не знаете, что делаете. Изменяется только строка User Agent для API-запросов.
project string	Проект Google Cloud Platform, который будет использоваться.
scopes list / elements=string	Массив используемых областей доступа
service_account_contents jsonarg	Содержимое JSON-файла учётной записи службы в виде словаря или JSON-строки, представляющей его.
service_account_email string	Необязательный адрес электронной почты учётной записи службы. Используется, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию.
service_account_file path	Путь к JSON-файлу учётной записи службы, если выбран тип serviceaccount.
src path	Исходное расположение файла (локальный компьютер или облако — в зависимости от действия). Пути в облаке должны быть закодированы для URL, включая косые черты.

Примеры

- name: Download an object
  google.cloud.gcp_storage_object:
    action: download
    bucket: ansible-bucket
    src: modules.zip
    dest: "~/modules.zip"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

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

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

Ключ	Описание
bucket string	Корзина, в которой находится объект. Возвращается: при скачивании и загрузке
cache_control string	Заголовок HTTP «Cache-Control» для этого объекта Возвращается: при скачивании и загрузке
chunk_size string	Размер фрагмента blob по умолчанию Возвращается: при скачивании и загрузке
media_link string	Ссылка на медиафайл Возвращается: при скачивании и загрузке
self_link string	Ссылка self_link на медиафайл. Возвращается: при скачивании и загрузке
storage_class string	Класс хранения объекта. Возвращается: при скачивании и загрузке

Авторы

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_storage_object_module.html