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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Dataset

public static final class Dataset.Access
extends GenericJson

Model definition for DatasetAccess.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Access()

Method Summary

Modifier and Type	Method and Description
Dataset.Access	clone()
DatasetAccessEntry	getDataset() [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset.
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.
RoutineReference	getRoutine() [Pick one] A routine from a different dataset to grant access to.
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	setDataset(DatasetAccessEntry dataset) [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset.
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	setRoutine(RoutineReference routine) [Pick one] A routine from a different dataset to grant access to.
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, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, 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

Constructor Detail

Access

public Access()

Method Detail

getDataset

public DatasetAccessEntry getDataset()

[Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation.

Returns:

value or null for none

setDataset

public Dataset.Access setDataset(DatasetAccessEntry dataset)

[Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation.

Parameters:

dataset - dataset or null for none

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

getRoutine

public RoutineReference getRoutine()

[Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation.

Returns:

value or null for none

setRoutine

public Dataset.Access setRoutine(RoutineReference routine)

[Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation.

Parameters:

routine - routine 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 GenericJson

clone

public Dataset.Access clone()

Overrides:

clone in class GenericJson