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.
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, routine, or dataset.
entity_type
typing.Optional[str]
Type of entity being granted the role. See EntityTypes for supported types.
If the entity_type is not 'view', 'routine', or 'dataset', the entity_id is the str ID of the entity being granted the role. If the entity_type is 'view' or 'routine', the entity_id is a dict representing the view or routine from a different dataset to grant access to in the following format for views:: { 'projectId': string, 'datasetId': string, 'tableId': string } For routines:: { 'projectId': string, 'datasetId': string, 'routineId': string } If the entity_type is 'dataset', the entity_id is a dict that includes a 'dataset' field with a dict representing the dataset and a 'target_types' field with a str value of the dataset's resource type:: { 'dataset': { 'projectId': string, 'datasetId': string, }, 'target_types: 'VIEWS' }
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', 'user@example.com') >>> view = { ... 'projectId': 'my-project', ... 'datasetId': 'my_dataset', ... 'tableId': 'my_table' ... } >>> entry = AccessEntry(None, 'view', view)
A read-only dataset resource from a list operation.
For performance reasons, the BigQuery API only includes some of the
dataset properties when listing datasets. Notably,
xref_access_entries is missing.
For a full list of the properties that the BigQuery API returns, see the
REST documentation for datasets.list
<https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets/list>_.
Parameter
Name
Description
resource
Dict[str, str]
A dataset-like resource object from a dataset list response. A datasetReference property is required.
Exceptions
Type
Description
ValueError
If datasetReference or one of its required members is missing from resource.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Module dataset (3.36.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.36.0 (latest)](/python/docs/reference/bigquery/latest/google.cloud.bigquery.dataset)\n- [3.35.1](/python/docs/reference/bigquery/3.35.1/google.cloud.bigquery.dataset)\n- [3.34.0](/python/docs/reference/bigquery/3.34.0/google.cloud.bigquery.dataset)\n- [3.33.0](/python/docs/reference/bigquery/3.33.0/google.cloud.bigquery.dataset)\n- [3.31.0](/python/docs/reference/bigquery/3.31.0/google.cloud.bigquery.dataset)\n- [3.30.0](/python/docs/reference/bigquery/3.30.0/google.cloud.bigquery.dataset)\n- [3.29.0](/python/docs/reference/bigquery/3.29.0/google.cloud.bigquery.dataset)\n- [3.27.0](/python/docs/reference/bigquery/3.27.0/google.cloud.bigquery.dataset)\n- [3.26.0](/python/docs/reference/bigquery/3.26.0/google.cloud.bigquery.dataset)\n- [3.25.0](/python/docs/reference/bigquery/3.25.0/google.cloud.bigquery.dataset)\n- [3.24.0](/python/docs/reference/bigquery/3.24.0/google.cloud.bigquery.dataset)\n- [3.23.1](/python/docs/reference/bigquery/3.23.1/google.cloud.bigquery.dataset)\n- [3.22.0](/python/docs/reference/bigquery/3.22.0/google.cloud.bigquery.dataset)\n- [3.21.0](/python/docs/reference/bigquery/3.21.0/google.cloud.bigquery.dataset)\n- [3.20.1](/python/docs/reference/bigquery/3.20.1/google.cloud.bigquery.dataset)\n- [3.19.0](/python/docs/reference/bigquery/3.19.0/google.cloud.bigquery.dataset)\n- [3.18.0](/python/docs/reference/bigquery/3.18.0/google.cloud.bigquery.dataset)\n- [3.17.2](/python/docs/reference/bigquery/3.17.2/google.cloud.bigquery.dataset)\n- [3.16.0](/python/docs/reference/bigquery/3.16.0/google.cloud.bigquery.dataset)\n- [3.15.0](/python/docs/reference/bigquery/3.15.0/google.cloud.bigquery.dataset)\n- [3.14.1](/python/docs/reference/bigquery/3.14.1/google.cloud.bigquery.dataset)\n- [3.13.0](/python/docs/reference/bigquery/3.13.0/google.cloud.bigquery.dataset)\n- [3.12.0](/python/docs/reference/bigquery/3.12.0/google.cloud.bigquery.dataset)\n- [3.11.4](/python/docs/reference/bigquery/3.11.4/google.cloud.bigquery.dataset)\n- [3.4.0](/python/docs/reference/bigquery/3.4.0/google.cloud.bigquery.dataset)\n- [3.3.6](/python/docs/reference/bigquery/3.3.6/google.cloud.bigquery.dataset)\n- [3.2.0](/python/docs/reference/bigquery/3.2.0/google.cloud.bigquery.dataset)\n- [3.1.0](/python/docs/reference/bigquery/3.1.0/google.cloud.bigquery.dataset)\n- [3.0.1](/python/docs/reference/bigquery/3.0.1/google.cloud.bigquery.dataset)\n- [2.34.4](/python/docs/reference/bigquery/2.34.4/google.cloud.bigquery.dataset)\n- [2.33.0](/python/docs/reference/bigquery/2.33.0/google.cloud.bigquery.dataset)\n- [2.32.0](/python/docs/reference/bigquery/2.32.0/google.cloud.bigquery.dataset)\n- [2.31.0](/python/docs/reference/bigquery/2.31.0/google.cloud.bigquery.dataset)\n- [2.30.1](/python/docs/reference/bigquery/2.30.1/google.cloud.bigquery.dataset)\n- [2.29.0](/python/docs/reference/bigquery/2.29.0/google.cloud.bigquery.dataset)\n- [2.28.1](/python/docs/reference/bigquery/2.28.1/google.cloud.bigquery.dataset)\n- [2.27.1](/python/docs/reference/bigquery/2.27.1/google.cloud.bigquery.dataset)\n- [2.26.0](/python/docs/reference/bigquery/2.26.0/google.cloud.bigquery.dataset)\n- [2.25.2](/python/docs/reference/bigquery/2.25.2/google.cloud.bigquery.dataset)\n- [2.24.1](/python/docs/reference/bigquery/2.24.1/google.cloud.bigquery.dataset)\n- [2.23.3](/python/docs/reference/bigquery/2.23.3/google.cloud.bigquery.dataset)\n- [2.22.1](/python/docs/reference/bigquery/2.22.1/google.cloud.bigquery.dataset)\n- [2.21.0](/python/docs/reference/bigquery/2.21.0/google.cloud.bigquery.dataset)\n- [2.20.0](/python/docs/reference/bigquery/2.20.0/google.cloud.bigquery.dataset)\n- [2.19.0](/python/docs/reference/bigquery/2.19.0/google.cloud.bigquery.dataset)\n- [2.18.0](/python/docs/reference/bigquery/2.18.0/google.cloud.bigquery.dataset)\n- [2.17.0](/python/docs/reference/bigquery/2.17.0/google.cloud.bigquery.dataset)\n- [2.16.1](/python/docs/reference/bigquery/2.16.1/google.cloud.bigquery.dataset)\n- [2.15.0](/python/docs/reference/bigquery/2.15.0/google.cloud.bigquery.dataset)\n- [2.14.0](/python/docs/reference/bigquery/2.14.0/google.cloud.bigquery.dataset)\n- [2.13.1](/python/docs/reference/bigquery/2.13.1/google.cloud.bigquery.dataset)\n- [2.12.0](/python/docs/reference/bigquery/2.12.0/google.cloud.bigquery.dataset)\n- [2.11.0](/python/docs/reference/bigquery/2.11.0/google.cloud.bigquery.dataset)\n- [2.10.0](/python/docs/reference/bigquery/2.10.0/google.cloud.bigquery.dataset)\n- [2.9.0](/python/docs/reference/bigquery/2.9.0/google.cloud.bigquery.dataset)\n- [2.8.0](/python/docs/reference/bigquery/2.8.0/google.cloud.bigquery.dataset)\n- [2.7.0](/python/docs/reference/bigquery/2.7.0/google.cloud.bigquery.dataset)\n- [2.6.2](/python/docs/reference/bigquery/2.6.2/google.cloud.bigquery.dataset)\n- [2.5.0](/python/docs/reference/bigquery/2.5.0/google.cloud.bigquery.dataset)\n- [2.4.0](/python/docs/reference/bigquery/2.4.0/google.cloud.bigquery.dataset)\n- [2.3.1](/python/docs/reference/bigquery/2.3.1/google.cloud.bigquery.dataset)\n- [2.2.0](/python/docs/reference/bigquery/2.2.0/google.cloud.bigquery.dataset)\n- [2.1.0](/python/docs/reference/bigquery/2.1.0/google.cloud.bigquery.dataset)\n- [2.0.0](/python/docs/reference/bigquery/2.0.0/google.cloud.bigquery.dataset)\n- [1.28.2](/python/docs/reference/bigquery/1.28.2/google.cloud.bigquery.dataset)\n- [1.27.2](/python/docs/reference/bigquery/1.27.2/google.cloud.bigquery.dataset)\n- [1.26.1](/python/docs/reference/bigquery/1.26.1/google.cloud.bigquery.dataset)\n- [1.25.0](/python/docs/reference/bigquery/1.25.0/google.cloud.bigquery.dataset)\n- [1.24.0](/python/docs/reference/bigquery/1.24.0/google.cloud.bigquery.dataset)\n- [1.23.1](/python/docs/reference/bigquery/1.23.1/google.cloud.bigquery.dataset)\n- [1.22.0](/python/docs/reference/bigquery/1.22.0/google.cloud.bigquery.dataset)\n- [1.21.0](/python/docs/reference/bigquery/1.21.0/google.cloud.bigquery.dataset)\n- [1.20.0](/python/docs/reference/bigquery/1.20.0/google.cloud.bigquery.dataset)\n- [1.19.0](/python/docs/reference/bigquery/1.19.0/google.cloud.bigquery.dataset)\n- [1.18.0](/python/docs/reference/bigquery/1.18.0/google.cloud.bigquery.dataset)\n- [1.17.0](/python/docs/reference/bigquery/1.17.0/google.cloud.bigquery.dataset)\n- [1.16.0](/python/docs/reference/bigquery/1.16.0/google.cloud.bigquery.dataset) \nDefine API Datasets.\n\nClasses\n-------\n\n### [AccessEntry](/python/docs/reference/bigquery/latest/google.cloud.bigquery.dataset.AccessEntry)\n\n AccessEntry(\n role: typing.Optional[str] = None,\n entity_type: typing.Optional[str] = None,\n entity_id: typing.Optional[typing.Union[typing.Dict[str, typing.Any], str]] = None,\n **kwargs\n )\n\nRepresents grant of an access role to an entity.\n\nAn entry must have exactly one of the allowed\nxref_EntityTypes. If anything but `view`, `routine`,\nor `dataset` are set, a `role` is also required. `role` is omitted for `view`,\n`routine`, `dataset`, because they are always read-only.\n\nSee \u003chttps://cloud.google.com/bigquery/docs/reference/rest/v2/datasets\u003e.\n\n### [Condition](/python/docs/reference/bigquery/latest/google.cloud.bigquery.dataset.Condition)\n\n Condition(\n expression: str,\n title: typing.Optional[str] = None,\n description: typing.Optional[str] = None,\n )\n\nRepresents a textual expression in the Common Expression Language (CEL) syntax.\n\nTypically used for filtering or policy rules, such as in IAM Conditions\nor BigQuery row/column access policies.\n\nSee:\n\u003chttps://cloud.google.com/iam/docs/reference/rest/Shared.Types/Expr\u003e\n\u003chttps://github.com/google/cel-spec\u003e\n\n### [Dataset](/python/docs/reference/bigquery/latest/google.cloud.bigquery.dataset.Dataset)\n\n Dataset(dataset_ref)\n\nDatasets are containers for tables.\n\nSee\n\u003chttps://cloud.google.com/bigquery/docs/reference/rest/v2/datasets#resource-dataset\u003e\n\n### [DatasetListItem](/python/docs/reference/bigquery/latest/google.cloud.bigquery.dataset.DatasetListItem)\n\n DatasetListItem(resource)\n\nA read-only dataset resource from a list operation.\n\nFor performance reasons, the BigQuery API only includes some of the\ndataset properties when listing datasets. Notably,\nxref_access_entries is missing.\n\nFor a full list of the properties that the BigQuery API returns, see the\n`REST documentation for datasets.list\n\u003chttps://cloud.google.com/bigquery/docs/reference/rest/v2/datasets/list\u003e`_.\n\n### [DatasetReference](/python/docs/reference/bigquery/latest/google.cloud.bigquery.dataset.DatasetReference)\n\n DatasetReference(project: str, dataset_id: str)\n\nDatasetReferences are pointers to datasets.\n\nSee\n\u003chttps://cloud.google.com/bigquery/docs/reference/rest/v2/datasets#datasetreference\u003e"]]