Skip to content

Commit

Permalink
Fix client_info bug, update docstrings. (#6405)
Browse files Browse the repository at this point in the history
  • Loading branch information
@dpebot @tseaver
dpebot authored and tseaver committed Nov 6, 2018
1 parent b2b86df commit 30f5523
Show file tree
Hide file tree
Showing 3 changed files with 76 additions and 67 deletions.
129 changes: 69 additions & 60 deletions ...-datatransfer/google/cloud/bigquery_datatransfer_v1/gapic/data_transfer_service_client.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -185,9 +185,10 @@ def __init__(self,
)

if client_info is None:
client_info = (
google.api_core.gapic_v1.client_info.DEFAULT_CLIENT_INFO)
client_info.gapic_version = _GAPIC_LIBRARY_VERSION
client_info = google.api_core.gapic_v1.client_info.ClientInfo(
gapic_version=_GAPIC_LIBRARY_VERSION, )
else:
client_info.gapic_version = _GAPIC_LIBRARY_VERSION
self._client_info = client_info

# Parse out the default settings for retry and timeout for each RPC
Expand Down Expand Up @@ -297,14 +298,14 @@ def list_data_sources(self,
>>> # Alternatively:
>>>
>>> # Iterate over results one page at a time
>>> for page in client.list_data_sources(parent, options=CallOptions(page_token=INITIAL_PAGE)):
>>> for page in client.list_data_sources(parent).pages:
... for element in page:
... # process element
... pass
Args:
parent (str): The BigQuery project id for which data sources should be returned.
Must be in the form: ``projects/{project_id}``
parent (str): The BigQuery project id for which data sources should be returned. Must
be in the form: ``projects/{project_id}``
page_size (int): The maximum number of resources contained in the
underlying API response. If page streaming is performed per-
resource, this parameter does not affect the return value. If page
Expand Down Expand Up @@ -391,35 +392,38 @@ def create_transfer_config(self,
>>>
>>> parent = client.project_path('[PROJECT]')
>>>
>>> # TODO: Initialize ``transfer_config``:
>>> # TODO: Initialize `transfer_config`:
>>> transfer_config = {}
>>>
>>> response = client.create_transfer_config(parent, transfer_config)
Args:
parent (str): The BigQuery project id where the transfer configuration should be created.
Must be in the format /projects/{project_id}/locations/{location_id}
If specified location and location of the destination bigquery dataset
do not match - the request will fail.
parent (str): The BigQuery project id where the transfer configuration should be
created. Must be in the format
/projects/{project\_id}/locations/{location\_id} If specified location
and location of the destination bigquery dataset do not match - the
request will fail.
transfer_config (Union[dict, ~google.cloud.bigquery_datatransfer_v1.types.TransferConfig]): Data transfer configuration to create.
If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.bigquery_datatransfer_v1.types.TransferConfig`
authorization_code (str): Optional OAuth2 authorization code to use with this transfer configuration.
This is required if new credentials are needed, as indicated by
``CheckValidCreds``.
In order to obtain authorization_code, please make a
request to
https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>
* client_id should be OAuth client_id of BigQuery DTS API for the given
data source returned by ListDataSources method.
* data_source_scopes are the scopes returned by ListDataSources method.
* redirect_uri is an optional parameter. If not specified, then
authorization code is posted to the opener of authorization flow window.
Otherwise it will be sent to the redirect uri. A special value of
urn:ietf:wg:oauth:2.0:oob means that authorization code should be
returned in the title bar of the browser, with the page text prompting
the user to copy the code and paste it in the application.
authorization_code (str): Optional OAuth2 authorization code to use with this transfer
configuration. This is required if new credentials are needed, as
indicated by ``CheckValidCreds``. In order to obtain
authorization\_code, please make a request to
https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client\_id=&scope=&redirect\_uri=
- client\_id should be OAuth client\_id of BigQuery DTS API for the
given data source returned by ListDataSources method.
- data\_source\_scopes are the scopes returned by ListDataSources
method.
- redirect\_uri is an optional parameter. If not specified, then
authorization code is posted to the opener of authorization flow
window. Otherwise it will be sent to the redirect uri. A special
value of urn:ietf:wg:oauth:2.0:oob means that authorization code
should be returned in the title bar of the browser, with the page
text prompting the user to copy the code and paste it in the
application.
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will not
be retried.
Expand Down Expand Up @@ -487,37 +491,40 @@ def update_transfer_config(self,
>>>
>>> client = bigquery_datatransfer_v1.DataTransferServiceClient()
>>>
>>> # TODO: Initialize ``transfer_config``:
>>> # TODO: Initialize `transfer_config`:
>>> transfer_config = {}
>>>
>>> # TODO: Initialize ``update_mask``:
>>> # TODO: Initialize `update_mask`:
>>> update_mask = {}
>>>
>>> response = client.update_transfer_config(transfer_config, update_mask)
Args:
transfer_config (Union[dict, ~google.cloud.bigquery_datatransfer_v1.types.TransferConfig]): Data transfer configuration to create.
If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.bigquery_datatransfer_v1.types.TransferConfig`
update_mask (Union[dict, ~google.cloud.bigquery_datatransfer_v1.types.FieldMask]): Required list of fields to be updated in this request.
If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.bigquery_datatransfer_v1.types.FieldMask`
authorization_code (str): Optional OAuth2 authorization code to use with this transfer configuration.
If it is provided, the transfer configuration will be associated with the
authorizing user.
In order to obtain authorization_code, please make a
request to
https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>
* client_id should be OAuth client_id of BigQuery DTS API for the given
data source returned by ListDataSources method.
* data_source_scopes are the scopes returned by ListDataSources method.
* redirect_uri is an optional parameter. If not specified, then
authorization code is posted to the opener of authorization flow window.
Otherwise it will be sent to the redirect uri. A special value of
urn:ietf:wg:oauth:2.0:oob means that authorization code should be
returned in the title bar of the browser, with the page text prompting
the user to copy the code and paste it in the application.
authorization_code (str): Optional OAuth2 authorization code to use with this transfer
configuration. If it is provided, the transfer configuration will be
associated with the authorizing user. In order to obtain
authorization\_code, please make a request to
https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client\_id=&scope=&redirect\_uri=
- client\_id should be OAuth client\_id of BigQuery DTS API for the
given data source returned by ListDataSources method.
- data\_source\_scopes are the scopes returned by ListDataSources
method.
- redirect\_uri is an optional parameter. If not specified, then
authorization code is posted to the opener of authorization flow
window. Otherwise it will be sent to the redirect uri. A special
value of urn:ietf:wg:oauth:2.0:oob means that authorization code
should be returned in the title bar of the browser, with the page
text prompting the user to copy the code and paste it in the
application.
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will not
be retried.
Expand Down Expand Up @@ -727,14 +734,14 @@ def list_transfer_configs(self,
>>> # Alternatively:
>>>
>>> # Iterate over results one page at a time
>>> for page in client.list_transfer_configs(parent, options=CallOptions(page_token=INITIAL_PAGE)):
>>> for page in client.list_transfer_configs(parent).pages:
... for element in page:
... # process element
... pass
Args:
parent (str): The BigQuery project id for which data sources
should be returned: ``projects/{project_id}``.
parent (str): The BigQuery project id for which data sources should be returned:
``projects/{project_id}``.
data_source_ids (list[str]): When specified, only configurations of requested data sources are returned.
page_size (int): The maximum number of resources contained in the
underlying API response. If page streaming is performed per-
Expand Down Expand Up @@ -814,10 +821,10 @@ def schedule_transfer_runs(self,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None):
"""
Creates transfer runs for a time range [start_time, end_time].
For each date - or whatever granularity the data source supports - in the
range, one transfer run is created.
Note that runs are created per UTC time in the time range.
Creates transfer runs for a time range [start\_time, end\_time]. For
each date - or whatever granularity the data source supports - in the
range, one transfer run is created. Note that runs are created per UTC
time in the time range.
Example:
>>> from google.cloud import bigquery_datatransfer_v1
Expand All @@ -826,10 +833,10 @@ def schedule_transfer_runs(self,
>>>
>>> parent = client.project_transfer_config_path('[PROJECT]', '[TRANSFER_CONFIG]')
>>>
>>> # TODO: Initialize ``start_time``:
>>> # TODO: Initialize `start_time`:
>>> start_time = {}
>>>
>>> # TODO: Initialize ``end_time``:
>>> # TODO: Initialize `end_time`:
>>> end_time = {}
>>>
>>> response = client.schedule_transfer_runs(parent, start_time, end_time)
Expand All @@ -838,11 +845,13 @@ def schedule_transfer_runs(self,
parent (str): Transfer configuration name in the form:
``projects/{project_id}/transferConfigs/{config_id}``.
start_time (Union[dict, ~google.cloud.bigquery_datatransfer_v1.types.Timestamp]): Start time of the range of transfer runs. For example,
``\"2017-05-25T00:00:00+00:00\"``.
``"2017-05-25T00:00:00+00:00"``.
If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.bigquery_datatransfer_v1.types.Timestamp`
end_time (Union[dict, ~google.cloud.bigquery_datatransfer_v1.types.Timestamp]): End time of the range of transfer runs. For example,
``\"2017-05-30T00:00:00+00:00\"``.
``"2017-05-30T00:00:00+00:00"``.
If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.bigquery_datatransfer_v1.types.Timestamp`
retry (Optional[google.api_core.retry.Retry]): A retry object used
Expand Down Expand Up @@ -1053,14 +1062,14 @@ def list_transfer_runs(self,
>>> # Alternatively:
>>>
>>> # Iterate over results one page at a time
>>> for page in client.list_transfer_runs(parent, options=CallOptions(page_token=INITIAL_PAGE)):
>>> for page in client.list_transfer_runs(parent).pages:
... for element in page:
... # process element
... pass
Args:
parent (str): Name of transfer configuration for which transfer runs should be retrieved.
Format of transfer configuration resource name is:
parent (str): Name of transfer configuration for which transfer runs should be
retrieved. Format of transfer configuration resource name is:
``projects/{project_id}/transferConfigs/{config_id}``.
states (list[~google.cloud.bigquery_datatransfer_v1.types.TransferState]): When specified, only transfer runs with requested states are returned.
page_size (int): The maximum number of resources contained in the
Expand Down Expand Up @@ -1161,7 +1170,7 @@ def list_transfer_logs(self,
>>> # Alternatively:
>>>
>>> # Iterate over results one page at a time
>>> for page in client.list_transfer_logs(parent, options=CallOptions(page_token=INITIAL_PAGE)):
>>> for page in client.list_transfer_logs(parent).pages:
... for element in page:
... # process element
... pass
Expand Down
6 changes: 3 additions & 3 deletions ...s/google-cloud-bigquery-datatransfer/google/cloud/bigquery_datatransfer_v1/gapic/enums.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@

class NullValue(enum.IntEnum):
"""
``NullValue`` is a singleton enumeration to represent the null value for the
``Value`` type union.
``NullValue`` is a singleton enumeration to represent the null value for
the ``Value`` type union.
The JSON representation for ``NullValue`` is JSON ``null``.
The JSON representation for ``NullValue`` is JSON ``null``.
Attributes:
NULL_VALUE (int): Null value.
Expand Down
8 changes: 4 additions & 4 deletions ...e/cloud/bigquery_datatransfer_v1/gapic/transports/data_transfer_service_grpc_transport.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -191,10 +191,10 @@ def list_transfer_configs(self):
def schedule_transfer_runs(self):
"""Return the gRPC stub for {$apiMethod.name}.
Creates transfer runs for a time range [start_time, end_time].
For each date - or whatever granularity the data source supports - in the
range, one transfer run is created.
Note that runs are created per UTC time in the time range.
Creates transfer runs for a time range [start\_time, end\_time]. For
each date - or whatever granularity the data source supports - in the
range, one transfer run is created. Note that runs are created per UTC
time in the time range.
Returns:
Callable: A callable which accepts the appropriate
Expand Down

0 comments on commit 30f5523

Please sign in to comment.