
target.apidocs.com.google.api.services.bigquery.model.Dataset.Access.html Maven / Gradle / Ivy
Dataset.Access (BigQuery API v2-rev20190423-1.28.0)
com.google.api.services.bigquery.model
Class Dataset.Access
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.json.GenericJson
-
- com.google.api.services.bigquery.model.Dataset.Access
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Constructor and Description
Access()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
Dataset.Access
clone()
String
getDomain()
[Pick one] A domain to grant access to.
String
getGroupByEmail()
[Pick one] An email address of a Google Group to grant access to.
String
getIamMember()
[Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group,
domain, or special group.
String
getRole()
[Required] An IAM role ID that should be granted to the user, group, or domain specified in
this access entry.
String
getSpecialGroup()
[Pick one] A special group to grant access to.
String
getUserByEmail()
[Pick one] An email address of a user to grant access to.
TableReference
getView()
[Pick one] A view from a different dataset to grant access to.
Dataset.Access
set(String fieldName,
Object value)
Dataset.Access
setDomain(String domain)
[Pick one] A domain to grant access to.
Dataset.Access
setGroupByEmail(String groupByEmail)
[Pick one] An email address of a Google Group to grant access to.
Dataset.Access
setIamMember(String iamMember)
[Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group,
domain, or special group.
Dataset.Access
setRole(String role)
[Required] An IAM role ID that should be granted to the user, group, or domain specified in
this access entry.
Dataset.Access
setSpecialGroup(String specialGroup)
[Pick one] A special group to grant access to.
Dataset.Access
setUserByEmail(String userByEmail)
[Pick one] An email address of a user to grant access to.
Dataset.Access
setView(TableReference view)
[Pick one] A view from a different dataset to grant access to.
-
Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString
-
Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
Method Detail
-
getDomain
public String getDomain()
[Pick one] A domain to grant access to. Any users signed in with the domain specified will be
granted the specified access. Example: "example.com". Maps to IAM policy member
"domain:DOMAIN".
- Returns:
- value or
null
for none
-
setDomain
public Dataset.Access setDomain(String domain)
[Pick one] A domain to grant access to. Any users signed in with the domain specified will be
granted the specified access. Example: "example.com". Maps to IAM policy member
"domain:DOMAIN".
- Parameters:
domain
- domain or null
for none
-
getGroupByEmail
public String getGroupByEmail()
[Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member
"group:GROUP".
- Returns:
- value or
null
for none
-
setGroupByEmail
public Dataset.Access setGroupByEmail(String groupByEmail)
[Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member
"group:GROUP".
- Parameters:
groupByEmail
- groupByEmail or null
for none
-
getIamMember
public String getIamMember()
[Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group,
domain, or special group.
- Returns:
- value or
null
for none
-
setIamMember
public Dataset.Access setIamMember(String iamMember)
[Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group,
domain, or special group.
- Parameters:
iamMember
- iamMember or null
for none
-
getRole
public String getRole()
[Required] An IAM role ID that should be granted to the user, group, or domain specified in
this access entry. The following legacy mappings will be applied: OWNER
roles/bigquery.dataOwner WRITER roles/bigquery.dataEditor READER roles/bigquery.dataViewer
This field will accept any of the above formats, but will return only the legacy format. For
example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as
"OWNER".
- Returns:
- value or
null
for none
-
setRole
public Dataset.Access setRole(String role)
[Required] An IAM role ID that should be granted to the user, group, or domain specified in
this access entry. The following legacy mappings will be applied: OWNER
roles/bigquery.dataOwner WRITER roles/bigquery.dataEditor READER roles/bigquery.dataViewer
This field will accept any of the above formats, but will return only the legacy format. For
example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as
"OWNER".
- Parameters:
role
- role or null
for none
-
getSpecialGroup
public String getSpecialGroup()
[Pick one] A special group to grant access to. Possible values include: projectOwners: Owners
of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters:
Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps
to similarly-named IAM members.
- Returns:
- value or
null
for none
-
setSpecialGroup
public Dataset.Access setSpecialGroup(String specialGroup)
[Pick one] A special group to grant access to. Possible values include: projectOwners: Owners
of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters:
Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps
to similarly-named IAM members.
- Parameters:
specialGroup
- specialGroup or null
for none
-
getUserByEmail
public String getUserByEmail()
[Pick one] An email address of a user to grant access to. For example: [email protected]. Maps
to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL".
- Returns:
- value or
null
for none
-
setUserByEmail
public Dataset.Access setUserByEmail(String userByEmail)
[Pick one] An email address of a user to grant access to. For example: [email protected]. Maps
to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL".
- Parameters:
userByEmail
- userByEmail or null
for none
-
getView
public TableReference getView()
[Pick one] A view from a different dataset to grant access to. Queries executed against that
view will have read access to tables in this dataset. The role field is not required when this
field is set. If that view is updated by any user, access to the view needs to be granted again
via an update operation.
- Returns:
- value or
null
for none
-
setView
public Dataset.Access setView(TableReference view)
[Pick one] A view from a different dataset to grant access to. Queries executed against that
view will have read access to tables in this dataset. The role field is not required when this
field is set. If that view is updated by any user, access to the view needs to be granted again
via an update operation.
- Parameters:
view
- view or null
for none
-
set
public Dataset.Access set(String fieldName,
Object value)
- Overrides:
set
in class com.google.api.client.json.GenericJson
-
clone
public Dataset.Access clone()
- Overrides:
clone
in class com.google.api.client.json.GenericJson
Copyright © 2011–2019 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy