docs: Improve clarity of "Output Only" fields in Dataset class (#2201) · googleapis/python-bigquery@bd5aba8
@@ -574,6 +574,10 @@ class Dataset(object):
574574 A pointer to a dataset. If ``dataset_ref`` is a string, it must
575575 include both the project ID and the dataset ID, separated by
576576 ``.``.
577+578+ Note:
579+ Fields marked as "Output Only" are populated by the server and will only be
580+ available after calling :meth:`google.cloud.bigquery.client.Client.get_dataset`.
577581 """
578582579583_PROPERTY_TO_API_FIELD = {
@@ -692,7 +696,7 @@ def access_entries(self, value):
692696693697@property
694698def created(self):
695-"""Union[datetime.datetime, None]: Datetime at which the dataset was
699+"""Union[datetime.datetime, None]: Output only. Datetime at which the dataset was
696700 created (:data:`None` until set from the server).
697701 """
698702creation_time = self._properties.get("creationTime")
@@ -709,8 +713,8 @@ def dataset_id(self):
709713710714@property
711715def full_dataset_id(self):
712-"""Union[str, None]: ID for the dataset resource (:data:`None` until
713- set from the server)
716+"""Union[str, None]: Output only. ID for the dataset resource
717+ (:data:`None` until set from the server).
714718715719 In the format ``project_id:dataset_id``.
716720 """
@@ -725,14 +729,14 @@ def reference(self):
725729726730@property
727731def etag(self):
728-"""Union[str, None]: ETag for the dataset resource (:data:`None` until
729- set from the server).
732+"""Union[str, None]: Output only. ETag for the dataset resource
733+ (:data:`None` until set from the server).
730734 """
731735return self._properties.get("etag")
732736733737@property
734738def modified(self):
735-"""Union[datetime.datetime, None]: Datetime at which the dataset was
739+"""Union[datetime.datetime, None]: Output only. Datetime at which the dataset was
736740 last modified (:data:`None` until set from the server).
737741 """
738742modified_time = self._properties.get("lastModifiedTime")
@@ -744,8 +748,8 @@ def modified(self):
744748745749@property
746750def self_link(self):
747-"""Union[str, None]: URL for the dataset resource (:data:`None` until
748- set from the server).
751+"""Union[str, None]: Output only. URL for the dataset resource
752+ (:data:`None` until set from the server).
749753 """
750754return self._properties.get("selfLink")
751755