Skip to content

docs: [google-cloud-bigquery-datatransfer] add a note to the CreateTransferConfigRequest and UpdateTransferConfigRequest to disable restricting service account usage #13051

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
parthea merged 2 commits into from
Sep 4, 2024
Merged

docs: [google-cloud-bigquery-datatransfer] add a note to the CreateTransferConfigRequest and UpdateTransferConfigRequest to disable restricting service account usage #13051

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5d4307c
docs: add a note to the CreateTransferConfigRequest and UpdateTransfe…
gcf-owl-bot[bot] Sep 4, 2024
4aa9b25
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Sep 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...es/google-cloud-bigquery-datatransfer/google/cloud/bigquery_datatransfer/gapic_version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
__version__ = "3.15.6" # {x-release-please-version}
__version__ = "0.0.0" # {x-release-please-version}
2 changes: 1 addition & 1 deletion ...google-cloud-bigquery-datatransfer/google/cloud/bigquery_datatransfer_v1/gapic_version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
__version__ = "3.15.6" # {x-release-please-version}
__version__ = "0.0.0" # {x-release-please-version}
38 changes: 23 additions & 15 deletions ...sfer/google/cloud/bigquery_datatransfer_v1/services/data_transfer_service/async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -554,17 +554,20 @@ async def sample_create_transfer_config():

Args:
request (Optional[Union[google.cloud.bigquery_datatransfer_v1.types.CreateTransferConfigRequest, dict]]):
The request object. A request to create a data transfer
configuration. If new credentials are
needed for this transfer configuration,
authorization info must be provided. If
authorization info is provided, the
transfer configuration will be
associated with the user id
corresponding to the authorization info.
Otherwise, the transfer configuration
will be associated with the calling
user.
The request object. A request to create a data transfer configuration. If
new credentials are needed for this transfer
configuration, authorization info must be provided. If
authorization info is provided, the transfer
configuration will be associated with the user id
corresponding to the authorization info. Otherwise, the
transfer configuration will be associated with the
calling user.

When using a cross project service account for creating
a transfer config, you must enable cross project service
account usage. For more information, see `Disable
attachment of service accounts to resources in other
projects <https://cloud.google.com/resource-manager/docs/organization-policy/restricting-service-accounts#disable_cross_project_service_accounts>`__.
parent (:class:`str`):
Required. The BigQuery project id where the transfer
configuration should be created. Must be in the format
Expand Down Expand Up @@ -693,10 +696,15 @@ async def sample_update_transfer_config():

Args:
request (Optional[Union[google.cloud.bigquery_datatransfer_v1.types.UpdateTransferConfigRequest, dict]]):
The request object. A request to update a transfer
configuration. To update the user id of
the transfer configuration,
authorization info needs to be provided.
The request object. A request to update a transfer configuration. To update
the user id of the transfer configuration, authorization
info needs to be provided.

When using a cross project service account for updating
a transfer config, you must enable cross project service
account usage. For more information, see `Disable
attachment of service accounts to resources in other
projects <https://cloud.google.com/resource-manager/docs/organization-policy/restricting-service-accounts#disable_cross_project_service_accounts>`__.
transfer_config (:class:`google.cloud.bigquery_datatransfer_v1.types.TransferConfig`):
Required. Data transfer configuration
to create.
Expand Down
38 changes: 23 additions & 15 deletions ...tatransfer/google/cloud/bigquery_datatransfer_v1/services/data_transfer_service/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1002,17 +1002,20 @@ def sample_create_transfer_config():

Args:
request (Union[google.cloud.bigquery_datatransfer_v1.types.CreateTransferConfigRequest, dict]):
The request object. A request to create a data transfer
configuration. If new credentials are
needed for this transfer configuration,
authorization info must be provided. If
authorization info is provided, the
transfer configuration will be
associated with the user id
corresponding to the authorization info.
Otherwise, the transfer configuration
will be associated with the calling
user.
The request object. A request to create a data transfer configuration. If
new credentials are needed for this transfer
configuration, authorization info must be provided. If
authorization info is provided, the transfer
configuration will be associated with the user id
corresponding to the authorization info. Otherwise, the
transfer configuration will be associated with the
calling user.

When using a cross project service account for creating
a transfer config, you must enable cross project service
account usage. For more information, see `Disable
attachment of service accounts to resources in other
projects <https://cloud.google.com/resource-manager/docs/organization-policy/restricting-service-accounts#disable_cross_project_service_accounts>`__.
parent (str):
Required. The BigQuery project id where the transfer
configuration should be created. Must be in the format
Expand Down Expand Up @@ -1138,10 +1141,15 @@ def sample_update_transfer_config():

