Skip to content

Commit 07760b7

Browse files
ci: javadoc job (JDK 17) in ci.yaml (#1819) (#2781)
* ci: javadoc job (JDK 17) in ci.yaml (#1819) This also changes the JDK distribution from zulu to temurin https://github.com/actions/setup-java#eclipse-temurin Source-Link: googleapis/synthtool@ef9fe2e Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-java:latest@sha256:31c8276a1bfb43766597d32645721c029cb94571f1b8d996cb2c290744fe52f9 * fix errors * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix error --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Neenu1995 <[email protected]>
1 parent 7fcfa63 commit 07760b7

File tree

12 files changed

+107
-100
lines changed

12 files changed

+107
-100
lines changed

.github/.OwlBot.lock.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,5 @@
1313
# limitations under the License.
1414
docker:
1515
image: gcr.io/cloud-devrel-public-resources/owlbot-java:latest
16-
digest: sha256:32851debfefed2b66038e0141f1b5c2103bb59ba80b7475adbc10ef7abab3de7
17-
# created: 2023-06-22T15:06:52.039318836Z
16+
digest: sha256:31c8276a1bfb43766597d32645721c029cb94571f1b8d996cb2c290744fe52f9
17+
# created: 2023-06-27T18:51:58.922150125Z

.github/workflows/ci.yaml

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ jobs:
3030
- uses: actions/checkout@v3
3131
- uses: actions/setup-java@v3
3232
with:
33-
distribution: zulu
33+
distribution: temurin
3434
java-version: ${{matrix.java}}
3535
- run: java -version
3636
- run: .kokoro/build.sh
@@ -45,7 +45,7 @@ jobs:
4545
- uses: actions/setup-java@v3
4646
with:
4747
java-version: 8
48-
distribution: zulu
48+
distribution: temurin
4949
- name: "Set jvm system property environment variable for surefire plugin (unit tests)"
5050
# Maven surefire plugin (unit tests) allows us to specify JVM to run the tests.
5151
# https://maven.apache.org/surefire/maven-surefire-plugin/test-mojo.html#jvm
@@ -54,7 +54,7 @@ jobs:
5454
- uses: actions/setup-java@v3
5555
with:
5656
java-version: 17
57-
distribution: zulu
57+
distribution: temurin
5858
- run: .kokoro/build.sh
5959
env:
6060
JOB_TYPE: test
@@ -66,7 +66,7 @@ jobs:
6666
- uses: actions/checkout@v3
6767
- uses: actions/setup-java@v3
6868
with:
69-
distribution: zulu
69+
distribution: temurin
7070
java-version: 8
7171
- run: java -version
7272
- run: .kokoro/build.bat
@@ -81,17 +81,29 @@ jobs:
8181
- uses: actions/checkout@v3
8282
- uses: actions/setup-java@v3
8383
with:
84-
distribution: zulu
84+
distribution: temurin
8585
java-version: ${{matrix.java}}
8686
- run: java -version
8787
- run: .kokoro/dependencies.sh
88+
javadoc:
89+
runs-on: ubuntu-latest
90+
steps:
91+
- uses: actions/checkout@v3
92+
- uses: actions/setup-java@v3
93+
with:
94+
distribution: temurin
95+
java-version: 17
96+
- run: java -version
97+
- run: .kokoro/build.sh
98+
env:
99+
JOB_TYPE: javadoc
88100
lint:
89101
runs-on: ubuntu-latest
90102
steps:
91103
- uses: actions/checkout@v3
92104
- uses: actions/setup-java@v3
93105
with:
94-
distribution: zulu
106+
distribution: temurin
95107
java-version: 11
96108
- run: java -version
97109
- run: .kokoro/build.sh
@@ -103,7 +115,7 @@ jobs:
103115
- uses: actions/checkout@v3
104116
- uses: actions/setup-java@v3
105117
with:
106-
distribution: zulu
118+
distribution: temurin
107119
java-version: 8
108120
- run: java -version
109121
- run: .kokoro/build.sh

.github/workflows/samples.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ jobs:
2323
- uses: actions/checkout@v3
2424
- uses: actions/setup-java@v3
2525
with:
26-
distribution: zulu
26+
distribution: temurin
2727
java-version: 8
2828
- name: Run checkstyle
2929
run: mvn -P lint --quiet --batch-mode checkstyle:check

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ If you are using Maven without the BOM, add this to your dependencies:
5353
If you are using Gradle 5.x or later, add this to your dependencies:
5454

5555
```Groovy
56-
implementation platform('com.google.cloud:libraries-bom:26.17.0')
56+
implementation platform('com.google.cloud:libraries-bom:26.18.0')
5757
5858
implementation 'com.google.cloud:google-cloud-bigquery'
5959
```

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

Lines changed: 40 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
* Access Control for a BigQuery Dataset. BigQuery uses ACLs to manage permissions on datasets. ACLs
3232
* are not directly supported on tables. A table inherits its ACL from the dataset that contains it.
3333
* Project roles affect your ability to run jobs or manage the project, while dataset roles affect
34-
* how you can access or modify the data inside of a project.
34+
* how you can access or modify the data inside a project.
3535
*
3636
* @see <a href="https://cloud.google.com/bigquery/access-control">Access Control</a>
3737
*/
@@ -82,12 +82,15 @@ public static Role valueOfStrict(String constant) {
8282
return type.valueOfStrict(constant);
8383
}
8484

85-
/** Get the Role for the given String constant, and allow unrecognized values. */
85+
/**
86+
* @param constant
87+
* @return Get the Role for the given String constant, and allow unrecognized values.
88+
*/
8689
public static Role valueOf(String constant) {
8790
return type.valueOf(constant);
8891
}
8992

90-
/** Return the known values for Role. */
93+
/** @return Return the known values for Role. */
9194
public static Role[] values() {
9295
return type.values();
9396
}
@@ -167,14 +170,19 @@ public static final class DatasetAclEntity extends Entity {
167170
private final DatasetId id;
168171
private final List<String> targetTypes;
169172

170-
/** Creates a DatasetAclEntity given the DatasetAclEntity's id. */
173+
/**
174+
* Creates a DatasetAclEntity given the DatasetAclEntity's id.
175+
*
176+
* @param id
177+
* @param targetTypes
178+
*/
171179
public DatasetAclEntity(DatasetId id, List<String> targetTypes) {
172180
super(Type.DATASET);
173181
this.id = id;
174182
this.targetTypes = targetTypes;
175183
}
176184

177-
/** Returns DatasetAclEntity's identity. */
185+
/** @return Returns DatasetAclEntity's identity. */
178186
public DatasetId getId() {
179187
return id;
180188
}
@@ -230,7 +238,7 @@ public Domain(String domain) {
230238
this.domain = domain;
231239
}
232240

233-
/** Returns the domain name. */
241+
/** @return Returns the domain name. */
234242
public String getDomain() {
235243
return domain;
236244
}
@@ -291,9 +299,9 @@ public Group(String identifier) {
291299
}
292300

293301
/**
294-
* Returns group's identifier, can be either a <a
295-
* href="https://cloud.google.com/bigquery/docs/reference/v2/datasets#access.specialGroup">
296-
* special group identifier</a> or a group email.
302+
* @return Returns group's identifier, can be either a <a
303+
* href="https://cloud.google.com/bigquery/docs/reference/v2/datasets#access.specialGroup">
304+
* special group identifier</a> or a group email.
297305
*/
298306
public String getIdentifier() {
299307
return identifier;
@@ -338,22 +346,22 @@ Access toPb() {
338346
}
339347
}
340348

341-
/** Returns a Group entity representing all project's owners. */
349+
/** @return Returns a Group entity representing all project's owners. */
342350
public static Group ofProjectOwners() {
343351
return new Group(PROJECT_OWNERS);
344352
}
345353

346-
/** Returns a Group entity representing all project's readers. */
354+
/** @return Returns a Group entity representing all project's readers. */
347355
public static Group ofProjectReaders() {
348356
return new Group(PROJECT_READERS);
349357
}
350358

351-
/** Returns a Group entity representing all project's writers. */
359+
/** @return Returns a Group entity representing all project's writers. */
352360
public static Group ofProjectWriters() {
353361
return new Group(PROJECT_WRITERS);
354362
}
355363

356-
/** Returns a Group entity representing all BigQuery authenticated users. */
364+
/** @return Returns a Group entity representing all BigQuery authenticated users. */
357365
public static Group ofAllAuthenticatedUsers() {
358366
return new Group(ALL_AUTHENTICATED_USERS);
359367
}
@@ -375,7 +383,7 @@ public User(String email) {
375383
this.email = email;
376384
}
377385

378-
/** Returns user's email. */
386+
/** @return Returns user's email. */
379387
public String getEmail() {
380388
return email;
381389
}
@@ -427,7 +435,7 @@ public View(TableId id) {
427435
this.id = id;
428436
}
429437

430-
/** Returns table's identity. */
438+
/** @return Returns table's identity. */
431439
public TableId getId() {
432440
return id;
433441
}
@@ -479,7 +487,7 @@ public Routine(RoutineId id) {
479487
this.id = id;
480488
}
481489

482-
/** Returns routine's identity. */
490+
/** @return Returns routine's identity. */
483491
public RoutineId getId() {
484492
return id;
485493
}
@@ -527,7 +535,7 @@ public IamMember(String iamMember) {
527535
this.iamMember = iamMember;
528536
}
529537

530-
/** Returns iamMember. */
538+
/** @return Returns iamMember. */
531539
public String getIamMember() {
532540
return iamMember;
533541
}
@@ -565,37 +573,45 @@ private Acl(Entity entity, Role role) {
565573
this.role = role;
566574
}
567575

568-
/** Returns the entity for this ACL. */
576+
/** @return Returns the entity for this ACL. */
569577
public Entity getEntity() {
570578
return entity;
571579
}
572580

573-
/** Returns the role specified by this ACL. */
581+
/** @return Returns the role specified by this ACL. */
574582
public Role getRole() {
575583
return role;
576584
}
577585

578586
/**
579-
* Returns an Acl object.
580-
*
587+
* @return Returns an Acl object.
581588
* @param entity the entity for this ACL object
582589
* @param role the role to associate to the {@code entity} object
583590
*/
584591
public static Acl of(Entity entity, Role role) {
585592
return new Acl(entity, role);
586593
}
587594

588-
/** Returns an Acl object for a datasetAclEntity. */
595+
/**
596+
* @param datasetAclEntity
597+
* @return Returns an Acl object for a datasetAclEntity.
598+
*/
589599
public static Acl of(DatasetAclEntity datasetAclEntity) {
590600
return new Acl(datasetAclEntity, null);
591601
}
592602

593-
/** Returns an Acl object for a view entity. */
603+
/**
604+
* @param view
605+
* @return Returns an Acl object for a view entity.
606+
*/
594607
public static Acl of(View view) {
595608
return new Acl(view, null);
596609
}
597610

598-
/** Returns an Acl object for a routine entity. */
611+
/**
612+
* @param routine
613+
* @return Returns an Acl object for a routine entity.
614+
*/
599615
public static Acl of(Routine routine) {
600616
return new Acl(routine, null);
601617
}

0 commit comments

Comments
 (0)