Storage: Bucket metadata sample (googleapis#5800)

JesseLovelace · web-flow · commit 083bdf9d5608 · 2019-08-01T13:58:07.000-07:00
* Bucket metadata sample

* Bucket metadata sample
diff --git a/google-cloud-examples/src/main/java/com/google/cloud/examples/storage/snippets/StorageSnippets.java b/google-cloud-examples/src/main/java/com/google/cloud/examples/storage/snippets/StorageSnippets.java
@@ -64,11 +64,7 @@
 import java.net.URL;
 import java.nio.ByteBuffer;
 import java.nio.file.Path;
-import java.util.Date;
-import java.util.HashMap;
-import java.util.LinkedList;
-import java.util.List;
-import java.util.Map;
+import java.util.*;
 import java.util.concurrent.TimeUnit;
 
 /** This class contains a number of snippets for the {@link Storage} interface. */
@@ -1126,6 +1122,44 @@ public Bucket setDefaultKmsKey(String bucketName, String kmsKeyName) throws Stor
     return bucket;
   }
 
+  /** Example of displaying Bucket metadata */
+  public void getBucketMetadata(String bucketName) throws StorageException {
+    // [START storage_get_bucket_metadata]
+    Storage storage = StorageOptions.getDefaultInstance().getService();
+
+    // The name of a bucket, e.g. "my-bucket"
+    // String bucketName = "my-bucket";
+
+    // Select all fields
+    // Fields can be selected individually e.g. Storage.BucketField.NAME
+    Bucket bucket = storage.get(bucketName, BucketGetOption.fields(Storage.BucketField.values()));
+
+    // Print bucket metadata
+    System.out.println("BucketName: " + bucket.getName());
+    System.out.println("DefaultEventBasedHold: " + bucket.getDefaultEventBasedHold());
+    System.out.println("DefaultKmsKeyName: " + bucket.getDefaultKmsKeyName());
+    System.out.println("Id: " + bucket.getGeneratedId());
+    System.out.println("IndexPage: " + bucket.getIndexPage());
+    System.out.println("Location: " + bucket.getLocation());
+    System.out.println("LocationType: " + bucket.getLocationType());
+    System.out.println("Metageneration: " + bucket.getMetageneration());
+    System.out.println("NotFoundPage: " + bucket.getNotFoundPage());
+    System.out.println("RetentionEffectiveTime: " + bucket.getRetentionEffectiveTime());
+    System.out.println("RetentionPeriod: " + bucket.getRetentionPeriod());
+    System.out.println("RetentionPolicyIsLocked: " + bucket.retentionPolicyIsLocked());
+    System.out.println("RequesterPays: " + bucket.requesterPays());
+    System.out.println("SelfLink: " + bucket.getSelfLink());
+    System.out.println("StorageClass: " + bucket.getStorageClass().name());
+    System.out.println("TimeCreated: " + bucket.getCreateTime());
+    System.out.println("VersioningEnabled: " + bucket.versioningEnabled());
+    if (bucket.getLabels() != null) {
+      System.out.println("\n\n\nLabels:");
+      for (Map.Entry<String, String> label : bucket.getLabels().entrySet()) {
+        System.out.println(label.getKey() + "=" + label.getValue());
+      }
+    }
+    // [END storage_get_bucket_metadata]
+  }
   /** Example of displaying Blob metadata */
   public void getBlobMetadata(String bucketName, String blobName) throws StorageException {
     // [START storage_get_metadata]
diff --git a/google-cloud-examples/src/test/java/com/google/cloud/examples/storage/snippets/ITStorageSnippets.java b/google-cloud-examples/src/test/java/com/google/cloud/examples/storage/snippets/ITStorageSnippets.java
@@ -457,6 +457,41 @@ public void testBlobDownload() throws Exception {
     assertArrayEquals(BLOB_BYTE_CONTENT, readBytes);
   }
 
+  @Test
+  public void testGetBucketMetadata() {
+    Bucket bucket =
+        storage.get(BUCKET, Storage.BucketGetOption.fields(Storage.BucketField.values()));
+    bucket = bucket.toBuilder().setLabels(ImmutableMap.of("k", "v")).build().update();
+    final ByteArrayOutputStream snippetOutputCapture = new ByteArrayOutputStream();
+    System.setOut(new PrintStream(snippetOutputCapture));
+    storageSnippets.getBucketMetadata(BUCKET);
+    String snippetOutput = snippetOutputCapture.toString();
+    System.setOut(System.out);
+    System.out.println(snippetOutput);
+    assertTrue(snippetOutput.contains(("BucketName: " + bucket.getName())));
+    assertTrue(
+        snippetOutput.contains(("DefaultEventBasedHold: " + bucket.getDefaultEventBasedHold())));
+    assertTrue(snippetOutput.contains(("DefaultKmsKeyName: " + bucket.getDefaultKmsKeyName())));
+    assertTrue(snippetOutput.contains(("Id: " + bucket.getGeneratedId())));
+    assertTrue(snippetOutput.contains(("IndexPage: " + bucket.getIndexPage())));
+    assertTrue(snippetOutput.contains(("Location: " + bucket.getLocation())));
+    assertTrue(snippetOutput.contains(("LocationType: " + bucket.getLocationType())));
+    assertTrue(snippetOutput.contains(("Metageneration: " + bucket.getMetageneration())));
+    assertTrue(snippetOutput.contains(("NotFoundPage: " + bucket.getNotFoundPage())));
+    assertTrue(
+        snippetOutput.contains(("RetentionEffectiveTime: " + bucket.getRetentionEffectiveTime())));
+    assertTrue(snippetOutput.contains(("RetentionPeriod: " + bucket.getRetentionPeriod())));
+    assertTrue(
+        snippetOutput.contains(("RetentionPolicyIsLocked: " + bucket.retentionPolicyIsLocked())));
+    assertTrue(snippetOutput.contains(("RequesterPays: " + bucket.requesterPays())));
+    assertTrue(snippetOutput.contains(("SelfLink: " + bucket.getSelfLink())));
+    assertTrue(snippetOutput.contains(("StorageClass: " + bucket.getStorageClass().name())));
+    assertTrue(snippetOutput.contains(("TimeCreated: " + bucket.getCreateTime())));
+    assertTrue(snippetOutput.contains(("VersioningEnabled: " + bucket.versioningEnabled())));
+    assertTrue(snippetOutput.contains("Labels:"));
+    assertTrue(snippetOutput.contains("k=v"));
+  }
+
   @Test
   public void testGetBlobMetadata() {
     String blobName = "test-create-empty-blob";