Args:
request (Union[google.cloud.bigquery_datatransfer_v1.types.UpdateTransferConfigRequest, dict]):
The request object. A request to update a transfer
configuration. To update the user id of
the transfer configuration,
authorization info needs to be provided.
The request object. A request to update a transfer configuration. To update
the user id of the transfer configuration, authorization
info needs to be provided.

When using a cross project service account for updating
a transfer config, you must enable cross project service
account usage. For more information, see `Disable
attachment of service accounts to resources in other
projects <https://cloud.google.com/resource-manager/docs/organization-policy/restricting-service-accounts#disable_cross_project_service_accounts>`__.
transfer_config (google.cloud.bigquery_datatransfer_v1.types.TransferConfig):
Required. Data transfer configuration
to create.
Expand Down
38 changes: 23 additions & 15 deletions ...r/google/cloud/bigquery_datatransfer_v1/services/data_transfer_service/transports/rest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -789,17 +789,20 @@ def __call__(

Args:
request (~.datatransfer.CreateTransferConfigRequest):
The request object. A request to create a data transfer
configuration. If new credentials are
needed for this transfer configuration,
authorization info must be provided. If
authorization info is provided, the
transfer configuration will be
associated with the user id
corresponding to the authorization info.
Otherwise, the transfer configuration
will be associated with the calling
user.
The request object. A request to create a data transfer configuration. If
new credentials are needed for this transfer
configuration, authorization info must be provided. If
authorization info is provided, the transfer
configuration will be associated with the user id
corresponding to the authorization info. Otherwise, the
transfer configuration will be associated with the
calling user.

When using a cross project service account for creating
a transfer config, you must enable cross project service
account usage. For more information, see `Disable
attachment of service accounts to resources in other
projects <https://cloud.google.com/resource-manager/docs/organization-policy/restricting-service-accounts#disable_cross_project_service_accounts>`__.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2104,10 +2107,15 @@ def __call__(

Args:
request (~.datatransfer.UpdateTransferConfigRequest):
The request object. A request to update a transfer
configuration. To update the user id of
the transfer configuration,
authorization info needs to be provided.
The request object. A request to update a transfer configuration. To update
the user id of the transfer configuration, authorization
info needs to be provided.

When using a cross project service account for updating
a transfer config, you must enable cross project service
account usage. For more information, see `Disable
attachment of service accounts to resources in other
projects <https://cloud.google.com/resource-manager/docs/organization-policy/restricting-service-accounts#disable_cross_project_service_accounts>`__.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down
18 changes: 15 additions & 3 deletions ...e-cloud-bigquery-datatransfer/google/cloud/bigquery_datatransfer_v1/types/datatransfer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -480,6 +480,12 @@ class CreateTransferConfigRequest(proto.Message):
user id corresponding to the authorization info. Otherwise, the
transfer configuration will be associated with the calling user.

When using a cross project service account for creating a transfer
config, you must enable cross project service account usage. For
more information, see `Disable attachment of service accounts to
resources in other
projects <https://cloud.google.com/resource-manager/docs/organization-policy/restricting-service-accounts#disable_cross_project_service_accounts>`__.

Attributes:
parent (str):
Required. The BigQuery project id where the transfer
Expand Down Expand Up @@ -577,9 +583,15 @@ class CreateTransferConfigRequest(proto.Message):


class UpdateTransferConfigRequest(proto.Message):
r"""A request to update a transfer configuration. To update the
user id of the transfer configuration, authorization info needs
to be provided.
r"""A request to update a transfer configuration. To update the user id
of the transfer configuration, authorization info needs to be
provided.

When using a cross project service account for updating a transfer
config, you must enable cross project service account usage. For
more information, see `Disable attachment of service accounts to
resources in other
projects <https://cloud.google.com/resource-manager/docs/organization-policy/restricting-service-accounts#disable_cross_project_service_accounts>`__.

Attributes:
transfer_config (google.cloud.bigquery_datatransfer_v1.types.TransferConfig):
Expand Down
2 changes: 1 addition & 1 deletion ...fer/samples/generated_samples/snippet_metadata_google.cloud.bigquery.datatransfer.v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
],
"language": "PYTHON",
"name": "google-cloud-bigquery-datatransfer",
"version": "3.15.6"
"version": "0.1.0"
},
"snippets": [
{
Expand Down