- 3.25.0 (latest)
- 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
Define API Datasets.
Classes
AccessEntry
AccessEntry(
role: typing.Optional[str] = None,
entity_type: typing.Optional[str] = None,
entity_id: typing.Optional[typing.Union[typing.Dict[str, typing.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.
Parameters | |
---|---|
Name | Description |
role |
typing.Optional[str]
Role granted to the entity. The following string values are supported: |
entity_type |
typing.Optional[str]
Type of entity being granted the role. See EntityTypes for supported types. |
entity_id |
typing.Union[typing.Dict[str, typing.Any], str, NoneType]
If the |
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) |
Dataset
Dataset(dataset_ref)
Datasets are containers for tables.
See https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets#resource-dataset
Parameter | |
---|---|
Name | Description |
dataset_ref |
Union[google.cloud.bigquery.dataset.DatasetReference, str]
A pointer to a dataset. If |
DatasetListItem
DatasetListItem(resource)
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 |
Exceptions | |
---|---|
Type | Description |
ValueError |
If datasetReference or one of its required members is missing from resource . |
DatasetReference
DatasetReference(project: str, dataset_id: str)
DatasetReferences are pointers to datasets.
See https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets#datasetreference
Parameters | |
---|---|
Name | Description |
project |
str
The ID of the project |
dataset_id |
str
The ID of the dataset |
Exceptions | |
---|---|
Type | Description |
ValueError |
If either argument is not of type str . |