Skip to content

doc: gcp bulkGet, copy, rename, move docs #4662

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: v1.16
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,13 @@ This component supports **output binding** with the following operations:

- `create` : [Create file](#create-file)
- `get` : [Get file](#get-file)
- `bulkGet` : [Bulk get objects](#bulk-get-objects)
- `delete` : [Delete file](#delete-file)
- `list`: [List file](#list-files)
- `copy`: [Copy file](#copy-files)
- `move`: [Move file](#move-files)
- `rename`: [Rename file](#rename-files)


### Create file

Expand Down Expand Up @@ -211,6 +216,72 @@ The metadata parameters are:

The response body contains the value stored in the object.

### Bulk get objects

To perform a bulk get operation that retrieves all bucket files at once, invoke the GCP bucket binding with a `POST` method and the following JSON body:

```json
{
"operation": "bulkGet",
}
```

The metadata parameters are:

- `encodeBase64` - (optional) configuration to encode base64 file content before return the content for all files

#### Example

{{< tabs Windows Linux >}}

{{% codetab %}}
```bash
curl -d '{ \"operation\": \"bulkget\"}' http://localhost:<dapr-port>/v1.0/bindings/<binding-name>
```
{{% /codetab %}}

{{% codetab %}}
```bash
curl -d '{ "operation": "bulkget"}' \
http://localhost:<dapr-port>/v1.0/bindings/<binding-name>
```
{{% /codetab %}}

{{< /tabs >}}

#### Response

The response body contains an array of objects, where each object represents a file in the bucket with the following structure:

```json
[
{
"name": "file1.txt",
"data": "content of file1",
"attrs": {
"bucket": "mybucket",
"name": "file1.txt",
"size": 1234,
...
}
},
{
"name": "file2.txt",
"data": "content of file2",
"attrs": {
"bucket": "mybucket",
"name": "file2.txt",
"size": 5678,
...
}
}
]
```

Each object in the array contains:
- `name`: The name of the file
- `data`: The content of the file
- `attrs`: Object attributes from GCP Storage including metadata like creation time, size, content type, etc.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we list all of these out or do they changes depending ong the bucket @nelson-parente


### Delete object

Expand Down Expand Up @@ -257,7 +328,7 @@ An HTTP 204 (No Content) and empty body will be retuned if successful.

### List objects

To perform a list object operation, invoke the S3 binding with a `POST` method and the following JSON body:
To perform a list object operation, invoke the GCP bucket binding with a `POST` method and the following JSON body:

```json
{
Expand Down Expand Up @@ -316,6 +387,58 @@ The list of objects will be returned as JSON array in the following form:
}
]
```

### Copy objects

To perform a copy object operation, invoke the GCP bucket binding with a `POST` method and the following JSON body:

```json
{
"operation": "copy",
"metadata": {
"destinationBucket": "destination-bucket-name",
}
}
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need specific responses on any of these? Assuming 204 no content for success or?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


The metadata parameters are:

- `destinationBucket` - the name of the destination bucket (required)

### Move objects

To perform a move object operation, invoke the GCP bucket binding with a `POST` method and the following JSON body:

```json
{
"operation": "move",
"metadata": {
"destinationBucket": "destination-bucket-name",
}
}
```

The metadata parameters are:

- `destinationBucket` - the name of the destination bucket (required)

### Rename objects

To perform a rename object operation, invoke the GCP bucket binding with a `POST` method and the following JSON body:

```json
{
"operation": "rename",
"metadata": {
"newName": "object-new-name",
}
}
```

The metadata parameters are:

- `newName` - the new name of the object (required)

## Related links

- [Basic schema for a Dapr component]({{< ref component-schema >}})
Expand Down
Loading