Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Adding Samples for Add/Remove Bucket Default Owner (#1260)
* docs: Adding Samples for Add/Remove Bucket Default Owner * 🦉 Updates from OwlBot 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
d82333b
commit 7223626
Showing
6 changed files
with
192 additions
and
2 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
46 changes: 46 additions & 0 deletions
46
samples/snippets/src/main/java/com/example/storage/bucket/AddBucketDefaultOwner.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,46 @@ | ||
| /* | ||
| * 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.bucket; | ||
|
|
||
| // [START storage_add_bucket_default_owner] | ||
|
|
||
| import com.google.cloud.storage.Acl; | ||
| import com.google.cloud.storage.Acl.Role; | ||
| import com.google.cloud.storage.Acl.User; | ||
| import com.google.cloud.storage.Bucket; | ||
| import com.google.cloud.storage.Storage; | ||
| import com.google.cloud.storage.StorageOptions; | ||
|
|
||
| public class AddBucketDefaultOwner { | ||
|
|
||
| public static void addBucketDefaultOwner(String bucketName, String userEmail) { | ||
|
|
||
| // The ID to give your GCS bucket | ||
| // String bucketName = "your-unique-bucket-name"; | ||
|
|
||
| // Email of the user you wish to remove as a default owner | ||
| // String userEmail = "someuser@domain.com" | ||
|
|
||
| Storage storage = StorageOptions.newBuilder().build().getService(); | ||
| Bucket bucket = storage.get(bucketName); | ||
| Acl newDefaultOwner = Acl.of(new User(userEmail), Role.OWNER); | ||
|
|
||
| bucket.createDefaultAcl(newDefaultOwner); | ||
| System.out.println("Added user " + userEmail + " as an owner on " + bucketName); | ||
| } | ||
| } | ||
| // [END storage_add_bucket_default_owner] |
48 changes: 48 additions & 0 deletions
48
samples/snippets/src/main/java/com/example/storage/bucket/RemoveBucketDefaultOwner.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 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.bucket; | ||
|
|
||
| // [START storage_remove_bucket_default_owner] | ||
|
|
||
| import com.google.cloud.storage.Acl.User; | ||
| import com.google.cloud.storage.Bucket; | ||
| import com.google.cloud.storage.Storage; | ||
| import com.google.cloud.storage.StorageOptions; | ||
|
|
||
| public class RemoveBucketDefaultOwner { | ||
|
|
||
| public static void removeBucketDefaultOwner(String bucketName, String userEmail) { | ||
|
|
||
| // The ID to give your GCS bucket | ||
| // String bucketName = "your-unique-bucket-name"; | ||
|
|
||
| // Email of the user you wish to remove as a default owner | ||
| // String userEmail = "someuser@domain.com" | ||
|
|
||
| Storage storage = StorageOptions.newBuilder().build().getService(); | ||
| Bucket bucket = storage.get(bucketName); | ||
| User userToRemove = new User(userEmail); | ||
|
|
||
| boolean success = bucket.deleteDefaultAcl(userToRemove); | ||
| if (success) { | ||
| System.out.println("Removed user " + userEmail + " as an owner on " + bucketName); | ||
| } else { | ||
| System.out.println("User " + userEmail + " was not found"); | ||
| } | ||
| } | ||
| } | ||
| // [END storage_remove_bucket_default_owner] |
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
39 changes: 39 additions & 0 deletions
39
samples/snippets/src/test/java/com/example/storage/bucket/AddBucketDefaultOwnerTest.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,39 @@ | ||
| /* | ||
| * 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.bucket; | ||
|
|
||
| import static com.google.common.truth.Truth.assertThat; | ||
| import static org.junit.Assert.assertNotNull; | ||
|
|
||
| import com.example.storage.TestBase; | ||
| import com.google.cloud.storage.Acl.User; | ||
| import org.junit.Test; | ||
|
|
||
| public class AddBucketDefaultOwnerTest extends TestBase { | ||
|
|
||
| public static final String IT_SERVICE_ACCOUNT_EMAIL = System.getenv("IT_SERVICE_ACCOUNT_EMAIL"); | ||
|
|
||
| @Test | ||
| public void testAddBucketDefaultOwner() { | ||
| // Check for user email before the actual test. | ||
| assertNotNull("Unable to determine user email", IT_SERVICE_ACCOUNT_EMAIL); | ||
|
|
||
| AddBucketDefaultOwner.addBucketDefaultOwner(bucketName, IT_SERVICE_ACCOUNT_EMAIL); | ||
| assertThat(stdOut.getCapturedOutputAsUtf8String()).contains(IT_SERVICE_ACCOUNT_EMAIL); | ||
| assertThat(bucket.getDefaultAcl(new User(IT_SERVICE_ACCOUNT_EMAIL))).isNotNull(); | ||
| } | ||
| } |
54 changes: 54 additions & 0 deletions
54
samples/snippets/src/test/java/com/example/storage/bucket/RemoveBucketDefaultOwnerTest.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,54 @@ | ||
| /* | ||
| * 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.bucket; | ||
|
|
||
| import static com.google.common.truth.Truth.assertThat; | ||
| import static org.junit.Assert.assertNotNull; | ||
|
|
||
| import com.example.storage.TestBase; | ||
| import com.google.cloud.storage.Acl; | ||
| import com.google.cloud.storage.Acl.Role; | ||
| import com.google.cloud.storage.Acl.User; | ||
| import org.junit.Test; | ||
|
|
||
| public class RemoveBucketDefaultOwnerTest extends TestBase { | ||
|
|
||
| public static final String IT_SERVICE_ACCOUNT_EMAIL = System.getenv("IT_SERVICE_ACCOUNT_EMAIL"); | ||
|
|
||
| @Test | ||
| public void testRemoveBucketDefaultOwner() { | ||
| // Check for user email before the actual test. | ||
| assertNotNull("Unable to determine user email", IT_SERVICE_ACCOUNT_EMAIL); | ||
| // Add User as Default Owner | ||
| Acl newDefaultOwner = Acl.of(new User(IT_SERVICE_ACCOUNT_EMAIL), Role.OWNER); | ||
| bucket.createDefaultAcl(newDefaultOwner); | ||
|
|
||
| // Remove User as Default owner | ||
| RemoveBucketDefaultOwner.removeBucketDefaultOwner(bucketName, IT_SERVICE_ACCOUNT_EMAIL); | ||
| assertThat(stdOut.getCapturedOutputAsUtf8String()).contains(IT_SERVICE_ACCOUNT_EMAIL); | ||
| assertThat(stdOut.getCapturedOutputAsUtf8String()).contains("Removed user"); | ||
| assertThat(bucket.getDefaultAcl(new User(IT_SERVICE_ACCOUNT_EMAIL))).isNull(); | ||
| } | ||
|
|
||
| @Test | ||
| public void testUserNotFound() { | ||
| // Remove User without Default Owner Permissions | ||
| RemoveBucketDefaultOwner.removeBucketDefaultOwner(bucketName, IT_SERVICE_ACCOUNT_EMAIL); | ||
| assertThat(stdOut.getCapturedOutputAsUtf8String()).contains(IT_SERVICE_ACCOUNT_EMAIL); | ||
| assertThat(stdOut.getCapturedOutputAsUtf8String()).contains("was not found"); | ||
| } | ||
| } |