1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-04-07 07:10:01 +02:00

94 lines
3.4 KiB
Plaintext
Raw Normal View History

2024-11-15 22:13:43 +03:00
---
sidebar_position: 1
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Put object
Uploads the file to the bucket
`Function PutObject(Val Name, Val Bucket, Val Entity, Val BasicData, Val Headers = Undefined) Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
2024-11-15 23:20:00 +03:00
| Name | --name | String | ✔ | Name of the object in the bucket |
2024-11-15 22:13:43 +03:00
| Bucket | --bucket | String | ✔ | Name of the bucket to put the object |
| Entity | --data | String, BinaryData | ✔ | File path or binary data of the object |
| BasicData | --basic | Structure of KeyAndValue | ✔ | Basic request data. See GetBasicDataStructure |
| Headers | --headers | Map Of KeyAndValue | ✖ | Additional request headers, if necessary |
Returns: Structure of KeyAndValue - serialized JSON response from storage
<br/>
:::tip
2024-11-21 11:30:08 +03:00
Method at AWS documentation (default): [PutObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)<br/>
Method at AWS documentation (multipart): [Multipart upload](https:<br/>
docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html)<br/>
You can use the `ChunkSize` field in the basic data to specify the minimum file and chunk size for a chunked upload<br/>
For example, ChunkSize=X means that all files larger than X (in bytes) will be downloaded in chunks, where one chunk will be of size X.<br/>
Chunk upload is used for large files. Default ChunkSize - 20971520 bytes (20 MB)<br/>
<br/><br/>
2024-11-15 22:13:43 +03:00
Parameters with Binary data type can also accept file paths on disk and URLs
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
URL = "storage-155.s3hoster.by";
AccessKey = "BRN5RKJE67...";
SecretKey = "NNhv+i9PrytpT8Tu0C1N...";
Region = "BTC";
BasicData = OPI_S3.GetBasicDataStructure(URL, AccessKey, SecretKey, Region);
Name = "picture.jpg";
Bucket = "opi-gpbucket3";
Entity = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Path or Binary Data
Result = OPI_S3.PutObject(Name, Bucket, Entity, BasicData);
2024-11-21 11:30:08 +03:00
Name = "fileChunked.mp3";
Bucket = "opi-gpbucket3";
Entity = "https://api.athenaeum.digital/test_data/song.mp3"; // URL, Path or Binary Data
BasicData.Insert("ChunkSize", 5242880);
Result = OPI_S3.PutObject(Name, Bucket, Entity, BasicData);
2024-11-15 22:13:43 +03:00
```
2024-11-17 16:09:58 +03:00
<Tabs>
<TabItem value="bash" label="Bash" default>
```bash
# JSON data can also be passed as a path to a .json file
oint s3 PutObject \
--name "picture.jpg" \
--bucket "opi-gpbucket3" \
--data "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" \
--basic "{'URL':'storage-155.s3hoster.by','AccessKey':'***','SecretKey':'***','Region':'BTC','Service':'s3'}"
```
</TabItem>
<TabItem value="bat" label="CMD/Bat" default>
```batch
:: JSON data can also be passed as a path to a .json file
oint s3 PutObject ^
--name "picture.jpg" ^
--bucket "opi-gpbucket3" ^
--data "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/picture.jpg" ^
--basic "{'URL':'storage-155.s3hoster.by','AccessKey':'***','SecretKey':'***','Region':'BTC','Service':'s3'}"
```
</TabItem>
</Tabs>
2024-11-15 22:13:43 +03:00
2024-11-20 14:49:03 +03:00