Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add samples for object retention (#2417)
* docs: add samples for object retention * docs: add samples for object retention * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * run formatter * fix checkstyle issue * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * remove unecessary tostring * add retention to metadata test * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
- Loading branch information
1 parent
f32aba5
commit 45837d3
Showing
7 changed files
with
177 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
48 changes: 48 additions & 0 deletions
48
...es/snippets/src/main/java/com/example/storage/bucket/CreateBucketWithObjectRetention.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| /* | ||
| * Copyright 2024 Google LLC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.example.storage.bucket; | ||
|
|
||
| // [START storage_create_bucket_with_object_retention] | ||
|
|
||
| import com.google.cloud.storage.Bucket; | ||
| import com.google.cloud.storage.BucketInfo; | ||
| import com.google.cloud.storage.Storage; | ||
| import com.google.cloud.storage.StorageOptions; | ||
|
|
||
| public class CreateBucketWithObjectRetention { | ||
| public static void createBucketWithObjectRetention(String projectId, String bucketName) { | ||
| // The ID of your GCP project | ||
| // String projectId = "your-project-id"; | ||
|
|
||
| // The ID to give your GCS bucket | ||
| // String bucketName = "your-unique-bucket-name"; | ||
|
|
||
| Storage storage = StorageOptions.newBuilder().setProjectId(projectId).build().getService(); | ||
|
|
||
| Bucket bucket = | ||
| storage.create( | ||
| BucketInfo.of(bucketName), Storage.BucketTargetOption.enableObjectRetention(true)); | ||
|
|
||
| System.out.println( | ||
| "Created bucket " | ||
| + bucket.getName() | ||
| + " with object retention enabled setting: " | ||
| + bucket.getObjectRetention().getMode().toString()); | ||
| } | ||
| } | ||
|
|
||
| // [END storage_create_bucket_with_object_retention] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
75 changes: 75 additions & 0 deletions
75
samples/snippets/src/main/java/com/example/storage/object/SetObjectRetentionPolicy.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| /* | ||
| * Copyright 2022 Google LLC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.example.storage.object; | ||
|
|
||
| // [START storage_set_object_retention_policy] | ||
|
|
||
| import static java.time.OffsetDateTime.now; | ||
|
|
||
| import com.google.cloud.storage.Blob; | ||
| import com.google.cloud.storage.BlobId; | ||
| import com.google.cloud.storage.BlobInfo.Retention; | ||
| import com.google.cloud.storage.Storage; | ||
| import com.google.cloud.storage.StorageException; | ||
| import com.google.cloud.storage.StorageOptions; | ||
|
|
||
| public class SetObjectRetentionPolicy { | ||
| public static void setObjectRetentionPolicy( | ||
| String projectId, String bucketName, String objectName) throws StorageException { | ||
| // The ID of your GCP project | ||
| // String projectId = "your-project-id"; | ||
|
|
||
| // The ID of your GCS bucket that has object retention enabled | ||
| // String bucketName = "your-unique-bucket-name"; | ||
|
|
||
| // The ID of your GCS object | ||
| // String objectName = "your-object-name"; | ||
|
|
||
| Storage storage = StorageOptions.newBuilder().setProjectId(projectId).build().getService(); | ||
| BlobId blobId = BlobId.of(bucketName, objectName); | ||
| Blob blob = storage.get(blobId); | ||
| if (blob == null) { | ||
| System.out.println("The object " + objectName + " was not found in " + bucketName); | ||
| return; | ||
| } | ||
|
|
||
| Blob updated = | ||
| blob.toBuilder() | ||
| .setRetention( | ||
| Retention.newBuilder() | ||
| .setMode(Retention.Mode.UNLOCKED) | ||
| .setRetainUntilTime(now().plusDays(10)) | ||
| .build()) | ||
| .build() | ||
| .update(); | ||
|
|
||
| System.out.println("Retention policy for object " + objectName + " was set to:"); | ||
| System.out.println(updated.getRetention().toString()); | ||
|
|
||
| // To modify an existing policy on an Unlocked object, pass in the override parameter | ||
| blob.toBuilder() | ||
| .setRetention( | ||
| updated.getRetention().toBuilder().setRetainUntilTime(now().plusDays(9)).build()) | ||
| .build() | ||
| .update(Storage.BlobTargetOption.overrideUnlockedRetention(true)); | ||
|
|
||
| System.out.println("Retention policy for object " + objectName + " was updated to:"); | ||
| System.out.println(storage.get(blobId).getRetention().toString()); | ||
| } | ||
| } | ||
|
|
||
| // [END storage_set_object_retention_policy] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters