Class AccessEntry (3.4.0)

Version 3.4.0

• 3.27.0 (latest)
• 3.26.0
• 3.25.0
• 3.24.0
• 3.23.1
• 3.22.0
• 3.21.0
• 3.20.1
• 3.19.0
• 3.18.0
• 3.17.2
• 3.16.0
• 3.15.0
• 3.14.1
• 3.13.0
• 3.12.0
• 3.11.4
• 3.4.0
• 3.3.6
• 3.2.0
• 3.1.0
• 3.0.1
• 2.34.4
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.1
• 2.29.0
• 2.28.1
• 2.27.1
• 2.26.0
• 2.25.2
• 2.24.1
• 2.23.3
• 2.22.1
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.1
• 2.15.0
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.2
• 2.5.0
• 2.4.0
• 2.3.1
• 2.2.0
• 2.1.0
• 2.0.0
• 1.28.2
• 1.27.2
• 1.26.1
• 1.25.0
• 1.24.0
• 1.23.1
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0

AccessEntry(
    role: Optional[str] = None,
    entity_type: Optional[str] = None,
    entity_id: Optional[Union[Dict[str, Any], str]] = None,
)

Represents grant of an access role to an entity.

An entry must have exactly one of the allowed xref_EntityTypes. If anything but view, routine, or dataset are set, a role is also required. role is omitted for view, routine, dataset, because they are always read-only.

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

Inheritance

builtins.object > AccessEntry

Properties

dataset

API resource representation of a dataset reference.

dataset_target_types

Which resources that the dataset in this entry applies to.

domain

A domain to grant access to.

entity_id

The entity_id of the entry.

entity_type

The entity_type of the entry.

group_by_email

An email address of a Google Group to grant access to.

role

The role of the entry.

routine

API resource representation of a routine reference.

special_group

A special group to grant access to.

user_by_email

An email address of a user to grant access to.

view

API resource representation of a view reference.

Methods

from_api_repr

from_api_repr(resource: dict)

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

__init__

__init__(
    role: Optional[str] = None,
    entity_type: Optional[str] = None,
    entity_id: Optional[Union[Dict[str, Any], str]] = None,
)

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

AccessEntry

AccessEntry(
    role: Optional[str] = None,
    entity_type: Optional[str] = None,
    entity_id: Optional[Union[Dict[str, Any], str]] = None,
)

Represents grant of an access role to an entity.

An entry must have exactly one of the allowed xref_EntityTypes. If anything but view, routine, or dataset are set, a role is also required. role is omitted for view, routine, dataset, because they are always read-only.

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

Exceptions
Type	Description
ValueError	If a view, routine, or dataset has role set, or a non view, non routine, and non dataset **does not** have a role set. .. rubric:: Examples >>> entry = AccessEntry('OWNER', 'userByEmail', '[e-mail]') >>> view = { ... 'projectId': 'my-project', ... 'datasetId': 'my_dataset', ... 'tableId': 'my_table' ... } >>> entry = AccessEntry(None, 'view', view)