Class AccessEntry (1.24.0)

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 is set, a role is also required. role is omitted for a view, because view s are always read-only.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets.

Attributes

Name	Description
role	`str` Role granted to the entity. The following string values are supported: `'READER'`, `'WRITER'`, `'OWNER'`. It may also be :data:`None` if the ``entity_type`` is ``view``.
entity_type	`str` Type of entity being granted the role. One of `ENTITY_TYPES`.
entity_id	`Union[str, Dict[str, str]]` If the ``entity_type`` is not 'view', the ``entity_id`` is the ``str`` ID of the entity being granted the role. If the ``entity_type`` is 'view', the ``entity_id`` is a ``dict`` representing the view from a different dataset to grant access to in the following format:: { 'projectId': string, 'datasetId': string, 'tableId': string }

Inheritance

builtins.object > AccessEntry

Methods

init

__init__(role, entity_type, entity_id)

Initialize self. See help(type(self)) for accurate signature.

from_api_repr

from_api_repr(resource)

Factory: construct an access entry given its API representation

Parameter

Name	Description
resource	`Dict[str, object]` Access entry resource representation returned from the API

Exceptions

Type	Description
ValueError	If the resource has more keys than ``role`` and one additional key.

Returns

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

Returns

Type	Description
Dict[str, object]	Access entry represented as an API resource