Модуль google.cloud.gcp_storage_object — Создаёт объект GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.4.1).
Возможно, эта коллекция уже установлена, если вы используете пакет 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 строка | Токен доступа OAuth2, если тип аутентификации — accesstoken. |
action строка | Действия, которые необходимо выполнить с этим объектом. Вы можете загрузить объект, загрузить объект или удалить его. Варианты:
|
auth_kind строка / обязательно | Тип используемых учетных данных. Варианты:
|
bucket строка | Имя ведра. |
dest путь | Место назначения файла (может быть локальным компьютером или облаком в зависимости от действия). Облачный путь должен быть закодирован в URL, включая косые черты. Требуется для загрузки и скачивания. |
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 выбран как тип. |
src путь / обязательно | Местоположение исходного файла (может быть локальным компьютером или облаком в зависимости от действия). Облачные расположения должны быть закодированы в 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 строка | Ведро, в котором содержится объект. Возвращается: загрузка, загрузка |
cache_control строка | Заголовок HTTP ‘Cache-Control’ для этого объекта Возвращается: загрузка, загрузка |
chunk_size строка | Получить размер блока по умолчанию Возвращается: загрузка, загрузка |
media_link строка | Ссылка для медиа Возвращается: загрузка, загрузка |
self_link строка | Ссылка self_link для медиа. Возвращается: загрузка, загрузка |
storage_class строка | Класс хранения для объекта. Возвращается: загрузка, загрузка |
Ссылки на коллекцию
© 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_storage_object_module.html