Skip to content
This repository was archived by the owner on Nov 29, 2023. It is now read-only.

Commit 9ca090a

Browse files
yoshi-automationtswast
authored andcommitted
feat(bigquerydatatransfer): add service_account_name option to transfer configs (#10013)
1 parent fc06995 commit 9ca090a

File tree

8 files changed

+3886
-135
lines changed

8 files changed

+3886
-135
lines changed

google/cloud/bigquery_datatransfer_v1/gapic/data_transfer_service_client.py

Lines changed: 40 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -338,7 +338,8 @@ def get_data_source(
338338
339339
Args:
340340
name (str): Required. The field will contain name of the resource requested, for
341-
example: ``projects/{project_id}/dataSources/{data_source_id}``
341+
example: ``projects/{project_id}/dataSources/{data_source_id}`` or
342+
``projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}``
342343
retry (Optional[google.api_core.retry.Retry]): A retry object used
343344
to retry requests. If ``None`` is specified, requests will
344345
be retried using a default configuration.
@@ -422,7 +423,8 @@ def list_data_sources(
422423
423424
Args:
424425
parent (str): Required. The BigQuery project id for which data sources should be
425-
returned. Must be in the form: ``projects/{project_id}``
426+
returned. Must be in the form: ``projects/{project_id}`` or
427+
\`projects/{project\_id}/locations/{location\_id}
426428
page_size (int): The maximum number of resources contained in the
427429
underlying API response. If page streaming is performed per-
428430
resource, this parameter does not affect the return value. If page
@@ -498,6 +500,7 @@ def create_transfer_config(
498500
transfer_config,
499501
authorization_code=None,
500502
version_info=None,
503+
service_account_name=None,
501504
retry=google.api_core.gapic_v1.method.DEFAULT,
502505
timeout=google.api_core.gapic_v1.method.DEFAULT,
503506
metadata=None,
@@ -520,9 +523,9 @@ def create_transfer_config(
520523
Args:
521524
parent (str): Required. The BigQuery project id where the transfer configuration
522525
should be created. Must be in the format
523-
projects/{project\_id}/locations/{location\_id} If specified location
524-
and location of the destination bigquery dataset do not match - the
525-
request will fail.
526+
projects/{project\_id}/locations/{location\_id} or
527+
projects/{project\_id}. If specified location and location of the
528+
destination bigquery dataset do not match - the request will fail.
526529
transfer_config (Union[dict, ~google.cloud.bigquery_datatransfer_v1.types.TransferConfig]): Required. Data transfer configuration to create.
527530
528531
If a dict is provided, it must be of the same form as the protobuf
@@ -550,6 +553,10 @@ def create_transfer_config(
550553
users must use the "none+gsession" response type. which be return a
551554
version\_info back in the authorization response which be be put in a
552555
JWT claim in the token request.
556+
service_account_name (str): Optional service account name. If this field is set, transfer config will
557+
be created with this service account credentials. It requires that
558+
requesting user calling this API has permissions to act as this service
559+
account.
553560
retry (Optional[google.api_core.retry.Retry]): A retry object used
554561
to retry requests. If ``None`` is specified, requests will
555562
be retried using a default configuration.
@@ -585,6 +592,7 @@ def create_transfer_config(
585592
transfer_config=transfer_config,
586593
authorization_code=authorization_code,
587594
version_info=version_info,
595+
service_account_name=service_account_name,
588596
)
589597
if metadata is None:
590598
metadata = []
@@ -609,6 +617,7 @@ def update_transfer_config(
609617
update_mask,
610618
authorization_code=None,
611619
version_info=None,
620+
service_account_name=None,
612621
retry=google.api_core.gapic_v1.method.DEFAULT,
613622
timeout=google.api_core.gapic_v1.method.DEFAULT,
614623
metadata=None,
@@ -662,6 +671,11 @@ def update_transfer_config(
662671
users must use the "none+gsession" response type. which be return a
663672
version\_info back in the authorization response which be be put in a
664673
JWT claim in the token request.
674+
service_account_name (str): Optional service account name. If this field is set and
675+
"service\_account\_name" is set in update\_mask, transfer config will be
676+
updated to use this service account credentials. It requires that
677+
requesting user calling this API has permissions to act as this service
678+
account.
665679
retry (Optional[google.api_core.retry.Retry]): A retry object used
666680
to retry requests. If ``None`` is specified, requests will
667681
be retried using a default configuration.
@@ -697,6 +711,7 @@ def update_transfer_config(
697711
update_mask=update_mask,
698712
authorization_code=authorization_code,
699713
version_info=version_info,
714+
service_account_name=service_account_name,
700715
)
701716
if metadata is None:
702717
metadata = []
@@ -737,7 +752,8 @@ def delete_transfer_config(
737752
738753
Args:
739754
name (str): Required. The field will contain name of the resource requested, for
740-
example: ``projects/{project_id}/transferConfigs/{config_id}``
755+
example: ``projects/{project_id}/transferConfigs/{config_id}`` or
756+
``projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}``
741757
retry (Optional[google.api_core.retry.Retry]): A retry object used
742758
to retry requests. If ``None`` is specified, requests will
743759
be retried using a default configuration.
@@ -804,7 +820,8 @@ def get_transfer_config(
804820
805821
Args:
806822
name (str): Required. The field will contain name of the resource requested, for
807-
example: ``projects/{project_id}/transferConfigs/{config_id}``
823+
example: ``projects/{project_id}/transferConfigs/{config_id}`` or
824+
``projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}``
808825
retry (Optional[google.api_core.retry.Retry]): A retry object used
809826
to retry requests. If ``None`` is specified, requests will
810827
be retried using a default configuration.
@@ -888,7 +905,8 @@ def list_transfer_configs(
888905
889906
Args:
890907
parent (str): Required. The BigQuery project id for which data sources should be
891-
returned: ``projects/{project_id}``.
908+
returned: ``projects/{project_id}`` or
909+
``projects/{project_id}/locations/{location_id}``
892910
data_source_ids (list[str]): When specified, only configurations of requested data sources are returned.
893911
page_size (int): The maximum number of resources contained in the
894912
underlying API response. If page streaming is performed per-
@@ -991,7 +1009,8 @@ def schedule_transfer_runs(
9911009
9921010
Args:
9931011
parent (str): Required. Transfer configuration name in the form:
994-
``projects/{project_id}/transferConfigs/{config_id}``.
1012+
``projects/{project_id}/transferConfigs/{config_id}`` or
1013+
``projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}``.
9951014
start_time (Union[dict, ~google.cloud.bigquery_datatransfer_v1.types.Timestamp]): Required. Start time of the range of transfer runs. For example,
9961015
``"2017-05-25T00:00:00+00:00"``.
9971016
@@ -1074,7 +1093,8 @@ def get_transfer_run(
10741093
Args:
10751094
name (str): Required. The field will contain name of the resource requested, for
10761095
example:
1077-
``projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}``
1096+
``projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`` or
1097+
``projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}``
10781098
retry (Optional[google.api_core.retry.Retry]): A retry object used
10791099
to retry requests. If ``None`` is specified, requests will
10801100
be retried using a default configuration.
@@ -1145,7 +1165,8 @@ def delete_transfer_run(
11451165
Args:
11461166
name (str): Required. The field will contain name of the resource requested, for
11471167
example:
1148-
``projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}``
1168+
``projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`` or
1169+
``projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}``
11491170
retry (Optional[google.api_core.retry.Retry]): A retry object used
11501171
to retry requests. If ``None`` is specified, requests will
11511172
be retried using a default configuration.
@@ -1228,7 +1249,8 @@ def list_transfer_runs(
12281249
Args:
12291250
parent (str): Required. Name of transfer configuration for which transfer runs should
12301251
be retrieved. Format of transfer configuration resource name is:
1231-
``projects/{project_id}/transferConfigs/{config_id}``.
1252+
``projects/{project_id}/transferConfigs/{config_id}`` or
1253+
``projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}``.
12321254
states (list[~google.cloud.bigquery_datatransfer_v1.types.TransferState]): When specified, only transfer runs with requested states are returned.
12331255
page_size (int): The maximum number of resources contained in the
12341256
underlying API response. If page streaming is performed per-
@@ -1335,7 +1357,8 @@ def list_transfer_logs(
13351357
13361358
Args:
13371359
parent (str): Required. Transfer run name in the form:
1338-
``projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}``.
1360+
``projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`` or
1361+
``projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}``
13391362
page_size (int): The maximum number of resources contained in the
13401363
underlying API response. If page streaming is performed per-
13411364
resource, this parameter does not affect the return value. If page
@@ -1433,7 +1456,8 @@ def check_valid_creds(
14331456
14341457
Args:
14351458
name (str): Required. The data source in the form:
1436-
``projects/{project_id}/dataSources/{data_source_id}``
1459+
``projects/{project_id}/dataSources/{data_source_id}`` or
1460+
``projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}``.
14371461
retry (Optional[google.api_core.retry.Retry]): A retry object used
14381462
to retry requests. If ``None`` is specified, requests will
14391463
be retried using a default configuration.
@@ -1506,7 +1530,8 @@ def start_manual_transfer_runs(
15061530
15071531
Args:
15081532
parent (str): Transfer configuration name in the form:
1509-
``projects/{project_id}/transferConfigs/{config_id}``.
1533+
``projects/{project_id}/transferConfigs/{config_id}`` or
1534+
``projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}``.
15101535
requested_time_range (Union[dict, ~google.cloud.bigquery_datatransfer_v1.types.TimeRange]): Time range for the transfer runs that should be started.
15111536
15121537
If a dict is provided, it must be of the same form as the protobuf

0 commit comments

Comments
 (0)