Add storagetransfer samples

cloud-storage/storage-transfer/README.md

@@ -0,0 +1,52 @@
+# Transfer Service sample using Java
+
+This app creates two types of transfers using the Transfer Service tool.
+
+## Prerequisites
+
+1. Set up a project on Google Developers Console.
+  1. Go to the [Developers Console](https://cloud.google.com/console) and create or select your project.
+     You will need the project ID later.
+1. Within Developers Console, select APIs & auth > Credentials.
+  1. Select Add credentials > Service account > JSON key.
+  1. Set the environment variable GOOGLE_APPLICATION_CREDENTIALS to point to your JSON key.
+1. Add the Storage Transfer service account, cloud-mobility@system.gserviceaccount.com as an
+   editor of your project.
+1. Set up gcloud for application default credentials.
+  1. `gcloud components update`
+  1. `gcloud auth login`
+  1. `gcloud config set project PROJECT_ID`
+
+## Transfer from Amazon S3 to Google Cloud Storage
+
+Creating a one-time transfer from Amazon S3 to Google Cloud Storage.
+1. Set up data sink.
+  1. Go to the Developers Console and create a bucket under Cloud Storage > Storage Browser.
+1. Set up data source.
+  1. Go to AWS Management Console and create a bucket.
+  1. Under Security Credentials, create an IAM User with access to the bucket.
+  1. Create an Access Key for the user. Note the Access Key ID and Secret Access Key.
+1. In AwsRequester.java, fill in the user-provided constants.
+1. Run with `mvn compile` and
+   `mvn exec:java -Dexec.mainClass="com.google.cloud.storage.storagetransfer.samples.AwsRequester"`
+  1. Note the job ID in the returned Transfer Job.
+
+## Transfer data from a standard Cloud Storage bucket to a Cloud Storage Nearline bucket
+
+Creating a daily transfer from a standard Cloud Storage bucket to a Cloud Storage Nearline
+bucket for files untouched for 30 days.
+1. Set up data sink.
+  1. Go to the Developers Console and create a bucket under Cloud Storage > Storage Browser.
+  1. Select Nearline for Storage Class.
+1. Set up data source.
+  1. Go to the Developers Console and create a bucket under Cloud Storage > Storage Browser.
+1. In NearlineRequester.java, fill in the user-provided constants.
+1. Run with `mvn compile` and
+   `mvn exec:java -Dexec.mainClass="com.google.cloud.storage.storagetransfer.samples.NearlineRequester"`
+  1. Note the job ID in the returned Transfer Job.
+
+## Checking the status of a transfer
+
+1. In RequestChecker.java, fill in the user-provided constants. Use the Job Name you recorded earlier.
+1. Run with `mvn compile` and
+   `mvn exec:java -Dexec.mainClass="com.google.cloud.storage.storagetransfer.samples.RequestChecker"`

cloud-storage/storage-transfer/pom.xml

@@ -0,0 +1,75 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ Copyright (c) 2015 Google Inc. All Rights Reserved.
+  ~
+  ~ 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.
+  -->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <parent>
+    <artifactId>doc-samples</artifactId>
+    <groupId>com.google.cloud</groupId>
+    <version>1.0.0</version>
+    <relativePath>../..</relativePath>
+  </parent>
+
+  <groupId>com.google.storagetransfer.samples</groupId>
+  <artifactId>transfersample</artifactId>
+  <version>0.1</version>
+  <packaging>jar</packaging>
+
+  <name>transfersample</name>
+  <url>http://maven.apache.org</url>
+
+  <properties>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    <powermock.version>1.6.2</powermock.version>
+  </properties>
+
+  <dependencies>
+    <dependency>
+      <groupId>com.google.apis</groupId>
+      <artifactId>google-api-services-storagetransfer</artifactId>
+      <version>v1-rev1-1.20.0</version>
+    </dependency>
+
+    <!-- Test Dependencies -->
+    <dependency>
+      <groupId>org.powermock</groupId>
+      <artifactId>powermock-module-junit4</artifactId>
+      <version>${powermock.version}</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.powermock</groupId>
+      <artifactId>powermock-api-mockito</artifactId>
+      <version>${powermock.version}</version>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-compiler-plugin</artifactId>
+        <version>3.1</version>
+        <configuration>
+          <source>1.7</source>
+          <target>1.7</target>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+</project>

cloud-storage/storage-transfer/src/main/java/com/google/cloud/storage/storagetransfer/samples/AwsRequester.java

@@ -0,0 +1,104 @@
+/**
+ * Copyright 2015 Google Inc. All Rights Reserved.
+ *
+ * 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.google.cloud.storage.storagetransfer.samples;
+
+import com.google.api.services.storagetransfer.Storagetransfer;
+import com.google.api.services.storagetransfer.model.AwsAccessKey;
+import com.google.api.services.storagetransfer.model.AwsS3Data;
+import com.google.api.services.storagetransfer.model.Date;
+import com.google.api.services.storagetransfer.model.GcsData;
+import com.google.api.services.storagetransfer.model.Schedule;
+import com.google.api.services.storagetransfer.model.TimeOfDay;
+import com.google.api.services.storagetransfer.model.TransferJob;
+import com.google.api.services.storagetransfer.model.TransferSpec;
+
+import java.io.IOException;
+import java.util.logging.Logger;
+
+/**
+ * Creates a one-off transfer job from Amazon S3 to Google Cloud Storage.
+ */
+public final class AwsRequester {
+
+  private static final String JOB_DESC = "YOUR DESCRIPTION";
+  private static final String PROJECT_ID = "YOUR_PROJECT_ID";
+  private static final String AWS_SOURCE_NAME = "YOUR SOURCE BUCKET";
+  private static final String AWS_ACCESS_KEY_ID = "YOUR_ACCESS_KEY_ID";
+  private static final String AWS_SECRET_ACCESS_KEY = "YOUR_SECRET_ACCESS_KEY";
+  private static final String GCS_SINK_NAME = "YOUR_SINK_BUCKET";
+
+  /**
+   * Specify times below using US Pacific Time Zone.
+   */
+  private static final String START_DATE = "YYYY-MM-DD";
+  private static final String START_TIME = "HH:MM:SS";
+
+  private static final Logger LOG = Logger.getLogger(AwsRequester.class.getName());
+
+  /**
+   * Creates and executes a request for a TransferJob from Amazon S3 to Cloud Storage.
+   *
+   * @return the response TransferJob if the request is successful
+   * @throws InstantiationException
+   *           if instantiation fails when building the TransferJob
+   * @throws IllegalAccessException
+   *           if an illegal access occurs when building the TransferJob
+   * @throws IOException
+   *           if the client failed to complete the request
+   */
+  public static TransferJob createAwsTransferJob() throws InstantiationException,
+    IllegalAccessException, IOException {
+    Date date = TransferJobUtils.createDate(START_DATE);
+    TimeOfDay time = TransferJobUtils.createTimeOfDay(START_TIME);
+    TransferJob transferJob = TransferJob.class
+        .newInstance()
+        .setDescription(JOB_DESC)
+        .setProjectId(PROJECT_ID)
+        .setTransferSpec(
+        TransferSpec.class
+          .newInstance()
+          .setAwsS3DataSource(
+            AwsS3Data.class
+              .newInstance()
+              .setBucketName(AWS_SOURCE_NAME)
+              .setAwsAccessKey(
+                AwsAccessKey.class.newInstance().setAccessKeyId(AWS_ACCESS_KEY_ID)
+                  .setSecretAccessKey(AWS_SECRET_ACCESS_KEY)))
+          .setGcsDataSink(GcsData.class.newInstance().setBucketName(GCS_SINK_NAME)))
+        .setSchedule(
+        Schedule.class.newInstance().setScheduleStartDate(date).setScheduleEndDate(date)
+          .setStartTimeOfDay(time)).setStatus("ENABLED");
+
+    Storagetransfer client = TransferClientCreator.createStorageTransferClient();
+    return client.transferJobs().create(transferJob).execute();
+  }
+
+  /**
+   * Output the contents of a successfully created TransferJob.
+   *
+   * @param args
+   *          arguments from the command line
+   */
+  public static void main(String[] args) {
+    try {
+      TransferJob responseT = createAwsTransferJob();
+      LOG.info("Return transferJob: " + responseT.toPrettyString());
+    } catch (Exception e) {
+      e.printStackTrace();
+    }
+  }
+}

cloud-storage/storage-transfer/src/main/java/com/google/cloud/storage/storagetransfer/samples/NearlineRequester.java

@@ -0,0 +1,101 @@
+/**
+ * Copyright 2015 Google Inc. All Rights Reserved.
+ *
+ * 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.google.cloud.storage.storagetransfer.samples;
+
+import com.google.api.services.storagetransfer.Storagetransfer;
+import com.google.api.services.storagetransfer.model.Date;
+import com.google.api.services.storagetransfer.model.GcsData;
+import com.google.api.services.storagetransfer.model.ObjectConditions;
+import com.google.api.services.storagetransfer.model.Schedule;
+import com.google.api.services.storagetransfer.model.TimeOfDay;
+import com.google.api.services.storagetransfer.model.TransferJob;
+import com.google.api.services.storagetransfer.model.TransferOptions;
+import com.google.api.services.storagetransfer.model.TransferSpec;
+
+import java.io.IOException;
+import java.util.logging.Logger;
+
+/**
+ * Creates a daily transfer from a standard Cloud Storage bucket to a Cloud Storage Nearline
+ * bucket for files untouched for 30 days. 
+ */
+public final class NearlineRequester {
+
+  private static final String JOB_DESC = "YOUR DESCRIPTION";
+  private static final String PROJECT_ID = "YOUR_PROJECT_ID";
+  private static final String GCS_SOURCE_NAME = "YOUR_SOURCE_BUCKET";
+  private static final String NEARLINE_SINK_NAME = "YOUR_SINK_BUCKET";
+
+  /**
+   * Specify times below using US Pacific Time Zone.
+   */
+  private static final String START_DATE = "YYYY-MM-DD";
+  private static final String START_TIME = "HH:MM:SS";
+
+  private static final Logger LOG = Logger.getLogger(AwsRequester.class.getName());
+
+  /**
+   * Creates and executes a request for a TransferJob to Cloud Storage Nearline.
+   *
+   * @return the response TransferJob if the request is successful
+   * @throws InstantiationException
+   *           if instantiation fails when building the TransferJob
+   * @throws IllegalAccessException
+   *           if an illegal access occurs when building the TransferJob
+   * @throws IOException
+   *           if the client failed to complete the request
+   */
+  public static TransferJob createNearlineTransferJob() throws InstantiationException,
+    IllegalAccessException, IOException {
+    Date date = TransferJobUtils.createDate(START_DATE);
+    TimeOfDay time = TransferJobUtils.createTimeOfDay(START_TIME);
+    TransferJob transferJob = TransferJob.class
+        .newInstance()
+        .setDescription(JOB_DESC)
+        .setProjectId(PROJECT_ID)
+        .setTransferSpec(
+        TransferSpec.class
+          .newInstance()
+          .setGcsDataSource(GcsData.class.newInstance().setBucketName(GCS_SOURCE_NAME))
+          .setGcsDataSink(GcsData.class.newInstance().setBucketName(NEARLINE_SINK_NAME))
+          .setObjectConditions(
+            ObjectConditions.class.newInstance().setMinTimeElapsedSinceLastModification("2592000s"))
+          .setTransferOptions(
+            TransferOptions.class.newInstance().setDeleteObjectsFromSourceAfterTransfer(true)))
+        .setSchedule(Schedule.class.newInstance().setScheduleStartDate(date)
+          .setStartTimeOfDay(time))
+        .setStatus("ENABLED");
+
+    Storagetransfer client = TransferClientCreator.createStorageTransferClient();
+    return client.transferJobs().create(transferJob).execute();
+  }
+
+  /**
+   * Output the contents of a successfully created TransferJob.
+   *
+   * @param args
+   *          arguments from the command line
+   */
+  public static void main(String[] args) {
+    try {
+      TransferJob responseT = createNearlineTransferJob();
+      LOG.info("Return transferJob: " + responseT.toPrettyString());
+    } catch (Exception e) {
+      e.printStackTrace();
+    }
+  }
+}