AccessEntry(role, entity_type, entity_id)
Represents grant of an access role to an entity.
An entry must have exactly one of the allowed ENTITY_TYPES
. If
anything but view
or routine
are set, a role
is also required.
role
is omitted for view
and routine
, because they are always
read-only.
See https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets.
Parameters
Name | Description |
role |
str
Role granted to the entity. The following string values are supported: |
entity_type |
str
Type of entity being granted the role. One of |
entity_id |
Union[str, Dict[str, str]]
If the |
Inheritance
builtins.object > AccessEntryProperties
entity_id
str: The entity_id of the entry.
entity_type
str: The entity_type of the entry.
role
str: The role of the entry.
Methods
from_api_repr
from_api_repr(resource: dict)
Factory: construct an access entry given its API representation
Name | Description |
resource |
Dict[str, object]
Access entry resource representation returned from the API |
Type | Description |
ValueError | If the resource has more keys than ``role`` and one additional key. |
Type | Description |
google.cloud.bigquery.dataset.AccessEntry | Access entry parsed from ``resource``. |
to_api_repr
to_api_repr()
Construct the API resource representation of this access entry
Type | Description |
Dict[str, object] | Access entry represented as an API resource |
__init__
__init__(role, entity_type, entity_id)
Initialize self. See help(type(self)) for accurate signature.
AccessEntry
AccessEntry(role, entity_type, entity_id)
Represents grant of an access role to an entity.
An entry must have exactly one of the allowed ENTITY_TYPES
. If
anything but view
or routine
are set, a role
is also required.
role
is omitted for view
and routine
, because they are always
read-only.
See https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets.
Name | Description |
role |
str
Role granted to the entity. The following string values are supported: |
entity_type |
str
Type of entity being granted the role. One of |
entity_id |
Union[str, Dict[str, str]]
If the |
Type | Description |
ValueError | If the ``entity_type`` is not among `ENTITY_TYPES`, or if a ``view`` or a ``routine`` has ``role`` set, or a non ``view`` and non ``routine`` **does not** have a ``role`` set. .. rubric:: Examples >>> entry = AccessEntry('OWNER', 'userByEmail', 'user@example.com') >>> view = { ... 'projectId': 'my-project', ... 'datasetId': 'my_dataset', ... 'tableId': 'my_table' ... } >>> entry = AccessEntry(None, 'view', view) |