Skip to content
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.

Sign up for GitHub

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

Jump to bottom

feat(docs): update docs #680

Merged
merged 1 commit into from
Nov 5, 2023
Merged

feat(docs): update docs #680

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 28 additions & 0 deletions versioned_docs/version-latest/04-standard-library/01-cloud/bucket.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,7 @@ new cloud.Bucket(props?: BucketProps);

| **Name** | **Description** |
| --- | --- |
| <code><a href="#@winglang/sdk.cloud.IBucketClient.copy">copy</a></code> | Copy an object to a new location in the bucket. |
| <code><a href="#@winglang/sdk.cloud.IBucketClient.delete">delete</a></code> | Delete an existing object using a key from the bucket. |
| <code><a href="#@winglang/sdk.cloud.IBucketClient.exists">exists</a></code> | Check if an object exists in the bucket. |
| <code><a href="#@winglang/sdk.cloud.IBucketClient.get">get</a></code> | Retrieve an object from the bucket. |
Expand Down Expand Up @@ -314,6 +315,33 @@ Run an inflight whenever a file is updated in the bucket.

---

##### `copy` <a name="copy" id="@winglang/sdk.cloud.IBucketClient.copy"></a>

```wing
inflight copy(srcKey: str, dstKey: str): void
```

Copy an object to a new location in the bucket.

If the destination object
already exists, it will be overwritten. Returns once the copying is finished.

###### `srcKey`<sup>Required</sup> <a name="srcKey" id="@winglang/sdk.cloud.IBucketClient.copy.parameter.srcKey"></a>

- *Type:* str

The key of the source object you wish to copy.

---

###### `dstKey`<sup>Required</sup> <a name="dstKey" id="@winglang/sdk.cloud.IBucketClient.copy.parameter.dstKey"></a>

- *Type:* str

The key of the destination object after copying.

---

##### `delete` <a name="delete" id="@winglang/sdk.cloud.IBucketClient.delete"></a>

```wing
Expand Down
6 changes: 3 additions & 3 deletions versioned_docs/version-latest/04-standard-library/compatibility/compatibility.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,11 +127,11 @@
"awscdk": { "implemented": false }
},
"copy": {
"sim": { "implemented": false, "issue": 4395 },
"tf-aws": { "implemented": false, "issue": 4396 },
"sim": { "implemented": true },
"tf-aws": { "implemented": true },
"tf-azure": { "implemented": false, "issue": 4397 },
"tf-gcp": { "implemented": false, "issue": 4398 },
"awscdk": { "implemented": false, "issue": 4396 }
"awscdk": { "implemented": true }
},
"list": {
"sim": { "implemented": true },
Expand Down