docs: Copy all storage samples from java-docs-samples (#1258)

* Copy all storage samples from java-docs-samples * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * use gcloud-devel testing account * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix cleanup config * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix cfg * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix cfg and owlbot * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix csek and request pays tests * fix cfg and owlbot ignore * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix requester pays samples * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix download requester pays sample * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix system out capture * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix disable requester pays sample * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix label and kms tests * add remaining samples and tests * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix hmac cleanup * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix snippet output capture * fix standardOut reset * Fix standard out capture * increase retry backoff multiplier * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix UBLA sample and HMAC service account * fix copyright header formatting * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix checkstyle * add sleeps for hmac tests * use java docs samples testing account * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix snapshot dependency * fix kms resource * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix hmac list test * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * add sleeps to fix 429 errors * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix hmac service account * Fix hmac service account * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix standard out * fix bucket retention test * fix checkstyle * Add comment about setout * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix acl sample comments * 🦉 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>

Author: JesseLovelace

.kokoro/nightly/samples.cfg

@@ -43,3 +43,4 @@ env_vars: {
  key: "IT_SERVICE_ACCOUNT_EMAIL"
  value: "samples@java-docs-samples-testing.iam.gserviceaccount.com"
 }
+

.kokoro/presubmit/integration.cfg

@@ -28,11 +28,12 @@ env_vars: {
 }
 
 env_vars: {
- key: "IT_SERVICE_ACCOUNT_EMAIL"
- value: "it-service-account@gcloud-devel.iam.gserviceaccount.com"
+ key: "SECRET_MANAGER_KEYS"
+ value: "java-it-service-account"
 }
 
 env_vars: {
- key: "SECRET_MANAGER_KEYS"
- value: "java-it-service-account"
+ key: "IT_SERVICE_ACCOUNT_EMAIL"
+ value: "it-service-account@gcloud-devel.iam.gserviceaccount.com"
 }
+

.kokoro/presubmit/samples.cfg

@@ -38,3 +38,4 @@ env_vars: {
  key: "IT_SERVICE_ACCOUNT_EMAIL"
  value: "samples@java-docs-samples-testing.iam.gserviceaccount.com"
 }
+

CONTRIBUTING.md

@@ -48,18 +48,17 @@ integration tests.
 
 ```bash
 export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service/account.json
-export IT_SERVICE_ACCOUNT_EMAIL=my-service-account@my-project.iam.gserviceaccount.com
 mvn -Penable-integration-tests clean verify
 ```
 
 ## Code Samples
 
-Code Samples must be bundled in separate Maven modules, and guarded by a
-Maven profile with the name `enable-samples`.
+All code samples must be in compliance with the [java sample formatting guide][3].
+Code Samples must be bundled in separate Maven modules.
 
 The samples must be separate from the primary project for a few reasons:
-1. Primary projects have a minimum Java version of Java 7 whereas samples have
- a minimum Java version of Java 8. Due to this we need the ability to
+1. Primary projects have a minimum Java version of Java 8 whereas samples can have
+ Java version of Java 11. Due to this we need the ability to
  selectively exclude samples from a build run.
 2. Many code samples depend on external GCP services and need
  credentials to access the service.
@@ -69,39 +68,16 @@ The samples must be separate from the primary project for a few reasons:
 ### Building
 
 ```bash
-mvn -Penable-samples clean verify
+mvn clean verify
 ```
 
 Some samples require access to GCP services and require a service account:
 
 ```bash
 export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service/account.json
-mvn -Penable-samples clean verify
+mvn clean verify
 ```
 
-### Profile Config
-
-1. To add samples in a profile to your Maven project, add the following to your
-`pom.xml`
-
- ```xml
- <project>
-  [...]
-  <profiles>
-  <profile>
-  <id>enable-samples</id>
-  <modules>
-  <module>sample</module>
-  </modules>
-  </profile>
-  </profiles>
-  [...]
- </project>
- ```
-
-2. [Activate](#profile-activation) the profile.
-3. Define your samples in a normal Maven project in the `samples/` directory.
-
 ### Code Formatting
 
 Code in this repo is formatted with
@@ -111,30 +87,6 @@ To run formatting on your project, you can run:
 mvn com.coveo:fmt-maven-plugin:format
 ```
 
-### Profile Activation
-
-To include code samples when building and testing the project, enable the 
-`enable-samples` Maven profile.
-
-#### Command line
-
-To activate the Maven profile on the command line add `-Penable-samples` to your
-Maven command.
-
-#### Maven `settings.xml`
-
-To activate the Maven profile in your `~/.m2/settings.xml` add an entry of
-`enable-samples` following the instructions in [Active Profiles][2].
-
-This method has the benefit of applying to all projects you build (and is
-respected by IntelliJ IDEA) and is recommended if you are going to be
-contributing samples to several projects.
-
-#### IntelliJ IDEA
-
-To activate the Maven Profile inside IntelliJ IDEA, follow the instructions in
-[Activate Maven profiles][3] to activate `enable-samples`.
-
 [1]: https://cloud.google.com/docs/authentication/getting-started#creating_a_service_account
 [2]: https://maven.apache.org/settings.html#Active_Profiles
-[3]: https://www.jetbrains.com/help/idea/work-with-maven-profiles.html#activate_maven_profiles
+[3]: https://github.com/GoogleCloudPlatform/java-docs-samples/blob/main/SAMPLE_FORMAT.md

README.md

@@ -3017,7 +3017,7 @@ private void retentionPolicyLockRequesterPays(boolean requesterPays)
  storage.update(bucketInfo, Storage.BucketTargetOption.userProject(projectId));
  assertFalse(updateBucket.requesterPays());
  }
- RemoteStorageHelper.forceDelete(storage, bucketName, 5, TimeUnit.SECONDS);
+ RemoteStorageHelper.forceDelete(storage, bucketName, 5, TimeUnit.SECONDS, projectId);
  }
  }
 

google-cloud-storage/src/test/java/com/google/cloud/storage/it/ITStorageTest.java

@@ -45,6 +45,18 @@
  <version>1.1.3</version>
  <scope>test</scope>
  </dependency>
+ <dependency>
+ <groupId>org.apache.httpcomponents</groupId>
+ <artifactId>httpclient</artifactId>
+ <version>4.5.13</version>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.httpcomponents</groupId>
+ <artifactId>httpmime</artifactId>
+ <version>4.5.13</version>
+ <scope>test</scope>
+ </dependency>
  </dependencies>
 
  <!-- compile and run all snippet tests -->

samples/install-without-bom/pom.xml

@@ -28,7 +28,7 @@
  <dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-storage</artifactId>
- <version>2.4.5</version>
+ <version>2.4.6-SNAPSHOT</version>
  </dependency>
 
  <dependency>
@@ -43,6 +43,12 @@
  <version>1.1.3</version>
  <scope>test</scope>
  </dependency>
+ <dependency>
+ <groupId>org.apache.httpcomponents</groupId>
+ <artifactId>httpmime</artifactId>
+ <version>4.5.13</version>
+ <scope>test</scope>
+ </dependency>
  </dependencies>
  <!-- {x-version-update-end} -->
 

samples/snapshot/pom.xml

@@ -0,0 +1,83 @@
+/*
+ * Copyright 2020 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;
+
+// [START storage_generate_signed_post_policy_v4]
+
+import com.google.cloud.storage.BlobInfo;
+import com.google.cloud.storage.PostPolicyV4;
+import com.google.cloud.storage.Storage;
+import com.google.cloud.storage.StorageOptions;
+import java.util.Map;
+import java.util.concurrent.TimeUnit;
+
+public class GenerateSignedPostPolicyV4 {
+ /**
+ * Generating a signed POST policy requires Credentials which implement ServiceAccountSigner.
+ * These can be set explicitly using the Storage.PostPolicyV4Option.signWith(ServiceAccountSigner)
+ * option. If you don't, you could also pass a service account signer to StorageOptions, i.e.
+ * StorageOptions().newBuilder().setCredentials(ServiceAccountSignerCredentials). In this example,
+ * neither of these options are used, which means the following code only works when the
+ * credentials are defined via the environment variable GOOGLE_APPLICATION_CREDENTIALS, and those
+ * credentials are authorized to sign a policy. See the documentation for
+ * Storage.generateSignedPostPolicyV4 for more details.
+ */
+ public static void generateSignedPostPolicyV4(
+ String projectId, String bucketName, String blobName) {
+ // The ID of your GCP project
+ // String projectId = "your-project-id";
+
+ // The ID of the GCS bucket to upload to
+ // String bucketName = "your-bucket-name"
+
+ // The name to give the object uploaded to GCS
+ // String blobName = "your-object-name"
+
+ Storage storage = StorageOptions.newBuilder().setProjectId(projectId).build().getService();
+
+ PostPolicyV4.PostFieldsV4 fields =
+ PostPolicyV4.PostFieldsV4.newBuilder().setCustomMetadataField("test", "data").build();
+
+ PostPolicyV4 policy =
+ storage.generateSignedPostPolicyV4(
+ BlobInfo.newBuilder(bucketName, blobName).build(), 10, TimeUnit.MINUTES, fields);
+
+ StringBuilder htmlForm =
+ new StringBuilder(
+ "<form action='"
+ + policy.getUrl()
+ + "' method='POST' enctype='multipart/form-data'>\n");
+ for (Map.Entry<String, String> entry : policy.getFields().entrySet()) {
+ htmlForm.append(
+ " <input name='"
+ + entry.getKey()
+ + "' value='"
+ + entry.getValue()
+ + "' type='hidden' />\n");
+ }
+ htmlForm.append(" <input type='file' name='file'/><br />\n");
+ htmlForm.append(" <input type='submit' value='Upload File'/><br />\n");
+ htmlForm.append("</form>\n");
+
+ System.out.println(
+ "You can use the following HTML form to upload an object to bucket "
+ + bucketName
+ + " for the next ten minutes:");
+ System.out.println(htmlForm.toString());
+ }
+}
+// [END storage_generate_signed_post_policy_v4]

samples/snippets/src/main/java/com/example/storage/GenerateSignedPostPolicyV4.java

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2020 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;
+
+// [START storage_get_service_account]
+import com.google.cloud.storage.ServiceAccount;
+import com.google.cloud.storage.Storage;
+import com.google.cloud.storage.StorageOptions;
+
+public class GetServiceAccount {
+ public static void getServiceAccount(String projectId) {
+ // The ID of your GCP project
+ // String projectId = "your-project-id";
+
+ Storage storage = StorageOptions.newBuilder().setProjectId(projectId).build().getService();
+ ServiceAccount serviceAccount = storage.getServiceAccount(projectId);
+ System.out.println(
+ "The GCS service account for project " + projectId + " is: " + serviceAccount.getEmail());
+ }
+}
+// [END storage_get_service_account]