Skip to content

Commit 54ac5fe

Browse files
mziccardmziccard
authored
Rename setters/getters/builders for BigQuery classes to meet proto conventions (#1310)
* Rename setters/getters/builders for BigQuery classes to meet proto conventions * Update BigQuery snippets to use renamed getters/setters/builders * Make deprecated methods call renamed ones * Remove useless parentheses from FieldValue
1 parent fff9a44 commit 54ac5fe

File tree

97 files changed

+6248
-2191
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

97 files changed

+6248
-2191
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ if (table == null) {
186186
System.out.println("Loading data into table " + tableId);
187187
Job loadJob = table.load(FormatOptions.csv(), "gs://bucket/path");
188188
loadJob = loadJob.waitFor();
189-
if (loadJob.status().error() != null) {
189+
if (loadJob.getStatus().getError() != null) {
190190
System.out.println("Job completed with errors");
191191
} else {
192192
System.out.println("Job succeeded");

‎TESTING.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ Here is an example that uses the `RemoteBigQueryHelper` to create a dataset.
2727
```java
2828
RemoteBigQueryHelper bigqueryHelper =
2929
RemoteBigQueryHelper.create(PROJECT_ID, new FileInputStream("/path/to/my/JSON/key.json"));
30-
BigQuery bigquery = bigqueryHelper.options().service();
30+
BigQuery bigquery = bigqueryHelper.getOptions().service();
3131
String dataset = RemoteBigQueryHelper.generateDatasetName();
32-
bigquery.create(DatasetInfo.builder(dataset).build());
32+
bigquery.create(DatasetInfo.newBuilder(dataset).build());
3333
```
3434

3535
4. Run your tests.

‎google-cloud-bigquery/README.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Then, to create the dataset, use the following code:
103103
```java
104104
// Create a dataset
105105
String datasetId = "my_dataset_id";
106-
bigquery.create(DatasetInfo.builder(datasetId).build());
106+
bigquery.create(DatasetInfo.newBuilder(datasetId).build());
107107
```
108108

109109
#### Creating a table
@@ -153,7 +153,7 @@ Map<String, Object> secondRow = new HashMap<>();
153153
firstRow.put("StringField", "value1");
154154
secondRow.put("StringField", "value2");
155155
// Create an insert request
156-
InsertAllRequest insertRequest = InsertAllRequest.builder(tableId)
156+
InsertAllRequest insertRequest = InsertAllRequest.newBuilder(tableId)
157157
.addRow(firstRow)
158158
.addRow(secondRow)
159159
.build();
@@ -183,18 +183,18 @@ Then add the following code to run the query and wait for the result:
183183
```java
184184
// Create a query request
185185
QueryRequest queryRequest =
186-
QueryRequest.builder("SELECT * FROM my_dataset_id.my_table_id")
187-
.maxWaitTime(60000L)
188-
.pageSize(1000L)
186+
QueryRequest.newBuilder("SELECT * FROM my_dataset_id.my_table_id")
187+
.setMaxWaitTime(60000L)
188+
.setPageSize(1000L)
189189
.build();
190190
// Request query to be executed and wait for results
191191
QueryResponse queryResponse = bigquery.query(queryRequest);
192192
while (!queryResponse.jobComplete()) {
193193
Thread.sleep(1000L);
194-
queryResponse = bigquery.getQueryResults(queryResponse.jobId());
194+
queryResponse = bigquery.getQueryResults(queryResponse.getJobId());
195195
}
196196
// Read rows
197-
Iterator<List<FieldValue>> rowIterator = queryResponse.result().iterateAll();
197+
Iterator<List<FieldValue>> rowIterator = queryResponse.getResult().iterateAll();
198198
System.out.println("Table rows:");
199199
while (rowIterator.hasNext()) {
200200
System.out.println(rowIterator.next());

‎google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/Acl.java‎

Lines changed: 65 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,12 @@ public enum Type {
8080
this.type = type;
8181
}
8282

83+
@Deprecated
8384
public Type type() {
85+
return getType();
86+
}
87+
88+
public Type getType() {
8489
return type;
8590
}
8691

@@ -129,7 +134,15 @@ public Domain(String domain) {
129134
/**
130135
* Returns the domain name.
131136
*/
137+
@Deprecated
132138
public String domain() {
139+
return getDomain();
140+
}
141+
142+
/**
143+
* Returns the domain name.
144+
*/
145+
public String getDomain() {
133146
return domain;
134147
}
135148

@@ -142,13 +155,13 @@ public boolean equals(Object obj) {
142155
return false;
143156
}
144157
Domain domainEntity = (Domain) obj;
145-
return Objects.equals(type(), domainEntity.type())
146-
&& Objects.equals(domain, domainEntity.domain());
158+
return Objects.equals(getType(), domainEntity.getType())
159+
&& Objects.equals(domain, domainEntity.getDomain());
147160
}
148161

149162
@Override
150163
public int hashCode() {
151-
return Objects.hash(type(), domain);
164+
return Objects.hash(getType(), domain);
152165
}
153166

154167
@Override
@@ -193,7 +206,17 @@ public Group(String identifier) {
193206
* <a href="https://cloud.google.com/bigquery/docs/reference/v2/datasets#access.specialGroup">
194207
* special group identifier</a> or a group email.
195208
*/
209+
@Deprecated
196210
public String identifier() {
211+
return getIdentifier();
212+
}
213+
214+
/**
215+
* Returns group's identifier, can be either a
216+
* <a href="https://cloud.google.com/bigquery/docs/reference/v2/datasets#access.specialGroup">
217+
* special group identifier</a> or a group email.
218+
*/
219+
public String getIdentifier() {
197220
return identifier;
198221
}
199222

@@ -206,12 +229,13 @@ public boolean equals(Object obj) {
206229
return false;
207230
}
208231
Group group = (Group) obj;
209-
return Objects.equals(type(), group.type()) && Objects.equals(identifier, group.identifier);
232+
return Objects.equals(getType(), group.getType())
233+
&& Objects.equals(identifier, group.identifier);
210234
}
211235

212236
@Override
213237
public int hashCode() {
214-
return Objects.hash(type(), identifier);
238+
return Objects.hash(getType(), identifier);
215239
}
216240

217241
@Override
@@ -285,7 +309,15 @@ public User(String email) {
285309
/**
286310
* Returns user's email.
287311
*/
312+
@Deprecated
288313
public String email() {
314+
return getEmail();
315+
}
316+
317+
/**
318+
* Returns user's email.
319+
*/
320+
public String getEmail() {
289321
return email;
290322
}
291323

@@ -298,12 +330,12 @@ public boolean equals(Object obj) {
298330
return false;
299331
}
300332
User user = (User) obj;
301-
return Objects.equals(type(), user.type()) && Objects.equals(email, user.email);
333+
return Objects.equals(getType(), user.getType()) && Objects.equals(email, user.email);
302334
}
303335

304336
@Override
305337
public int hashCode() {
306-
return Objects.hash(type(), email);
338+
return Objects.hash(getType(), email);
307339
}
308340

309341
@Override
@@ -340,7 +372,15 @@ public View(TableId id) {
340372
/**
341373
* Returns table's identity.
342374
*/
375+
@Deprecated
343376
public TableId id() {
377+
return getId();
378+
}
379+
380+
/**
381+
* Returns table's identity.
382+
*/
383+
public TableId getId() {
344384
return id;
345385
}
346386

@@ -353,12 +393,12 @@ public boolean equals(Object obj) {
353393
return false;
354394
}
355395
View view = (View) obj;
356-
return Objects.equals(type(), view.type()) && Objects.equals(id, view.id);
396+
return Objects.equals(getType(), view.getType()) && Objects.equals(id, view.id);
357397
}
358398

359399
@Override
360400
public int hashCode() {
361-
return Objects.hash(type(), id);
401+
return Objects.hash(getType(), id);
362402
}
363403

364404
@Override
@@ -380,14 +420,30 @@ private Acl(Entity entity, Role role) {
380420
/**
381421
* Returns the entity for this ACL.
382422
*/
423+
@Deprecated
383424
public Entity entity() {
425+
return getEntity();
426+
}
427+
428+
/**
429+
* Returns the entity for this ACL.
430+
*/
431+
public Entity getEntity() {
384432
return entity;
385433
}
386434

387435
/**
388436
* Returns the role specified by this ACL.
389437
*/
438+
@Deprecated
390439
public Role role() {
440+
return getRole();
441+
}
442+
443+
/**
444+
* Returns the role specified by this ACL.
445+
*/
446+
public Role getRole() {
391447
return role;
392448
}
393449

‎google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/BigQuery.java‎

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -443,7 +443,7 @@ public static QueryResultsOption maxWaitTime(long maxWaitTime) {
443443
* <pre> {@code
444444
* String datasetName = "my_dataset_name";
445445
* Dataset dataset = null;
446-
* DatasetInfo datasetInfo = DatasetInfo.builder(datasetName).build();
446+
* DatasetInfo datasetInfo = DatasetInfo.newBuilder(datasetName).build();
447447
* try {
448448
* // the dataset was created
449449
* dataset = bigquery.create(datasetInfo);
@@ -470,7 +470,7 @@ public static QueryResultsOption maxWaitTime(long maxWaitTime) {
470470
* // Table schema definition
471471
* Schema schema = Schema.of(field);
472472
* TableDefinition tableDefinition = StandardTableDefinition.of(schema);
473-
* TableInfo tableInfo = TableInfo.builder(tableId, tableDefinition).build();
473+
* TableInfo tableInfo = TableInfo.newBuilder(tableId, tableDefinition).build();
474474
* Table table = bigquery.create(tableInfo);
475475
* }</pre>
476476
*
@@ -659,7 +659,7 @@ public static QueryResultsOption maxWaitTime(long maxWaitTime) {
659659
* String datasetName = "my_dataset_name";
660660
* String newFriendlyName = "some_new_friendly_name";
661661
* Dataset oldDataset = bigquery.getDataset(datasetName);
662-
* DatasetInfo datasetInfo = oldDataset.toBuilder().friendlyName(newFriendlyName).build();
662+
* DatasetInfo datasetInfo = oldDataset.toBuilder().setFriendlyName(newFriendlyName).build();
663663
* Dataset newDataset = bigquery.update(datasetInfo);
664664
* }</pre>
665665
*
@@ -676,7 +676,7 @@ public static QueryResultsOption maxWaitTime(long maxWaitTime) {
676676
* String tableName = "my_table_name";
677677
* String newFriendlyName = "new_friendly_name";
678678
* Table oldTable = bigquery.getTable(datasetName, tableName);
679-
* TableInfo tableInfo = oldTable.toBuilder().friendlyName(newFriendlyName).build();
679+
* TableInfo tableInfo = oldTable.toBuilder().setFriendlyName(newFriendlyName).build();
680680
* Table newTable = bigquery.update(tableInfo);
681681
* }</pre>
682682
*
@@ -773,13 +773,13 @@ public static QueryResultsOption maxWaitTime(long maxWaitTime) {
773773
* rowContent.put("booleanField", true);
774774
* // Bytes are passed in base64
775775
* rowContent.put("bytesField", "DQ4KDQ==");
776-
* InsertAllResponse response = bigquery.insertAll(InsertAllRequest.builder(tableId)
776+
* InsertAllResponse response = bigquery.insertAll(InsertAllRequest.newBuilder(tableId)
777777
* .addRow("rowId", rowContent)
778778
* // More rows can be added in the same RPC by invoking .addRow() on the builder
779779
* .build());
780780
* if (response.hasErrors()) {
781781
* // If any of the insertions failed, this lets you inspect the errors
782-
* for (Entry<Long, List<BigQueryError>> entry : response.insertErrors().entrySet()) {
782+
* for (Entry<Long, List<BigQueryError>> entry : response.getInsertErrors().entrySet()) {
783783
* // inspect row error
784784
* }
785785
* }
@@ -937,12 +937,12 @@ Page<List<FieldValue>> listTableData(String datasetId, String tableId,
937937
* // Wait for things to finish
938938
* while (!response.jobCompleted()) {
939939
* Thread.sleep(1000);
940-
* response = bigquery.getQueryResults(response.jobId());
940+
* response = bigquery.getQueryResults(response.getJobId());
941941
* }
942942
* if (response.hasErrors()) {
943943
* // handle errors
944944
* }
945-
* QueryResult result = response.result();
945+
* QueryResult result = response.getResult();
946946
* Iterator<List<FieldValue>> rowIterator = result.iterateAll();
947947
* while (rowIterator.hasNext()) {
948948
* List<FieldValue> row = rowIterator.next();
@@ -965,12 +965,12 @@ Page<List<FieldValue>> listTableData(String datasetId, String tableId,
965965
* // Wait for things to finish
966966
* while (!response.jobCompleted()) {
967967
* Thread.sleep(1000);
968-
* response = bigquery.getQueryResults(response.jobId());
968+
* response = bigquery.getQueryResults(response.getJobId());
969969
* }
970970
* if (response.hasErrors()) {
971971
* // handle errors
972972
* }
973-
* QueryResult result = response.result();
973+
* QueryResult result = response.getResult();
974974
* Iterator<List<FieldValue>> rowIterator = result.iterateAll();
975975
* while (rowIterator.hasNext()) {
976976
* List<FieldValue> row = rowIterator.next();
@@ -993,7 +993,9 @@ Page<List<FieldValue>> listTableData(String datasetId, String tableId,
993993
* String csvData = "StringValue1\nStringValue2\n";
994994
* TableId tableId = TableId.of(datasetName, tableName);
995995
* WriteChannelConfiguration writeChannelConfiguration =
996-
* WriteChannelConfiguration.builder(tableId).formatOptions(FormatOptions.csv()).build();
996+
* WriteChannelConfiguration.newBuilder(tableId)
997+
* .setFormatOptions(FormatOptions.csv())
998+
* .build();
997999
* BaseWriteChannel<BigQueryOptions, WriteChannelConfiguration> writer =
9981000
* bigquery.writer(writeChannelConfiguration);
9991001
* // Write data to writer

‎google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/BigQueryError.java‎

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,25 +76,52 @@ public BigQueryError(String reason, String location, String message) {
7676
* @see <a href="https://cloud.google.com/bigquery/troubleshooting-errors">Troubleshooting
7777
* Errors</a>
7878
*/
79+
@Deprecated
7980
public String reason() {
81+
return getReason();
82+
}
83+
84+
/**
85+
* Returns short error code that summarizes the error.
86+
*
87+
* @see <a href="https://cloud.google.com/bigquery/troubleshooting-errors">Troubleshooting
88+
* Errors</a>
89+
*/
90+
public String getReason() {
8091
return reason;
8192
}
8293

8394
/**
8495
* Returns where the error occurred, if present.
8596
*/
97+
@Deprecated
8698
public String location() {
99+
return getLocation();
100+
}
101+
102+
/**
103+
* Returns where the error occurred, if present.
104+
*/
105+
public String getLocation() {
87106
return location;
88107
}
89108

90-
String debugInfo() {
109+
String getDebugInfo() {
91110
return debugInfo;
92111
}
93112

94113
/**
95114
* Returns a human-readable description of the error.
96115
*/
116+
@Deprecated
97117
public String message() {
118+
return getMessage();
119+
}
120+
121+
/**
122+
* Returns a human-readable description of the error.
123+
*/
124+
public String getMessage() {
98125
return message;
99126
}
100127

0 commit comments

Comments
 (0)