mirror of
https://github.com/GAM-team/GAM.git
synced 2026-06-18 13:11:37 +00:00
caddda2b1c
Some checks failed
Build and test GAM / build (Win64, build, 7, VC-WIN64A, windows-2022) (push) Has been cancelled
Build and test GAM / build (aarch64, build, 2, linux-aarch64, [self-hosted linux arm64]) (push) Has been cancelled
Build and test GAM / build (aarch64, build, 4, linux-aarch64, [self-hosted linux arm64], yes) (push) Has been cancelled
Build and test GAM / build (aarch64, build, 6, darwin64-arm64, macos-14) (push) Has been cancelled
Build and test GAM / build (x86_64, build, 1, linux-x86_64, ubuntu-22.04) (push) Has been cancelled
Build and test GAM / build (x86_64, build, 3, linux-x86_64, ubuntu-22.04, yes) (push) Has been cancelled
Build and test GAM / build (x86_64, build, 5, darwin64-x86_64, macos-13) (push) Has been cancelled
Build and test GAM / build (x86_64, test, 10, ubuntu-24.04, 3.10) (push) Has been cancelled
Build and test GAM / build (x86_64, test, 11, ubuntu-24.04, 3.11) (push) Has been cancelled
Build and test GAM / build (x86_64, test, 8, ubuntu-24.04, 3.13) (push) Has been cancelled
Build and test GAM / build (x86_64, test, 9, ubuntu-24.04, 3.9) (push) Has been cancelled
CodeQL / Analyze (python) (push) Has been cancelled
Check for Google Root CA Updates / check-apis (push) Has been cancelled
Build and test GAM / merge (push) Has been cancelled
Build and test GAM / publish (push) Has been cancelled
58 lines
2.3 KiB
Markdown
58 lines
2.3 KiB
Markdown
!# Cloud Storage
|
|
- [API documentation](#api-documentation)
|
|
- [Notes](#notes)
|
|
- [Definitions](#definitions)
|
|
- [Download a Cloud Storage Bucket Object](#download-a-cloud-storage-bucket-object)
|
|
|
|
## API documentation
|
|
* https://cloud.google.com/storage/docs/json_api/v1/objects
|
|
|
|
## Notes
|
|
To use these commands you must add the 'Cloud Storage API' to your project and update your client access authorization.
|
|
Enable `Cloud Storage API (Read, Vault/Takeout Download)`.
|
|
```
|
|
gam update project
|
|
gam oauth create
|
|
```
|
|
|
|
## Definitions
|
|
```
|
|
<StorageBucketName> ::= <String>
|
|
<StorageObjectName> ::= <String>
|
|
<StorageBucketObjectName> ::=
|
|
https://storage.cloud.google.com/<StorageBucketName>/<StorageObjectName>|
|
|
https://storage.googleapis.com/<StorageBucketName>/<StorageObjectName>|
|
|
gs://<StorageBucketName>/<StorageObjectName>|
|
|
<StorageBucketName>/<StorageObjectName>
|
|
```
|
|
## Download a Cloud Storage Bucket Object
|
|
```
|
|
gam download storagefile <StorageBucketObjectName>
|
|
[targetfolder <FilePath>] [overwrite [<Boolean>]] [nogcspath [<Boolean>]]
|
|
```
|
|
By default, the takeout files will be downloaded to the directory specified by `drive_dir` in gam.cfg.
|
|
* `targetfolder <FilePath>` - The takeout files will be downloaded to `<FilePath>`
|
|
|
|
By default, when getting a document, an existing local file will not be overwritten; a numeric prefix is added to the filename.
|
|
* `overwrite false` - Do not overwite an existing file; add a numeric prefix and create a new file
|
|
* `overwrite | overwrite true` - Overwite an existing file
|
|
|
|
By default, when getting a document, its Google Cloud Storage path is preserved.
|
|
* `nogcspath false` - Preserve the Google Cloud Storage path
|
|
* `nogcspath | nogcspath true` - Do not preserve the Google Cloud Storage path
|
|
|
|
### Example
|
|
This example downloads a Google Cloud Storage file preserving its path
|
|
```
|
|
$ gam download storagefile gs://gam-bucket/SubFolder/SimpleText.txt
|
|
Getting File SubFolder/SimpleText.txt
|
|
Cloud Storage File: SubFolder/SimpleText.txt, Downloaded to: /Users/admin/Documents/GamWork/SubFolder/SimpleText.txt
|
|
```
|
|
This example downloads a Google Cloud Storage file removing its path
|
|
```
|
|
$ gam download storagefile gs://gam-bucket/SubFolder/SimpleText.txt nogcspath
|
|
Getting File SubFolder/SimpleText.txt
|
|
Cloud Storage File: SubFolder/SimpleText.txt, Downloaded to: /Users/admin/Documents/GamWork/SimpleText.txt
|
|
|
|
```
|