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 com.google.api.client.json.GenericJson

Model definition for DatasetAccess.

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>

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()
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	getRole() [Required] Describes the rights granted to the user specified by the other member of the access object.
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	setRole(String role) [Required] Describes the rights granted to the user specified by the other member of the access object.
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

Constructor Detail

Access

public Access()

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".

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".

Parameters:

domain - domain or null for none

getGroupByEmail

public String getGroupByEmail()

[Pick one] An email address of a Google Group to grant access to.

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.

Parameters:

groupByEmail - groupByEmail or null for none

getRole

public String getRole()

[Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READER, WRITER, OWNER.

Returns:

value or null for none

setRole

public Dataset.Access setRole(String role)

[Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READER, WRITER, 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.

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.

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: fred@example.com.

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: fred@example.com.

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