Class DatasetListItem (3.14.0)

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

NameDescription
resource Dict[str, str]

A dataset-like resource object from a dataset list response. A datasetReference property is required.

Properties

dataset_id

str: Dataset ID.

friendly_name

Union[str, None]: Title of the dataset as set by the user (defaults to :data:None).

full_dataset_id

Union[str, None]: ID for the dataset resource (:data:None until set from the server)

In the format project_id:dataset_id.

labels

Dict[str, str]: Labels for the dataset.

project

str: Project bound to the dataset.

reference

google.cloud.bigquery.dataset.DatasetReference: A reference to this dataset.

Methods

model

model(model_id)

Constructs a ModelReference.

Parameter
NameDescription
model_id str

the ID of the model.

Returns
TypeDescription
google.cloud.bigquery.model.ModelReferenceA ModelReference for a model in this dataset.

routine

routine(routine_id)

Constructs a RoutineReference.

Parameter
NameDescription
routine_id str

the ID of the routine.

Returns
TypeDescription
google.cloud.bigquery.routine.RoutineReferenceA RoutineReference for a routine in this dataset.

table

table(table_id: str) -> google.cloud.bigquery.table.TableReference

Constructs a TableReference.

Parameter
NameDescription
table_id str

The ID of the table.

Returns
TypeDescription
google.cloud.bigquery.table.TableReferenceA table reference for a table in this dataset.

__init__

__init__(resource)

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

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
NameDescription
resource Dict[str, str]

A dataset-like resource object from a dataset list response. A datasetReference property is required.

Exceptions
TypeDescription
ValueErrorIf datasetReference or one of its required members is missing from resource.