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