Skip to content

Commit 9baea2b

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
docs: Improvements to various message and field descriptions (#202)
- [x] Regenerate this pull request now. PiperOrigin-RevId: 391604499 Source-Link: googleapis/googleapis@853cfd3 Source-Link: googleapis/googleapis-gen@512fb81
1 parent 41c24d4 commit 9baea2b

6 files changed

Lines changed: 40 additions & 26 deletions

File tree

‎packages/google-cloud-bigquery-datatransfer/google/cloud/bigquery_datatransfer_v1/services/data_transfer_service/async_client.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -724,8 +724,8 @@ async def list_transfer_configs(
724724
timeout: float = None,
725725
metadata: Sequence[Tuple[str, str]] = (),
726726
) -> pagers.ListTransferConfigsAsyncPager:
727-
r"""Returns information about all data transfers in the
728-
project.
727+
r"""Returns information about all transfer configs owned
728+
by a project in the specified location.
729729
730730
Args:
731731
request (:class:`google.cloud.bigquery_datatransfer_v1.types.ListTransferConfigsRequest`):

‎packages/google-cloud-bigquery-datatransfer/google/cloud/bigquery_datatransfer_v1/services/data_transfer_service/client.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -897,8 +897,8 @@ def list_transfer_configs(
897897
timeout: float = None,
898898
metadata: Sequence[Tuple[str, str]] = (),
899899
) -> pagers.ListTransferConfigsPager:
900-
r"""Returns information about all data transfers in the
901-
project.
900+
r"""Returns information about all transfer configs owned
901+
by a project in the specified location.
902902
903903
Args:
904904
request (google.cloud.bigquery_datatransfer_v1.types.ListTransferConfigsRequest):

‎packages/google-cloud-bigquery-datatransfer/google/cloud/bigquery_datatransfer_v1/services/data_transfer_service/transports/grpc.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -401,8 +401,8 @@ def list_transfer_configs(
401401
]:
402402
r"""Return a callable for the list transfer configs method over gRPC.
403403
404-
Returns information about all data transfers in the
405-
project.
404+
Returns information about all transfer configs owned
405+
by a project in the specified location.
406406
407407
Returns:
408408
Callable[[~.ListTransferConfigsRequest],

‎packages/google-cloud-bigquery-datatransfer/google/cloud/bigquery_datatransfer_v1/services/data_transfer_service/transports/grpc_asyncio.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -415,8 +415,8 @@ def list_transfer_configs(
415415
]:
416416
r"""Return a callable for the list transfer configs method over gRPC.
417417
418-
Returns information about all data transfers in the
419-
project.
418+
Returns information about all transfer configs owned
419+
by a project in the specified location.
420420
421421
Returns:
422422
Callable[[~.ListTransferConfigsRequest],

‎packages/google-cloud-bigquery-datatransfer/google/cloud/bigquery_datatransfer_v1/types/datatransfer.py‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -731,13 +731,14 @@ class TimeRange(proto.Message):
731731
Start time of the range of transfer runs. For example,
732732
``"2017-05-25T00:00:00+00:00"``. The start_time must be
733733
strictly less than the end_time. Creates transfer runs where
734-
run_time is in the range betwen start_time (inclusive) and
735-
end_time (exlusive).
734+
run_time is in the range between start_time (inclusive) and
735+
end_time (exclusive).
736736
end_time (google.protobuf.timestamp_pb2.Timestamp):
737737
End time of the range of transfer runs. For example,
738738
``"2017-05-30T00:00:00+00:00"``. The end_time must not be in
739739
the future. Creates transfer runs where run_time is in the
740-
range betwen start_time (inclusive) and end_time (exlusive).
740+
range between start_time (inclusive) and end_time
741+
(exclusive).
741742
"""
742743

743744
start_time = proto.Field(

‎packages/google-cloud-bigquery-datatransfer/google/cloud/bigquery_datatransfer_v1/types/transfer.py‎

Lines changed: 28 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -108,13 +108,11 @@ class TransferConfig(proto.Message):
108108
Attributes:
109109
name (str):
110110
The resource name of the transfer config. Transfer config
111-
names have the form of
111+
names have the form
112112
``projects/{project_id}/locations/{region}/transferConfigs/{config_id}``.
113-
The name is automatically generated based on the config_id
114-
specified in CreateTransferConfigRequest along with
115-
project_id and region. If config_id is not provided, usually
116-
a uuid, even though it is not guaranteed or required, will
117-
be generated for config_id.
113+
Where ``config_id`` is usually a uuid, even though it is not
114+
guaranteed or required. The name is ignored when creating a
115+
transfer config.
118116
destination_dataset_id (str):
119117
The BigQuery target dataset id.
120118
display_name (str):
@@ -124,7 +122,13 @@ class TransferConfig(proto.Message):
124122
Data source id. Cannot be changed once data
125123
transfer is created.
126124
params (google.protobuf.struct_pb2.Struct):
127-
Data transfer specific parameters.
125+
Parameters specific to each data source. For
126+
more information see the bq tab in the 'Setting
127+
up a data transfer' section for each data
128+
source. For example the parameters for Cloud
129+
Storage transfers are listed here:
130+
https://cloud.google.com/bigquery-
131+
transfer/docs/cloud-storage-transfer#bq
128132
schedule (str):
129133
Data transfer schedule. If the data source does not support
130134
a custom schedule, this should be empty. If it is empty, the
@@ -166,9 +170,11 @@ class TransferConfig(proto.Message):
166170
Output only. Region in which BigQuery dataset
167171
is located.
168172
notification_pubsub_topic (str):
169-
Pub/Sub topic where notifications will be
170-
sent after transfer runs associated with this
171-
transfer config finish.
173+
Pub/Sub topic where notifications will be sent after
174+
transfer runs associated with this transfer config finish.
175+
176+
The format for specifying a pubsub topic is:
177+
``projects/{project}/topics/{topic}``
172178
email_preferences (google.cloud.bigquery_datatransfer_v1.types.EmailPreferences):
173179
Email notifications will be sent according to
174180
these preferences to the email address of the
@@ -224,8 +230,13 @@ class TransferRun(proto.Message):
224230
Output only. Last time the data transfer run
225231
state was updated.
226232
params (google.protobuf.struct_pb2.Struct):
227-
Output only. Data transfer specific
228-
parameters.
233+
Output only. Parameters specific to each data
234+
source. For more information see the bq tab in
235+
the 'Setting up a data transfer' section for
236+
each data source. For example the parameters for
237+
Cloud Storage transfers are listed here:
238+
https://cloud.google.com/bigquery-
239+
transfer/docs/cloud-storage-transfer#bq
229240
destination_dataset_id (str):
230241
Output only. The BigQuery target dataset id.
231242
data_source_id (str):
@@ -244,9 +255,11 @@ class TransferRun(proto.Message):
244255
depending on the current load, so ``schedule_time`` doesn't
245256
always match this.
246257
notification_pubsub_topic (str):
247-
Output only. Pub/Sub topic where a
248-
notification will be sent after this transfer
249-
run finishes
258+
Output only. Pub/Sub topic where a notification will be sent
259+
after this transfer run finishes.
260+
261+
The format for specifying a pubsub topic is:
262+
``projects/{project}/topics/{topic}``
250263
email_preferences (google.cloud.bigquery_datatransfer_v1.types.EmailPreferences):
251264
Output only. Email notifications will be sent
252265
according to these preferences to the email

0 commit comments

Comments
 (0)