Skip to content
Permalink
Browse files
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
  • Loading branch information
gcf-owl-bot committed Aug 27, 2021
1 parent 10c2f3a commit 9684723aed8c743d665ccac2b338770dd09fc94a
@@ -724,8 +724,8 @@ async def list_transfer_configs(
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListTransferConfigsAsyncPager:
r"""Returns information about all data transfers in the
project.
r"""Returns information about all transfer configs owned
by a project in the specified location.
Args:
request (:class:`google.cloud.bigquery_datatransfer_v1.types.ListTransferConfigsRequest`):
@@ -897,8 +897,8 @@ def list_transfer_configs(
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListTransferConfigsPager:
r"""Returns information about all data transfers in the
project.
r"""Returns information about all transfer configs owned
by a project in the specified location.
Args:
request (google.cloud.bigquery_datatransfer_v1.types.ListTransferConfigsRequest):
@@ -401,8 +401,8 @@ def list_transfer_configs(
]:
r"""Return a callable for the list transfer configs method over gRPC.
Returns information about all data transfers in the
project.
Returns information about all transfer configs owned
by a project in the specified location.
Returns:
Callable[[~.ListTransferConfigsRequest],
@@ -415,8 +415,8 @@ def list_transfer_configs(
]:
r"""Return a callable for the list transfer configs method over gRPC.
Returns information about all data transfers in the
project.
Returns information about all transfer configs owned
by a project in the specified location.
Returns:
Callable[[~.ListTransferConfigsRequest],
@@ -731,13 +731,14 @@ class TimeRange(proto.Message):
Start time of the range of transfer runs. For example,
``"2017-05-25T00:00:00+00:00"``. The start_time must be
strictly less than the end_time. Creates transfer runs where
run_time is in the range betwen start_time (inclusive) and
end_time (exlusive).
run_time is in the range between start_time (inclusive) and
end_time (exclusive).
end_time (google.protobuf.timestamp_pb2.Timestamp):
End time of the range of transfer runs. For example,
``"2017-05-30T00:00:00+00:00"``. The end_time must not be in
the future. Creates transfer runs where run_time is in the
range betwen start_time (inclusive) and end_time (exlusive).
range between start_time (inclusive) and end_time
(exclusive).
"""

start_time = proto.Field(
@@ -108,13 +108,11 @@ class TransferConfig(proto.Message):
Attributes:
name (str):
The resource name of the transfer config. Transfer config
names have the form of
names have the form
``projects/{project_id}/locations/{region}/transferConfigs/{config_id}``.
The name is automatically generated based on the config_id
specified in CreateTransferConfigRequest along with
project_id and region. If config_id is not provided, usually
a uuid, even though it is not guaranteed or required, will
be generated for config_id.
Where ``config_id`` is usually a uuid, even though it is not
guaranteed or required. The name is ignored when creating a
transfer config.
destination_dataset_id (str):
The BigQuery target dataset id.
display_name (str):
@@ -124,7 +122,13 @@ class TransferConfig(proto.Message):
Data source id. Cannot be changed once data
transfer is created.
params (google.protobuf.struct_pb2.Struct):
Data transfer specific parameters.
Parameters specific to each data source. For
more information see the bq tab in the 'Setting
up a data transfer' section for each data
source. For example the parameters for Cloud
Storage transfers are listed here:
https://cloud.google.com/bigquery-
transfer/docs/cloud-storage-transfer#bq
schedule (str):
Data transfer schedule. If the data source does not support
a custom schedule, this should be empty. If it is empty, the
@@ -166,9 +170,11 @@ class TransferConfig(proto.Message):
Output only. Region in which BigQuery dataset
is located.
notification_pubsub_topic (str):
Pub/Sub topic where notifications will be
sent after transfer runs associated with this
transfer config finish.
Pub/Sub topic where notifications will be sent after
transfer runs associated with this transfer config finish.
The format for specifying a pubsub topic is:
``projects/{project}/topics/{topic}``
email_preferences (google.cloud.bigquery_datatransfer_v1.types.EmailPreferences):
Email notifications will be sent according to
these preferences to the email address of the
@@ -224,8 +230,13 @@ class TransferRun(proto.Message):
Output only. Last time the data transfer run
state was updated.
params (google.protobuf.struct_pb2.Struct):
Output only. Data transfer specific
parameters.
Output only. Parameters specific to each data
source. For more information see the bq tab in
the 'Setting up a data transfer' section for
each data source. For example the parameters for
Cloud Storage transfers are listed here:
https://cloud.google.com/bigquery-
transfer/docs/cloud-storage-transfer#bq
destination_dataset_id (str):
Output only. The BigQuery target dataset id.
data_source_id (str):
@@ -244,9 +255,11 @@ class TransferRun(proto.Message):
depending on the current load, so ``schedule_time`` doesn't
always match this.
notification_pubsub_topic (str):
Output only. Pub/Sub topic where a
notification will be sent after this transfer
run finishes
Output only. Pub/Sub topic where a notification will be sent
after this transfer run finishes.
The format for specifying a pubsub topic is:
``projects/{project}/topics/{topic}``
email_preferences (google.cloud.bigquery_datatransfer_v1.types.EmailPreferences):
Output only. Email notifications will be sent
according to these preferences to the email

0 comments on commit 9684723

Please sign in to comment.