10000 docs: Improve clarity of "Output Only" fields in Dataset class by Linchin · Pull Request #2201 · googleapis/python-bigquery · GitHub
[go: up one dir, main page]
Skip to content

docs: Improve clarity of "Output Only" fields in Dataset class #2201

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 5, 2025
Merged

docs: Improve clarity of "Output Only" fields in Dataset class #2201

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
359c99f
Here's the plan:
google-labs-jules[bot] May 22, 2025
00e2dc7
docs: Improve clarity of "Output Only" fields in Dataset class
google-labs-jules[bot] May 22, 2025
95b2cc3
Merge branch 'main' into fix-dataset-output-only-docs-final
Linchin May 23, 2025
b73f946
Merge branch 'main' into fix-dataset-output-only-docs-final
chalmerlowe May 27, 2025
8c28a21
Merge branch 'main' into fix-dataset-output-only-docs-final
chalmerlowe Jun 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 12 additions & 8 deletions google/cloud/bigquery/dataset.py
View file
Open in desktop
Original file line number Diff line number Dif FB25 f line change
Expand Up @@ -574,6 +574,10 @@ class Dataset(object):
A pointer to a dataset. If ``dataset_ref`` is a string, it must
include both the project ID and the dataset ID, separated by
``.``.

Note:
Fields marked as "Output Only" are populated by the server and will only be
available after calling :meth:`google.cloud.bigquery.client.Client.get_dataset`.
"""

_PROPERTY_TO_API_FIELD = {
Expand Down Expand Up @@ -692,7 +696,7 @@ def access_entries(self, value):

@property
def created(self):
"""Union[datetime.datetime, None]: Datetime at which the dataset was
"""Union[datetime.datetime, None]: Output only. Datetime at which the dataset was
created (:data:`None` until set from the server).
"""
creation_time = self._properties.get("creationTime")
Expand All @@ -709,8 +713,8 @@ def dataset_id(self):

@property
def full_dataset_id(self):
"""Union[str, None]: ID for the dataset resource (:data:`None` until
set from the server)
"""Union[str, None]: Output only. ID for the dataset resource
(:data:`None` until set from the server).

In the format ``project_id:dataset_id``.
"""
Expand All @@ -725,14 +729,14 @@ def reference(self):

@property
def etag(self):
"""Union[str, None]: ETag for the dataset resource (:data:`None` until
set from the server).
"""Union[str, None]: Output only. ETag for the dataset resource
(:data:`None` until set from the server).
"""
return self._properties.get("etag")

@property
def modified(self):
"""Union[datetime.datetime, None]: Datetime at which the dataset was
"""Union[datetime.datetime, None]: Output only. Datetime at which the dataset was
last modified (:data:`None` until set from the server).
"""
modified_time = self._properties.get("lastModifiedTime")
Expand All @@ -744,8 +748,8 @@ def modified(self):

@property
def self_link(self):
"""Union[str, None]: URL for the dataset resource (:data:`None` until
set from the server).
"""Union[str, None]: Output only. URL for the dataset resource
(:data:`None` until set from the server).
"""
return self._properties.get("selfLink")

Expand Down
0