31
31
* Access Control for a BigQuery Dataset. BigQuery uses ACLs to manage permissions on datasets. ACLs
32
32
* are not directly supported on tables. A table inherits its ACL from the dataset that contains it.
33
33
* 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.
35
35
*
36
36
* @see <a href="https://cloud.google.com/bigquery/access-control">Access Control</a>
37
37
*/
@@ -82,12 +82,15 @@ public static Role valueOfStrict(String constant) {
82
82
return type .valueOfStrict (constant );
83
83
}
84
84
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
+ */
86
89
public static Role valueOf (String constant ) {
87
90
return type .valueOf (constant );
88
91
}
89
92
90
- /** Return the known values for Role. */
93
+ /** @return Return the known values for Role. */
91
94
public static Role [] values () {
92
95
return type .values ();
93
96
}
@@ -167,14 +170,19 @@ public static final class DatasetAclEntity extends Entity {
167
170
private final DatasetId id ;
168
171
private final List <String > targetTypes ;
169
172
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
+ */
171
179
public DatasetAclEntity (DatasetId id , List <String > targetTypes ) {
172
180
super (Type .DATASET );
173
181
this .id = id ;
174
182
this .targetTypes = targetTypes ;
175
183
}
176
184
177
- /** Returns DatasetAclEntity's identity. */
185
+ /** @return Returns DatasetAclEntity's identity. */
178
186
public DatasetId getId () {
179
187
return id ;
180
188
}
@@ -230,7 +238,7 @@ public Domain(String domain) {
230
238
this .domain = domain ;
231
239
}
232
240
233
- /** Returns the domain name. */
241
+ /** @return Returns the domain name. */
234
242
public String getDomain () {
235
243
return domain ;
236
244
}
@@ -291,9 +299,9 @@ public Group(String identifier) {
291
299
}
292
300
293
301
/**
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.
297
305
*/
298
306
public String getIdentifier () {
299
307
return identifier ;
@@ -338,22 +346,22 @@ Access toPb() {
338
346
}
339
347
}
340
348
341
- /** Returns a Group entity representing all project's owners. */
349
+ /** @return Returns a Group entity representing all project's owners. */
342
350
public static Group ofProjectOwners () {
343
351
return new Group (PROJECT_OWNERS );
344
352
}
345
353
346
- /** Returns a Group entity representing all project's readers. */
354
+ /** @return Returns a Group entity representing all project's readers. */
347
355
public static Group ofProjectReaders () {
348
356
return new Group (PROJECT_READERS );
349
357
}
350
358
351
- /** Returns a Group entity representing all project's writers. */
359
+ /** @return Returns a Group entity representing all project's writers. */
352
360
public static Group ofProjectWriters () {
353
361
return new Group (PROJECT_WRITERS );
354
362
}
355
363
356
- /** Returns a Group entity representing all BigQuery authenticated users. */
364
+ /** @return Returns a Group entity representing all BigQuery authenticated users. */
357
365
public static Group ofAllAuthenticatedUsers () {
358
366
return new Group (ALL_AUTHENTICATED_USERS );
359
367
}
@@ -375,7 +383,7 @@ public User(String email) {
375
383
this .email = email ;
376
384
}
377
385
378
- /** Returns user's email. */
386
+ /** @return Returns user's email. */
379
387
public String getEmail () {
380
388
return email ;
381
389
}
@@ -427,7 +435,7 @@ public View(TableId id) {
427
435
this .id = id ;
428
436
}
429
437
430
- /** Returns table's identity. */
438
+ /** @return Returns table's identity. */
431
439
public TableId getId () {
432
440
return id ;
433
441
}
@@ -479,7 +487,7 @@ public Routine(RoutineId id) {
479
487
this .id = id ;
480
488
}
481
489
482
- /** Returns routine's identity. */
490
+ /** @return Returns routine's identity. */
483
491
public RoutineId getId () {
484
492
return id ;
485
493
}
@@ -527,7 +535,7 @@ public IamMember(String iamMember) {
527
535
this .iamMember = iamMember ;
528
536
}
529
537
530
- /** Returns iamMember. */
538
+ /** @return Returns iamMember. */
531
539
public String getIamMember () {
532
540
return iamMember ;
533
541
}
@@ -565,37 +573,45 @@ private Acl(Entity entity, Role role) {
565
573
this .role = role ;
566
574
}
567
575
568
- /** Returns the entity for this ACL. */
576
+ /** @return Returns the entity for this ACL. */
569
577
public Entity getEntity () {
570
578
return entity ;
571
579
}
572
580
573
- /** Returns the role specified by this ACL. */
581
+ /** @return Returns the role specified by this ACL. */
574
582
public Role getRole () {
575
583
return role ;
576
584
}
577
585
578
586
/**
579
- * Returns an Acl object.
580
- *
587
+ * @return Returns an Acl object.
581
588
* @param entity the entity for this ACL object
582
589
* @param role the role to associate to the {@code entity} object
583
590
*/
584
591
public static Acl of (Entity entity , Role role ) {
585
592
return new Acl (entity , role );
586
593
}
587
594
588
- /** Returns an Acl object for a datasetAclEntity. */
595
+ /**
596
+ * @param datasetAclEntity
597
+ * @return Returns an Acl object for a datasetAclEntity.
598
+ */
589
599
public static Acl of (DatasetAclEntity datasetAclEntity ) {
590
600
return new Acl (datasetAclEntity , null );
591
601
}
592
602
593
- /** Returns an Acl object for a view entity. */
603
+ /**
604
+ * @param view
605
+ * @return Returns an Acl object for a view entity.
606
+ */
594
607
public static Acl of (View view ) {
595
608
return new Acl (view , null );
596
609
}
597
610
598
- /** Returns an Acl object for a routine entity. */
611
+ /**
612
+ * @param routine
613
+ * @return Returns an Acl object for a routine entity.
614
+ */
599
615
public static Acl of (Routine routine ) {
600
616
return new Acl (routine , null );
601
617
}
0 commit comments