@@ -177,16 +177,16 @@ public Builder addRow(RowToInsert rowToInsert) {
* Adds a row to be inserted with associated id.
*
* Example usage of adding a row with associated id:
- *
{@code
- * InsertAllRequest.Builder builder = InsertAllRequest.builder(tableId);
- * List repeatedFieldValue = Arrays.asList(1L, 2L);
- * Map recordContent = new HashMap();
- * recordContent.put("subfieldName1", "value");
- * recordContent.put("subfieldName2", repeatedFieldValue);
- * Map rowContent = new HashMap();
- * rowContent.put("fieldName1", true);
- * rowContent.put("fieldName2", recordContent);
- * builder.addRow("rowId", rowContent);
+ * {@code
+ * InsertAllRequest.Builder builder = InsertAllRequest.builder(tableId);
+ * List repeatedFieldValue = Arrays.asList(1L, 2L);
+ * Map recordContent = new HashMap();
+ * recordContent.put("subfieldName1", "value");
+ * recordContent.put("subfieldName2", repeatedFieldValue);
+ * Map rowContent = new HashMap();
+ * rowContent.put("fieldName1", true);
+ * rowContent.put("fieldName2", recordContent);
+ * builder.addRow("rowId", rowContent);
* }
*/
public Builder addRow(String id, Map content) {
@@ -198,16 +198,16 @@ public Builder addRow(String id, Map content) {
* Adds a row to be inserted without an associated id.
*
* Example usage of adding a row without an associated id:
- *
{@code
- * InsertAllRequest.Builder builder = InsertAllRequest.builder(tableId);
- * List repeatedFieldValue = Arrays.asList(1L, 2L);
- * Map recordContent = new HashMap();
- * recordContent.put("subfieldName1", "value");
- * recordContent.put("subfieldName2", repeatedFieldValue);
- * Map rowContent = new HashMap();
- * rowContent.put("fieldName1", true);
- * rowContent.put("fieldName2", recordContent);
- * builder.addRow(rowContent);
+ * {@code
+ * InsertAllRequest.Builder builder = InsertAllRequest.builder(tableId);
+ * List repeatedFieldValue = Arrays.asList(1L, 2L);
+ * Map recordContent = new HashMap();
+ * recordContent.put("subfieldName1", "value");
+ * recordContent.put("subfieldName2", repeatedFieldValue);
+ * Map rowContent = new HashMap();
+ * rowContent.put("fieldName1", true);
+ * rowContent.put("fieldName2", recordContent);
+ * builder.addRow(rowContent);
* }
*/
public Builder addRow(Map content) {
diff --git a/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/Job.java b/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/Job.java
index c0d7ddc29c37..1e63344a600d 100644
--- a/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/Job.java
+++ b/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/Job.java
@@ -18,50 +18,102 @@
import static com.google.common.base.Preconditions.checkNotNull;
+import java.io.IOException;
+import java.io.ObjectInputStream;
+import java.util.Objects;
+
/**
* A Google BigQuery Job.
*
* Objects of this class are immutable. To get a {@code Job} object with the most recent
- * information use {@link #reload}.
+ * information use {@link #reload}. {@code Job} adds a layer of service-related functionality over
+ * {@link JobInfo}.
*
*/
-public final class Job {
+public final class Job extends JobInfo {
- private final BigQuery bigquery;
- private final JobInfo info;
+ private static final long serialVersionUID = -4324100991693024704L;
- /**
- * Constructs a {@code Job} object for the provided {@code JobInfo}. The BigQuery service
- * is used to issue requests.
- *
- * @param bigquery the BigQuery service used for issuing requests
- * @param info jobs's info
- */
- public Job(BigQuery bigquery, JobInfo info) {
- this.bigquery = checkNotNull(bigquery);
- this.info = checkNotNull(info);
- }
+ private final BigQueryOptions options;
+ private transient BigQuery bigquery;
/**
- * Creates a {@code Job} object for the provided job's user-defined id. Performs an RPC call to
- * get the latest job information.
- *
- * @param bigquery the BigQuery service used for issuing requests
- * @param job job's id, either user-defined or picked by the BigQuery service
- * @param options job options
- * @return the {@code Job} object or {@code null} if not found
- * @throws BigQueryException upon failure
+ * A builder for {@code Job} objects.
*/
- public static Job get(BigQuery bigquery, String job, BigQuery.JobOption... options) {
- JobInfo info = bigquery.getJob(job, options);
- return info != null ? new Job(bigquery, info) : null;
+ public static final class Builder extends JobInfo.Builder {
+
+ private final BigQuery bigquery;
+ private final JobInfo.BuilderImpl infoBuilder;
+
+ Builder(BigQuery bigquery, JobConfiguration configuration) {
+ this.bigquery = bigquery;
+ this.infoBuilder = new JobInfo.BuilderImpl();
+ this.infoBuilder.configuration(configuration);
+ }
+
+ Builder(Job job) {
+ this.bigquery = job.bigquery;
+ this.infoBuilder = new JobInfo.BuilderImpl(job);
+ }
+
+ @Override
+ Builder etag(String etag) {
+ infoBuilder.etag(etag);
+ return this;
+ }
+
+ @Override
+ Builder id(String id) {
+ infoBuilder.id(id);
+ return this;
+ }
+
+ @Override
+ public Builder jobId(JobId jobId) {
+ infoBuilder.jobId(jobId);
+ return this;
+ }
+
+ @Override
+ Builder selfLink(String selfLink) {
+ infoBuilder.selfLink(selfLink);
+ return this;
+ }
+
+ @Override
+ Builder status(JobStatus status) {
+ infoBuilder.status(status);
+ return this;
+ }
+
+ @Override
+ Builder statistics(JobStatistics statistics) {
+ infoBuilder.statistics(statistics);
+ return this;
+ }
+
+ @Override
+ Builder userEmail(String userEmail) {
+ infoBuilder.userEmail(userEmail);
+ return this;
+ }
+
+ @Override
+ public Builder configuration(JobConfiguration configuration) {
+ infoBuilder.configuration(configuration);
+ return this;
+ }
+
+ @Override
+ public Job build() {
+ return new Job(bigquery, infoBuilder);
+ }
}
- /**
- * Returns the job's information.
- */
- public JobInfo info() {
- return info;
+ Job(BigQuery bigquery, JobInfo.BuilderImpl infoBuilder) {
+ super(infoBuilder);
+ this.bigquery = checkNotNull(bigquery);
+ this.options = bigquery.options();
}
/**
@@ -71,7 +123,7 @@ public JobInfo info() {
* @throws BigQueryException upon failure
*/
public boolean exists() {
- return bigquery.getJob(info.jobId(), BigQuery.JobOption.fields()) != null;
+ return bigquery.getJob(jobId(), BigQuery.JobOption.fields()) != null;
}
/**
@@ -90,8 +142,7 @@ public boolean exists() {
* @throws BigQueryException upon failure
*/
public boolean isDone() {
- JobInfo job = bigquery.getJob(info.jobId(),
- BigQuery.JobOption.fields(BigQuery.JobField.STATUS));
+ Job job = bigquery.getJob(jobId(), BigQuery.JobOption.fields(BigQuery.JobField.STATUS));
return job != null && job.status().state() == JobStatus.State.DONE;
}
@@ -103,7 +154,7 @@ public boolean isDone() {
* @throws BigQueryException upon failure
*/
public Job reload(BigQuery.JobOption... options) {
- return Job.get(bigquery, info.jobId().job(), options);
+ return bigquery.getJob(jobId().job(), options);
}
/**
@@ -114,7 +165,7 @@ public Job reload(BigQuery.JobOption... options) {
* @throws BigQueryException upon failure
*/
public boolean cancel() {
- return bigquery.cancel(info.jobId());
+ return bigquery.cancel(jobId());
}
/**
@@ -123,4 +174,30 @@ public boolean cancel() {
public BigQuery bigquery() {
return bigquery;
}
+
+ @Override
+ public Builder toBuilder() {
+ return new Builder(this);
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ return obj instanceof Job
+ && Objects.equals(toPb(), ((Job) obj).toPb())
+ && Objects.equals(options, ((Job) obj).options);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(super.hashCode(), options);
+ }
+
+ private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {
+ in.defaultReadObject();
+ this.bigquery = options.service();
+ }
+
+ static Job fromPb(BigQuery bigquery, com.google.api.services.bigquery.model.Job jobPb) {
+ return new Job(bigquery, new JobInfo.BuilderImpl(jobPb));
+ }
}
diff --git a/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/JobInfo.java b/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/JobInfo.java
index 47135b6d97d0..1adf7fabafc1 100644
--- a/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/JobInfo.java
+++ b/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/JobInfo.java
@@ -32,7 +32,7 @@
*
* @see Jobs
*/
-public final class JobInfo implements Serializable {
+public class JobInfo implements Serializable {
static final Function FROM_PB_FUNCTION =
new Function() {
@@ -41,8 +41,18 @@ public JobInfo apply(Job pb) {
return JobInfo.fromPb(pb);
}
};
+
private static final long serialVersionUID = -3272941007234620265L;
+ private final String etag;
+ private final String id;
+ private final JobId jobId;
+ private final String selfLink;
+ private final JobStatus status;
+ private final JobStatistics statistics;
+ private final String userEmail;
+ private final JobConfiguration configuration;
+
/**
* Specifies whether the job is allowed to create new tables.
*/
@@ -78,16 +88,44 @@ public enum WriteDisposition {
WRITE_EMPTY
}
- private final String etag;
- private final String id;
- private final JobId jobId;
- private final String selfLink;
- private final JobStatus status;
- private final JobStatistics statistics;
- private final String userEmail;
- private final JobConfiguration configuration;
+ /**
+ * A builder for {@code JobInfo} objects.
+ */
+ public abstract static class Builder {
+
+ abstract Builder etag(String etag);
+
+ abstract Builder id(String id);
+
+ /**
+ * Sets the job identity.
+ */
+ public abstract Builder jobId(JobId jobId);
+
+ abstract Builder selfLink(String selfLink);
+
+ abstract Builder status(JobStatus status);
+
+ abstract Builder statistics(JobStatistics statistics);
- public static final class Builder {
+ abstract Builder userEmail(String userEmail);
+
+ /**
+ * Sets a configuration for the {@code JobInfo} object. Use {@link CopyJobConfiguration} for a
+ * job that copies an existing table. Use {@link ExtractJobConfiguration} for a job that exports
+ * a table to Google Cloud Storage. Use {@link LoadJobConfiguration} for a job that loads data
+ * from Google Cloud Storage into a table. Use {@link QueryJobConfiguration} for a job that runs
+ * a query.
+ */
+ public abstract Builder configuration(JobConfiguration configuration);
+
+ /**
+ * Creates a {@code JobInfo} object.
+ */
+ public abstract JobInfo build();
+ }
+
+ static final class BuilderImpl extends Builder {
private String etag;
private String id;
@@ -98,9 +136,9 @@ public static final class Builder {
private String userEmail;
private JobConfiguration configuration;
- private Builder() {}
+ BuilderImpl() {}
- private Builder(JobInfo jobInfo) {
+ BuilderImpl(JobInfo jobInfo) {
this.etag = jobInfo.etag;
this.id = jobInfo.id;
this.jobId = jobInfo.jobId;
@@ -111,7 +149,7 @@ private Builder(JobInfo jobInfo) {
this.configuration = jobInfo.configuration;
}
- protected Builder(Job jobPb) {
+ BuilderImpl(Job jobPb) {
this.etag = jobPb.getEtag();
this.id = jobPb.getId();
if (jobPb.getJobReference() != null) {
@@ -128,55 +166,61 @@ protected Builder(Job jobPb) {
this.configuration = JobConfiguration.fromPb(jobPb.getConfiguration());
}
+ @Override
Builder etag(String etag) {
this.etag = etag;
return this;
}
+ @Override
Builder id(String id) {
this.id = id;
return this;
}
- /**
- * Sets the job identity.
- */
+ @Override
public Builder jobId(JobId jobId) {
this.jobId = jobId;
return this;
}
+ @Override
Builder selfLink(String selfLink) {
this.selfLink = selfLink;
return this;
}
+ @Override
Builder status(JobStatus status) {
this.status = status;
return this;
}
+ @Override
Builder statistics(JobStatistics statistics) {
this.statistics = statistics;
return this;
}
+ @Override
Builder userEmail(String userEmail) {
this.userEmail = userEmail;
return this;
}
+ @Override
public Builder configuration(JobConfiguration configuration) {
this.configuration = configuration;
return this;
}
+ @Override
public JobInfo build() {
return new JobInfo(this);
}
}
- private JobInfo(Builder builder) {
+ JobInfo(BuilderImpl builder) {
this.jobId = builder.jobId;
this.etag = builder.etag;
this.id = builder.id;
@@ -248,10 +292,10 @@ public C configuration() {
}
/**
- * Returns a builder for the job.
+ * Returns a builder for the job object.
*/
public Builder toBuilder() {
- return new Builder(this);
+ return new BuilderImpl(this);
}
@Override
@@ -275,7 +319,9 @@ public int hashCode() {
@Override
public boolean equals(Object obj) {
- return obj instanceof JobInfo && Objects.equals(toPb(), ((JobInfo) obj).toPb());
+ return obj != null
+ && obj.getClass().equals(JobInfo.class)
+ && Objects.equals(toPb(), ((JobInfo) obj).toPb());
}
JobInfo setProjectId(String projectId) {
@@ -301,19 +347,40 @@ Job toPb() {
return jobPb;
}
+ /**
+ * Returns a builder for a {@code JobInfo} object given the job configuration. Use
+ * {@link CopyJobConfiguration} for a job that copies an existing table. Use
+ * {@link ExtractJobConfiguration} for a job that exports a table to Google Cloud Storage. Use
+ * {@link LoadJobConfiguration} for a job that loads data from Google Cloud Storage into a table.
+ * Use {@link QueryJobConfiguration} for a job that runs a query.
+ */
public static Builder builder(JobConfiguration configuration) {
- return new Builder().configuration(configuration);
+ return new BuilderImpl().configuration(configuration);
}
+ /**
+ * Returns a {@code JobInfo} object given the job configuration. Use {@link CopyJobConfiguration}
+ * for a job that copies an existing table. Use {@link ExtractJobConfiguration} for a job that
+ * exports a table to Google Cloud Storage. Use {@link LoadJobConfiguration} for a job that loads
+ * data from Google Cloud Storage into a table. Use {@link QueryJobConfiguration} for a job that
+ * runs a query.
+ */
public static JobInfo of(JobConfiguration configuration) {
return builder(configuration).build();
}
+ /**
+ * Returns a builder for a {@code JobInfo} object given the job identity and configuration. Use
+ * {@link CopyJobConfiguration} for a job that copies an existing table. Use
+ * {@link ExtractJobConfiguration} for a job that exports a table to Google Cloud Storage. Use
+ * {@link LoadJobConfiguration} for a job that loads data from Google Cloud Storage into a table.
+ * Use {@link QueryJobConfiguration} for a job that runs a query.
+ */
public static JobInfo of(JobId jobId, JobConfiguration configuration) {
return builder(configuration).jobId(jobId).build();
}
static JobInfo fromPb(Job jobPb) {
- return new Builder(jobPb).build();
+ return new BuilderImpl(jobPb).build();
}
}
diff --git a/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/LoadJobConfiguration.java b/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/LoadJobConfiguration.java
index 1f98a3dfaca1..9c9fa7a769b6 100644
--- a/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/LoadJobConfiguration.java
+++ b/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/LoadJobConfiguration.java
@@ -282,6 +282,7 @@ LoadJobConfiguration setProjectId(String projectId) {
return toBuilder().destinationTable(destinationTable().setProjectId(projectId)).build();
}
+ @Override
com.google.api.services.bigquery.model.JobConfiguration toPb() {
JobConfigurationLoad loadConfigurationPb = new JobConfigurationLoad();
loadConfigurationPb.setDestinationTable(destinationTable.toPb());
diff --git a/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/QueryJobConfiguration.java b/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/QueryJobConfiguration.java
index 94c16de149ed..688611d07526 100644
--- a/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/QueryJobConfiguration.java
+++ b/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/QueryJobConfiguration.java
@@ -472,6 +472,7 @@ QueryJobConfiguration setProjectId(String projectId) {
return builder.build();
}
+ @Override
com.google.api.services.bigquery.model.JobConfiguration toPb() {
com.google.api.services.bigquery.model.JobConfiguration configurationPb =
new com.google.api.services.bigquery.model.JobConfiguration();
diff --git a/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/QueryRequest.java b/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/QueryRequest.java
index 0bcfb3d4a9ae..5f99f3c5b4ee 100644
--- a/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/QueryRequest.java
+++ b/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/QueryRequest.java
@@ -35,26 +35,26 @@
* {@link QueryResponse#jobCompleted()} returns {@code true}.
*
* Example usage of a query request:
- *
{@code
- * // Substitute "field", "table" and "dataset" with real field, table and dataset identifiers
- * QueryRequest request = QueryRequest.builder("SELECT field FROM table")
- * .defaultDataset(DatasetId.of("dataset"))
- * .maxWaitTime(60000L)
- * .maxResults(1000L)
- * .build();
- * QueryResponse response = bigquery.query(request);
- * while (!response.jobCompleted()) {
- * Thread.sleep(1000);
- * response = bigquery.getQueryResults(response.jobId());
- * }
- * List executionErrors = response.executionErrors();
- * // look for errors in executionErrors
- * QueryResult result = response.result();
- * Iterator> rowIterator = result.iterateAll();
- * while(rowIterator.hasNext()) {
- * List row = rowIterator.next();
- * // do something with row
- * }
+ * {@code
+ * // Substitute "field", "table" and "dataset" with real field, table and dataset identifiers
+ * QueryRequest request = QueryRequest.builder("SELECT field FROM table")
+ * .defaultDataset(DatasetId.of("dataset"))
+ * .maxWaitTime(60000L)
+ * .maxResults(1000L)
+ * .build();
+ * QueryResponse response = bigquery.query(request);
+ * while (!response.jobCompleted()) {
+ * Thread.sleep(1000);
+ * response = bigquery.getQueryResults(response.jobId());
+ * }
+ * List executionErrors = response.executionErrors();
+ * // look for errors in executionErrors
+ * QueryResult result = response.result();
+ * Iterator> rowIterator = result.iterateAll();
+ * while(rowIterator.hasNext()) {
+ * List row = rowIterator.next();
+ * // do something with row
+ * }
* }
*
* @see Query
diff --git a/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/QueryResponse.java b/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/QueryResponse.java
index 77386747754f..12000cc1cbd2 100644
--- a/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/QueryResponse.java
+++ b/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/QueryResponse.java
@@ -29,20 +29,20 @@
* Query Request ({@link BigQuery#query(QueryRequest)}).
*
* Example usage of a query response:
- *
{@code
- * QueryResponse response = bigquery.query(request);
- * while (!response.jobCompleted()) {
- * Thread.sleep(1000);
- * response = bigquery.getQueryResults(response.jobId());
- * }
- * List executionErrors = response.executionErrors();
- * // look for errors in executionErrors
- * QueryResult result = response.result();
- * Iterator> rowIterator = result.iterateAll();
- * while(rowIterator.hasNext()) {
- * List row = rowIterator.next();
- * // do something with row
- * }
+ * {@code
+ * QueryResponse response = bigquery.query(request);
+ * while (!response.jobCompleted()) {
+ * Thread.sleep(1000);
+ * response = bigquery.getQueryResults(response.jobId());
+ * }
+ * List executionErrors = response.executionErrors();
+ * // look for errors in executionErrors
+ * QueryResult result = response.result();
+ * Iterator> rowIterator = result.iterateAll();
+ * while(rowIterator.hasNext()) {
+ * List row = rowIterator.next();
+ * // do something with row
+ * }
* }
*
* @see Get Query
diff --git a/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/StandardTableDefinition.java b/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/StandardTableDefinition.java
index d6e8f0176609..d0e49157a99c 100644
--- a/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/StandardTableDefinition.java
+++ b/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/StandardTableDefinition.java
@@ -26,10 +26,11 @@
import java.util.Objects;
/**
- * A Google BigQuery default table type. This type is used for standard, two-dimensional tables with
- * individual records organized in rows, and a data type assigned to each column (also called a
- * field). Individual fields within a record may contain nested and repeated children fields. Every
- * table is described by a schema that describes field names, types, and other information.
+ * A Google BigQuery default table definition. This definition is used for standard, two-dimensional
+ * tables with individual records organized in rows, and a data type assigned to each column (also
+ * called a field). Individual fields within a record may contain nested and repeated children
+ * fields. Every table is described by a schema that describes field names, types, and other
+ * information.
*
* @see Managing Tables
*/
@@ -218,14 +219,14 @@ public StreamingBuffer streamingBuffer() {
}
/**
- * Returns a builder for a BigQuery default table type.
+ * Returns a builder for a BigQuery standard table definition.
*/
public static Builder builder() {
return new Builder();
}
/**
- * Creates a BigQuery default table type given its schema.
+ * Creates a BigQuery standard table definition given its schema.
*
* @param schema the schema of the table
*/
diff --git a/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/Table.java b/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/Table.java
index cb45c52afd7e..3f902d2ff242 100644
--- a/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/Table.java
+++ b/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/Table.java
@@ -16,12 +16,13 @@
package com.google.gcloud.bigquery;
-import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;
import com.google.common.collect.ImmutableList;
import com.google.gcloud.Page;
+import java.io.IOException;
+import java.io.ObjectInputStream;
import java.util.List;
import java.util.Objects;
@@ -30,62 +31,106 @@
*
* Objects of this class are immutable. Operations that modify the table like {@link #update}
* return a new object. To get a {@code Table} object with the most recent information use
- * {@link #reload}.
+ * {@link #reload}. {@code Table} adds a layer of service-related functionality over
+ * {@link TableInfo}.
*
*/
-public final class Table {
+public final class Table extends TableInfo {
- private final BigQuery bigquery;
- private final TableInfo info;
+ private static final long serialVersionUID = 5744556727066570096L;
- /**
- * Constructs a {@code Table} object for the provided {@code TableInfo}. The BigQuery service
- * is used to issue requests.
- *
- * @param bigquery the BigQuery service used for issuing requests
- * @param info table's info
- */
- public Table(BigQuery bigquery, TableInfo info) {
- this.bigquery = checkNotNull(bigquery);
- this.info = checkNotNull(info);
- }
+ private final BigQueryOptions options;
+ private transient BigQuery bigquery;
/**
- * Creates a {@code Table} object for the provided dataset and table's user-defined ids. Performs
- * an RPC call to get the latest table information.
- *
- * @param bigquery the BigQuery service used for issuing requests
- * @param dataset the dataset's user-defined id
- * @param table the table's user-defined id
- * @param options table options
- * @return the {@code Table} object or {@code null} if not found
- * @throws BigQueryException upon failure
+ * A builder for {@code Table} objects.
*/
- public static Table get(BigQuery bigquery, String dataset, String table,
- BigQuery.TableOption... options) {
- return get(bigquery, TableId.of(dataset, table), options);
- }
+ public static class Builder extends TableInfo.Builder {
- /**
- * Creates a {@code Table} object for the provided table identity. Performs an RPC call to get the
- * latest table information.
- *
- * @param bigquery the BigQuery service used for issuing requests
- * @param table the table's identity
- * @param options table options
- * @return the {@code Table} object or {@code null} if not found
- * @throws BigQueryException upon failure
- */
- public static Table get(BigQuery bigquery, TableId table, BigQuery.TableOption... options) {
- TableInfo info = bigquery.getTable(table, options);
- return info != null ? new Table(bigquery, info) : null;
+ private final BigQuery bigquery;
+ private final TableInfo.BuilderImpl infoBuilder;
+
+ Builder(BigQuery bigquery, TableId tableId, TableDefinition defintion) {
+ this.bigquery = bigquery;
+ this.infoBuilder = new TableInfo.BuilderImpl();
+ this.infoBuilder.tableId(tableId).definition(defintion);
+ }
+
+ Builder(Table table) {
+ this.bigquery = table.bigquery;
+ this.infoBuilder = new TableInfo.BuilderImpl(table);
+ }
+
+ @Override
+ Builder creationTime(Long creationTime) {
+ infoBuilder.creationTime(creationTime);
+ return this;
+ }
+
+ @Override
+ public Builder description(String description) {
+ infoBuilder.description(description);
+ return this;
+ }
+
+ @Override
+ Builder etag(String etag) {
+ infoBuilder.etag(etag);
+ return this;
+ }
+
+ @Override
+ public Builder expirationTime(Long expirationTime) {
+ infoBuilder.expirationTime(expirationTime);
+ return this;
+ }
+
+ @Override
+ public Builder friendlyName(String friendlyName) {
+ infoBuilder.friendlyName(friendlyName);
+ return this;
+ }
+
+ @Override
+ Builder id(String id) {
+ infoBuilder.id(id);
+ return this;
+ }
+
+ @Override
+ Builder lastModifiedTime(Long lastModifiedTime) {
+ infoBuilder.lastModifiedTime(lastModifiedTime);
+ return this;
+ }
+
+ @Override
+ Builder selfLink(String selfLink) {
+ infoBuilder.selfLink(selfLink);
+ return this;
+ }
+
+ @Override
+ public Builder tableId(TableId tableId) {
+ infoBuilder.tableId(tableId);
+ return this;
+ }
+
+ @Override
+ public Builder definition(TableDefinition definition) {
+ infoBuilder.definition(definition);
+ return this;
+ }
+
+ @Override
+ public Table build() {
+ return new Table(bigquery, infoBuilder);
+ }
}
- /**
- * Returns the table's information.
- */
- public TableInfo info() {
- return info;
+ Table(BigQuery bigquery, TableInfo.BuilderImpl infoBuilder) {
+ super(infoBuilder);
+ this.bigquery = checkNotNull(bigquery);
+ this.options = bigquery.options();
}
/**
@@ -95,7 +140,7 @@ public TableInfo info() {
* @throws BigQueryException upon failure
*/
public boolean exists() {
- return bigquery.getTable(info.tableId(), BigQuery.TableOption.fields()) != null;
+ return bigquery.getTable(tableId(), BigQuery.TableOption.fields()) != null;
}
/**
@@ -106,25 +151,19 @@ public boolean exists() {
* @throws BigQueryException upon failure
*/
public Table reload(BigQuery.TableOption... options) {
- return Table.get(bigquery, info.tableId(), options);
+ return bigquery.getTable(tableId(), options);
}
/**
- * Updates the table's information. Dataset's and table's user-defined ids cannot be changed. A
- * new {@code Table} object is returned.
+ * Updates the table's information with this table's information. Dataset's and table's
+ * user-defined ids cannot be changed. A new {@code Table} object is returned.
*
- * @param tableInfo new table's information. Dataset's and table's user-defined ids must match the
- * ones of the current table
* @param options dataset options
* @return a {@code Table} object with updated information
* @throws BigQueryException upon failure
*/
- public Table update(TableInfo tableInfo, BigQuery.TableOption... options) {
- checkArgument(Objects.equals(tableInfo.tableId().dataset(),
- info.tableId().dataset()), "Dataset's user-defined ids must match");
- checkArgument(Objects.equals(tableInfo.tableId().table(),
- info.tableId().table()), "Table's user-defined ids must match");
- return new Table(bigquery, bigquery.update(tableInfo, options));
+ public Table update(BigQuery.TableOption... options) {
+ return bigquery.update(this, options);
}
/**
@@ -134,7 +173,7 @@ public Table update(TableInfo tableInfo, BigQuery.TableOption... options) {
* @throws BigQueryException upon failure
*/
public boolean delete() {
- return bigquery.delete(info.tableId());
+ return bigquery.delete(tableId());
}
/**
@@ -143,8 +182,9 @@ public boolean delete() {
* @param rows rows to be inserted
* @throws BigQueryException upon failure
*/
- InsertAllResponse insert(Iterable rows) throws BigQueryException {
- return bigquery.insertAll(InsertAllRequest.of(info.tableId(), rows));
+ public InsertAllResponse insert(Iterable rows)
+ throws BigQueryException {
+ return bigquery.insertAll(InsertAllRequest.of(tableId(), rows));
}
/**
@@ -158,9 +198,9 @@ InsertAllResponse insert(Iterable rows) throws Big
* to be invalid
* @throws BigQueryException upon failure
*/
- InsertAllResponse insert(Iterable rows, boolean skipInvalidRows,
- boolean ignoreUnknownValues) throws BigQueryException {
- InsertAllRequest request = InsertAllRequest.builder(info.tableId(), rows)
+ public InsertAllResponse insert(Iterable rows,
+ boolean skipInvalidRows, boolean ignoreUnknownValues) throws BigQueryException {
+ InsertAllRequest request = InsertAllRequest.builder(tableId(), rows)
.skipInvalidRows(skipInvalidRows)
.ignoreUnknownValues(ignoreUnknownValues)
.build();
@@ -173,8 +213,9 @@ InsertAllResponse insert(Iterable rows, boolean sk
* @param options table data list options
* @throws BigQueryException upon failure
*/
- Page> list(BigQuery.TableDataListOption... options) throws BigQueryException {
- return bigquery.listTableData(info.tableId(), options);
+ public Page> list(BigQuery.TableDataListOption... options)
+ throws BigQueryException {
+ return bigquery.listTableData(tableId(), options);
}
/**
@@ -186,7 +227,7 @@ Page> list(BigQuery.TableDataListOption... options) throws BigQ
* @param options job options
* @throws BigQueryException upon failure
*/
- Job copy(String destinationDataset, String destinationTable, BigQuery.JobOption... options)
+ public Job copy(String destinationDataset, String destinationTable, BigQuery.JobOption... options)
throws BigQueryException {
return copy(TableId.of(destinationDataset, destinationTable), options);
}
@@ -199,9 +240,10 @@ Job copy(String destinationDataset, String destinationTable, BigQuery.JobOption.
* @param options job options
* @throws BigQueryException upon failure
*/
- Job copy(TableId destinationTable, BigQuery.JobOption... options) throws BigQueryException {
- CopyJobConfiguration configuration = CopyJobConfiguration.of(destinationTable, info.tableId());
- return new Job(bigquery, bigquery.create(JobInfo.of(configuration), options));
+ public Job copy(TableId destinationTable, BigQuery.JobOption... options)
+ throws BigQueryException {
+ CopyJobConfiguration configuration = CopyJobConfiguration.of(destinationTable, tableId());
+ return bigquery.create(JobInfo.of(configuration), options);
}
/**
@@ -214,7 +256,7 @@ Job copy(TableId destinationTable, BigQuery.JobOption... options) throws BigQuer
* @param options job options
* @throws BigQueryException upon failure
*/
- Job extract(String format, String destinationUri, BigQuery.JobOption... options)
+ public Job extract(String format, String destinationUri, BigQuery.JobOption... options)
throws BigQueryException {
return extract(format, ImmutableList.of(destinationUri), options);
}
@@ -229,11 +271,11 @@ Job extract(String format, String destinationUri, BigQuery.JobOption... options)
* @param options job options
* @throws BigQueryException upon failure
*/
- Job extract(String format, List destinationUris, BigQuery.JobOption... options)
+ public Job extract(String format, List destinationUris, BigQuery.JobOption... options)
throws BigQueryException {
ExtractJobConfiguration extractConfiguration =
- ExtractJobConfiguration.of(info.tableId(), destinationUris, format);
- return new Job(bigquery, bigquery.create(JobInfo.of(extractConfiguration), options));
+ ExtractJobConfiguration.of(tableId(), destinationUris, format);
+ return bigquery.create(JobInfo.of(extractConfiguration), options);
}
/**
@@ -246,7 +288,7 @@ Job extract(String format, List destinationUris, BigQuery.JobOption... o
* @param options job options
* @throws BigQueryException upon failure
*/
- Job load(FormatOptions format, String sourceUri, BigQuery.JobOption... options)
+ public Job load(FormatOptions format, String sourceUri, BigQuery.JobOption... options)
throws BigQueryException {
return load(format, ImmutableList.of(sourceUri), options);
}
@@ -261,10 +303,10 @@ Job load(FormatOptions format, String sourceUri, BigQuery.JobOption... options)
* @param options job options
* @throws BigQueryException upon failure
*/
- Job load(FormatOptions format, List sourceUris, BigQuery.JobOption... options)
+ public Job load(FormatOptions format, List sourceUris, BigQuery.JobOption... options)
throws BigQueryException {
- LoadJobConfiguration loadConfig = LoadJobConfiguration.of(info.tableId(), sourceUris, format);
- return new Job(bigquery, bigquery.create(JobInfo.of(loadConfig), options));
+ LoadJobConfiguration loadConfig = LoadJobConfiguration.of(tableId(), sourceUris, format);
+ return bigquery.create(JobInfo.of(loadConfig), options);
}
/**
@@ -273,4 +315,30 @@ Job load(FormatOptions format, List sourceUris, BigQuery.JobOption... op
public BigQuery bigquery() {
return bigquery;
}
+
+ @Override
+ public Builder toBuilder() {
+ return new Builder(this);
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ return obj instanceof Table
+ && Objects.equals(toPb(), ((Table) obj).toPb())
+ && Objects.equals(options, ((Table) obj).options);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(super.hashCode(), options);
+ }
+
+ private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {
+ in.defaultReadObject();
+ this.bigquery = options.service();
+ }
+
+ static Table fromPb(BigQuery bigquery, com.google.api.services.bigquery.model.Table tablePb) {
+ return new Table(bigquery, new TableInfo.BuilderImpl(tablePb));
+ }
}
diff --git a/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/TableDataWriteChannel.java b/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/TableDataWriteChannel.java
index bee0340a29a8..9c6a950ca27f 100644
--- a/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/TableDataWriteChannel.java
+++ b/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/TableDataWriteChannel.java
@@ -53,6 +53,7 @@ public void run() {
}
}
+ @Override
protected StateImpl.Builder stateBuilder() {
return StateImpl.builder(options(), entity(), uploadId());
}
diff --git a/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/TableDefinition.java b/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/TableDefinition.java
index de858f54ac43..26e7bcc76f55 100644
--- a/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/TableDefinition.java
+++ b/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/TableDefinition.java
@@ -25,7 +25,7 @@
import java.util.Objects;
/**
- * Base class for a Google BigQuery table type.
+ * Base class for a Google BigQuery table definition.
*/
public abstract class TableDefinition implements Serializable {
@@ -63,10 +63,10 @@ public enum Type {
}
/**
- * Base builder for table types.
+ * Base builder for table definitions.
*
- * @param the table type class
- * @param the table type builder
+ * @param the table definition class
+ * @param the table definition builder
*/
public abstract static class Builder> {
@@ -152,8 +152,8 @@ final int baseHashCode() {
return Objects.hash(type);
}
- final boolean baseEquals(TableDefinition jobConfiguration) {
- return Objects.equals(toPb(), jobConfiguration.toPb());
+ final boolean baseEquals(TableDefinition tableDefinition) {
+ return Objects.equals(toPb(), tableDefinition.toPb());
}
Table toPb() {
diff --git a/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/TableInfo.java b/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/TableInfo.java
index 814b8cac1e97..de331350e978 100644
--- a/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/TableInfo.java
+++ b/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/TableInfo.java
@@ -23,7 +23,6 @@
import com.google.api.services.bigquery.model.Table;
import com.google.common.base.Function;
import com.google.common.base.MoreObjects;
-import com.google.common.base.MoreObjects.ToStringHelper;
import java.io.Serializable;
import java.math.BigInteger;
@@ -36,7 +35,7 @@
*
* @see Managing Tables
*/
-public final class TableInfo implements Serializable {
+public class TableInfo implements Serializable {
static final Function FROM_PB_FUNCTION =
new Function() {
@@ -67,9 +66,55 @@ public Table apply(TableInfo tableInfo) {
private final TableDefinition definition;
/**
- * Builder for tables.
+ * A builder for {@code TableInfo} objects.
*/
- public static class Builder {
+ public abstract static class Builder {
+
+ abstract Builder creationTime(Long creationTime);
+
+ /**
+ * Sets a user-friendly description for the table.
+ */
+ public abstract Builder description(String description);
+
+ abstract Builder etag(String etag);
+
+ /**
+ * Sets the time when this table expires, in milliseconds since the epoch. If not present, the
+ * table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.
+ */
+ public abstract Builder expirationTime(Long expirationTime);
+
+ /**
+ * Sets a user-friendly name for the table.
+ */
+ public abstract Builder friendlyName(String friendlyName);
+
+ abstract Builder id(String id);
+
+ abstract Builder lastModifiedTime(Long lastModifiedTime);
+
+ abstract Builder selfLink(String selfLink);
+
+ /**
+ * Sets the table identity.
+ */
+ public abstract Builder tableId(TableId tableId);
+
+ /**
+ * Sets the table definition. Use {@link StandardTableDefinition} to create simple BigQuery
+ * table. Use {@link ViewDefinition} to create a BigQuery view. Use
+ * {@link ExternalTableDefinition} to create a BigQuery a table backed by external data.
+ */
+ public abstract Builder definition(TableDefinition definition);
+
+ /**
+ * Creates a {@code TableInfo} object.
+ */
+ public abstract TableInfo build();
+ }
+
+ static class BuilderImpl extends Builder {
private String etag;
private String id;
@@ -82,9 +127,9 @@ public static class Builder {
private Long lastModifiedTime;
private TableDefinition definition;
- private Builder() {}
+ BuilderImpl() {}
- private Builder(TableInfo tableInfo) {
+ BuilderImpl(TableInfo tableInfo) {
this.etag = tableInfo.etag;
this.id = tableInfo.id;
this.selfLink = tableInfo.selfLink;
@@ -97,7 +142,7 @@ private Builder(TableInfo tableInfo) {
this.definition = tableInfo.definition;
}
- private Builder(Table tablePb) {
+ BuilderImpl(Table tablePb) {
this.tableId = TableId.fromPb(tablePb.getTableReference());
if (tablePb.getLastModifiedTime() != null) {
this.lastModifiedTime(tablePb.getLastModifiedTime().longValue());
@@ -112,83 +157,73 @@ private Builder(Table tablePb) {
this.definition = TableDefinition.fromPb(tablePb);
}
+ @Override
Builder creationTime(Long creationTime) {
this.creationTime = creationTime;
return this;
}
- /**
- * Sets a user-friendly description for the table.
- */
+ @Override
public Builder description(String description) {
this.description = firstNonNull(description, Data.nullOf(String.class));
return this;
}
+ @Override
Builder etag(String etag) {
this.etag = etag;
return this;
}
- /**
- * Sets the time when this table expires, in milliseconds since the epoch. If not present, the
- * table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.
- */
+ @Override
public Builder expirationTime(Long expirationTime) {
this.expirationTime = firstNonNull(expirationTime, Data.nullOf(Long.class));
return this;
}
- /**
- * Sets a user-friendly name for the table.
- */
+ @Override
public Builder friendlyName(String friendlyName) {
this.friendlyName = firstNonNull(friendlyName, Data.nullOf(String.class));
return this;
}
+ @Override
Builder id(String id) {
this.id = id;
return this;
}
+ @Override
Builder lastModifiedTime(Long lastModifiedTime) {
this.lastModifiedTime = lastModifiedTime;
return this;
}
+ @Override
Builder selfLink(String selfLink) {
this.selfLink = selfLink;
return this;
}
- /**
- * Sets the table identity.
- */
+ @Override
public Builder tableId(TableId tableId) {
this.tableId = checkNotNull(tableId);
return this;
}
- /**
- * Sets the table definition. Use {@link StandardTableDefinition} to create simple BigQuery
- * table. Use {@link ViewDefinition} to create a BigQuery view. Use
- * {@link ExternalTableDefinition} to create a BigQuery a table backed by external data.
- */
+ @Override
public Builder definition(TableDefinition definition) {
this.definition = checkNotNull(definition);
return this;
}
- /**
- * Creates a {@code TableInfo} object.
- */
+ @Override
public TableInfo build() {
return new TableInfo(this);
}
}
- private TableInfo(Builder builder) {
+ TableInfo(BuilderImpl builder) {
this.tableId = checkNotNull(builder.tableId);
this.etag = builder.etag;
this.id = builder.id;
@@ -275,13 +310,14 @@ public T definition() {
}
/**
- * Returns a builder for the object.
+ * Returns a builder for the table object.
*/
public Builder toBuilder() {
- return new Builder(this);
+ return new BuilderImpl(this);
}
- ToStringHelper toStringHelper() {
+ @Override
+ public String toString() {
return MoreObjects.toStringHelper(this)
.add("tableId", tableId)
.add("etag", etag)
@@ -292,12 +328,8 @@ ToStringHelper toStringHelper() {
.add("expirationTime", expirationTime)
.add("creationTime", creationTime)
.add("lastModifiedTime", lastModifiedTime)
- .add("definition", definition);
- }
-
- @Override
- public String toString() {
- return toStringHelper().toString();
+ .add("definition", definition)
+ .toString();
}
@Override
@@ -307,18 +339,26 @@ public int hashCode() {
@Override
public boolean equals(Object obj) {
- return obj instanceof TableInfo && Objects.equals(toPb(), ((TableInfo) obj).toPb());
+ return obj != null
+ && obj.getClass().equals(TableInfo.class)
+ && Objects.equals(toPb(), ((TableInfo) obj).toPb());
}
/**
- * Returns a builder for a {@code TableInfo} object given table identity and definition.
+ * Returns a builder for a {@code TableInfo} object given table identity and definition. Use
+ * {@link StandardTableDefinition} to create simple BigQuery table. Use {@link ViewDefinition} to
+ * create a BigQuery view. Use {@link ExternalTableDefinition} to create a BigQuery a table backed
+ * by external data.
*/
public static Builder builder(TableId tableId, TableDefinition definition) {
- return new Builder().tableId(tableId).definition(definition);
+ return new BuilderImpl().tableId(tableId).definition(definition);
}
/**
- * Returns a {@code TableInfo} object given table identity and definition.
+ * Returns a {@code TableInfo} object given table identity and definition. Use
+ * {@link StandardTableDefinition} to create simple BigQuery table. Use {@link ViewDefinition} to
+ * create a BigQuery view. Use {@link ExternalTableDefinition} to create a BigQuery a table backed
+ * by external data.
*/
public static TableInfo of(TableId tableId, TableDefinition definition) {
return builder(tableId, definition).build();
@@ -345,6 +385,6 @@ Table toPb() {
}
static TableInfo fromPb(Table tablePb) {
- return new Builder(tablePb).build();
+ return new BuilderImpl(tablePb).build();
}
}
diff --git a/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/ViewDefinition.java b/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/ViewDefinition.java
index 7065bcc155d2..796dd411b4a1 100644
--- a/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/ViewDefinition.java
+++ b/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/ViewDefinition.java
@@ -27,8 +27,9 @@
import java.util.Objects;
/**
- * Google BigQuery view table type. BigQuery's views are logical views, not materialized views,
- * which means that the query that defines the view is re-executed every time the view is queried.
+ * Google BigQuery view table definition. BigQuery's views are logical views, not materialized
+ * views, which means that the query that defines the view is re-executed every time the view is
+ * queried.
*
* @see Views
*/
@@ -168,7 +169,7 @@ Table toPb() {
}
/**
- * Returns a builder for a BigQuery view type.
+ * Returns a builder for a BigQuery view definition.
*
* @param query the query used to generate the view
*/
@@ -177,7 +178,7 @@ public static Builder builder(String query) {
}
/**
- * Returns a builder for a BigQuery view type.
+ * Returns a builder for a BigQuery view definition.
*
* @param query the query used to generate the table
* @param functions user-defined functions that can be used by the query
@@ -187,7 +188,7 @@ public static Builder builder(String query, List functions)
}
/**
- * Returns a builder for a BigQuery view type.
+ * Returns a builder for a BigQuery view definition.
*
* @param query the query used to generate the table
* @param functions user-defined functions that can be used by the query
@@ -197,7 +198,7 @@ public static Builder builder(String query, UserDefinedFunction... functions) {
}
/**
- * Creates a BigQuery view type given the query used to generate the table.
+ * Creates a BigQuery view definition given the query used to generate the table.
*
* @param query the query used to generate the table
*/
@@ -206,7 +207,7 @@ public static ViewDefinition of(String query) {
}
/**
- * Creates a BigQuery view type given a query and some user-defined functions.
+ * Creates a BigQuery view definition given a query and some user-defined functions.
*
* @param query the query used to generate the table
* @param functions user-defined functions that can be used by the query
@@ -216,7 +217,7 @@ public static ViewDefinition of(String query, List function
}
/**
- * Creates a BigQuery view type given a query and some user-defined functions.
+ * Creates a BigQuery view definition given a query and some user-defined functions.
*
* @param query the query used to generate the table
* @param functions user-defined functions that can be used by the query
diff --git a/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/WriteChannelConfiguration.java b/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/WriteChannelConfiguration.java
index 18342bac1bff..6cc44ce7d5d6 100644
--- a/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/WriteChannelConfiguration.java
+++ b/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/WriteChannelConfiguration.java
@@ -155,6 +155,7 @@ public Builder projectionFields(List projectionFields) {
return this;
}
+ @Override
public WriteChannelConfiguration build() {
return new WriteChannelConfiguration(this);
}
diff --git a/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/package-info.java b/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/package-info.java
index a249768f9d8d..db5e956e0a12 100644
--- a/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/package-info.java
+++ b/gcloud-java-bigquery/src/main/java/com/google/gcloud/bigquery/package-info.java
@@ -17,30 +17,29 @@
/**
* A client to Google Cloud BigQuery.
*
- * A simple usage example:
+ *
A simple usage example showing how to create a table if it does not exist and load data into
+ * it. For the complete source code see
+ *
+ * CreateTableAndLoadData.java.
*
{@code
* BigQuery bigquery = BigQueryOptions.defaultInstance().service();
* TableId tableId = TableId.of("dataset", "table");
- * TableInfo info = bigquery.getTable(tableId);
- * if (info == null) {
+ * Table table = bigquery.getTable(tableId);
+ * if (table == null) {
* System.out.println("Creating table " + tableId);
* Field integerField = Field.of("fieldName", Field.Type.integer());
* Schema schema = Schema.of(integerField);
- * bigquery.create(TableInfo.of(tableId, StandardTableDefinition.of(schema)));
+ * table = bigquery.create(TableInfo.of(tableId, StandardTableDefinition.of(schema)));
+ * }
+ * System.out.println("Loading data into table " + tableId);
+ * Job loadJob = table.load(FormatOptions.csv(), "gs://bucket/path");
+ * while (!loadJob.isDone()) {
+ * Thread.sleep(1000L);
+ * }
+ * if (loadJob.status().error() != null) {
+ * System.out.println("Job completed with errors");
* } else {
- * System.out.println("Loading data into table " + tableId);
- * LoadJobConfiguration configuration = LoadJobConfiguration.of(tableId, "gs://bucket/path");
- * JobInfo loadJob = JobInfo.of(configuration);
- * loadJob = bigquery.create(loadJob);
- * while (loadJob.status().state() != JobStatus.State.DONE) {
- * Thread.sleep(1000L);
- * loadJob = bigquery.getJob(loadJob.jobId());
- * }
- * if (loadJob.status().error() != null) {
- * System.out.println("Job completed with errors");
- * } else {
- * System.out.println("Job succeeded");
- * }
+ * System.out.println("Job succeeded");
* }}
*
* @see Google Cloud BigQuery
diff --git a/gcloud-java-bigquery/src/main/java/com/google/gcloud/spi/BigQueryRpc.java b/gcloud-java-bigquery/src/main/java/com/google/gcloud/spi/BigQueryRpc.java
index 6062e19950e0..a1935e5ab136 100644
--- a/gcloud-java-bigquery/src/main/java/com/google/gcloud/spi/BigQueryRpc.java
+++ b/gcloud-java-bigquery/src/main/java/com/google/gcloud/spi/BigQueryRpc.java
@@ -100,7 +100,7 @@ public Y y() {
*
* @throws BigQueryException upon failure
*/
- Dataset getDataset(String datasetId, Map options) throws BigQueryException;
+ Dataset getDataset(String datasetId, Map options);
/**
* Lists the project's datasets. Partial information is returned on a dataset (datasetReference,
@@ -108,13 +108,28 @@ public Y y() {
*
* @throws BigQueryException upon failure
*/
- Tuple> listDatasets(Map options) throws BigQueryException;
+ Tuple> listDatasets(Map options);
- Dataset create(Dataset dataset, Map options) throws BigQueryException;
+ /**
+ * Creates a new dataset.
+ *
+ * @throws BigQueryException upon failure
+ */
+ Dataset create(Dataset dataset, Map options);
- Table create(Table table, Map options) throws BigQueryException;
+ /**
+ * Creates a new table.
+ *
+ * @throws BigQueryException upon failure
+ */
+ Table create(Table table, Map options);
- Job create(Job job, Map options) throws BigQueryException;
+ /**
+ * Creates a new job.
+ *
+ * @throws BigQueryException upon failure
+ */
+ Job create(Job job, Map options);
/**
* Delete the requested dataset.
@@ -122,18 +137,28 @@ public Y y() {
* @return {@code true} if dataset was deleted, {@code false} if it was not found
* @throws BigQueryException upon failure
*/
- boolean deleteDataset(String datasetId, Map options) throws BigQueryException;
+ boolean deleteDataset(String datasetId, Map options);
- Dataset patch(Dataset dataset, Map options) throws BigQueryException;
+ /**
+ * Updates dataset information.
+ *
+ * @throws BigQueryException upon failure
+ */
+ Dataset patch(Dataset dataset, Map options);
- Table patch(Table table, Map options) throws BigQueryException;
+ /**
+ * Updates table information.
+ *
+ * @throws BigQueryException upon failure
+ */
+ Table patch(Table table, Map options);
/**
* Returns the requested table or {@code null} if not found.
*
* @throws BigQueryException upon failure
*/
- Table getTable(String datasetId, String tableId, Map options) throws BigQueryException;
+ Table getTable(String datasetId, String tableId, Map options);
/**
* Lists the dataset's tables. Partial information is returned on a table (tableReference,
@@ -141,8 +166,7 @@ public Y y() {
*
* @throws BigQueryException upon failure
*/
- Tuple> listTables(String dataset, Map options)
- throws BigQueryException;
+ Tuple> listTables(String dataset, Map options);
/**
* Delete the requested table.
@@ -150,27 +174,37 @@ Tuple> listTables(String dataset, Map options
* @return {@code true} if table was deleted, {@code false} if it was not found
* @throws BigQueryException upon failure
*/
- boolean deleteTable(String datasetId, String tableId) throws BigQueryException;
+ boolean deleteTable(String datasetId, String tableId);
+ /**
+ * Sends an insert all request.
+ *
+ * @throws BigQueryException upon failure
+ */
TableDataInsertAllResponse insertAll(String datasetId, String tableId,
- TableDataInsertAllRequest request) throws BigQueryException;
+ TableDataInsertAllRequest request);
+ /**
+ * Lists the table's rows.
+ *
+ * @throws BigQueryException upon failure
+ */
Tuple> listTableData(String datasetId, String tableId,
- Map options) throws BigQueryException;
+ Map options);
/**
* Returns the requested job or {@code null} if not found.
*
* @throws BigQueryException upon failure
*/
- Job getJob(String jobId, Map options) throws BigQueryException;
+ Job getJob(String jobId, Map options);
/**
* Lists the project's jobs.
*
* @throws BigQueryException upon failure
*/
- Tuple> listJobs(Map options) throws BigQueryException;
+ Tuple> listJobs(Map options);
/**
* Sends a job cancel request. This call will return immediately, and the client will need to poll
@@ -180,12 +214,21 @@ Tuple> listTableData(String datasetId, String tableId
* found
* @throws BigQueryException upon failure
*/
- boolean cancel(String jobId) throws BigQueryException;
+ boolean cancel(String jobId);
- GetQueryResultsResponse getQueryResults(String jobId, Map options)
- throws BigQueryException;
+ /**
+ * Returns results of the query associated with the provided job.
+ *
+ * @throws BigQueryException upon failure
+ */
+ GetQueryResultsResponse getQueryResults(String jobId, Map options);
- QueryResponse query(QueryRequest request) throws BigQueryException;
+ /**
+ * Runs the query associated with the request.
+ *
+ * @throws BigQueryException upon failure
+ */
+ QueryResponse query(QueryRequest request);
/**
* Opens a resumable upload session to load data into a BigQuery table and returns an upload URI.
@@ -193,7 +236,7 @@ GetQueryResultsResponse getQueryResults(String jobId, Map options)
* @param configuration load configuration
* @throws BigQueryException upon failure
*/
- String open(JobConfiguration configuration) throws BigQueryException;
+ String open(JobConfiguration configuration);
/**
* Uploads the provided data to the resumable upload session at the specified position.
@@ -207,5 +250,5 @@ GetQueryResultsResponse getQueryResults(String jobId, Map options)
* @throws BigQueryException upon failure
*/
void write(String uploadId, byte[] toWrite, int toWriteOffset, long destOffset, int length,
- boolean last) throws BigQueryException;
+ boolean last);
}
diff --git a/gcloud-java-bigquery/src/main/java/com/google/gcloud/spi/DefaultBigQueryRpc.java b/gcloud-java-bigquery/src/main/java/com/google/gcloud/spi/DefaultBigQueryRpc.java
index b57f1dc8a128..a5c44129955a 100644
--- a/gcloud-java-bigquery/src/main/java/com/google/gcloud/spi/DefaultBigQueryRpc.java
+++ b/gcloud-java-bigquery/src/main/java/com/google/gcloud/spi/DefaultBigQueryRpc.java
@@ -90,7 +90,7 @@ private static BigQueryException translate(IOException exception) {
}
@Override
- public Dataset getDataset(String datasetId, Map options) throws BigQueryException {
+ public Dataset getDataset(String datasetId, Map options) {
try {
return bigquery.datasets()
.get(this.options.projectId(), datasetId)
@@ -106,8 +106,7 @@ public Dataset getDataset(String datasetId, Map options) throws BigQu
}
@Override
- public Tuple> listDatasets(Map options)
- throws BigQueryException {
+ public Tuple> listDatasets(Map options) {
try {
DatasetList datasetsList = bigquery.datasets()
.list(this.options.projectId())
@@ -135,7 +134,7 @@ public Dataset apply(DatasetList.Datasets datasetPb) {
}
@Override
- public Dataset create(Dataset dataset, Map options) throws BigQueryException {
+ public Dataset create(Dataset dataset, Map