diff --git a/.flake8 b/.flake8 index 29227d4..2e43874 100644 --- a/.flake8 +++ b/.flake8 @@ -16,7 +16,7 @@ # Generated by synthtool. DO NOT EDIT! [flake8] -ignore = E203, E266, E501, W503 +ignore = E203, E231, E266, E501, W503 exclude = # Exclude generated code. **/proto/** diff --git a/.github/.OwlBot.lock.yaml b/.github/.OwlBot.lock.yaml index 44c78f7..fa57622 100644 --- a/.github/.OwlBot.lock.yaml +++ b/.github/.OwlBot.lock.yaml @@ -13,4 +13,5 @@ # limitations under the License. docker: image: gcr.io/cloud-devrel-public-resources/owlbot-python:latest - digest: sha256:4e1991042fe54b991db9ca17c8fb386e61b22fe4d1472a568bf0fcac85dcf5d3 + digest: sha256:1894490910e891a385484514b22eb5133578897eb5b3c380e6d8ad475c6647cd +# created: 2022-04-01T15:48:07.524222836Z diff --git a/.github/auto-label.yaml b/.github/auto-label.yaml new file mode 100644 index 0000000..09c8d73 --- /dev/null +++ b/.github/auto-label.yaml @@ -0,0 +1,2 @@ +requestsize: + enabled: true diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 62eb5a7..46d2371 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -22,7 +22,7 @@ repos: - id: end-of-file-fixer - id: check-yaml - repo: https://github.com/psf/black - rev: 19.10b0 + rev: 22.3.0 hooks: - id: black - repo: https://gitlab.com/pycqa/flake8 diff --git a/.repo-metadata.json b/.repo-metadata.json index cb3e092..de3c591 100644 --- a/.repo-metadata.json +++ b/.repo-metadata.json @@ -11,7 +11,7 @@ "distribution_name": "google-cloud-bigquery-migration", "api_id": "bigquerymigration.googleapis.com", "requires_billing": true, - "default_version": "v2alpha", + "default_version": "v2", "codeowner_team": "@googleapis/api-bigquery", "api_shortname": "bigquerymigration" } diff --git a/CHANGELOG.md b/CHANGELOG.md index 2d25bbf..a7126dc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,17 @@ # Changelog +## [0.4.0](https://github.com/googleapis/python-bigquery-migration/compare/v0.3.1...v0.4.0) (2022-04-03) + + +### Features + +* Add bigquery_migration v2 client library ([#54](https://github.com/googleapis/python-bigquery-migration/issues/54)) ([776ea61](https://github.com/googleapis/python-bigquery-migration/commit/776ea6189f6a94c5daa5af6b4fa7e0e3b21015ec)) + + +### Bug Fixes + +* set bigquery_migration_v2 as the default import ([776ea61](https://github.com/googleapis/python-bigquery-migration/commit/776ea6189f6a94c5daa5af6b4fa7e0e3b21015ec)) + ### [0.3.1](https://github.com/googleapis/python-bigquery-migration/compare/v0.3.0...v0.3.1) (2022-03-05) diff --git a/docs/bigquery_migration_v2/migration_service.rst b/docs/bigquery_migration_v2/migration_service.rst new file mode 100644 index 0000000..513891e --- /dev/null +++ b/docs/bigquery_migration_v2/migration_service.rst @@ -0,0 +1,10 @@ +MigrationService +---------------------------------- + +.. automodule:: google.cloud.bigquery_migration_v2.services.migration_service + :members: + :inherited-members: + +.. automodule:: google.cloud.bigquery_migration_v2.services.migration_service.pagers + :members: + :inherited-members: diff --git a/docs/bigquery_migration_v2/services.rst b/docs/bigquery_migration_v2/services.rst new file mode 100644 index 0000000..74ebb7a --- /dev/null +++ b/docs/bigquery_migration_v2/services.rst @@ -0,0 +1,6 @@ +Services for Google Cloud Bigquery Migration v2 API +=================================================== +.. toctree:: + :maxdepth: 2 + + migration_service diff --git a/docs/bigquery_migration_v2/types.rst b/docs/bigquery_migration_v2/types.rst new file mode 100644 index 0000000..a632ea8 --- /dev/null +++ b/docs/bigquery_migration_v2/types.rst @@ -0,0 +1,7 @@ +Types for Google Cloud Bigquery Migration v2 API +================================================ + +.. automodule:: google.cloud.bigquery_migration_v2.types + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/conf.py b/docs/conf.py index 87e5a71..2a7d645 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -361,7 +361,10 @@ intersphinx_mapping = { "python": ("https://python.readthedocs.org/en/latest/", None), "google-auth": ("https://googleapis.dev/python/google-auth/latest/", None), - "google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None,), + "google.api_core": ( + "https://googleapis.dev/python/google-api-core/latest/", + None, + ), "grpc": ("https://grpc.github.io/grpc/python/", None), "proto-plus": ("https://proto-plus-python.readthedocs.io/en/latest/", None), "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), diff --git a/docs/index.rst b/docs/index.rst index 1636190..a86d116 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,6 +2,17 @@ .. include:: multiprocessing.rst +This package includes clients for multiple versions of Google BigQuery Migration. +By default, you will get version ``bigquery_migration_v2``. + + +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + bigquery_migration_v2/services + bigquery_migration_v2/types API Reference ------------- diff --git a/google/cloud/bigquery_migration/__init__.py b/google/cloud/bigquery_migration/__init__.py index 2bdf2d7..214c2d8 100644 --- a/google/cloud/bigquery_migration/__init__.py +++ b/google/cloud/bigquery_migration/__init__.py @@ -14,97 +14,87 @@ # limitations under the License. # -from google.cloud.bigquery_migration_v2alpha.services.migration_service.client import ( +from google.cloud.bigquery_migration_v2.services.migration_service.client import ( MigrationServiceClient, ) -from google.cloud.bigquery_migration_v2alpha.services.migration_service.async_client import ( +from google.cloud.bigquery_migration_v2.services.migration_service.async_client import ( MigrationServiceAsyncClient, ) -from google.cloud.bigquery_migration_v2alpha.types.assessment_task import ( - AssessmentOrchestrationResultDetails, -) -from google.cloud.bigquery_migration_v2alpha.types.assessment_task import ( - AssessmentTaskDetails, -) -from google.cloud.bigquery_migration_v2alpha.types.migration_entities import ( - MigrationSubtask, -) -from google.cloud.bigquery_migration_v2alpha.types.migration_entities import ( - MigrationTask, -) -from google.cloud.bigquery_migration_v2alpha.types.migration_entities import ( - MigrationTaskOrchestrationResult, -) -from google.cloud.bigquery_migration_v2alpha.types.migration_entities import ( +from google.cloud.bigquery_migration_v2.types.migration_entities import MigrationSubtask +from google.cloud.bigquery_migration_v2.types.migration_entities import MigrationTask +from google.cloud.bigquery_migration_v2.types.migration_entities import ( MigrationWorkflow, ) -from google.cloud.bigquery_migration_v2alpha.types.migration_error_details import ( - ErrorDetail, -) -from google.cloud.bigquery_migration_v2alpha.types.migration_error_details import ( +from google.cloud.bigquery_migration_v2.types.migration_error_details import ErrorDetail +from google.cloud.bigquery_migration_v2.types.migration_error_details import ( ErrorLocation, ) -from google.cloud.bigquery_migration_v2alpha.types.migration_error_details import ( +from google.cloud.bigquery_migration_v2.types.migration_error_details import ( ResourceErrorDetail, ) -from google.cloud.bigquery_migration_v2alpha.types.migration_metrics import Point -from google.cloud.bigquery_migration_v2alpha.types.migration_metrics import TimeInterval -from google.cloud.bigquery_migration_v2alpha.types.migration_metrics import TimeSeries -from google.cloud.bigquery_migration_v2alpha.types.migration_metrics import TypedValue -from google.cloud.bigquery_migration_v2alpha.types.migration_service import ( +from google.cloud.bigquery_migration_v2.types.migration_metrics import Point +from google.cloud.bigquery_migration_v2.types.migration_metrics import TimeInterval +from google.cloud.bigquery_migration_v2.types.migration_metrics import TimeSeries +from google.cloud.bigquery_migration_v2.types.migration_metrics import TypedValue +from google.cloud.bigquery_migration_v2.types.migration_service import ( CreateMigrationWorkflowRequest, ) -from google.cloud.bigquery_migration_v2alpha.types.migration_service import ( +from google.cloud.bigquery_migration_v2.types.migration_service import ( DeleteMigrationWorkflowRequest, ) -from google.cloud.bigquery_migration_v2alpha.types.migration_service import ( +from google.cloud.bigquery_migration_v2.types.migration_service import ( GetMigrationSubtaskRequest, ) -from google.cloud.bigquery_migration_v2alpha.types.migration_service import ( +from google.cloud.bigquery_migration_v2.types.migration_service import ( GetMigrationWorkflowRequest, ) -from google.cloud.bigquery_migration_v2alpha.types.migration_service import ( +from google.cloud.bigquery_migration_v2.types.migration_service import ( ListMigrationSubtasksRequest, ) -from google.cloud.bigquery_migration_v2alpha.types.migration_service import ( +from google.cloud.bigquery_migration_v2.types.migration_service import ( ListMigrationSubtasksResponse, ) -from google.cloud.bigquery_migration_v2alpha.types.migration_service import ( +from google.cloud.bigquery_migration_v2.types.migration_service import ( ListMigrationWorkflowsRequest, ) -from google.cloud.bigquery_migration_v2alpha.types.migration_service import ( +from google.cloud.bigquery_migration_v2.types.migration_service import ( ListMigrationWorkflowsResponse, ) -from google.cloud.bigquery_migration_v2alpha.types.migration_service import ( +from google.cloud.bigquery_migration_v2.types.migration_service import ( StartMigrationWorkflowRequest, ) -from google.cloud.bigquery_migration_v2alpha.types.translation_task import BteqOptions -from google.cloud.bigquery_migration_v2alpha.types.translation_task import ( - DatasetReference, -) -from google.cloud.bigquery_migration_v2alpha.types.translation_task import Filter -from google.cloud.bigquery_migration_v2alpha.types.translation_task import ( - IdentifierSettings, -) -from google.cloud.bigquery_migration_v2alpha.types.translation_task import ( - TeradataOptions, -) -from google.cloud.bigquery_migration_v2alpha.types.translation_task import ( - TranslationFileMapping, -) -from google.cloud.bigquery_migration_v2alpha.types.translation_task import ( - TranslationTaskDetails, -) +from google.cloud.bigquery_migration_v2.types.translation_config import ( + AzureSynapseDialect, +) +from google.cloud.bigquery_migration_v2.types.translation_config import BigQueryDialect +from google.cloud.bigquery_migration_v2.types.translation_config import Dialect +from google.cloud.bigquery_migration_v2.types.translation_config import HiveQLDialect +from google.cloud.bigquery_migration_v2.types.translation_config import NameMappingKey +from google.cloud.bigquery_migration_v2.types.translation_config import NameMappingValue +from google.cloud.bigquery_migration_v2.types.translation_config import NetezzaDialect +from google.cloud.bigquery_migration_v2.types.translation_config import ( + ObjectNameMapping, +) +from google.cloud.bigquery_migration_v2.types.translation_config import ( + ObjectNameMappingList, +) +from google.cloud.bigquery_migration_v2.types.translation_config import OracleDialect +from google.cloud.bigquery_migration_v2.types.translation_config import RedshiftDialect +from google.cloud.bigquery_migration_v2.types.translation_config import SnowflakeDialect +from google.cloud.bigquery_migration_v2.types.translation_config import SourceEnv +from google.cloud.bigquery_migration_v2.types.translation_config import SparkSQLDialect +from google.cloud.bigquery_migration_v2.types.translation_config import TeradataDialect +from google.cloud.bigquery_migration_v2.types.translation_config import ( + TranslationConfigDetails, +) +from google.cloud.bigquery_migration_v2.types.translation_config import VerticaDialect __all__ = ( "MigrationServiceClient", "MigrationServiceAsyncClient", - "AssessmentOrchestrationResultDetails", - "AssessmentTaskDetails", "MigrationSubtask", "MigrationTask", - "MigrationTaskOrchestrationResult", "MigrationWorkflow", "ErrorDetail", "ErrorLocation", @@ -122,11 +112,21 @@ "ListMigrationWorkflowsRequest", "ListMigrationWorkflowsResponse", "StartMigrationWorkflowRequest", - "BteqOptions", - "DatasetReference", - "Filter", - "IdentifierSettings", - "TeradataOptions", - "TranslationFileMapping", - "TranslationTaskDetails", + "AzureSynapseDialect", + "BigQueryDialect", + "Dialect", + "HiveQLDialect", + "NameMappingKey", + "NameMappingValue", + "NetezzaDialect", + "ObjectNameMapping", + "ObjectNameMappingList", + "OracleDialect", + "RedshiftDialect", + "SnowflakeDialect", + "SourceEnv", + "SparkSQLDialect", + "TeradataDialect", + "TranslationConfigDetails", + "VerticaDialect", ) diff --git a/google/cloud/bigquery_migration_v2/__init__.py b/google/cloud/bigquery_migration_v2/__init__.py new file mode 100644 index 0000000..c503015 --- /dev/null +++ b/google/cloud/bigquery_migration_v2/__init__.py @@ -0,0 +1,96 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from .services.migration_service import MigrationServiceClient +from .services.migration_service import MigrationServiceAsyncClient + +from .types.migration_entities import MigrationSubtask +from .types.migration_entities import MigrationTask +from .types.migration_entities import MigrationWorkflow +from .types.migration_error_details import ErrorDetail +from .types.migration_error_details import ErrorLocation +from .types.migration_error_details import ResourceErrorDetail +from .types.migration_metrics import Point +from .types.migration_metrics import TimeInterval +from .types.migration_metrics import TimeSeries +from .types.migration_metrics import TypedValue +from .types.migration_service import CreateMigrationWorkflowRequest +from .types.migration_service import DeleteMigrationWorkflowRequest +from .types.migration_service import GetMigrationSubtaskRequest +from .types.migration_service import GetMigrationWorkflowRequest +from .types.migration_service import ListMigrationSubtasksRequest +from .types.migration_service import ListMigrationSubtasksResponse +from .types.migration_service import ListMigrationWorkflowsRequest +from .types.migration_service import ListMigrationWorkflowsResponse +from .types.migration_service import StartMigrationWorkflowRequest +from .types.translation_config import AzureSynapseDialect +from .types.translation_config import BigQueryDialect +from .types.translation_config import Dialect +from .types.translation_config import HiveQLDialect +from .types.translation_config import NameMappingKey +from .types.translation_config import NameMappingValue +from .types.translation_config import NetezzaDialect +from .types.translation_config import ObjectNameMapping +from .types.translation_config import ObjectNameMappingList +from .types.translation_config import OracleDialect +from .types.translation_config import RedshiftDialect +from .types.translation_config import SnowflakeDialect +from .types.translation_config import SourceEnv +from .types.translation_config import SparkSQLDialect +from .types.translation_config import TeradataDialect +from .types.translation_config import TranslationConfigDetails +from .types.translation_config import VerticaDialect + +__all__ = ( + "MigrationServiceAsyncClient", + "AzureSynapseDialect", + "BigQueryDialect", + "CreateMigrationWorkflowRequest", + "DeleteMigrationWorkflowRequest", + "Dialect", + "ErrorDetail", + "ErrorLocation", + "GetMigrationSubtaskRequest", + "GetMigrationWorkflowRequest", + "HiveQLDialect", + "ListMigrationSubtasksRequest", + "ListMigrationSubtasksResponse", + "ListMigrationWorkflowsRequest", + "ListMigrationWorkflowsResponse", + "MigrationServiceClient", + "MigrationSubtask", + "MigrationTask", + "MigrationWorkflow", + "NameMappingKey", + "NameMappingValue", + "NetezzaDialect", + "ObjectNameMapping", + "ObjectNameMappingList", + "OracleDialect", + "Point", + "RedshiftDialect", + "ResourceErrorDetail", + "SnowflakeDialect", + "SourceEnv", + "SparkSQLDialect", + "StartMigrationWorkflowRequest", + "TeradataDialect", + "TimeInterval", + "TimeSeries", + "TranslationConfigDetails", + "TypedValue", + "VerticaDialect", +) diff --git a/google/cloud/bigquery_migration_v2/gapic_metadata.json b/google/cloud/bigquery_migration_v2/gapic_metadata.json new file mode 100644 index 0000000..f841186 --- /dev/null +++ b/google/cloud/bigquery_migration_v2/gapic_metadata.json @@ -0,0 +1,93 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.cloud.bigquery_migration_v2", + "protoPackage": "google.cloud.bigquery.migration.v2", + "schema": "1.0", + "services": { + "MigrationService": { + "clients": { + "grpc": { + "libraryClient": "MigrationServiceClient", + "rpcs": { + "CreateMigrationWorkflow": { + "methods": [ + "create_migration_workflow" + ] + }, + "DeleteMigrationWorkflow": { + "methods": [ + "delete_migration_workflow" + ] + }, + "GetMigrationSubtask": { + "methods": [ + "get_migration_subtask" + ] + }, + "GetMigrationWorkflow": { + "methods": [ + "get_migration_workflow" + ] + }, + "ListMigrationSubtasks": { + "methods": [ + "list_migration_subtasks" + ] + }, + "ListMigrationWorkflows": { + "methods": [ + "list_migration_workflows" + ] + }, + "StartMigrationWorkflow": { + "methods": [ + "start_migration_workflow" + ] + } + } + }, + "grpc-async": { + "libraryClient": "MigrationServiceAsyncClient", + "rpcs": { + "CreateMigrationWorkflow": { + "methods": [ + "create_migration_workflow" + ] + }, + "DeleteMigrationWorkflow": { + "methods": [ + "delete_migration_workflow" + ] + }, + "GetMigrationSubtask": { + "methods": [ + "get_migration_subtask" + ] + }, + "GetMigrationWorkflow": { + "methods": [ + "get_migration_workflow" + ] + }, + "ListMigrationSubtasks": { + "methods": [ + "list_migration_subtasks" + ] + }, + "ListMigrationWorkflows": { + "methods": [ + "list_migration_workflows" + ] + }, + "StartMigrationWorkflow": { + "methods": [ + "start_migration_workflow" + ] + } + } + } + } + } + } +} diff --git a/google/cloud/bigquery_migration_v2/py.typed b/google/cloud/bigquery_migration_v2/py.typed new file mode 100644 index 0000000..fcbd0b5 --- /dev/null +++ b/google/cloud/bigquery_migration_v2/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-bigquery-migration package uses inline types. diff --git a/google/cloud/bigquery_migration_v2/services/__init__.py b/google/cloud/bigquery_migration_v2/services/__init__.py new file mode 100644 index 0000000..e8e1c38 --- /dev/null +++ b/google/cloud/bigquery_migration_v2/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/google/cloud/bigquery_migration_v2/services/migration_service/__init__.py b/google/cloud/bigquery_migration_v2/services/migration_service/__init__.py new file mode 100644 index 0000000..36329bb --- /dev/null +++ b/google/cloud/bigquery_migration_v2/services/migration_service/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .client import MigrationServiceClient +from .async_client import MigrationServiceAsyncClient + +__all__ = ( + "MigrationServiceClient", + "MigrationServiceAsyncClient", +) diff --git a/google/cloud/bigquery_migration_v2/services/migration_service/async_client.py b/google/cloud/bigquery_migration_v2/services/migration_service/async_client.py new file mode 100644 index 0000000..54730a6 --- /dev/null +++ b/google/cloud/bigquery_migration_v2/services/migration_service/async_client.py @@ -0,0 +1,954 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import functools +import re +from typing import Dict, Optional, Sequence, Tuple, Type, Union +import pkg_resources + +from google.api_core.client_options import ClientOptions +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.cloud.bigquery_migration_v2.services.migration_service import pagers +from google.cloud.bigquery_migration_v2.types import migration_entities +from google.cloud.bigquery_migration_v2.types import migration_error_details +from google.cloud.bigquery_migration_v2.types import migration_metrics +from google.cloud.bigquery_migration_v2.types import migration_service +from google.protobuf import timestamp_pb2 # type: ignore +from google.rpc import error_details_pb2 # type: ignore +from .transports.base import MigrationServiceTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import MigrationServiceGrpcAsyncIOTransport +from .client import MigrationServiceClient + + +class MigrationServiceAsyncClient: + """Service to handle EDW migrations.""" + + _client: MigrationServiceClient + + DEFAULT_ENDPOINT = MigrationServiceClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = MigrationServiceClient.DEFAULT_MTLS_ENDPOINT + + migration_subtask_path = staticmethod(MigrationServiceClient.migration_subtask_path) + parse_migration_subtask_path = staticmethod( + MigrationServiceClient.parse_migration_subtask_path + ) + migration_workflow_path = staticmethod( + MigrationServiceClient.migration_workflow_path + ) + parse_migration_workflow_path = staticmethod( + MigrationServiceClient.parse_migration_workflow_path + ) + common_billing_account_path = staticmethod( + MigrationServiceClient.common_billing_account_path + ) + parse_common_billing_account_path = staticmethod( + MigrationServiceClient.parse_common_billing_account_path + ) + common_folder_path = staticmethod(MigrationServiceClient.common_folder_path) + parse_common_folder_path = staticmethod( + MigrationServiceClient.parse_common_folder_path + ) + common_organization_path = staticmethod( + MigrationServiceClient.common_organization_path + ) + parse_common_organization_path = staticmethod( + MigrationServiceClient.parse_common_organization_path + ) + common_project_path = staticmethod(MigrationServiceClient.common_project_path) + parse_common_project_path = staticmethod( + MigrationServiceClient.parse_common_project_path + ) + common_location_path = staticmethod(MigrationServiceClient.common_location_path) + parse_common_location_path = staticmethod( + MigrationServiceClient.parse_common_location_path + ) + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + info (dict): The service account private key info. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + MigrationServiceAsyncClient: The constructed client. + """ + return MigrationServiceClient.from_service_account_info.__func__(MigrationServiceAsyncClient, info, *args, **kwargs) # type: ignore + + @classmethod + def from_service_account_file(cls, filename: str, *args, **kwargs): + """Creates an instance of this client using the provided credentials + file. + + Args: + filename (str): The path to the service account private key json + file. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + MigrationServiceAsyncClient: The constructed client. + """ + return MigrationServiceClient.from_service_account_file.__func__(MigrationServiceAsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @classmethod + def get_mtls_endpoint_and_cert_source( + cls, client_options: Optional[ClientOptions] = None + ): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variabel is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + return MigrationServiceClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore + + @property + def transport(self) -> MigrationServiceTransport: + """Returns the transport used by the client instance. + + Returns: + MigrationServiceTransport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial( + type(MigrationServiceClient).get_transport_class, type(MigrationServiceClient) + ) + + def __init__( + self, + *, + credentials: ga_credentials.Credentials = None, + transport: Union[str, MigrationServiceTransport] = "grpc_asyncio", + client_options: ClientOptions = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the migration service client. + + Args: + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + transport (Union[str, ~.MigrationServiceTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (ClientOptions): Custom options for the client. It + won't take effect if a ``transport`` instance is provided. + (1) The ``api_endpoint`` property can be used to override the + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + """ + self._client = MigrationServiceClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + ) + + async def create_migration_workflow( + self, + request: Union[migration_service.CreateMigrationWorkflowRequest, dict] = None, + *, + parent: str = None, + migration_workflow: migration_entities.MigrationWorkflow = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> migration_entities.MigrationWorkflow: + r"""Creates a migration workflow. + + .. code-block:: python + + from google.cloud import bigquery_migration_v2 + + def sample_create_migration_workflow(): + # Create a client + client = bigquery_migration_v2.MigrationServiceClient() + + # Initialize request argument(s) + request = bigquery_migration_v2.CreateMigrationWorkflowRequest( + parent="parent_value", + ) + + # Make the request + response = client.create_migration_workflow(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.bigquery_migration_v2.types.CreateMigrationWorkflowRequest, dict]): + The request object. Request to create a migration + workflow resource. + parent (:class:`str`): + Required. The name of the project to which this + migration workflow belongs. Example: + ``projects/foo/locations/bar`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + migration_workflow (:class:`google.cloud.bigquery_migration_v2.types.MigrationWorkflow`): + Required. The migration workflow to + create. + + This corresponds to the ``migration_workflow`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.bigquery_migration_v2.types.MigrationWorkflow: + A migration workflow which specifies + what needs to be done for an EDW + migration. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, migration_workflow]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = migration_service.CreateMigrationWorkflowRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if migration_workflow is not None: + request.migration_workflow = migration_workflow + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.create_migration_workflow, + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_migration_workflow( + self, + request: Union[migration_service.GetMigrationWorkflowRequest, dict] = None, + *, + name: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> migration_entities.MigrationWorkflow: + r"""Gets a previously created migration workflow. + + .. code-block:: python + + from google.cloud import bigquery_migration_v2 + + def sample_get_migration_workflow(): + # Create a client + client = bigquery_migration_v2.MigrationServiceClient() + + # Initialize request argument(s) + request = bigquery_migration_v2.GetMigrationWorkflowRequest( + name="name_value", + ) + + # Make the request + response = client.get_migration_workflow(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.bigquery_migration_v2.types.GetMigrationWorkflowRequest, dict]): + The request object. A request to get a previously + created migration workflow. + name (:class:`str`): + Required. The unique identifier for the migration + workflow. Example: + ``projects/123/locations/us/workflows/1234`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.bigquery_migration_v2.types.MigrationWorkflow: + A migration workflow which specifies + what needs to be done for an EDW + migration. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = migration_service.GetMigrationWorkflowRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_migration_workflow, + default_retry=retries.Retry( + initial=1.0, + maximum=10.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_migration_workflows( + self, + request: Union[migration_service.ListMigrationWorkflowsRequest, dict] = None, + *, + parent: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListMigrationWorkflowsAsyncPager: + r"""Lists previously created migration workflow. + + .. code-block:: python + + from google.cloud import bigquery_migration_v2 + + def sample_list_migration_workflows(): + # Create a client + client = bigquery_migration_v2.MigrationServiceClient() + + # Initialize request argument(s) + request = bigquery_migration_v2.ListMigrationWorkflowsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_migration_workflows(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.bigquery_migration_v2.types.ListMigrationWorkflowsRequest, dict]): + The request object. A request to list previously created + migration workflows. + parent (:class:`str`): + Required. The project and location of the migration + workflows to list. Example: + ``projects/123/locations/us`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.bigquery_migration_v2.services.migration_service.pagers.ListMigrationWorkflowsAsyncPager: + Response object for a ListMigrationWorkflows call. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = migration_service.ListMigrationWorkflowsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_migration_workflows, + default_retry=retries.Retry( + initial=1.0, + maximum=10.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListMigrationWorkflowsAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def delete_migration_workflow( + self, + request: Union[migration_service.DeleteMigrationWorkflowRequest, dict] = None, + *, + name: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes a migration workflow by name. + + .. code-block:: python + + from google.cloud import bigquery_migration_v2 + + def sample_delete_migration_workflow(): + # Create a client + client = bigquery_migration_v2.MigrationServiceClient() + + # Initialize request argument(s) + request = bigquery_migration_v2.DeleteMigrationWorkflowRequest( + name="name_value", + ) + + # Make the request + client.delete_migration_workflow(request=request) + + Args: + request (Union[google.cloud.bigquery_migration_v2.types.DeleteMigrationWorkflowRequest, dict]): + The request object. A request to delete a previously + created migration workflow. + name (:class:`str`): + Required. The unique identifier for the migration + workflow. Example: + ``projects/123/locations/us/workflows/1234`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = migration_service.DeleteMigrationWorkflowRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.delete_migration_workflow, + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def start_migration_workflow( + self, + request: Union[migration_service.StartMigrationWorkflowRequest, dict] = None, + *, + name: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Starts a previously created migration workflow. I.e., + the state transitions from DRAFT to RUNNING. This is a + no-op if the state is already RUNNING. An error will be + signaled if the state is anything other than DRAFT or + RUNNING. + + + .. code-block:: python + + from google.cloud import bigquery_migration_v2 + + def sample_start_migration_workflow(): + # Create a client + client = bigquery_migration_v2.MigrationServiceClient() + + # Initialize request argument(s) + request = bigquery_migration_v2.StartMigrationWorkflowRequest( + name="name_value", + ) + + # Make the request + client.start_migration_workflow(request=request) + + Args: + request (Union[google.cloud.bigquery_migration_v2.types.StartMigrationWorkflowRequest, dict]): + The request object. A request to start a previously + created migration workflow. + name (:class:`str`): + Required. The unique identifier for the migration + workflow. Example: + ``projects/123/locations/us/workflows/1234`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = migration_service.StartMigrationWorkflowRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.start_migration_workflow, + default_retry=retries.Retry( + initial=1.0, + maximum=10.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def get_migration_subtask( + self, + request: Union[migration_service.GetMigrationSubtaskRequest, dict] = None, + *, + name: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> migration_entities.MigrationSubtask: + r"""Gets a previously created migration subtask. + + .. code-block:: python + + from google.cloud import bigquery_migration_v2 + + def sample_get_migration_subtask(): + # Create a client + client = bigquery_migration_v2.MigrationServiceClient() + + # Initialize request argument(s) + request = bigquery_migration_v2.GetMigrationSubtaskRequest( + name="name_value", + ) + + # Make the request + response = client.get_migration_subtask(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.bigquery_migration_v2.types.GetMigrationSubtaskRequest, dict]): + The request object. A request to get a previously + created migration subtasks. + name (:class:`str`): + Required. The unique identifier for the migration + subtask. Example: + ``projects/123/locations/us/workflows/1234/subtasks/543`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.bigquery_migration_v2.types.MigrationSubtask: + A subtask for a migration which + carries details about the configuration + of the subtask. The content of the + details should not matter to the end + user, but is a contract between the + subtask creator and subtask worker. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = migration_service.GetMigrationSubtaskRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_migration_subtask, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_migration_subtasks( + self, + request: Union[migration_service.ListMigrationSubtasksRequest, dict] = None, + *, + parent: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListMigrationSubtasksAsyncPager: + r"""Lists previously created migration subtasks. + + .. code-block:: python + + from google.cloud import bigquery_migration_v2 + + def sample_list_migration_subtasks(): + # Create a client + client = bigquery_migration_v2.MigrationServiceClient() + + # Initialize request argument(s) + request = bigquery_migration_v2.ListMigrationSubtasksRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_migration_subtasks(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.bigquery_migration_v2.types.ListMigrationSubtasksRequest, dict]): + The request object. A request to list previously created + migration subtasks. + parent (:class:`str`): + Required. The migration task of the subtasks to list. + Example: ``projects/123/locations/us/workflows/1234`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.bigquery_migration_v2.services.migration_service.pagers.ListMigrationSubtasksAsyncPager: + Response object for a ListMigrationSubtasks call. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = migration_service.ListMigrationSubtasksRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_migration_subtasks, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListMigrationSubtasksAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def __aenter__(self): + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-bigquery-migration", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ("MigrationServiceAsyncClient",) diff --git a/google/cloud/bigquery_migration_v2/services/migration_service/client.py b/google/cloud/bigquery_migration_v2/services/migration_service/client.py new file mode 100644 index 0000000..b808306 --- /dev/null +++ b/google/cloud/bigquery_migration_v2/services/migration_service/client.py @@ -0,0 +1,1178 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import os +import re +from typing import Dict, Optional, Sequence, Tuple, Type, Union +import pkg_resources + +from google.api_core import client_options as client_options_lib +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.cloud.bigquery_migration_v2.services.migration_service import pagers +from google.cloud.bigquery_migration_v2.types import migration_entities +from google.cloud.bigquery_migration_v2.types import migration_error_details +from google.cloud.bigquery_migration_v2.types import migration_metrics +from google.cloud.bigquery_migration_v2.types import migration_service +from google.protobuf import timestamp_pb2 # type: ignore +from google.rpc import error_details_pb2 # type: ignore +from .transports.base import MigrationServiceTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import MigrationServiceGrpcTransport +from .transports.grpc_asyncio import MigrationServiceGrpcAsyncIOTransport + + +class MigrationServiceClientMeta(type): + """Metaclass for the MigrationService client. + + This provides class-level methods for building and retrieving + support objects (e.g. transport) without polluting the client instance + objects. + """ + + _transport_registry = ( + OrderedDict() + ) # type: Dict[str, Type[MigrationServiceTransport]] + _transport_registry["grpc"] = MigrationServiceGrpcTransport + _transport_registry["grpc_asyncio"] = MigrationServiceGrpcAsyncIOTransport + + def get_transport_class( + cls, + label: str = None, + ) -> Type[MigrationServiceTransport]: + """Returns an appropriate transport class. + + Args: + label: The name of the desired transport. If none is + provided, then the first transport in the registry is used. + + Returns: + The transport class to use. + """ + # If a specific transport is requested, return that one. + if label: + return cls._transport_registry[label] + + # No transport is requested; return the default (that is, the first one + # in the dictionary). + return next(iter(cls._transport_registry.values())) + + +class MigrationServiceClient(metaclass=MigrationServiceClientMeta): + """Service to handle EDW migrations.""" + + @staticmethod + def _get_default_mtls_endpoint(api_endpoint): + """Converts api endpoint to mTLS endpoint. + + Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to + "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. + Args: + api_endpoint (Optional[str]): the api endpoint to convert. + Returns: + str: converted mTLS api endpoint. + """ + if not api_endpoint: + return api_endpoint + + mtls_endpoint_re = re.compile( + r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" + ) + + m = mtls_endpoint_re.match(api_endpoint) + name, mtls, sandbox, googledomain = m.groups() + if mtls or not googledomain: + return api_endpoint + + if sandbox: + return api_endpoint.replace( + "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" + ) + + return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") + + DEFAULT_ENDPOINT = "bigquerymigration.googleapis.com" + DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore + DEFAULT_ENDPOINT + ) + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + info (dict): The service account private key info. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + MigrationServiceClient: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_info(info) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + @classmethod + def from_service_account_file(cls, filename: str, *args, **kwargs): + """Creates an instance of this client using the provided credentials + file. + + Args: + filename (str): The path to the service account private key json + file. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + MigrationServiceClient: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_file(filename) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + from_service_account_json = from_service_account_file + + @property + def transport(self) -> MigrationServiceTransport: + """Returns the transport used by the client instance. + + Returns: + MigrationServiceTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def migration_subtask_path( + project: str, + location: str, + workflow: str, + subtask: str, + ) -> str: + """Returns a fully-qualified migration_subtask string.""" + return "projects/{project}/locations/{location}/workflows/{workflow}/subtasks/{subtask}".format( + project=project, + location=location, + workflow=workflow, + subtask=subtask, + ) + + @staticmethod + def parse_migration_subtask_path(path: str) -> Dict[str, str]: + """Parses a migration_subtask path into its component segments.""" + m = re.match( + r"^projects/(?P.+?)/locations/(?P.+?)/workflows/(?P.+?)/subtasks/(?P.+?)$", + path, + ) + return m.groupdict() if m else {} + + @staticmethod + def migration_workflow_path( + project: str, + location: str, + workflow: str, + ) -> str: + """Returns a fully-qualified migration_workflow string.""" + return "projects/{project}/locations/{location}/workflows/{workflow}".format( + project=project, + location=location, + workflow=workflow, + ) + + @staticmethod + def parse_migration_workflow_path(path: str) -> Dict[str, str]: + """Parses a migration_workflow path into its component segments.""" + m = re.match( + r"^projects/(?P.+?)/locations/(?P.+?)/workflows/(?P.+?)$", + path, + ) + return m.groupdict() if m else {} + + @staticmethod + def common_billing_account_path( + billing_account: str, + ) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format( + billing_account=billing_account, + ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str, str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path( + folder: str, + ) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format( + folder=folder, + ) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str, str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path( + organization: str, + ) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format( + organization=organization, + ) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str, str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path( + project: str, + ) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format( + project=project, + ) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str, str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path( + project: str, + location: str, + ) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format( + project=project, + location=location, + ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str, str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @classmethod + def get_mtls_endpoint_and_cert_source( + cls, client_options: Optional[client_options_lib.ClientOptions] = None + ): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variabel is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + if client_options is None: + client_options = client_options_lib.ClientOptions() + use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_client_cert not in ("true", "false"): + raise ValueError( + "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + ) + if use_mtls_endpoint not in ("auto", "never", "always"): + raise MutualTLSChannelError( + "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + ) + + # Figure out the client cert source to use. + client_cert_source = None + if use_client_cert == "true": + if client_options.client_cert_source: + client_cert_source = client_options.client_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + elif use_mtls_endpoint == "always" or ( + use_mtls_endpoint == "auto" and client_cert_source + ): + api_endpoint = cls.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = cls.DEFAULT_ENDPOINT + + return api_endpoint, client_cert_source + + def __init__( + self, + *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, MigrationServiceTransport, None] = None, + client_options: Optional[client_options_lib.ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the migration service client. + + Args: + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + transport (Union[str, MigrationServiceTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. It won't take effect if a ``transport`` instance is provided. + (1) The ``api_endpoint`` property can be used to override the + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + """ + if isinstance(client_options, dict): + client_options = client_options_lib.from_dict(client_options) + if client_options is None: + client_options = client_options_lib.ClientOptions() + + api_endpoint, client_cert_source_func = self.get_mtls_endpoint_and_cert_source( + client_options + ) + + api_key_value = getattr(client_options, "api_key", None) + if api_key_value and credentials: + raise ValueError( + "client_options.api_key and credentials are mutually exclusive" + ) + + # Save or instantiate the transport. + # Ordinarily, we provide the transport, but allowing a custom transport + # instance provides an extensibility point for unusual situations. + if isinstance(transport, MigrationServiceTransport): + # transport is a MigrationServiceTransport instance. + if credentials or client_options.credentials_file or api_key_value: + raise ValueError( + "When providing a transport instance, " + "provide its credentials directly." + ) + if client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = transport + else: + import google.auth._default # type: ignore + + if api_key_value and hasattr( + google.auth._default, "get_api_key_credentials" + ): + credentials = google.auth._default.get_api_key_credentials( + api_key_value + ) + + Transport = type(self).get_transport_class(transport) + self._transport = Transport( + credentials=credentials, + credentials_file=client_options.credentials_file, + host=api_endpoint, + scopes=client_options.scopes, + client_cert_source_for_mtls=client_cert_source_func, + quota_project_id=client_options.quota_project_id, + client_info=client_info, + always_use_jwt_access=True, + ) + + def create_migration_workflow( + self, + request: Union[migration_service.CreateMigrationWorkflowRequest, dict] = None, + *, + parent: str = None, + migration_workflow: migration_entities.MigrationWorkflow = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> migration_entities.MigrationWorkflow: + r"""Creates a migration workflow. + + .. code-block:: python + + from google.cloud import bigquery_migration_v2 + + def sample_create_migration_workflow(): + # Create a client + client = bigquery_migration_v2.MigrationServiceClient() + + # Initialize request argument(s) + request = bigquery_migration_v2.CreateMigrationWorkflowRequest( + parent="parent_value", + ) + + # Make the request + response = client.create_migration_workflow(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.bigquery_migration_v2.types.CreateMigrationWorkflowRequest, dict]): + The request object. Request to create a migration + workflow resource. + parent (str): + Required. The name of the project to which this + migration workflow belongs. Example: + ``projects/foo/locations/bar`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + migration_workflow (google.cloud.bigquery_migration_v2.types.MigrationWorkflow): + Required. The migration workflow to + create. + + This corresponds to the ``migration_workflow`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.bigquery_migration_v2.types.MigrationWorkflow: + A migration workflow which specifies + what needs to be done for an EDW + migration. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, migration_workflow]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a migration_service.CreateMigrationWorkflowRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, migration_service.CreateMigrationWorkflowRequest): + request = migration_service.CreateMigrationWorkflowRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if migration_workflow is not None: + request.migration_workflow = migration_workflow + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[ + self._transport.create_migration_workflow + ] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_migration_workflow( + self, + request: Union[migration_service.GetMigrationWorkflowRequest, dict] = None, + *, + name: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> migration_entities.MigrationWorkflow: + r"""Gets a previously created migration workflow. + + .. code-block:: python + + from google.cloud import bigquery_migration_v2 + + def sample_get_migration_workflow(): + # Create a client + client = bigquery_migration_v2.MigrationServiceClient() + + # Initialize request argument(s) + request = bigquery_migration_v2.GetMigrationWorkflowRequest( + name="name_value", + ) + + # Make the request + response = client.get_migration_workflow(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.bigquery_migration_v2.types.GetMigrationWorkflowRequest, dict]): + The request object. A request to get a previously + created migration workflow. + name (str): + Required. The unique identifier for the migration + workflow. Example: + ``projects/123/locations/us/workflows/1234`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.bigquery_migration_v2.types.MigrationWorkflow: + A migration workflow which specifies + what needs to be done for an EDW + migration. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a migration_service.GetMigrationWorkflowRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, migration_service.GetMigrationWorkflowRequest): + request = migration_service.GetMigrationWorkflowRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_migration_workflow] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_migration_workflows( + self, + request: Union[migration_service.ListMigrationWorkflowsRequest, dict] = None, + *, + parent: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListMigrationWorkflowsPager: + r"""Lists previously created migration workflow. + + .. code-block:: python + + from google.cloud import bigquery_migration_v2 + + def sample_list_migration_workflows(): + # Create a client + client = bigquery_migration_v2.MigrationServiceClient() + + # Initialize request argument(s) + request = bigquery_migration_v2.ListMigrationWorkflowsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_migration_workflows(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.bigquery_migration_v2.types.ListMigrationWorkflowsRequest, dict]): + The request object. A request to list previously created + migration workflows. + parent (str): + Required. The project and location of the migration + workflows to list. Example: + ``projects/123/locations/us`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.bigquery_migration_v2.services.migration_service.pagers.ListMigrationWorkflowsPager: + Response object for a ListMigrationWorkflows call. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a migration_service.ListMigrationWorkflowsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, migration_service.ListMigrationWorkflowsRequest): + request = migration_service.ListMigrationWorkflowsRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_migration_workflows] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListMigrationWorkflowsPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def delete_migration_workflow( + self, + request: Union[migration_service.DeleteMigrationWorkflowRequest, dict] = None, + *, + name: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes a migration workflow by name. + + .. code-block:: python + + from google.cloud import bigquery_migration_v2 + + def sample_delete_migration_workflow(): + # Create a client + client = bigquery_migration_v2.MigrationServiceClient() + + # Initialize request argument(s) + request = bigquery_migration_v2.DeleteMigrationWorkflowRequest( + name="name_value", + ) + + # Make the request + client.delete_migration_workflow(request=request) + + Args: + request (Union[google.cloud.bigquery_migration_v2.types.DeleteMigrationWorkflowRequest, dict]): + The request object. A request to delete a previously + created migration workflow. + name (str): + Required. The unique identifier for the migration + workflow. Example: + ``projects/123/locations/us/workflows/1234`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a migration_service.DeleteMigrationWorkflowRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, migration_service.DeleteMigrationWorkflowRequest): + request = migration_service.DeleteMigrationWorkflowRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[ + self._transport.delete_migration_workflow + ] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + def start_migration_workflow( + self, + request: Union[migration_service.StartMigrationWorkflowRequest, dict] = None, + *, + name: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Starts a previously created migration workflow. I.e., + the state transitions from DRAFT to RUNNING. This is a + no-op if the state is already RUNNING. An error will be + signaled if the state is anything other than DRAFT or + RUNNING. + + + .. code-block:: python + + from google.cloud import bigquery_migration_v2 + + def sample_start_migration_workflow(): + # Create a client + client = bigquery_migration_v2.MigrationServiceClient() + + # Initialize request argument(s) + request = bigquery_migration_v2.StartMigrationWorkflowRequest( + name="name_value", + ) + + # Make the request + client.start_migration_workflow(request=request) + + Args: + request (Union[google.cloud.bigquery_migration_v2.types.StartMigrationWorkflowRequest, dict]): + The request object. A request to start a previously + created migration workflow. + name (str): + Required. The unique identifier for the migration + workflow. Example: + ``projects/123/locations/us/workflows/1234`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a migration_service.StartMigrationWorkflowRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, migration_service.StartMigrationWorkflowRequest): + request = migration_service.StartMigrationWorkflowRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.start_migration_workflow] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + def get_migration_subtask( + self, + request: Union[migration_service.GetMigrationSubtaskRequest, dict] = None, + *, + name: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> migration_entities.MigrationSubtask: + r"""Gets a previously created migration subtask. + + .. code-block:: python + + from google.cloud import bigquery_migration_v2 + + def sample_get_migration_subtask(): + # Create a client + client = bigquery_migration_v2.MigrationServiceClient() + + # Initialize request argument(s) + request = bigquery_migration_v2.GetMigrationSubtaskRequest( + name="name_value", + ) + + # Make the request + response = client.get_migration_subtask(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.bigquery_migration_v2.types.GetMigrationSubtaskRequest, dict]): + The request object. A request to get a previously + created migration subtasks. + name (str): + Required. The unique identifier for the migration + subtask. Example: + ``projects/123/locations/us/workflows/1234/subtasks/543`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.bigquery_migration_v2.types.MigrationSubtask: + A subtask for a migration which + carries details about the configuration + of the subtask. The content of the + details should not matter to the end + user, but is a contract between the + subtask creator and subtask worker. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a migration_service.GetMigrationSubtaskRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, migration_service.GetMigrationSubtaskRequest): + request = migration_service.GetMigrationSubtaskRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_migration_subtask] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_migration_subtasks( + self, + request: Union[migration_service.ListMigrationSubtasksRequest, dict] = None, + *, + parent: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListMigrationSubtasksPager: + r"""Lists previously created migration subtasks. + + .. code-block:: python + + from google.cloud import bigquery_migration_v2 + + def sample_list_migration_subtasks(): + # Create a client + client = bigquery_migration_v2.MigrationServiceClient() + + # Initialize request argument(s) + request = bigquery_migration_v2.ListMigrationSubtasksRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_migration_subtasks(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.cloud.bigquery_migration_v2.types.ListMigrationSubtasksRequest, dict]): + The request object. A request to list previously created + migration subtasks. + parent (str): + Required. The migration task of the subtasks to list. + Example: ``projects/123/locations/us/workflows/1234`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.bigquery_migration_v2.services.migration_service.pagers.ListMigrationSubtasksPager: + Response object for a ListMigrationSubtasks call. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a migration_service.ListMigrationSubtasksRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, migration_service.ListMigrationSubtasksRequest): + request = migration_service.ListMigrationSubtasksRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_migration_subtasks] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListMigrationSubtasksPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def __enter__(self): + return self + + def __exit__(self, type, value, traceback): + """Releases underlying transport's resources. + + .. warning:: + ONLY use as a context manager if the transport is NOT shared + with other clients! Exiting the with block will CLOSE the transport + and may cause errors in other clients! + """ + self.transport.close() + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-bigquery-migration", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ("MigrationServiceClient",) diff --git a/google/cloud/bigquery_migration_v2/services/migration_service/pagers.py b/google/cloud/bigquery_migration_v2/services/migration_service/pagers.py new file mode 100644 index 0000000..c890f78 --- /dev/null +++ b/google/cloud/bigquery_migration_v2/services/migration_service/pagers.py @@ -0,0 +1,292 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from typing import ( + Any, + AsyncIterator, + Awaitable, + Callable, + Sequence, + Tuple, + Optional, + Iterator, +) + +from google.cloud.bigquery_migration_v2.types import migration_entities +from google.cloud.bigquery_migration_v2.types import migration_service + + +class ListMigrationWorkflowsPager: + """A pager for iterating through ``list_migration_workflows`` requests. + + This class thinly wraps an initial + :class:`google.cloud.bigquery_migration_v2.types.ListMigrationWorkflowsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``migration_workflows`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListMigrationWorkflows`` requests and continue to iterate + through the ``migration_workflows`` field on the + corresponding responses. + + All the usual :class:`google.cloud.bigquery_migration_v2.types.ListMigrationWorkflowsResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + + def __init__( + self, + method: Callable[..., migration_service.ListMigrationWorkflowsResponse], + request: migration_service.ListMigrationWorkflowsRequest, + response: migration_service.ListMigrationWorkflowsResponse, + *, + metadata: Sequence[Tuple[str, str]] = () + ): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.bigquery_migration_v2.types.ListMigrationWorkflowsRequest): + The initial request object. + response (google.cloud.bigquery_migration_v2.types.ListMigrationWorkflowsResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = migration_service.ListMigrationWorkflowsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[migration_service.ListMigrationWorkflowsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[migration_entities.MigrationWorkflow]: + for page in self.pages: + yield from page.migration_workflows + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListMigrationWorkflowsAsyncPager: + """A pager for iterating through ``list_migration_workflows`` requests. + + This class thinly wraps an initial + :class:`google.cloud.bigquery_migration_v2.types.ListMigrationWorkflowsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``migration_workflows`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListMigrationWorkflows`` requests and continue to iterate + through the ``migration_workflows`` field on the + corresponding responses. + + All the usual :class:`google.cloud.bigquery_migration_v2.types.ListMigrationWorkflowsResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + + def __init__( + self, + method: Callable[ + ..., Awaitable[migration_service.ListMigrationWorkflowsResponse] + ], + request: migration_service.ListMigrationWorkflowsRequest, + response: migration_service.ListMigrationWorkflowsResponse, + *, + metadata: Sequence[Tuple[str, str]] = () + ): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.bigquery_migration_v2.types.ListMigrationWorkflowsRequest): + The initial request object. + response (google.cloud.bigquery_migration_v2.types.ListMigrationWorkflowsResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = migration_service.ListMigrationWorkflowsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages( + self, + ) -> AsyncIterator[migration_service.ListMigrationWorkflowsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + + def __aiter__(self) -> AsyncIterator[migration_entities.MigrationWorkflow]: + async def async_generator(): + async for page in self.pages: + for response in page.migration_workflows: + yield response + + return async_generator() + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListMigrationSubtasksPager: + """A pager for iterating through ``list_migration_subtasks`` requests. + + This class thinly wraps an initial + :class:`google.cloud.bigquery_migration_v2.types.ListMigrationSubtasksResponse` object, and + provides an ``__iter__`` method to iterate through its + ``migration_subtasks`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListMigrationSubtasks`` requests and continue to iterate + through the ``migration_subtasks`` field on the + corresponding responses. + + All the usual :class:`google.cloud.bigquery_migration_v2.types.ListMigrationSubtasksResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + + def __init__( + self, + method: Callable[..., migration_service.ListMigrationSubtasksResponse], + request: migration_service.ListMigrationSubtasksRequest, + response: migration_service.ListMigrationSubtasksResponse, + *, + metadata: Sequence[Tuple[str, str]] = () + ): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.bigquery_migration_v2.types.ListMigrationSubtasksRequest): + The initial request object. + response (google.cloud.bigquery_migration_v2.types.ListMigrationSubtasksResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = migration_service.ListMigrationSubtasksRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[migration_service.ListMigrationSubtasksResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[migration_entities.MigrationSubtask]: + for page in self.pages: + yield from page.migration_subtasks + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListMigrationSubtasksAsyncPager: + """A pager for iterating through ``list_migration_subtasks`` requests. + + This class thinly wraps an initial + :class:`google.cloud.bigquery_migration_v2.types.ListMigrationSubtasksResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``migration_subtasks`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListMigrationSubtasks`` requests and continue to iterate + through the ``migration_subtasks`` field on the + corresponding responses. + + All the usual :class:`google.cloud.bigquery_migration_v2.types.ListMigrationSubtasksResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + + def __init__( + self, + method: Callable[ + ..., Awaitable[migration_service.ListMigrationSubtasksResponse] + ], + request: migration_service.ListMigrationSubtasksRequest, + response: migration_service.ListMigrationSubtasksResponse, + *, + metadata: Sequence[Tuple[str, str]] = () + ): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.bigquery_migration_v2.types.ListMigrationSubtasksRequest): + The initial request object. + response (google.cloud.bigquery_migration_v2.types.ListMigrationSubtasksResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = migration_service.ListMigrationSubtasksRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages( + self, + ) -> AsyncIterator[migration_service.ListMigrationSubtasksResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + + def __aiter__(self) -> AsyncIterator[migration_entities.MigrationSubtask]: + async def async_generator(): + async for page in self.pages: + for response in page.migration_subtasks: + yield response + + return async_generator() + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) diff --git a/google/cloud/bigquery_migration_v2/services/migration_service/transports/__init__.py b/google/cloud/bigquery_migration_v2/services/migration_service/transports/__init__.py new file mode 100644 index 0000000..10ee142 --- /dev/null +++ b/google/cloud/bigquery_migration_v2/services/migration_service/transports/__init__.py @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +from typing import Dict, Type + +from .base import MigrationServiceTransport +from .grpc import MigrationServiceGrpcTransport +from .grpc_asyncio import MigrationServiceGrpcAsyncIOTransport + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[MigrationServiceTransport]] +_transport_registry["grpc"] = MigrationServiceGrpcTransport +_transport_registry["grpc_asyncio"] = MigrationServiceGrpcAsyncIOTransport + +__all__ = ( + "MigrationServiceTransport", + "MigrationServiceGrpcTransport", + "MigrationServiceGrpcAsyncIOTransport", +) diff --git a/google/cloud/bigquery_migration_v2/services/migration_service/transports/base.py b/google/cloud/bigquery_migration_v2/services/migration_service/transports/base.py new file mode 100644 index 0000000..4c2a173 --- /dev/null +++ b/google/cloud/bigquery_migration_v2/services/migration_service/transports/base.py @@ -0,0 +1,277 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union +import pkg_resources + +import google.auth # type: ignore +import google.api_core +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.bigquery_migration_v2.types import migration_entities +from google.cloud.bigquery_migration_v2.types import migration_service +from google.protobuf import empty_pb2 # type: ignore + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-bigquery-migration", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +class MigrationServiceTransport(abc.ABC): + """Abstract transport class for MigrationService.""" + + AUTH_SCOPES = ("https://www.googleapis.com/auth/cloud-platform",) + + DEFAULT_HOST: str = "bigquerymigration.googleapis.com" + + def __init__( + self, + *, + host: str = DEFAULT_HOST, + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ":" not in host: + host += ":443" + self._host = host + + scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} + + # Save the scopes. + self._scopes = scopes + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs( + "'credentials_file' and 'credentials' are mutually exclusive" + ) + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, **scopes_kwargs, quota_project_id=quota_project_id + ) + elif credentials is None: + credentials, _ = google.auth.default( + **scopes_kwargs, quota_project_id=quota_project_id + ) + + # If the credentials are service account credentials, then always try to use self signed JWT. + if ( + always_use_jwt_access + and isinstance(credentials, service_account.Credentials) + and hasattr(service_account.Credentials, "with_always_use_jwt_access") + ): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.create_migration_workflow: gapic_v1.method.wrap_method( + self.create_migration_workflow, + default_timeout=60.0, + client_info=client_info, + ), + self.get_migration_workflow: gapic_v1.method.wrap_method( + self.get_migration_workflow, + default_retry=retries.Retry( + initial=1.0, + maximum=10.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.list_migration_workflows: gapic_v1.method.wrap_method( + self.list_migration_workflows, + default_retry=retries.Retry( + initial=1.0, + maximum=10.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.delete_migration_workflow: gapic_v1.method.wrap_method( + self.delete_migration_workflow, + default_timeout=60.0, + client_info=client_info, + ), + self.start_migration_workflow: gapic_v1.method.wrap_method( + self.start_migration_workflow, + default_retry=retries.Retry( + initial=1.0, + maximum=10.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.ServiceUnavailable, + ), + deadline=60.0, + ), + default_timeout=60.0, + client_info=client_info, + ), + self.get_migration_subtask: gapic_v1.method.wrap_method( + self.get_migration_subtask, + default_timeout=None, + client_info=client_info, + ), + self.list_migration_subtasks: gapic_v1.method.wrap_method( + self.list_migration_subtasks, + default_timeout=None, + client_info=client_info, + ), + } + + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + + @property + def create_migration_workflow( + self, + ) -> Callable[ + [migration_service.CreateMigrationWorkflowRequest], + Union[ + migration_entities.MigrationWorkflow, + Awaitable[migration_entities.MigrationWorkflow], + ], + ]: + raise NotImplementedError() + + @property + def get_migration_workflow( + self, + ) -> Callable[ + [migration_service.GetMigrationWorkflowRequest], + Union[ + migration_entities.MigrationWorkflow, + Awaitable[migration_entities.MigrationWorkflow], + ], + ]: + raise NotImplementedError() + + @property + def list_migration_workflows( + self, + ) -> Callable[ + [migration_service.ListMigrationWorkflowsRequest], + Union[ + migration_service.ListMigrationWorkflowsResponse, + Awaitable[migration_service.ListMigrationWorkflowsResponse], + ], + ]: + raise NotImplementedError() + + @property + def delete_migration_workflow( + self, + ) -> Callable[ + [migration_service.DeleteMigrationWorkflowRequest], + Union[empty_pb2.Empty, Awaitable[empty_pb2.Empty]], + ]: + raise NotImplementedError() + + @property + def start_migration_workflow( + self, + ) -> Callable[ + [migration_service.StartMigrationWorkflowRequest], + Union[empty_pb2.Empty, Awaitable[empty_pb2.Empty]], + ]: + raise NotImplementedError() + + @property + def get_migration_subtask( + self, + ) -> Callable[ + [migration_service.GetMigrationSubtaskRequest], + Union[ + migration_entities.MigrationSubtask, + Awaitable[migration_entities.MigrationSubtask], + ], + ]: + raise NotImplementedError() + + @property + def list_migration_subtasks( + self, + ) -> Callable[ + [migration_service.ListMigrationSubtasksRequest], + Union[ + migration_service.ListMigrationSubtasksResponse, + Awaitable[migration_service.ListMigrationSubtasksResponse], + ], + ]: + raise NotImplementedError() + + +__all__ = ("MigrationServiceTransport",) diff --git a/google/cloud/bigquery_migration_v2/services/migration_service/transports/grpc.py b/google/cloud/bigquery_migration_v2/services/migration_service/transports/grpc.py new file mode 100644 index 0000000..1a88446 --- /dev/null +++ b/google/cloud/bigquery_migration_v2/services/migration_service/transports/grpc.py @@ -0,0 +1,437 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import grpc_helpers +from google.api_core import gapic_v1 +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore + +from google.cloud.bigquery_migration_v2.types import migration_entities +from google.cloud.bigquery_migration_v2.types import migration_service +from google.protobuf import empty_pb2 # type: ignore +from .base import MigrationServiceTransport, DEFAULT_CLIENT_INFO + + +class MigrationServiceGrpcTransport(MigrationServiceTransport): + """gRPC backend transport for MigrationService. + + Service to handle EDW migrations. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + + _stubs: Dict[str, Callable] + + def __init__( + self, + *, + host: str = "bigquerymigration.googleapis.com", + credentials: ga_credentials.Credentials = None, + credentials_file: str = None, + scopes: Sequence[str] = None, + channel: grpc.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + channel (Optional[grpc.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel( + cls, + host: str = "bigquerymigration.googleapis.com", + credentials: ga_credentials.Credentials = None, + credentials_file: str = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs, + ) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs, + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service.""" + return self._grpc_channel + + @property + def create_migration_workflow( + self, + ) -> Callable[ + [migration_service.CreateMigrationWorkflowRequest], + migration_entities.MigrationWorkflow, + ]: + r"""Return a callable for the create migration workflow method over gRPC. + + Creates a migration workflow. + + Returns: + Callable[[~.CreateMigrationWorkflowRequest], + ~.MigrationWorkflow]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "create_migration_workflow" not in self._stubs: + self._stubs["create_migration_workflow"] = self.grpc_channel.unary_unary( + "/google.cloud.bigquery.migration.v2.MigrationService/CreateMigrationWorkflow", + request_serializer=migration_service.CreateMigrationWorkflowRequest.serialize, + response_deserializer=migration_entities.MigrationWorkflow.deserialize, + ) + return self._stubs["create_migration_workflow"] + + @property + def get_migration_workflow( + self, + ) -> Callable[ + [migration_service.GetMigrationWorkflowRequest], + migration_entities.MigrationWorkflow, + ]: + r"""Return a callable for the get migration workflow method over gRPC. + + Gets a previously created migration workflow. + + Returns: + Callable[[~.GetMigrationWorkflowRequest], + ~.MigrationWorkflow]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_migration_workflow" not in self._stubs: + self._stubs["get_migration_workflow"] = self.grpc_channel.unary_unary( + "/google.cloud.bigquery.migration.v2.MigrationService/GetMigrationWorkflow", + request_serializer=migration_service.GetMigrationWorkflowRequest.serialize, + response_deserializer=migration_entities.MigrationWorkflow.deserialize, + ) + return self._stubs["get_migration_workflow"] + + @property + def list_migration_workflows( + self, + ) -> Callable[ + [migration_service.ListMigrationWorkflowsRequest], + migration_service.ListMigrationWorkflowsResponse, + ]: + r"""Return a callable for the list migration workflows method over gRPC. + + Lists previously created migration workflow. + + Returns: + Callable[[~.ListMigrationWorkflowsRequest], + ~.ListMigrationWorkflowsResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_migration_workflows" not in self._stubs: + self._stubs["list_migration_workflows"] = self.grpc_channel.unary_unary( + "/google.cloud.bigquery.migration.v2.MigrationService/ListMigrationWorkflows", + request_serializer=migration_service.ListMigrationWorkflowsRequest.serialize, + response_deserializer=migration_service.ListMigrationWorkflowsResponse.deserialize, + ) + return self._stubs["list_migration_workflows"] + + @property + def delete_migration_workflow( + self, + ) -> Callable[[migration_service.DeleteMigrationWorkflowRequest], empty_pb2.Empty]: + r"""Return a callable for the delete migration workflow method over gRPC. + + Deletes a migration workflow by name. + + Returns: + Callable[[~.DeleteMigrationWorkflowRequest], + ~.Empty]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "delete_migration_workflow" not in self._stubs: + self._stubs["delete_migration_workflow"] = self.grpc_channel.unary_unary( + "/google.cloud.bigquery.migration.v2.MigrationService/DeleteMigrationWorkflow", + request_serializer=migration_service.DeleteMigrationWorkflowRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs["delete_migration_workflow"] + + @property + def start_migration_workflow( + self, + ) -> Callable[[migration_service.StartMigrationWorkflowRequest], empty_pb2.Empty]: + r"""Return a callable for the start migration workflow method over gRPC. + + Starts a previously created migration workflow. I.e., + the state transitions from DRAFT to RUNNING. This is a + no-op if the state is already RUNNING. An error will be + signaled if the state is anything other than DRAFT or + RUNNING. + + Returns: + Callable[[~.StartMigrationWorkflowRequest], + ~.Empty]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "start_migration_workflow" not in self._stubs: + self._stubs["start_migration_workflow"] = self.grpc_channel.unary_unary( + "/google.cloud.bigquery.migration.v2.MigrationService/StartMigrationWorkflow", + request_serializer=migration_service.StartMigrationWorkflowRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs["start_migration_workflow"] + + @property + def get_migration_subtask( + self, + ) -> Callable[ + [migration_service.GetMigrationSubtaskRequest], + migration_entities.MigrationSubtask, + ]: + r"""Return a callable for the get migration subtask method over gRPC. + + Gets a previously created migration subtask. + + Returns: + Callable[[~.GetMigrationSubtaskRequest], + ~.MigrationSubtask]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_migration_subtask" not in self._stubs: + self._stubs["get_migration_subtask"] = self.grpc_channel.unary_unary( + "/google.cloud.bigquery.migration.v2.MigrationService/GetMigrationSubtask", + request_serializer=migration_service.GetMigrationSubtaskRequest.serialize, + response_deserializer=migration_entities.MigrationSubtask.deserialize, + ) + return self._stubs["get_migration_subtask"] + + @property + def list_migration_subtasks( + self, + ) -> Callable[ + [migration_service.ListMigrationSubtasksRequest], + migration_service.ListMigrationSubtasksResponse, + ]: + r"""Return a callable for the list migration subtasks method over gRPC. + + Lists previously created migration subtasks. + + Returns: + Callable[[~.ListMigrationSubtasksRequest], + ~.ListMigrationSubtasksResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_migration_subtasks" not in self._stubs: + self._stubs["list_migration_subtasks"] = self.grpc_channel.unary_unary( + "/google.cloud.bigquery.migration.v2.MigrationService/ListMigrationSubtasks", + request_serializer=migration_service.ListMigrationSubtasksRequest.serialize, + response_deserializer=migration_service.ListMigrationSubtasksResponse.deserialize, + ) + return self._stubs["list_migration_subtasks"] + + def close(self): + self.grpc_channel.close() + + +__all__ = ("MigrationServiceGrpcTransport",) diff --git a/google/cloud/bigquery_migration_v2/services/migration_service/transports/grpc_asyncio.py b/google/cloud/bigquery_migration_v2/services/migration_service/transports/grpc_asyncio.py new file mode 100644 index 0000000..3dafa3e --- /dev/null +++ b/google/cloud/bigquery_migration_v2/services/migration_service/transports/grpc_asyncio.py @@ -0,0 +1,444 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers_async +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore +from grpc.experimental import aio # type: ignore + +from google.cloud.bigquery_migration_v2.types import migration_entities +from google.cloud.bigquery_migration_v2.types import migration_service +from google.protobuf import empty_pb2 # type: ignore +from .base import MigrationServiceTransport, DEFAULT_CLIENT_INFO +from .grpc import MigrationServiceGrpcTransport + + +class MigrationServiceGrpcAsyncIOTransport(MigrationServiceTransport): + """gRPC AsyncIO backend transport for MigrationService. + + Service to handle EDW migrations. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + + _grpc_channel: aio.Channel + _stubs: Dict[str, Callable] = {} + + @classmethod + def create_channel( + cls, + host: str = "bigquerymigration.googleapis.com", + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs, + ) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs, + ) + + def __init__( + self, + *, + host: str = "bigquerymigration.googleapis.com", + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: aio.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id=None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[aio.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @property + def grpc_channel(self) -> aio.Channel: + """Create the channel designed to connect to this service. + + This property caches on the instance; repeated calls return + the same channel. + """ + # Return the channel from cache. + return self._grpc_channel + + @property + def create_migration_workflow( + self, + ) -> Callable[ + [migration_service.CreateMigrationWorkflowRequest], + Awaitable[migration_entities.MigrationWorkflow], + ]: + r"""Return a callable for the create migration workflow method over gRPC. + + Creates a migration workflow. + + Returns: + Callable[[~.CreateMigrationWorkflowRequest], + Awaitable[~.MigrationWorkflow]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "create_migration_workflow" not in self._stubs: + self._stubs["create_migration_workflow"] = self.grpc_channel.unary_unary( + "/google.cloud.bigquery.migration.v2.MigrationService/CreateMigrationWorkflow", + request_serializer=migration_service.CreateMigrationWorkflowRequest.serialize, + response_deserializer=migration_entities.MigrationWorkflow.deserialize, + ) + return self._stubs["create_migration_workflow"] + + @property + def get_migration_workflow( + self, + ) -> Callable[ + [migration_service.GetMigrationWorkflowRequest], + Awaitable[migration_entities.MigrationWorkflow], + ]: + r"""Return a callable for the get migration workflow method over gRPC. + + Gets a previously created migration workflow. + + Returns: + Callable[[~.GetMigrationWorkflowRequest], + Awaitable[~.MigrationWorkflow]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_migration_workflow" not in self._stubs: + self._stubs["get_migration_workflow"] = self.grpc_channel.unary_unary( + "/google.cloud.bigquery.migration.v2.MigrationService/GetMigrationWorkflow", + request_serializer=migration_service.GetMigrationWorkflowRequest.serialize, + response_deserializer=migration_entities.MigrationWorkflow.deserialize, + ) + return self._stubs["get_migration_workflow"] + + @property + def list_migration_workflows( + self, + ) -> Callable[ + [migration_service.ListMigrationWorkflowsRequest], + Awaitable[migration_service.ListMigrationWorkflowsResponse], + ]: + r"""Return a callable for the list migration workflows method over gRPC. + + Lists previously created migration workflow. + + Returns: + Callable[[~.ListMigrationWorkflowsRequest], + Awaitable[~.ListMigrationWorkflowsResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_migration_workflows" not in self._stubs: + self._stubs["list_migration_workflows"] = self.grpc_channel.unary_unary( + "/google.cloud.bigquery.migration.v2.MigrationService/ListMigrationWorkflows", + request_serializer=migration_service.ListMigrationWorkflowsRequest.serialize, + response_deserializer=migration_service.ListMigrationWorkflowsResponse.deserialize, + ) + return self._stubs["list_migration_workflows"] + + @property + def delete_migration_workflow( + self, + ) -> Callable[ + [migration_service.DeleteMigrationWorkflowRequest], Awaitable[empty_pb2.Empty] + ]: + r"""Return a callable for the delete migration workflow method over gRPC. + + Deletes a migration workflow by name. + + Returns: + Callable[[~.DeleteMigrationWorkflowRequest], + Awaitable[~.Empty]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "delete_migration_workflow" not in self._stubs: + self._stubs["delete_migration_workflow"] = self.grpc_channel.unary_unary( + "/google.cloud.bigquery.migration.v2.MigrationService/DeleteMigrationWorkflow", + request_serializer=migration_service.DeleteMigrationWorkflowRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs["delete_migration_workflow"] + + @property + def start_migration_workflow( + self, + ) -> Callable[ + [migration_service.StartMigrationWorkflowRequest], Awaitable[empty_pb2.Empty] + ]: + r"""Return a callable for the start migration workflow method over gRPC. + + Starts a previously created migration workflow. I.e., + the state transitions from DRAFT to RUNNING. This is a + no-op if the state is already RUNNING. An error will be + signaled if the state is anything other than DRAFT or + RUNNING. + + Returns: + Callable[[~.StartMigrationWorkflowRequest], + Awaitable[~.Empty]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "start_migration_workflow" not in self._stubs: + self._stubs["start_migration_workflow"] = self.grpc_channel.unary_unary( + "/google.cloud.bigquery.migration.v2.MigrationService/StartMigrationWorkflow", + request_serializer=migration_service.StartMigrationWorkflowRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs["start_migration_workflow"] + + @property + def get_migration_subtask( + self, + ) -> Callable[ + [migration_service.GetMigrationSubtaskRequest], + Awaitable[migration_entities.MigrationSubtask], + ]: + r"""Return a callable for the get migration subtask method over gRPC. + + Gets a previously created migration subtask. + + Returns: + Callable[[~.GetMigrationSubtaskRequest], + Awaitable[~.MigrationSubtask]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_migration_subtask" not in self._stubs: + self._stubs["get_migration_subtask"] = self.grpc_channel.unary_unary( + "/google.cloud.bigquery.migration.v2.MigrationService/GetMigrationSubtask", + request_serializer=migration_service.GetMigrationSubtaskRequest.serialize, + response_deserializer=migration_entities.MigrationSubtask.deserialize, + ) + return self._stubs["get_migration_subtask"] + + @property + def list_migration_subtasks( + self, + ) -> Callable[ + [migration_service.ListMigrationSubtasksRequest], + Awaitable[migration_service.ListMigrationSubtasksResponse], + ]: + r"""Return a callable for the list migration subtasks method over gRPC. + + Lists previously created migration subtasks. + + Returns: + Callable[[~.ListMigrationSubtasksRequest], + Awaitable[~.ListMigrationSubtasksResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_migration_subtasks" not in self._stubs: + self._stubs["list_migration_subtasks"] = self.grpc_channel.unary_unary( + "/google.cloud.bigquery.migration.v2.MigrationService/ListMigrationSubtasks", + request_serializer=migration_service.ListMigrationSubtasksRequest.serialize, + response_deserializer=migration_service.ListMigrationSubtasksResponse.deserialize, + ) + return self._stubs["list_migration_subtasks"] + + def close(self): + return self.grpc_channel.close() + + +__all__ = ("MigrationServiceGrpcAsyncIOTransport",) diff --git a/google/cloud/bigquery_migration_v2/types/__init__.py b/google/cloud/bigquery_migration_v2/types/__init__.py new file mode 100644 index 0000000..c22d36d --- /dev/null +++ b/google/cloud/bigquery_migration_v2/types/__init__.py @@ -0,0 +1,100 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .migration_entities import ( + MigrationSubtask, + MigrationTask, + MigrationWorkflow, +) +from .migration_error_details import ( + ErrorDetail, + ErrorLocation, + ResourceErrorDetail, +) +from .migration_metrics import ( + Point, + TimeInterval, + TimeSeries, + TypedValue, +) +from .migration_service import ( + CreateMigrationWorkflowRequest, + DeleteMigrationWorkflowRequest, + GetMigrationSubtaskRequest, + GetMigrationWorkflowRequest, + ListMigrationSubtasksRequest, + ListMigrationSubtasksResponse, + ListMigrationWorkflowsRequest, + ListMigrationWorkflowsResponse, + StartMigrationWorkflowRequest, +) +from .translation_config import ( + AzureSynapseDialect, + BigQueryDialect, + Dialect, + HiveQLDialect, + NameMappingKey, + NameMappingValue, + NetezzaDialect, + ObjectNameMapping, + ObjectNameMappingList, + OracleDialect, + RedshiftDialect, + SnowflakeDialect, + SourceEnv, + SparkSQLDialect, + TeradataDialect, + TranslationConfigDetails, + VerticaDialect, +) + +__all__ = ( + "MigrationSubtask", + "MigrationTask", + "MigrationWorkflow", + "ErrorDetail", + "ErrorLocation", + "ResourceErrorDetail", + "Point", + "TimeInterval", + "TimeSeries", + "TypedValue", + "CreateMigrationWorkflowRequest", + "DeleteMigrationWorkflowRequest", + "GetMigrationSubtaskRequest", + "GetMigrationWorkflowRequest", + "ListMigrationSubtasksRequest", + "ListMigrationSubtasksResponse", + "ListMigrationWorkflowsRequest", + "ListMigrationWorkflowsResponse", + "StartMigrationWorkflowRequest", + "AzureSynapseDialect", + "BigQueryDialect", + "Dialect", + "HiveQLDialect", + "NameMappingKey", + "NameMappingValue", + "NetezzaDialect", + "ObjectNameMapping", + "ObjectNameMappingList", + "OracleDialect", + "RedshiftDialect", + "SnowflakeDialect", + "SourceEnv", + "SparkSQLDialect", + "TeradataDialect", + "TranslationConfigDetails", + "VerticaDialect", +) diff --git a/google/cloud/bigquery_migration_v2/types/migration_entities.py b/google/cloud/bigquery_migration_v2/types/migration_entities.py new file mode 100644 index 0000000..9225a7e --- /dev/null +++ b/google/cloud/bigquery_migration_v2/types/migration_entities.py @@ -0,0 +1,285 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import proto # type: ignore + +from google.cloud.bigquery_migration_v2.types import migration_error_details +from google.cloud.bigquery_migration_v2.types import migration_metrics +from google.cloud.bigquery_migration_v2.types import translation_config +from google.protobuf import timestamp_pb2 # type: ignore +from google.rpc import error_details_pb2 # type: ignore + + +__protobuf__ = proto.module( + package="google.cloud.bigquery.migration.v2", + manifest={ + "MigrationWorkflow", + "MigrationTask", + "MigrationSubtask", + }, +) + + +class MigrationWorkflow(proto.Message): + r"""A migration workflow which specifies what needs to be done + for an EDW migration. + + Attributes: + name (str): + Output only. Immutable. The unique identifier for the + migration workflow. The ID is server-generated. + + Example: ``projects/123/locations/us/workflows/345`` + display_name (str): + The display name of the workflow. This can be + set to give a workflow a descriptive name. There + is no guarantee or enforcement of uniqueness. + tasks (Sequence[google.cloud.bigquery_migration_v2.types.MigrationWorkflow.TasksEntry]): + The tasks in a workflow in a named map. The + name (i.e. key) has no meaning and is merely a + convenient way to address a specific task in a + workflow. + state (google.cloud.bigquery_migration_v2.types.MigrationWorkflow.State): + Output only. That status of the workflow. + create_time (google.protobuf.timestamp_pb2.Timestamp): + Time when the workflow was created. + last_update_time (google.protobuf.timestamp_pb2.Timestamp): + Time when the workflow was last updated. + """ + + class State(proto.Enum): + r"""Possible migration workflow states.""" + STATE_UNSPECIFIED = 0 + DRAFT = 1 + RUNNING = 2 + PAUSED = 3 + COMPLETED = 4 + + name = proto.Field( + proto.STRING, + number=1, + ) + display_name = proto.Field( + proto.STRING, + number=6, + ) + tasks = proto.MapField( + proto.STRING, + proto.MESSAGE, + number=2, + message="MigrationTask", + ) + state = proto.Field( + proto.ENUM, + number=3, + enum=State, + ) + create_time = proto.Field( + proto.MESSAGE, + number=4, + message=timestamp_pb2.Timestamp, + ) + last_update_time = proto.Field( + proto.MESSAGE, + number=5, + message=timestamp_pb2.Timestamp, + ) + + +class MigrationTask(proto.Message): + r"""A single task for a migration which has details about the + configuration of the task. + + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + translation_config_details (google.cloud.bigquery_migration_v2.types.TranslationConfigDetails): + Task configuration for Batch SQL Translation. + + This field is a member of `oneof`_ ``task_details``. + id (str): + Output only. Immutable. The unique identifier + for the migration task. The ID is + server-generated. + type_ (str): + The type of the task. This must be one of the supported task + types: Translation_Teradata2BQ, Translation_Redshift2BQ, + Translation_Bteq2BQ, Translation_Oracle2BQ, + Translation_HiveQL2BQ, Translation_SparkSQL2BQ, + Translation_Snowflake2BQ, Translation_Netezza2BQ. + state (google.cloud.bigquery_migration_v2.types.MigrationTask.State): + Output only. The current state of the task. + processing_error (google.rpc.error_details_pb2.ErrorInfo): + Output only. An explanation that may be + populated when the task is in FAILED state. + create_time (google.protobuf.timestamp_pb2.Timestamp): + Time when the task was created. + last_update_time (google.protobuf.timestamp_pb2.Timestamp): + Time when the task was last updated. + """ + + class State(proto.Enum): + r"""Possible states of a migration task.""" + STATE_UNSPECIFIED = 0 + PENDING = 1 + ORCHESTRATING = 2 + RUNNING = 3 + PAUSED = 4 + SUCCEEDED = 5 + FAILED = 6 + + translation_config_details = proto.Field( + proto.MESSAGE, + number=14, + oneof="task_details", + message=translation_config.TranslationConfigDetails, + ) + id = proto.Field( + proto.STRING, + number=1, + ) + type_ = proto.Field( + proto.STRING, + number=2, + ) + state = proto.Field( + proto.ENUM, + number=4, + enum=State, + ) + processing_error = proto.Field( + proto.MESSAGE, + number=5, + message=error_details_pb2.ErrorInfo, + ) + create_time = proto.Field( + proto.MESSAGE, + number=6, + message=timestamp_pb2.Timestamp, + ) + last_update_time = proto.Field( + proto.MESSAGE, + number=7, + message=timestamp_pb2.Timestamp, + ) + + +class MigrationSubtask(proto.Message): + r"""A subtask for a migration which carries details about the + configuration of the subtask. The content of the details should + not matter to the end user, but is a contract between the + subtask creator and subtask worker. + + Attributes: + name (str): + Output only. Immutable. The resource name for the migration + subtask. The ID is server-generated. + + Example: + ``projects/123/locations/us/workflows/345/subtasks/678`` + task_id (str): + The unique ID of the task to which this + subtask belongs. + type_ (str): + The type of the Subtask. The migration + service does not check whether this is a known + type. It is up to the task creator (i.e. + orchestrator or worker) to ensure it only + creates subtasks for which there are compatible + workers polling for Subtasks. + state (google.cloud.bigquery_migration_v2.types.MigrationSubtask.State): + Output only. The current state of the + subtask. + processing_error (google.rpc.error_details_pb2.ErrorInfo): + Output only. An explanation that may be + populated when the task is in FAILED state. + resource_error_details (Sequence[google.cloud.bigquery_migration_v2.types.ResourceErrorDetail]): + Output only. Provides details to errors and + issues encountered while processing the subtask. + Presence of error details does not mean that the + subtask failed. + resource_error_count (int): + The number or resources with errors. Note: This is not the + total number of errors as each resource can have more than + one error. This is used to indicate truncation by having a + ``resource_error_count`` that is higher than the size of + ``resource_error_details``. + create_time (google.protobuf.timestamp_pb2.Timestamp): + Time when the subtask was created. + last_update_time (google.protobuf.timestamp_pb2.Timestamp): + Time when the subtask was last updated. + metrics (Sequence[google.cloud.bigquery_migration_v2.types.TimeSeries]): + The metrics for the subtask. + """ + + class State(proto.Enum): + r"""Possible states of a migration subtask.""" + STATE_UNSPECIFIED = 0 + ACTIVE = 1 + RUNNING = 2 + SUCCEEDED = 3 + FAILED = 4 + PAUSED = 5 + + name = proto.Field( + proto.STRING, + number=1, + ) + task_id = proto.Field( + proto.STRING, + number=2, + ) + type_ = proto.Field( + proto.STRING, + number=3, + ) + state = proto.Field( + proto.ENUM, + number=5, + enum=State, + ) + processing_error = proto.Field( + proto.MESSAGE, + number=6, + message=error_details_pb2.ErrorInfo, + ) + resource_error_details = proto.RepeatedField( + proto.MESSAGE, + number=12, + message=migration_error_details.ResourceErrorDetail, + ) + resource_error_count = proto.Field( + proto.INT32, + number=13, + ) + create_time = proto.Field( + proto.MESSAGE, + number=7, + message=timestamp_pb2.Timestamp, + ) + last_update_time = proto.Field( + proto.MESSAGE, + number=8, + message=timestamp_pb2.Timestamp, + ) + metrics = proto.RepeatedField( + proto.MESSAGE, + number=11, + message=migration_metrics.TimeSeries, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/google/cloud/bigquery_migration_v2/types/migration_error_details.py b/google/cloud/bigquery_migration_v2/types/migration_error_details.py new file mode 100644 index 0000000..e7446b4 --- /dev/null +++ b/google/cloud/bigquery_migration_v2/types/migration_error_details.py @@ -0,0 +1,112 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import proto # type: ignore + +from google.rpc import error_details_pb2 # type: ignore + + +__protobuf__ = proto.module( + package="google.cloud.bigquery.migration.v2", + manifest={ + "ResourceErrorDetail", + "ErrorDetail", + "ErrorLocation", + }, +) + + +class ResourceErrorDetail(proto.Message): + r"""Provides details for errors and the corresponding resources. + + Attributes: + resource_info (google.rpc.error_details_pb2.ResourceInfo): + Required. Information about the resource + where the error is located. + error_details (Sequence[google.cloud.bigquery_migration_v2.types.ErrorDetail]): + Required. The error details for the resource. + error_count (int): + Required. How many errors there are in total for the + resource. Truncation can be indicated by having an + ``error_count`` that is higher than the size of + ``error_details``. + """ + + resource_info = proto.Field( + proto.MESSAGE, + number=1, + message=error_details_pb2.ResourceInfo, + ) + error_details = proto.RepeatedField( + proto.MESSAGE, + number=2, + message="ErrorDetail", + ) + error_count = proto.Field( + proto.INT32, + number=3, + ) + + +class ErrorDetail(proto.Message): + r"""Provides details for errors, e.g. issues that where + encountered when processing a subtask. + + Attributes: + location (google.cloud.bigquery_migration_v2.types.ErrorLocation): + Optional. The exact location within the + resource (if applicable). + error_info (google.rpc.error_details_pb2.ErrorInfo): + Required. Describes the cause of the error + with structured detail. + """ + + location = proto.Field( + proto.MESSAGE, + number=1, + message="ErrorLocation", + ) + error_info = proto.Field( + proto.MESSAGE, + number=2, + message=error_details_pb2.ErrorInfo, + ) + + +class ErrorLocation(proto.Message): + r"""Holds information about where the error is located. + + Attributes: + line (int): + Optional. If applicable, denotes the line + where the error occurred. A zero value means + that there is no line information. + column (int): + Optional. If applicable, denotes the column + where the error occurred. A zero value means + that there is no columns information. + """ + + line = proto.Field( + proto.INT32, + number=1, + ) + column = proto.Field( + proto.INT32, + number=2, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/google/cloud/bigquery_migration_v2/types/migration_metrics.py b/google/cloud/bigquery_migration_v2/types/migration_metrics.py new file mode 100644 index 0000000..6204272 --- /dev/null +++ b/google/cloud/bigquery_migration_v2/types/migration_metrics.py @@ -0,0 +1,208 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import proto # type: ignore + +from google.api import distribution_pb2 # type: ignore +from google.api import metric_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore + + +__protobuf__ = proto.module( + package="google.cloud.bigquery.migration.v2", + manifest={ + "TimeSeries", + "Point", + "TimeInterval", + "TypedValue", + }, +) + + +class TimeSeries(proto.Message): + r"""The metrics object for a SubTask. + + Attributes: + metric (str): + Required. The name of the metric. + If the metric is not known by the service yet, + it will be auto-created. + value_type (google.api.metric_pb2.ValueType): + Required. The value type of the time series. + metric_kind (google.api.metric_pb2.MetricKind): + Optional. The metric kind of the time series. + + If present, it must be the same as the metric kind of the + associated metric. If the associated metric's descriptor + must be auto-created, then this field specifies the metric + kind of the new descriptor and must be either ``GAUGE`` (the + default) or ``CUMULATIVE``. + points (Sequence[google.cloud.bigquery_migration_v2.types.Point]): + Required. The data points of this time series. When listing + time series, points are returned in reverse time order. + + When creating a time series, this field must contain exactly + one point and the point's type must be the same as the value + type of the associated metric. If the associated metric's + descriptor must be auto-created, then the value type of the + descriptor is determined by the point's type, which must be + ``BOOL``, ``INT64``, ``DOUBLE``, or ``DISTRIBUTION``. + """ + + metric = proto.Field( + proto.STRING, + number=1, + ) + value_type = proto.Field( + proto.ENUM, + number=2, + enum=metric_pb2.MetricDescriptor.ValueType, + ) + metric_kind = proto.Field( + proto.ENUM, + number=3, + enum=metric_pb2.MetricDescriptor.MetricKind, + ) + points = proto.RepeatedField( + proto.MESSAGE, + number=4, + message="Point", + ) + + +class Point(proto.Message): + r"""A single data point in a time series. + + Attributes: + interval (google.cloud.bigquery_migration_v2.types.TimeInterval): + The time interval to which the data point applies. For + ``GAUGE`` metrics, the start time does not need to be + supplied, but if it is supplied, it must equal the end time. + For ``DELTA`` metrics, the start and end time should specify + a non-zero interval, with subsequent points specifying + contiguous and non-overlapping intervals. For ``CUMULATIVE`` + metrics, the start and end time should specify a non-zero + interval, with subsequent points specifying the same start + time and increasing end times, until an event resets the + cumulative value to zero and sets a new start time for the + following points. + value (google.cloud.bigquery_migration_v2.types.TypedValue): + The value of the data point. + """ + + interval = proto.Field( + proto.MESSAGE, + number=1, + message="TimeInterval", + ) + value = proto.Field( + proto.MESSAGE, + number=2, + message="TypedValue", + ) + + +class TimeInterval(proto.Message): + r"""A time interval extending just after a start time through an + end time. If the start time is the same as the end time, then + the interval represents a single point in time. + + Attributes: + start_time (google.protobuf.timestamp_pb2.Timestamp): + Optional. The beginning of the time interval. + The default value for the start time is the end + time. The start time must not be later than the + end time. + end_time (google.protobuf.timestamp_pb2.Timestamp): + Required. The end of the time interval. + """ + + start_time = proto.Field( + proto.MESSAGE, + number=1, + message=timestamp_pb2.Timestamp, + ) + end_time = proto.Field( + proto.MESSAGE, + number=2, + message=timestamp_pb2.Timestamp, + ) + + +class TypedValue(proto.Message): + r"""A single strongly-typed value. + + This message has `oneof`_ fields (mutually exclusive fields). + For each oneof, at most one member field can be set at the same time. + Setting any member of the oneof automatically clears all other + members. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + bool_value (bool): + A Boolean value: ``true`` or ``false``. + + This field is a member of `oneof`_ ``value``. + int64_value (int): + A 64-bit integer. Its range is approximately + ``+/-9.2x10^18``. + + This field is a member of `oneof`_ ``value``. + double_value (float): + A 64-bit double-precision floating-point number. Its + magnitude is approximately ``+/-10^(+/-300)`` and it has 16 + significant digits of precision. + + This field is a member of `oneof`_ ``value``. + string_value (str): + A variable-length string value. + + This field is a member of `oneof`_ ``value``. + distribution_value (google.api.distribution_pb2.Distribution): + A distribution value. + + This field is a member of `oneof`_ ``value``. + """ + + bool_value = proto.Field( + proto.BOOL, + number=1, + oneof="value", + ) + int64_value = proto.Field( + proto.INT64, + number=2, + oneof="value", + ) + double_value = proto.Field( + proto.DOUBLE, + number=3, + oneof="value", + ) + string_value = proto.Field( + proto.STRING, + number=4, + oneof="value", + ) + distribution_value = proto.Field( + proto.MESSAGE, + number=5, + oneof="value", + message=distribution_pb2.Distribution, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/google/cloud/bigquery_migration_v2/types/migration_service.py b/google/cloud/bigquery_migration_v2/types/migration_service.py new file mode 100644 index 0000000..28555d6 --- /dev/null +++ b/google/cloud/bigquery_migration_v2/types/migration_service.py @@ -0,0 +1,284 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import proto # type: ignore + +from google.cloud.bigquery_migration_v2.types import migration_entities +from google.protobuf import field_mask_pb2 # type: ignore + + +__protobuf__ = proto.module( + package="google.cloud.bigquery.migration.v2", + manifest={ + "CreateMigrationWorkflowRequest", + "GetMigrationWorkflowRequest", + "ListMigrationWorkflowsRequest", + "ListMigrationWorkflowsResponse", + "DeleteMigrationWorkflowRequest", + "StartMigrationWorkflowRequest", + "GetMigrationSubtaskRequest", + "ListMigrationSubtasksRequest", + "ListMigrationSubtasksResponse", + }, +) + + +class CreateMigrationWorkflowRequest(proto.Message): + r"""Request to create a migration workflow resource. + + Attributes: + parent (str): + Required. The name of the project to which this migration + workflow belongs. Example: ``projects/foo/locations/bar`` + migration_workflow (google.cloud.bigquery_migration_v2.types.MigrationWorkflow): + Required. The migration workflow to create. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + migration_workflow = proto.Field( + proto.MESSAGE, + number=2, + message=migration_entities.MigrationWorkflow, + ) + + +class GetMigrationWorkflowRequest(proto.Message): + r"""A request to get a previously created migration workflow. + + Attributes: + name (str): + Required. The unique identifier for the migration workflow. + Example: ``projects/123/locations/us/workflows/1234`` + read_mask (google.protobuf.field_mask_pb2.FieldMask): + The list of fields to be retrieved. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + read_mask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + + +class ListMigrationWorkflowsRequest(proto.Message): + r"""A request to list previously created migration workflows. + + Attributes: + parent (str): + Required. The project and location of the migration + workflows to list. Example: ``projects/123/locations/us`` + read_mask (google.protobuf.field_mask_pb2.FieldMask): + The list of fields to be retrieved. + page_size (int): + The maximum number of migration workflows to + return. The service may return fewer than this + number. + page_token (str): + A page token, received from previous + ``ListMigrationWorkflows`` call. Provide this to retrieve + the subsequent page. + + When paginating, all other parameters provided to + ``ListMigrationWorkflows`` must match the call that provided + the page token. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + read_mask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + page_size = proto.Field( + proto.INT32, + number=3, + ) + page_token = proto.Field( + proto.STRING, + number=4, + ) + + +class ListMigrationWorkflowsResponse(proto.Message): + r"""Response object for a ``ListMigrationWorkflows`` call. + + Attributes: + migration_workflows (Sequence[google.cloud.bigquery_migration_v2.types.MigrationWorkflow]): + The migration workflows for the specified + project / location. + next_page_token (str): + A token, which can be sent as ``page_token`` to retrieve the + next page. If this field is omitted, there are no subsequent + pages. + """ + + @property + def raw_page(self): + return self + + migration_workflows = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=migration_entities.MigrationWorkflow, + ) + next_page_token = proto.Field( + proto.STRING, + number=2, + ) + + +class DeleteMigrationWorkflowRequest(proto.Message): + r"""A request to delete a previously created migration workflow. + + Attributes: + name (str): + Required. The unique identifier for the migration workflow. + Example: ``projects/123/locations/us/workflows/1234`` + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + + +class StartMigrationWorkflowRequest(proto.Message): + r"""A request to start a previously created migration workflow. + + Attributes: + name (str): + Required. The unique identifier for the migration workflow. + Example: ``projects/123/locations/us/workflows/1234`` + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + + +class GetMigrationSubtaskRequest(proto.Message): + r"""A request to get a previously created migration subtasks. + + Attributes: + name (str): + Required. The unique identifier for the migration subtask. + Example: + ``projects/123/locations/us/workflows/1234/subtasks/543`` + read_mask (google.protobuf.field_mask_pb2.FieldMask): + Optional. The list of fields to be retrieved. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + read_mask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + + +class ListMigrationSubtasksRequest(proto.Message): + r"""A request to list previously created migration subtasks. + + Attributes: + parent (str): + Required. The migration task of the subtasks to list. + Example: ``projects/123/locations/us/workflows/1234`` + read_mask (google.protobuf.field_mask_pb2.FieldMask): + Optional. The list of fields to be retrieved. + page_size (int): + Optional. The maximum number of migration + tasks to return. The service may return fewer + than this number. + page_token (str): + Optional. A page token, received from previous + ``ListMigrationSubtasks`` call. Provide this to retrieve the + subsequent page. + + When paginating, all other parameters provided to + ``ListMigrationSubtasks`` must match the call that provided + the page token. + filter (str): + Optional. The filter to apply. This can be used to get the + subtasks of a specific tasks in a workflow, e.g. + ``migration_task = "ab012"`` where ``"ab012"`` is the task + ID (not the name in the named map). + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + read_mask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + page_size = proto.Field( + proto.INT32, + number=3, + ) + page_token = proto.Field( + proto.STRING, + number=4, + ) + filter = proto.Field( + proto.STRING, + number=5, + ) + + +class ListMigrationSubtasksResponse(proto.Message): + r"""Response object for a ``ListMigrationSubtasks`` call. + + Attributes: + migration_subtasks (Sequence[google.cloud.bigquery_migration_v2.types.MigrationSubtask]): + The migration subtasks for the specified + task. + next_page_token (str): + A token, which can be sent as ``page_token`` to retrieve the + next page. If this field is omitted, there are no subsequent + pages. + """ + + @property + def raw_page(self): + return self + + migration_subtasks = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=migration_entities.MigrationSubtask, + ) + next_page_token = proto.Field( + proto.STRING, + number=2, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/google/cloud/bigquery_migration_v2/types/translation_config.py b/google/cloud/bigquery_migration_v2/types/translation_config.py new file mode 100644 index 0000000..5e3979b --- /dev/null +++ b/google/cloud/bigquery_migration_v2/types/translation_config.py @@ -0,0 +1,440 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import proto # type: ignore + + +__protobuf__ = proto.module( + package="google.cloud.bigquery.migration.v2", + manifest={ + "TranslationConfigDetails", + "Dialect", + "BigQueryDialect", + "HiveQLDialect", + "RedshiftDialect", + "TeradataDialect", + "OracleDialect", + "SparkSQLDialect", + "SnowflakeDialect", + "NetezzaDialect", + "AzureSynapseDialect", + "VerticaDialect", + "ObjectNameMappingList", + "ObjectNameMapping", + "NameMappingKey", + "NameMappingValue", + "SourceEnv", + }, +) + + +class TranslationConfigDetails(proto.Message): + r"""The translation config to capture necessary settings for a + translation task and subtask. + + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + gcs_source_path (str): + The Cloud Storage path for a directory of + files to translate in a task. + + This field is a member of `oneof`_ ``source_location``. + gcs_target_path (str): + The Cloud Storage path to write back the + corresponding input files to. + + This field is a member of `oneof`_ ``target_location``. + source_dialect (google.cloud.bigquery_migration_v2.types.Dialect): + The dialect of the input files. + target_dialect (google.cloud.bigquery_migration_v2.types.Dialect): + The target dialect for the engine to + translate the input to. + name_mapping_list (google.cloud.bigquery_migration_v2.types.ObjectNameMappingList): + The mapping of objects to their desired + output names in list form. + + This field is a member of `oneof`_ ``output_name_mapping``. + source_env (google.cloud.bigquery_migration_v2.types.SourceEnv): + The default source environment values for the + translation. + """ + + gcs_source_path = proto.Field( + proto.STRING, + number=1, + oneof="source_location", + ) + gcs_target_path = proto.Field( + proto.STRING, + number=2, + oneof="target_location", + ) + source_dialect = proto.Field( + proto.MESSAGE, + number=3, + message="Dialect", + ) + target_dialect = proto.Field( + proto.MESSAGE, + number=4, + message="Dialect", + ) + name_mapping_list = proto.Field( + proto.MESSAGE, + number=5, + oneof="output_name_mapping", + message="ObjectNameMappingList", + ) + source_env = proto.Field( + proto.MESSAGE, + number=6, + message="SourceEnv", + ) + + +class Dialect(proto.Message): + r"""The possible dialect options for translation. + + This message has `oneof`_ fields (mutually exclusive fields). + For each oneof, at most one member field can be set at the same time. + Setting any member of the oneof automatically clears all other + members. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + bigquery_dialect (google.cloud.bigquery_migration_v2.types.BigQueryDialect): + The BigQuery dialect + + This field is a member of `oneof`_ ``dialect_value``. + hiveql_dialect (google.cloud.bigquery_migration_v2.types.HiveQLDialect): + The HiveQL dialect + + This field is a member of `oneof`_ ``dialect_value``. + redshift_dialect (google.cloud.bigquery_migration_v2.types.RedshiftDialect): + The Redshift dialect + + This field is a member of `oneof`_ ``dialect_value``. + teradata_dialect (google.cloud.bigquery_migration_v2.types.TeradataDialect): + The Teradata dialect + + This field is a member of `oneof`_ ``dialect_value``. + oracle_dialect (google.cloud.bigquery_migration_v2.types.OracleDialect): + The Oracle dialect + + This field is a member of `oneof`_ ``dialect_value``. + sparksql_dialect (google.cloud.bigquery_migration_v2.types.SparkSQLDialect): + The SparkSQL dialect + + This field is a member of `oneof`_ ``dialect_value``. + snowflake_dialect (google.cloud.bigquery_migration_v2.types.SnowflakeDialect): + The Snowflake dialect + + This field is a member of `oneof`_ ``dialect_value``. + netezza_dialect (google.cloud.bigquery_migration_v2.types.NetezzaDialect): + The Netezza dialect + + This field is a member of `oneof`_ ``dialect_value``. + azure_synapse_dialect (google.cloud.bigquery_migration_v2.types.AzureSynapseDialect): + The Azure Synapse dialect + + This field is a member of `oneof`_ ``dialect_value``. + vertica_dialect (google.cloud.bigquery_migration_v2.types.VerticaDialect): + The Vertica dialect + + This field is a member of `oneof`_ ``dialect_value``. + """ + + bigquery_dialect = proto.Field( + proto.MESSAGE, + number=1, + oneof="dialect_value", + message="BigQueryDialect", + ) + hiveql_dialect = proto.Field( + proto.MESSAGE, + number=2, + oneof="dialect_value", + message="HiveQLDialect", + ) + redshift_dialect = proto.Field( + proto.MESSAGE, + number=3, + oneof="dialect_value", + message="RedshiftDialect", + ) + teradata_dialect = proto.Field( + proto.MESSAGE, + number=4, + oneof="dialect_value", + message="TeradataDialect", + ) + oracle_dialect = proto.Field( + proto.MESSAGE, + number=5, + oneof="dialect_value", + message="OracleDialect", + ) + sparksql_dialect = proto.Field( + proto.MESSAGE, + number=6, + oneof="dialect_value", + message="SparkSQLDialect", + ) + snowflake_dialect = proto.Field( + proto.MESSAGE, + number=7, + oneof="dialect_value", + message="SnowflakeDialect", + ) + netezza_dialect = proto.Field( + proto.MESSAGE, + number=8, + oneof="dialect_value", + message="NetezzaDialect", + ) + azure_synapse_dialect = proto.Field( + proto.MESSAGE, + number=9, + oneof="dialect_value", + message="AzureSynapseDialect", + ) + vertica_dialect = proto.Field( + proto.MESSAGE, + number=10, + oneof="dialect_value", + message="VerticaDialect", + ) + + +class BigQueryDialect(proto.Message): + r"""The dialect definition for BigQuery.""" + + +class HiveQLDialect(proto.Message): + r"""The dialect definition for HiveQL.""" + + +class RedshiftDialect(proto.Message): + r"""The dialect definition for Redshift.""" + + +class TeradataDialect(proto.Message): + r"""The dialect definition for Teradata. + + Attributes: + mode (google.cloud.bigquery_migration_v2.types.TeradataDialect.Mode): + Which Teradata sub-dialect mode the user + specifies. + """ + + class Mode(proto.Enum): + r"""The sub-dialect options for Teradata.""" + MODE_UNSPECIFIED = 0 + SQL = 1 + BTEQ = 2 + + mode = proto.Field( + proto.ENUM, + number=1, + enum=Mode, + ) + + +class OracleDialect(proto.Message): + r"""The dialect definition for Oracle.""" + + +class SparkSQLDialect(proto.Message): + r"""The dialect definition for SparkSQL.""" + + +class SnowflakeDialect(proto.Message): + r"""The dialect definition for Snowflake.""" + + +class NetezzaDialect(proto.Message): + r"""The dialect definition for Netezza.""" + + +class AzureSynapseDialect(proto.Message): + r"""The dialect definition for Azure Synapse.""" + + +class VerticaDialect(proto.Message): + r"""The dialect definition for Vertica.""" + + +class ObjectNameMappingList(proto.Message): + r"""Represents a map of name mappings using a list of key:value + proto messages of existing name to desired output name. + + Attributes: + name_map (Sequence[google.cloud.bigquery_migration_v2.types.ObjectNameMapping]): + The elements of the object name map. + """ + + name_map = proto.RepeatedField( + proto.MESSAGE, + number=1, + message="ObjectNameMapping", + ) + + +class ObjectNameMapping(proto.Message): + r"""Represents a key-value pair of NameMappingKey to + NameMappingValue to represent the mapping of SQL names from the + input value to desired output. + + Attributes: + source (google.cloud.bigquery_migration_v2.types.NameMappingKey): + The name of the object in source that is + being mapped. + target (google.cloud.bigquery_migration_v2.types.NameMappingValue): + The desired target name of the object that is + being mapped. + """ + + source = proto.Field( + proto.MESSAGE, + number=1, + message="NameMappingKey", + ) + target = proto.Field( + proto.MESSAGE, + number=2, + message="NameMappingValue", + ) + + +class NameMappingKey(proto.Message): + r"""The potential components of a full name mapping that will be + mapped during translation in the source data warehouse. + + Attributes: + type_ (google.cloud.bigquery_migration_v2.types.NameMappingKey.Type): + The type of object that is being mapped. + database (str): + The database name (BigQuery project ID + equivalent in the source data warehouse). + schema (str): + The schema name (BigQuery dataset equivalent + in the source data warehouse). + relation (str): + The relation name (BigQuery table or view + equivalent in the source data warehouse). + attribute (str): + The attribute name (BigQuery column + equivalent in the source data warehouse). + """ + + class Type(proto.Enum): + r"""The type of the object that is being mapped.""" + TYPE_UNSPECIFIED = 0 + DATABASE = 1 + SCHEMA = 2 + RELATION = 3 + ATTRIBUTE = 4 + RELATION_ALIAS = 5 + ATTRIBUTE_ALIAS = 6 + FUNCTION = 7 + + type_ = proto.Field( + proto.ENUM, + number=1, + enum=Type, + ) + database = proto.Field( + proto.STRING, + number=2, + ) + schema = proto.Field( + proto.STRING, + number=3, + ) + relation = proto.Field( + proto.STRING, + number=4, + ) + attribute = proto.Field( + proto.STRING, + number=5, + ) + + +class NameMappingValue(proto.Message): + r"""The potential components of a full name mapping that will be + mapped during translation in the target data warehouse. + + Attributes: + database (str): + The database name (BigQuery project ID + equivalent in the target data warehouse). + schema (str): + The schema name (BigQuery dataset equivalent + in the target data warehouse). + relation (str): + The relation name (BigQuery table or view + equivalent in the target data warehouse). + attribute (str): + The attribute name (BigQuery column + equivalent in the target data warehouse). + """ + + database = proto.Field( + proto.STRING, + number=1, + ) + schema = proto.Field( + proto.STRING, + number=2, + ) + relation = proto.Field( + proto.STRING, + number=3, + ) + attribute = proto.Field( + proto.STRING, + number=4, + ) + + +class SourceEnv(proto.Message): + r"""Represents the default source environment values for the + translation. + + Attributes: + default_database (str): + The default database name to fully qualify + SQL objects when their database name is missing. + schema_search_path (Sequence[str]): + The schema search path. When SQL objects are + missing schema name, translation engine will + search through this list to find the value. + """ + + default_database = proto.Field( + proto.STRING, + number=1, + ) + schema_search_path = proto.RepeatedField( + proto.STRING, + number=2, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/google/cloud/bigquery_migration_v2alpha/services/migration_service/async_client.py b/google/cloud/bigquery_migration_v2alpha/services/migration_service/async_client.py index 652a0ce..c7dc00a 100644 --- a/google/cloud/bigquery_migration_v2alpha/services/migration_service/async_client.py +++ b/google/cloud/bigquery_migration_v2alpha/services/migration_service/async_client.py @@ -312,7 +312,12 @@ def sample_create_migration_workflow(): ) # Send the request. - response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) # Done; return the response. return response @@ -413,7 +418,12 @@ def sample_get_migration_workflow(): ) # Send the request. - response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) # Done; return the response. return response @@ -516,12 +526,20 @@ def sample_list_migration_workflows(): ) # Send the request. - response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) # This method is paged; wrap the response in a pager, which provides # an `__aiter__` convenience method. response = pagers.ListMigrationWorkflowsAsyncPager( - method=rpc, request=request, response=response, metadata=metadata, + method=rpc, + request=request, + response=response, + metadata=metadata, ) # Done; return the response. @@ -605,7 +623,10 @@ def sample_delete_migration_workflow(): # Send the request. await rpc( - request, retry=retry, timeout=timeout, metadata=metadata, + request, + retry=retry, + timeout=timeout, + metadata=metadata, ) async def start_migration_workflow( @@ -700,7 +721,10 @@ def sample_start_migration_workflow(): # Send the request. await rpc( - request, retry=retry, timeout=timeout, metadata=metadata, + request, + retry=retry, + timeout=timeout, + metadata=metadata, ) async def get_migration_subtask( @@ -802,7 +826,12 @@ def sample_get_migration_subtask(): ) # Send the request. - response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) # Done; return the response. return response @@ -904,12 +933,20 @@ def sample_list_migration_subtasks(): ) # Send the request. - response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) # This method is paged; wrap the response in a pager, which provides # an `__aiter__` convenience method. response = pagers.ListMigrationSubtasksAsyncPager( - method=rpc, request=request, response=response, metadata=metadata, + method=rpc, + request=request, + response=response, + metadata=metadata, ) # Done; return the response. diff --git a/google/cloud/bigquery_migration_v2alpha/services/migration_service/client.py b/google/cloud/bigquery_migration_v2alpha/services/migration_service/client.py index 9487d62..4b84546 100644 --- a/google/cloud/bigquery_migration_v2alpha/services/migration_service/client.py +++ b/google/cloud/bigquery_migration_v2alpha/services/migration_service/client.py @@ -60,7 +60,10 @@ class MigrationServiceClientMeta(type): _transport_registry["grpc"] = MigrationServiceGrpcTransport _transport_registry["grpc_asyncio"] = MigrationServiceGrpcAsyncIOTransport - def get_transport_class(cls, label: str = None,) -> Type[MigrationServiceTransport]: + def get_transport_class( + cls, + label: str = None, + ) -> Type[MigrationServiceTransport]: """Returns an appropriate transport class. Args: @@ -166,11 +169,17 @@ def transport(self) -> MigrationServiceTransport: @staticmethod def migration_subtask_path( - project: str, location: str, workflow: str, subtask: str, + project: str, + location: str, + workflow: str, + subtask: str, ) -> str: """Returns a fully-qualified migration_subtask string.""" return "projects/{project}/locations/{location}/workflows/{workflow}/subtasks/{subtask}".format( - project=project, location=location, workflow=workflow, subtask=subtask, + project=project, + location=location, + workflow=workflow, + subtask=subtask, ) @staticmethod @@ -183,10 +192,16 @@ def parse_migration_subtask_path(path: str) -> Dict[str, str]: return m.groupdict() if m else {} @staticmethod - def migration_workflow_path(project: str, location: str, workflow: str,) -> str: + def migration_workflow_path( + project: str, + location: str, + workflow: str, + ) -> str: """Returns a fully-qualified migration_workflow string.""" return "projects/{project}/locations/{location}/workflows/{workflow}".format( - project=project, location=location, workflow=workflow, + project=project, + location=location, + workflow=workflow, ) @staticmethod @@ -199,7 +214,9 @@ def parse_migration_workflow_path(path: str) -> Dict[str, str]: return m.groupdict() if m else {} @staticmethod - def common_billing_account_path(billing_account: str,) -> str: + def common_billing_account_path( + billing_account: str, + ) -> str: """Returns a fully-qualified billing_account string.""" return "billingAccounts/{billing_account}".format( billing_account=billing_account, @@ -212,9 +229,13 @@ def parse_common_billing_account_path(path: str) -> Dict[str, str]: return m.groupdict() if m else {} @staticmethod - def common_folder_path(folder: str,) -> str: + def common_folder_path( + folder: str, + ) -> str: """Returns a fully-qualified folder string.""" - return "folders/{folder}".format(folder=folder,) + return "folders/{folder}".format( + folder=folder, + ) @staticmethod def parse_common_folder_path(path: str) -> Dict[str, str]: @@ -223,9 +244,13 @@ def parse_common_folder_path(path: str) -> Dict[str, str]: return m.groupdict() if m else {} @staticmethod - def common_organization_path(organization: str,) -> str: + def common_organization_path( + organization: str, + ) -> str: """Returns a fully-qualified organization string.""" - return "organizations/{organization}".format(organization=organization,) + return "organizations/{organization}".format( + organization=organization, + ) @staticmethod def parse_common_organization_path(path: str) -> Dict[str, str]: @@ -234,9 +259,13 @@ def parse_common_organization_path(path: str) -> Dict[str, str]: return m.groupdict() if m else {} @staticmethod - def common_project_path(project: str,) -> str: + def common_project_path( + project: str, + ) -> str: """Returns a fully-qualified project string.""" - return "projects/{project}".format(project=project,) + return "projects/{project}".format( + project=project, + ) @staticmethod def parse_common_project_path(path: str) -> Dict[str, str]: @@ -245,10 +274,14 @@ def parse_common_project_path(path: str) -> Dict[str, str]: return m.groupdict() if m else {} @staticmethod - def common_location_path(project: str, location: str,) -> str: + def common_location_path( + project: str, + location: str, + ) -> str: """Returns a fully-qualified location string.""" return "projects/{project}/locations/{location}".format( - project=project, location=location, + project=project, + location=location, ) @staticmethod @@ -521,7 +554,12 @@ def sample_create_migration_workflow(): ) # Send the request. - response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) # Done; return the response. return response @@ -613,7 +651,12 @@ def sample_get_migration_workflow(): ) # Send the request. - response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) # Done; return the response. return response @@ -707,12 +750,20 @@ def sample_list_migration_workflows(): ) # Send the request. - response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) # This method is paged; wrap the response in a pager, which provides # an `__iter__` convenience method. response = pagers.ListMigrationWorkflowsPager( - method=rpc, request=request, response=response, metadata=metadata, + method=rpc, + request=request, + response=response, + metadata=metadata, ) # Done; return the response. @@ -798,7 +849,10 @@ def sample_delete_migration_workflow(): # Send the request. rpc( - request, retry=retry, timeout=timeout, metadata=metadata, + request, + retry=retry, + timeout=timeout, + metadata=metadata, ) def start_migration_workflow( @@ -884,7 +938,10 @@ def sample_start_migration_workflow(): # Send the request. rpc( - request, retry=retry, timeout=timeout, metadata=metadata, + request, + retry=retry, + timeout=timeout, + metadata=metadata, ) def get_migration_subtask( @@ -977,7 +1034,12 @@ def sample_get_migration_subtask(): ) # Send the request. - response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) # Done; return the response. return response @@ -1070,12 +1132,20 @@ def sample_list_migration_subtasks(): ) # Send the request. - response = rpc(request, retry=retry, timeout=timeout, metadata=metadata,) + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) # This method is paged; wrap the response in a pager, which provides # an `__iter__` convenience method. response = pagers.ListMigrationSubtasksPager( - method=rpc, request=request, response=response, metadata=metadata, + method=rpc, + request=request, + response=response, + metadata=metadata, ) # Done; return the response. diff --git a/google/cloud/bigquery_migration_v2alpha/services/migration_service/transports/base.py b/google/cloud/bigquery_migration_v2alpha/services/migration_service/transports/base.py index 6a7452c..984bd13 100644 --- a/google/cloud/bigquery_migration_v2alpha/services/migration_service/transports/base.py +++ b/google/cloud/bigquery_migration_v2alpha/services/migration_service/transports/base.py @@ -207,9 +207,9 @@ def _prep_wrapped_messages(self, client_info): def close(self): """Closes resources associated with the transport. - .. warning:: - Only call this method if the transport is NOT shared - with other clients - this may cause errors in other clients! + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! """ raise NotImplementedError() diff --git a/google/cloud/bigquery_migration_v2alpha/services/migration_service/transports/grpc.py b/google/cloud/bigquery_migration_v2alpha/services/migration_service/transports/grpc.py index 7e437af..990cddf 100644 --- a/google/cloud/bigquery_migration_v2alpha/services/migration_service/transports/grpc.py +++ b/google/cloud/bigquery_migration_v2alpha/services/migration_service/transports/grpc.py @@ -226,8 +226,7 @@ def create_channel( @property def grpc_channel(self) -> grpc.Channel: - """Return the channel designed to connect to this service. - """ + """Return the channel designed to connect to this service.""" return self._grpc_channel @property diff --git a/google/cloud/bigquery_migration_v2alpha/types/assessment_task.py b/google/cloud/bigquery_migration_v2alpha/types/assessment_task.py index 9c2a70c..6865bc7 100644 --- a/google/cloud/bigquery_migration_v2alpha/types/assessment_task.py +++ b/google/cloud/bigquery_migration_v2alpha/types/assessment_task.py @@ -18,7 +18,10 @@ __protobuf__ = proto.module( package="google.cloud.bigquery.migration.v2alpha", - manifest={"AssessmentTaskDetails", "AssessmentOrchestrationResultDetails",}, + manifest={ + "AssessmentTaskDetails", + "AssessmentOrchestrationResultDetails", + }, ) @@ -41,10 +44,22 @@ class AssessmentTaskDetails(proto.Message): input data is extracted. """ - input_path = proto.Field(proto.STRING, number=1,) - output_dataset = proto.Field(proto.STRING, number=2,) - querylogs_path = proto.Field(proto.STRING, number=3,) - data_source = proto.Field(proto.STRING, number=4,) + input_path = proto.Field( + proto.STRING, + number=1, + ) + output_dataset = proto.Field( + proto.STRING, + number=2, + ) + querylogs_path = proto.Field( + proto.STRING, + number=3, + ) + data_source = proto.Field( + proto.STRING, + number=4, + ) class AssessmentOrchestrationResultDetails(proto.Message): @@ -56,7 +71,10 @@ class AssessmentOrchestrationResultDetails(proto.Message): table schemas. """ - output_tables_schema_version = proto.Field(proto.STRING, number=1,) + output_tables_schema_version = proto.Field( + proto.STRING, + number=1, + ) __all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/google/cloud/bigquery_migration_v2alpha/types/migration_entities.py b/google/cloud/bigquery_migration_v2alpha/types/migration_entities.py index fdaf062..be880f7 100644 --- a/google/cloud/bigquery_migration_v2alpha/types/migration_entities.py +++ b/google/cloud/bigquery_migration_v2alpha/types/migration_entities.py @@ -70,15 +70,34 @@ class State(proto.Enum): PAUSED = 3 COMPLETED = 4 - name = proto.Field(proto.STRING, number=1,) - display_name = proto.Field(proto.STRING, number=6,) + name = proto.Field( + proto.STRING, + number=1, + ) + display_name = proto.Field( + proto.STRING, + number=6, + ) tasks = proto.MapField( - proto.STRING, proto.MESSAGE, number=2, message="MigrationTask", + proto.STRING, + proto.MESSAGE, + number=2, + message="MigrationTask", + ) + state = proto.Field( + proto.ENUM, + number=3, + enum=State, + ) + create_time = proto.Field( + proto.MESSAGE, + number=4, + message=timestamp_pb2.Timestamp, ) - state = proto.Field(proto.ENUM, number=3, enum=State,) - create_time = proto.Field(proto.MESSAGE, number=4, message=timestamp_pb2.Timestamp,) last_update_time = proto.Field( - proto.MESSAGE, number=5, message=timestamp_pb2.Timestamp, + proto.MESSAGE, + number=5, + message=timestamp_pb2.Timestamp, ) @@ -150,19 +169,43 @@ class State(proto.Enum): oneof="task_details", message=translation_task.TranslationTaskDetails, ) - id = proto.Field(proto.STRING, number=1,) - type_ = proto.Field(proto.STRING, number=2,) - details = proto.Field(proto.MESSAGE, number=3, message=any_pb2.Any,) - state = proto.Field(proto.ENUM, number=4, enum=State,) + id = proto.Field( + proto.STRING, + number=1, + ) + type_ = proto.Field( + proto.STRING, + number=2, + ) + details = proto.Field( + proto.MESSAGE, + number=3, + message=any_pb2.Any, + ) + state = proto.Field( + proto.ENUM, + number=4, + enum=State, + ) processing_error = proto.Field( - proto.MESSAGE, number=5, message=error_details_pb2.ErrorInfo, + proto.MESSAGE, + number=5, + message=error_details_pb2.ErrorInfo, + ) + create_time = proto.Field( + proto.MESSAGE, + number=6, + message=timestamp_pb2.Timestamp, ) - create_time = proto.Field(proto.MESSAGE, number=6, message=timestamp_pb2.Timestamp,) last_update_time = proto.Field( - proto.MESSAGE, number=7, message=timestamp_pb2.Timestamp, + proto.MESSAGE, + number=7, + message=timestamp_pb2.Timestamp, ) orchestration_result = proto.Field( - proto.MESSAGE, number=10, message="MigrationTaskOrchestrationResult", + proto.MESSAGE, + number=10, + message="MigrationTaskOrchestrationResult", ) @@ -223,23 +266,51 @@ class State(proto.Enum): FAILED = 4 PAUSED = 5 - name = proto.Field(proto.STRING, number=1,) - task_id = proto.Field(proto.STRING, number=2,) - type_ = proto.Field(proto.STRING, number=3,) - state = proto.Field(proto.ENUM, number=5, enum=State,) + name = proto.Field( + proto.STRING, + number=1, + ) + task_id = proto.Field( + proto.STRING, + number=2, + ) + type_ = proto.Field( + proto.STRING, + number=3, + ) + state = proto.Field( + proto.ENUM, + number=5, + enum=State, + ) processing_error = proto.Field( - proto.MESSAGE, number=6, message=error_details_pb2.ErrorInfo, + proto.MESSAGE, + number=6, + message=error_details_pb2.ErrorInfo, ) resource_error_details = proto.RepeatedField( - proto.MESSAGE, number=12, message=migration_error_details.ResourceErrorDetail, + proto.MESSAGE, + number=12, + message=migration_error_details.ResourceErrorDetail, + ) + resource_error_count = proto.Field( + proto.INT32, + number=13, + ) + create_time = proto.Field( + proto.MESSAGE, + number=7, + message=timestamp_pb2.Timestamp, ) - resource_error_count = proto.Field(proto.INT32, number=13,) - create_time = proto.Field(proto.MESSAGE, number=7, message=timestamp_pb2.Timestamp,) last_update_time = proto.Field( - proto.MESSAGE, number=8, message=timestamp_pb2.Timestamp, + proto.MESSAGE, + number=8, + message=timestamp_pb2.Timestamp, ) metrics = proto.RepeatedField( - proto.MESSAGE, number=11, message=migration_metrics.TimeSeries, + proto.MESSAGE, + number=11, + message=migration_metrics.TimeSeries, ) diff --git a/google/cloud/bigquery_migration_v2alpha/types/migration_error_details.py b/google/cloud/bigquery_migration_v2alpha/types/migration_error_details.py index f78750d..7885bd7 100644 --- a/google/cloud/bigquery_migration_v2alpha/types/migration_error_details.py +++ b/google/cloud/bigquery_migration_v2alpha/types/migration_error_details.py @@ -20,7 +20,11 @@ __protobuf__ = proto.module( package="google.cloud.bigquery.migration.v2alpha", - manifest={"ResourceErrorDetail", "ErrorDetail", "ErrorLocation",}, + manifest={ + "ResourceErrorDetail", + "ErrorDetail", + "ErrorLocation", + }, ) @@ -41,10 +45,19 @@ class ResourceErrorDetail(proto.Message): """ resource_info = proto.Field( - proto.MESSAGE, number=1, message=error_details_pb2.ResourceInfo, + proto.MESSAGE, + number=1, + message=error_details_pb2.ResourceInfo, + ) + error_details = proto.RepeatedField( + proto.MESSAGE, + number=2, + message="ErrorDetail", + ) + error_count = proto.Field( + proto.INT32, + number=3, ) - error_details = proto.RepeatedField(proto.MESSAGE, number=2, message="ErrorDetail",) - error_count = proto.Field(proto.INT32, number=3,) class ErrorDetail(proto.Message): @@ -60,9 +73,15 @@ class ErrorDetail(proto.Message): with structured detail. """ - location = proto.Field(proto.MESSAGE, number=1, message="ErrorLocation",) + location = proto.Field( + proto.MESSAGE, + number=1, + message="ErrorLocation", + ) error_info = proto.Field( - proto.MESSAGE, number=2, message=error_details_pb2.ErrorInfo, + proto.MESSAGE, + number=2, + message=error_details_pb2.ErrorInfo, ) @@ -80,8 +99,14 @@ class ErrorLocation(proto.Message): that there is no columns information. """ - line = proto.Field(proto.INT32, number=1,) - column = proto.Field(proto.INT32, number=2,) + line = proto.Field( + proto.INT32, + number=1, + ) + column = proto.Field( + proto.INT32, + number=2, + ) __all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/google/cloud/bigquery_migration_v2alpha/types/migration_metrics.py b/google/cloud/bigquery_migration_v2alpha/types/migration_metrics.py index 9d68cd8..a3f53be 100644 --- a/google/cloud/bigquery_migration_v2alpha/types/migration_metrics.py +++ b/google/cloud/bigquery_migration_v2alpha/types/migration_metrics.py @@ -22,7 +22,12 @@ __protobuf__ = proto.module( package="google.cloud.bigquery.migration.v2alpha", - manifest={"TimeSeries", "Point", "TimeInterval", "TypedValue",}, + manifest={ + "TimeSeries", + "Point", + "TimeInterval", + "TypedValue", + }, ) @@ -56,14 +61,25 @@ class TimeSeries(proto.Message): ``BOOL``, ``INT64``, ``DOUBLE``, or ``DISTRIBUTION``. """ - metric = proto.Field(proto.STRING, number=1,) + metric = proto.Field( + proto.STRING, + number=1, + ) value_type = proto.Field( - proto.ENUM, number=2, enum=metric_pb2.MetricDescriptor.ValueType, + proto.ENUM, + number=2, + enum=metric_pb2.MetricDescriptor.ValueType, ) metric_kind = proto.Field( - proto.ENUM, number=3, enum=metric_pb2.MetricDescriptor.MetricKind, + proto.ENUM, + number=3, + enum=metric_pb2.MetricDescriptor.MetricKind, + ) + points = proto.RepeatedField( + proto.MESSAGE, + number=4, + message="Point", ) - points = proto.RepeatedField(proto.MESSAGE, number=4, message="Point",) class Point(proto.Message): @@ -86,8 +102,16 @@ class Point(proto.Message): The value of the data point. """ - interval = proto.Field(proto.MESSAGE, number=1, message="TimeInterval",) - value = proto.Field(proto.MESSAGE, number=2, message="TypedValue",) + interval = proto.Field( + proto.MESSAGE, + number=1, + message="TimeInterval", + ) + value = proto.Field( + proto.MESSAGE, + number=2, + message="TypedValue", + ) class TimeInterval(proto.Message): @@ -105,8 +129,16 @@ class TimeInterval(proto.Message): Required. The end of the time interval. """ - start_time = proto.Field(proto.MESSAGE, number=1, message=timestamp_pb2.Timestamp,) - end_time = proto.Field(proto.MESSAGE, number=2, message=timestamp_pb2.Timestamp,) + start_time = proto.Field( + proto.MESSAGE, + number=1, + message=timestamp_pb2.Timestamp, + ) + end_time = proto.Field( + proto.MESSAGE, + number=2, + message=timestamp_pb2.Timestamp, + ) class TypedValue(proto.Message): @@ -146,12 +178,31 @@ class TypedValue(proto.Message): This field is a member of `oneof`_ ``value``. """ - bool_value = proto.Field(proto.BOOL, number=1, oneof="value",) - int64_value = proto.Field(proto.INT64, number=2, oneof="value",) - double_value = proto.Field(proto.DOUBLE, number=3, oneof="value",) - string_value = proto.Field(proto.STRING, number=4, oneof="value",) + bool_value = proto.Field( + proto.BOOL, + number=1, + oneof="value", + ) + int64_value = proto.Field( + proto.INT64, + number=2, + oneof="value", + ) + double_value = proto.Field( + proto.DOUBLE, + number=3, + oneof="value", + ) + string_value = proto.Field( + proto.STRING, + number=4, + oneof="value", + ) distribution_value = proto.Field( - proto.MESSAGE, number=5, oneof="value", message=distribution_pb2.Distribution, + proto.MESSAGE, + number=5, + oneof="value", + message=distribution_pb2.Distribution, ) diff --git a/google/cloud/bigquery_migration_v2alpha/types/migration_service.py b/google/cloud/bigquery_migration_v2alpha/types/migration_service.py index 0e7c48a..20e9bc3 100644 --- a/google/cloud/bigquery_migration_v2alpha/types/migration_service.py +++ b/google/cloud/bigquery_migration_v2alpha/types/migration_service.py @@ -46,9 +46,14 @@ class CreateMigrationWorkflowRequest(proto.Message): Required. The migration workflow to create. """ - parent = proto.Field(proto.STRING, number=1,) + parent = proto.Field( + proto.STRING, + number=1, + ) migration_workflow = proto.Field( - proto.MESSAGE, number=2, message=migration_entities.MigrationWorkflow, + proto.MESSAGE, + number=2, + message=migration_entities.MigrationWorkflow, ) @@ -63,8 +68,15 @@ class GetMigrationWorkflowRequest(proto.Message): The list of fields to be retrieved. """ - name = proto.Field(proto.STRING, number=1,) - read_mask = proto.Field(proto.MESSAGE, number=2, message=field_mask_pb2.FieldMask,) + name = proto.Field( + proto.STRING, + number=1, + ) + read_mask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) class ListMigrationWorkflowsRequest(proto.Message): @@ -90,10 +102,23 @@ class ListMigrationWorkflowsRequest(proto.Message): the page token. """ - parent = proto.Field(proto.STRING, number=1,) - read_mask = proto.Field(proto.MESSAGE, number=2, message=field_mask_pb2.FieldMask,) - page_size = proto.Field(proto.INT32, number=3,) - page_token = proto.Field(proto.STRING, number=4,) + parent = proto.Field( + proto.STRING, + number=1, + ) + read_mask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + page_size = proto.Field( + proto.INT32, + number=3, + ) + page_token = proto.Field( + proto.STRING, + number=4, + ) class ListMigrationWorkflowsResponse(proto.Message): @@ -114,9 +139,14 @@ def raw_page(self): return self migration_workflows = proto.RepeatedField( - proto.MESSAGE, number=1, message=migration_entities.MigrationWorkflow, + proto.MESSAGE, + number=1, + message=migration_entities.MigrationWorkflow, + ) + next_page_token = proto.Field( + proto.STRING, + number=2, ) - next_page_token = proto.Field(proto.STRING, number=2,) class DeleteMigrationWorkflowRequest(proto.Message): @@ -128,7 +158,10 @@ class DeleteMigrationWorkflowRequest(proto.Message): Example: ``projects/123/locations/us/workflows/1234`` """ - name = proto.Field(proto.STRING, number=1,) + name = proto.Field( + proto.STRING, + number=1, + ) class StartMigrationWorkflowRequest(proto.Message): @@ -140,7 +173,10 @@ class StartMigrationWorkflowRequest(proto.Message): Example: ``projects/123/locations/us/workflows/1234`` """ - name = proto.Field(proto.STRING, number=1,) + name = proto.Field( + proto.STRING, + number=1, + ) class GetMigrationSubtaskRequest(proto.Message): @@ -155,8 +191,15 @@ class GetMigrationSubtaskRequest(proto.Message): Optional. The list of fields to be retrieved. """ - name = proto.Field(proto.STRING, number=1,) - read_mask = proto.Field(proto.MESSAGE, number=2, message=field_mask_pb2.FieldMask,) + name = proto.Field( + proto.STRING, + number=1, + ) + read_mask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) class ListMigrationSubtasksRequest(proto.Message): @@ -187,11 +230,27 @@ class ListMigrationSubtasksRequest(proto.Message): ID (not the name in the named map). """ - parent = proto.Field(proto.STRING, number=1,) - read_mask = proto.Field(proto.MESSAGE, number=2, message=field_mask_pb2.FieldMask,) - page_size = proto.Field(proto.INT32, number=3,) - page_token = proto.Field(proto.STRING, number=4,) - filter = proto.Field(proto.STRING, number=5,) + parent = proto.Field( + proto.STRING, + number=1, + ) + read_mask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + page_size = proto.Field( + proto.INT32, + number=3, + ) + page_token = proto.Field( + proto.STRING, + number=4, + ) + filter = proto.Field( + proto.STRING, + number=5, + ) class ListMigrationSubtasksResponse(proto.Message): @@ -212,9 +271,14 @@ def raw_page(self): return self migration_subtasks = proto.RepeatedField( - proto.MESSAGE, number=1, message=migration_entities.MigrationSubtask, + proto.MESSAGE, + number=1, + message=migration_entities.MigrationSubtask, + ) + next_page_token = proto.Field( + proto.STRING, + number=2, ) - next_page_token = proto.Field(proto.STRING, number=2,) __all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/google/cloud/bigquery_migration_v2alpha/types/translation_task.py b/google/cloud/bigquery_migration_v2alpha/types/translation_task.py index 7c3a8ba..5c76b7b 100644 --- a/google/cloud/bigquery_migration_v2alpha/types/translation_task.py +++ b/google/cloud/bigquery_migration_v2alpha/types/translation_task.py @@ -43,8 +43,14 @@ class TranslationFileMapping(proto.Message): corresponding input file to. """ - input_path = proto.Field(proto.STRING, number=1,) - output_path = proto.Field(proto.STRING, number=2,) + input_path = proto.Field( + proto.STRING, + number=1, + ) + output_path = proto.Field( + proto.STRING, + number=2, + ) class TranslationTaskDetails(proto.Message): @@ -130,26 +136,59 @@ class TokenType(proto.Enum): TIMESTAMP = 7 teradata_options = proto.Field( - proto.MESSAGE, number=10, oneof="language_options", message="TeradataOptions", + proto.MESSAGE, + number=10, + oneof="language_options", + message="TeradataOptions", ) bteq_options = proto.Field( - proto.MESSAGE, number=11, oneof="language_options", message="BteqOptions", + proto.MESSAGE, + number=11, + oneof="language_options", + message="BteqOptions", + ) + input_path = proto.Field( + proto.STRING, + number=1, + ) + output_path = proto.Field( + proto.STRING, + number=2, ) - input_path = proto.Field(proto.STRING, number=1,) - output_path = proto.Field(proto.STRING, number=2,) file_paths = proto.RepeatedField( - proto.MESSAGE, number=12, message="TranslationFileMapping", + proto.MESSAGE, + number=12, + message="TranslationFileMapping", + ) + schema_path = proto.Field( + proto.STRING, + number=3, + ) + file_encoding = proto.Field( + proto.ENUM, + number=4, + enum=FileEncoding, ) - schema_path = proto.Field(proto.STRING, number=3,) - file_encoding = proto.Field(proto.ENUM, number=4, enum=FileEncoding,) identifier_settings = proto.Field( - proto.MESSAGE, number=5, message="IdentifierSettings", + proto.MESSAGE, + number=5, + message="IdentifierSettings", ) special_token_map = proto.MapField( - proto.STRING, proto.ENUM, number=6, enum=TokenType, + proto.STRING, + proto.ENUM, + number=6, + enum=TokenType, + ) + filter = proto.Field( + proto.MESSAGE, + number=7, + message="Filter", + ) + translation_exception_table = proto.Field( + proto.STRING, + number=13, ) - filter = proto.Field(proto.MESSAGE, number=7, message="Filter",) - translation_exception_table = proto.Field(proto.STRING, number=13,) class Filter(proto.Message): @@ -161,7 +200,10 @@ class Filter(proto.Message): processing for input files. """ - input_file_exclusion_prefixes = proto.RepeatedField(proto.STRING, number=1,) + input_file_exclusion_prefixes = proto.RepeatedField( + proto.STRING, + number=1, + ) class IdentifierSettings(proto.Message): @@ -189,15 +231,20 @@ class IdentifierRewriteMode(proto.Enum): NONE = 1 REWRITE_ALL = 2 - output_identifier_case = proto.Field(proto.ENUM, number=1, enum=IdentifierCase,) + output_identifier_case = proto.Field( + proto.ENUM, + number=1, + enum=IdentifierCase, + ) identifier_rewrite_mode = proto.Field( - proto.ENUM, number=2, enum=IdentifierRewriteMode, + proto.ENUM, + number=2, + enum=IdentifierRewriteMode, ) class TeradataOptions(proto.Message): - r"""Teradata SQL specific translation task related settings. - """ + r"""Teradata SQL specific translation task related settings.""" class BteqOptions(proto.Message): @@ -219,9 +266,20 @@ class BteqOptions(proto.Message): translation (the value). """ - project_dataset = proto.Field(proto.MESSAGE, number=1, message="DatasetReference",) - default_path_uri = proto.Field(proto.STRING, number=2,) - file_replacement_map = proto.MapField(proto.STRING, proto.STRING, number=3,) + project_dataset = proto.Field( + proto.MESSAGE, + number=1, + message="DatasetReference", + ) + default_path_uri = proto.Field( + proto.STRING, + number=2, + ) + file_replacement_map = proto.MapField( + proto.STRING, + proto.STRING, + number=3, + ) class DatasetReference(proto.Message): @@ -237,8 +295,14 @@ class DatasetReference(proto.Message): dataset. """ - dataset_id = proto.Field(proto.STRING, number=1,) - project_id = proto.Field(proto.STRING, number=2,) + dataset_id = proto.Field( + proto.STRING, + number=1, + ) + project_id = proto.Field( + proto.STRING, + number=2, + ) __all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/noxfile.py b/noxfile.py index 2a2001c..6ee5e8a 100644 --- a/noxfile.py +++ b/noxfile.py @@ -20,16 +20,40 @@ import os import pathlib import shutil +import warnings import nox - -BLACK_VERSION = "black==19.10b0" +BLACK_VERSION = "black==22.3.0" BLACK_PATHS = ["docs", "google", "tests", "noxfile.py", "setup.py"] DEFAULT_PYTHON_VERSION = "3.8" -SYSTEM_TEST_PYTHON_VERSIONS = ["3.8"] + UNIT_TEST_PYTHON_VERSIONS = ["3.6", "3.7", "3.8", "3.9", "3.10"] +UNIT_TEST_STANDARD_DEPENDENCIES = [ + "mock", + "asyncmock", + "pytest", + "pytest-cov", + "pytest-asyncio", +] +UNIT_TEST_EXTERNAL_DEPENDENCIES = [] +UNIT_TEST_LOCAL_DEPENDENCIES = [] +UNIT_TEST_DEPENDENCIES = [] +UNIT_TEST_EXTRAS = [] +UNIT_TEST_EXTRAS_BY_PYTHON = {} + +SYSTEM_TEST_PYTHON_VERSIONS = ["3.8"] +SYSTEM_TEST_STANDARD_DEPENDENCIES = [ + "mock", + "pytest", + "google-cloud-testutils", +] +SYSTEM_TEST_EXTERNAL_DEPENDENCIES = [] +SYSTEM_TEST_LOCAL_DEPENDENCIES = [] +SYSTEM_TEST_DEPENDENCIES = [] +SYSTEM_TEST_EXTRAS = [] +SYSTEM_TEST_EXTRAS_BY_PYTHON = {} CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() @@ -57,7 +81,9 @@ def lint(session): """ session.install("flake8", BLACK_VERSION) session.run( - "black", "--check", *BLACK_PATHS, + "black", + "--check", + *BLACK_PATHS, ) session.run("flake8", "google", "tests") @@ -67,7 +93,8 @@ def blacken(session): """Run black. Format code to uniform standard.""" session.install(BLACK_VERSION) session.run( - "black", *BLACK_PATHS, + "black", + *BLACK_PATHS, ) @@ -78,23 +105,41 @@ def lint_setup_py(session): session.run("python", "setup.py", "check", "--restructuredtext", "--strict") +def install_unittest_dependencies(session, *constraints): + standard_deps = UNIT_TEST_STANDARD_DEPENDENCIES + UNIT_TEST_DEPENDENCIES + session.install(*standard_deps, *constraints) + + if UNIT_TEST_EXTERNAL_DEPENDENCIES: + warnings.warn( + "'unit_test_external_dependencies' is deprecated. Instead, please " + "use 'unit_test_dependencies' or 'unit_test_local_dependencies'.", + DeprecationWarning, + ) + session.install(*UNIT_TEST_EXTERNAL_DEPENDENCIES, *constraints) + + if UNIT_TEST_LOCAL_DEPENDENCIES: + session.install(*UNIT_TEST_LOCAL_DEPENDENCIES, *constraints) + + if UNIT_TEST_EXTRAS_BY_PYTHON: + extras = UNIT_TEST_EXTRAS_BY_PYTHON.get(session.python, []) + elif UNIT_TEST_EXTRAS: + extras = UNIT_TEST_EXTRAS + else: + extras = [] + + if extras: + session.install("-e", f".[{','.join(extras)}]", *constraints) + else: + session.install("-e", ".", *constraints) + + def default(session): # Install all test dependencies, then install this package in-place. constraints_path = str( CURRENT_DIRECTORY / "testing" / f"constraints-{session.python}.txt" ) - session.install( - "mock", - "asyncmock", - "pytest", - "pytest-cov", - "pytest-asyncio", - "-c", - constraints_path, - ) - - session.install("-e", ".", "-c", constraints_path) + install_unittest_dependencies(session, "-c", constraints_path) # Run py.test against the unit tests. session.run( @@ -118,6 +163,35 @@ def unit(session): default(session) +def install_systemtest_dependencies(session, *constraints): + + # Use pre-release gRPC for system tests. + session.install("--pre", "grpcio") + + session.install(*SYSTEM_TEST_STANDARD_DEPENDENCIES, *constraints) + + if SYSTEM_TEST_EXTERNAL_DEPENDENCIES: + session.install(*SYSTEM_TEST_EXTERNAL_DEPENDENCIES, *constraints) + + if SYSTEM_TEST_LOCAL_DEPENDENCIES: + session.install("-e", *SYSTEM_TEST_LOCAL_DEPENDENCIES, *constraints) + + if SYSTEM_TEST_DEPENDENCIES: + session.install("-e", *SYSTEM_TEST_DEPENDENCIES, *constraints) + + if SYSTEM_TEST_EXTRAS_BY_PYTHON: + extras = SYSTEM_TEST_EXTRAS_BY_PYTHON.get(session.python, []) + elif SYSTEM_TEST_EXTRAS: + extras = SYSTEM_TEST_EXTRAS + else: + extras = [] + + if extras: + session.install("-e", f".[{','.join(extras)}]", *constraints) + else: + session.install("-e", ".", *constraints) + + @nox.session(python=SYSTEM_TEST_PYTHON_VERSIONS) def system(session): """Run the system test suite.""" @@ -140,13 +214,7 @@ def system(session): if not system_test_exists and not system_test_folder_exists: session.skip("System tests were not found") - # Use pre-release gRPC for system tests. - session.install("--pre", "grpcio") - - # Install all test dependencies, then install this package into the - # virtualenv's dist-packages. - session.install("mock", "pytest", "google-cloud-testutils", "-c", constraints_path) - session.install("-e", ".", "-c", constraints_path) + install_systemtest_dependencies(session, "-c", constraints_path) # Run py.test against the system tests. if system_test_exists: diff --git a/samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_create_migration_workflow_async.py b/samples/generated_samples/bigquerymigration_v2_generated_migration_service_create_migration_workflow_async.py similarity index 76% rename from samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_create_migration_workflow_async.py rename to samples/generated_samples/bigquerymigration_v2_generated_migration_service_create_migration_workflow_async.py index 5fa45d2..91e1345 100644 --- a/samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_create_migration_workflow_async.py +++ b/samples/generated_samples/bigquerymigration_v2_generated_migration_service_create_migration_workflow_async.py @@ -23,16 +23,16 @@ # python3 -m pip install google-cloud-bigquery-migration -# [START bigquerymigration_v2alpha_generated_MigrationService_CreateMigrationWorkflow_async] -from google.cloud import bigquery_migration_v2alpha +# [START bigquerymigration_v2_generated_MigrationService_CreateMigrationWorkflow_async] +from google.cloud import bigquery_migration_v2 async def sample_create_migration_workflow(): # Create a client - client = bigquery_migration_v2alpha.MigrationServiceAsyncClient() + client = bigquery_migration_v2.MigrationServiceAsyncClient() # Initialize request argument(s) - request = bigquery_migration_v2alpha.CreateMigrationWorkflowRequest( + request = bigquery_migration_v2.CreateMigrationWorkflowRequest( parent="parent_value", ) @@ -42,4 +42,4 @@ async def sample_create_migration_workflow(): # Handle the response print(response) -# [END bigquerymigration_v2alpha_generated_MigrationService_CreateMigrationWorkflow_async] +# [END bigquerymigration_v2_generated_MigrationService_CreateMigrationWorkflow_async] diff --git a/samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_create_migration_workflow_sync.py b/samples/generated_samples/bigquerymigration_v2_generated_migration_service_create_migration_workflow_sync.py similarity index 76% rename from samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_create_migration_workflow_sync.py rename to samples/generated_samples/bigquerymigration_v2_generated_migration_service_create_migration_workflow_sync.py index e669e6e..173cfcf 100644 --- a/samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_create_migration_workflow_sync.py +++ b/samples/generated_samples/bigquerymigration_v2_generated_migration_service_create_migration_workflow_sync.py @@ -23,16 +23,16 @@ # python3 -m pip install google-cloud-bigquery-migration -# [START bigquerymigration_v2alpha_generated_MigrationService_CreateMigrationWorkflow_sync] -from google.cloud import bigquery_migration_v2alpha +# [START bigquerymigration_v2_generated_MigrationService_CreateMigrationWorkflow_sync] +from google.cloud import bigquery_migration_v2 def sample_create_migration_workflow(): # Create a client - client = bigquery_migration_v2alpha.MigrationServiceClient() + client = bigquery_migration_v2.MigrationServiceClient() # Initialize request argument(s) - request = bigquery_migration_v2alpha.CreateMigrationWorkflowRequest( + request = bigquery_migration_v2.CreateMigrationWorkflowRequest( parent="parent_value", ) @@ -42,4 +42,4 @@ def sample_create_migration_workflow(): # Handle the response print(response) -# [END bigquerymigration_v2alpha_generated_MigrationService_CreateMigrationWorkflow_sync] +# [END bigquerymigration_v2_generated_MigrationService_CreateMigrationWorkflow_sync] diff --git a/samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_delete_migration_workflow_async.py b/samples/generated_samples/bigquerymigration_v2_generated_migration_service_delete_migration_workflow_async.py similarity index 75% rename from samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_delete_migration_workflow_async.py rename to samples/generated_samples/bigquerymigration_v2_generated_migration_service_delete_migration_workflow_async.py index 9754d02..45607ec 100644 --- a/samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_delete_migration_workflow_async.py +++ b/samples/generated_samples/bigquerymigration_v2_generated_migration_service_delete_migration_workflow_async.py @@ -23,16 +23,16 @@ # python3 -m pip install google-cloud-bigquery-migration -# [START bigquerymigration_v2alpha_generated_MigrationService_DeleteMigrationWorkflow_async] -from google.cloud import bigquery_migration_v2alpha +# [START bigquerymigration_v2_generated_MigrationService_DeleteMigrationWorkflow_async] +from google.cloud import bigquery_migration_v2 async def sample_delete_migration_workflow(): # Create a client - client = bigquery_migration_v2alpha.MigrationServiceAsyncClient() + client = bigquery_migration_v2.MigrationServiceAsyncClient() # Initialize request argument(s) - request = bigquery_migration_v2alpha.DeleteMigrationWorkflowRequest( + request = bigquery_migration_v2.DeleteMigrationWorkflowRequest( name="name_value", ) @@ -40,4 +40,4 @@ async def sample_delete_migration_workflow(): await client.delete_migration_workflow(request=request) -# [END bigquerymigration_v2alpha_generated_MigrationService_DeleteMigrationWorkflow_async] +# [END bigquerymigration_v2_generated_MigrationService_DeleteMigrationWorkflow_async] diff --git a/samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_delete_migration_workflow_sync.py b/samples/generated_samples/bigquerymigration_v2_generated_migration_service_delete_migration_workflow_sync.py similarity index 75% rename from samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_delete_migration_workflow_sync.py rename to samples/generated_samples/bigquerymigration_v2_generated_migration_service_delete_migration_workflow_sync.py index cf7a9ac..a9a1044 100644 --- a/samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_delete_migration_workflow_sync.py +++ b/samples/generated_samples/bigquerymigration_v2_generated_migration_service_delete_migration_workflow_sync.py @@ -23,16 +23,16 @@ # python3 -m pip install google-cloud-bigquery-migration -# [START bigquerymigration_v2alpha_generated_MigrationService_DeleteMigrationWorkflow_sync] -from google.cloud import bigquery_migration_v2alpha +# [START bigquerymigration_v2_generated_MigrationService_DeleteMigrationWorkflow_sync] +from google.cloud import bigquery_migration_v2 def sample_delete_migration_workflow(): # Create a client - client = bigquery_migration_v2alpha.MigrationServiceClient() + client = bigquery_migration_v2.MigrationServiceClient() # Initialize request argument(s) - request = bigquery_migration_v2alpha.DeleteMigrationWorkflowRequest( + request = bigquery_migration_v2.DeleteMigrationWorkflowRequest( name="name_value", ) @@ -40,4 +40,4 @@ def sample_delete_migration_workflow(): client.delete_migration_workflow(request=request) -# [END bigquerymigration_v2alpha_generated_MigrationService_DeleteMigrationWorkflow_sync] +# [END bigquerymigration_v2_generated_MigrationService_DeleteMigrationWorkflow_sync] diff --git a/samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_get_migration_subtask_async.py b/samples/generated_samples/bigquerymigration_v2_generated_migration_service_get_migration_subtask_async.py similarity index 76% rename from samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_get_migration_subtask_async.py rename to samples/generated_samples/bigquerymigration_v2_generated_migration_service_get_migration_subtask_async.py index 238c7c4..d055a9b 100644 --- a/samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_get_migration_subtask_async.py +++ b/samples/generated_samples/bigquerymigration_v2_generated_migration_service_get_migration_subtask_async.py @@ -23,16 +23,16 @@ # python3 -m pip install google-cloud-bigquery-migration -# [START bigquerymigration_v2alpha_generated_MigrationService_GetMigrationSubtask_async] -from google.cloud import bigquery_migration_v2alpha +# [START bigquerymigration_v2_generated_MigrationService_GetMigrationSubtask_async] +from google.cloud import bigquery_migration_v2 async def sample_get_migration_subtask(): # Create a client - client = bigquery_migration_v2alpha.MigrationServiceAsyncClient() + client = bigquery_migration_v2.MigrationServiceAsyncClient() # Initialize request argument(s) - request = bigquery_migration_v2alpha.GetMigrationSubtaskRequest( + request = bigquery_migration_v2.GetMigrationSubtaskRequest( name="name_value", ) @@ -42,4 +42,4 @@ async def sample_get_migration_subtask(): # Handle the response print(response) -# [END bigquerymigration_v2alpha_generated_MigrationService_GetMigrationSubtask_async] +# [END bigquerymigration_v2_generated_MigrationService_GetMigrationSubtask_async] diff --git a/samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_get_migration_subtask_sync.py b/samples/generated_samples/bigquerymigration_v2_generated_migration_service_get_migration_subtask_sync.py similarity index 77% rename from samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_get_migration_subtask_sync.py rename to samples/generated_samples/bigquerymigration_v2_generated_migration_service_get_migration_subtask_sync.py index eb7b23c..45229e1 100644 --- a/samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_get_migration_subtask_sync.py +++ b/samples/generated_samples/bigquerymigration_v2_generated_migration_service_get_migration_subtask_sync.py @@ -23,16 +23,16 @@ # python3 -m pip install google-cloud-bigquery-migration -# [START bigquerymigration_v2alpha_generated_MigrationService_GetMigrationSubtask_sync] -from google.cloud import bigquery_migration_v2alpha +# [START bigquerymigration_v2_generated_MigrationService_GetMigrationSubtask_sync] +from google.cloud import bigquery_migration_v2 def sample_get_migration_subtask(): # Create a client - client = bigquery_migration_v2alpha.MigrationServiceClient() + client = bigquery_migration_v2.MigrationServiceClient() # Initialize request argument(s) - request = bigquery_migration_v2alpha.GetMigrationSubtaskRequest( + request = bigquery_migration_v2.GetMigrationSubtaskRequest( name="name_value", ) @@ -42,4 +42,4 @@ def sample_get_migration_subtask(): # Handle the response print(response) -# [END bigquerymigration_v2alpha_generated_MigrationService_GetMigrationSubtask_sync] +# [END bigquerymigration_v2_generated_MigrationService_GetMigrationSubtask_sync] diff --git a/samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_get_migration_workflow_async.py b/samples/generated_samples/bigquerymigration_v2_generated_migration_service_get_migration_workflow_async.py similarity index 76% rename from samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_get_migration_workflow_async.py rename to samples/generated_samples/bigquerymigration_v2_generated_migration_service_get_migration_workflow_async.py index 45a6473..350c880 100644 --- a/samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_get_migration_workflow_async.py +++ b/samples/generated_samples/bigquerymigration_v2_generated_migration_service_get_migration_workflow_async.py @@ -23,16 +23,16 @@ # python3 -m pip install google-cloud-bigquery-migration -# [START bigquerymigration_v2alpha_generated_MigrationService_GetMigrationWorkflow_async] -from google.cloud import bigquery_migration_v2alpha +# [START bigquerymigration_v2_generated_MigrationService_GetMigrationWorkflow_async] +from google.cloud import bigquery_migration_v2 async def sample_get_migration_workflow(): # Create a client - client = bigquery_migration_v2alpha.MigrationServiceAsyncClient() + client = bigquery_migration_v2.MigrationServiceAsyncClient() # Initialize request argument(s) - request = bigquery_migration_v2alpha.GetMigrationWorkflowRequest( + request = bigquery_migration_v2.GetMigrationWorkflowRequest( name="name_value", ) @@ -42,4 +42,4 @@ async def sample_get_migration_workflow(): # Handle the response print(response) -# [END bigquerymigration_v2alpha_generated_MigrationService_GetMigrationWorkflow_async] +# [END bigquerymigration_v2_generated_MigrationService_GetMigrationWorkflow_async] diff --git a/samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_get_migration_workflow_sync.py b/samples/generated_samples/bigquerymigration_v2_generated_migration_service_get_migration_workflow_sync.py similarity index 77% rename from samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_get_migration_workflow_sync.py rename to samples/generated_samples/bigquerymigration_v2_generated_migration_service_get_migration_workflow_sync.py index fad8d73..c51ddb4 100644 --- a/samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_get_migration_workflow_sync.py +++ b/samples/generated_samples/bigquerymigration_v2_generated_migration_service_get_migration_workflow_sync.py @@ -23,16 +23,16 @@ # python3 -m pip install google-cloud-bigquery-migration -# [START bigquerymigration_v2alpha_generated_MigrationService_GetMigrationWorkflow_sync] -from google.cloud import bigquery_migration_v2alpha +# [START bigquerymigration_v2_generated_MigrationService_GetMigrationWorkflow_sync] +from google.cloud import bigquery_migration_v2 def sample_get_migration_workflow(): # Create a client - client = bigquery_migration_v2alpha.MigrationServiceClient() + client = bigquery_migration_v2.MigrationServiceClient() # Initialize request argument(s) - request = bigquery_migration_v2alpha.GetMigrationWorkflowRequest( + request = bigquery_migration_v2.GetMigrationWorkflowRequest( name="name_value", ) @@ -42,4 +42,4 @@ def sample_get_migration_workflow(): # Handle the response print(response) -# [END bigquerymigration_v2alpha_generated_MigrationService_GetMigrationWorkflow_sync] +# [END bigquerymigration_v2_generated_MigrationService_GetMigrationWorkflow_sync] diff --git a/samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_list_migration_subtasks_async.py b/samples/generated_samples/bigquerymigration_v2_generated_migration_service_list_migration_subtasks_async.py similarity index 77% rename from samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_list_migration_subtasks_async.py rename to samples/generated_samples/bigquerymigration_v2_generated_migration_service_list_migration_subtasks_async.py index dc4cda1..939433d 100644 --- a/samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_list_migration_subtasks_async.py +++ b/samples/generated_samples/bigquerymigration_v2_generated_migration_service_list_migration_subtasks_async.py @@ -23,16 +23,16 @@ # python3 -m pip install google-cloud-bigquery-migration -# [START bigquerymigration_v2alpha_generated_MigrationService_ListMigrationSubtasks_async] -from google.cloud import bigquery_migration_v2alpha +# [START bigquerymigration_v2_generated_MigrationService_ListMigrationSubtasks_async] +from google.cloud import bigquery_migration_v2 async def sample_list_migration_subtasks(): # Create a client - client = bigquery_migration_v2alpha.MigrationServiceAsyncClient() + client = bigquery_migration_v2.MigrationServiceAsyncClient() # Initialize request argument(s) - request = bigquery_migration_v2alpha.ListMigrationSubtasksRequest( + request = bigquery_migration_v2.ListMigrationSubtasksRequest( parent="parent_value", ) @@ -43,4 +43,4 @@ async def sample_list_migration_subtasks(): async for response in page_result: print(response) -# [END bigquerymigration_v2alpha_generated_MigrationService_ListMigrationSubtasks_async] +# [END bigquerymigration_v2_generated_MigrationService_ListMigrationSubtasks_async] diff --git a/samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_list_migration_subtasks_sync.py b/samples/generated_samples/bigquerymigration_v2_generated_migration_service_list_migration_subtasks_sync.py similarity index 77% rename from samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_list_migration_subtasks_sync.py rename to samples/generated_samples/bigquerymigration_v2_generated_migration_service_list_migration_subtasks_sync.py index f3f4bd0..5d7d3a9 100644 --- a/samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_list_migration_subtasks_sync.py +++ b/samples/generated_samples/bigquerymigration_v2_generated_migration_service_list_migration_subtasks_sync.py @@ -23,16 +23,16 @@ # python3 -m pip install google-cloud-bigquery-migration -# [START bigquerymigration_v2alpha_generated_MigrationService_ListMigrationSubtasks_sync] -from google.cloud import bigquery_migration_v2alpha +# [START bigquerymigration_v2_generated_MigrationService_ListMigrationSubtasks_sync] +from google.cloud import bigquery_migration_v2 def sample_list_migration_subtasks(): # Create a client - client = bigquery_migration_v2alpha.MigrationServiceClient() + client = bigquery_migration_v2.MigrationServiceClient() # Initialize request argument(s) - request = bigquery_migration_v2alpha.ListMigrationSubtasksRequest( + request = bigquery_migration_v2.ListMigrationSubtasksRequest( parent="parent_value", ) @@ -43,4 +43,4 @@ def sample_list_migration_subtasks(): for response in page_result: print(response) -# [END bigquerymigration_v2alpha_generated_MigrationService_ListMigrationSubtasks_sync] +# [END bigquerymigration_v2_generated_MigrationService_ListMigrationSubtasks_sync] diff --git a/samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_list_migration_workflows_async.py b/samples/generated_samples/bigquerymigration_v2_generated_migration_service_list_migration_workflows_async.py similarity index 77% rename from samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_list_migration_workflows_async.py rename to samples/generated_samples/bigquerymigration_v2_generated_migration_service_list_migration_workflows_async.py index 868a82f..32cd362 100644 --- a/samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_list_migration_workflows_async.py +++ b/samples/generated_samples/bigquerymigration_v2_generated_migration_service_list_migration_workflows_async.py @@ -23,16 +23,16 @@ # python3 -m pip install google-cloud-bigquery-migration -# [START bigquerymigration_v2alpha_generated_MigrationService_ListMigrationWorkflows_async] -from google.cloud import bigquery_migration_v2alpha +# [START bigquerymigration_v2_generated_MigrationService_ListMigrationWorkflows_async] +from google.cloud import bigquery_migration_v2 async def sample_list_migration_workflows(): # Create a client - client = bigquery_migration_v2alpha.MigrationServiceAsyncClient() + client = bigquery_migration_v2.MigrationServiceAsyncClient() # Initialize request argument(s) - request = bigquery_migration_v2alpha.ListMigrationWorkflowsRequest( + request = bigquery_migration_v2.ListMigrationWorkflowsRequest( parent="parent_value", ) @@ -43,4 +43,4 @@ async def sample_list_migration_workflows(): async for response in page_result: print(response) -# [END bigquerymigration_v2alpha_generated_MigrationService_ListMigrationWorkflows_async] +# [END bigquerymigration_v2_generated_MigrationService_ListMigrationWorkflows_async] diff --git a/samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_list_migration_workflows_sync.py b/samples/generated_samples/bigquerymigration_v2_generated_migration_service_list_migration_workflows_sync.py similarity index 77% rename from samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_list_migration_workflows_sync.py rename to samples/generated_samples/bigquerymigration_v2_generated_migration_service_list_migration_workflows_sync.py index c48711f..79f7be7 100644 --- a/samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_list_migration_workflows_sync.py +++ b/samples/generated_samples/bigquerymigration_v2_generated_migration_service_list_migration_workflows_sync.py @@ -23,16 +23,16 @@ # python3 -m pip install google-cloud-bigquery-migration -# [START bigquerymigration_v2alpha_generated_MigrationService_ListMigrationWorkflows_sync] -from google.cloud import bigquery_migration_v2alpha +# [START bigquerymigration_v2_generated_MigrationService_ListMigrationWorkflows_sync] +from google.cloud import bigquery_migration_v2 def sample_list_migration_workflows(): # Create a client - client = bigquery_migration_v2alpha.MigrationServiceClient() + client = bigquery_migration_v2.MigrationServiceClient() # Initialize request argument(s) - request = bigquery_migration_v2alpha.ListMigrationWorkflowsRequest( + request = bigquery_migration_v2.ListMigrationWorkflowsRequest( parent="parent_value", ) @@ -43,4 +43,4 @@ def sample_list_migration_workflows(): for response in page_result: print(response) -# [END bigquerymigration_v2alpha_generated_MigrationService_ListMigrationWorkflows_sync] +# [END bigquerymigration_v2_generated_MigrationService_ListMigrationWorkflows_sync] diff --git a/samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_start_migration_workflow_async.py b/samples/generated_samples/bigquerymigration_v2_generated_migration_service_start_migration_workflow_async.py similarity index 75% rename from samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_start_migration_workflow_async.py rename to samples/generated_samples/bigquerymigration_v2_generated_migration_service_start_migration_workflow_async.py index 670e67a..1a70efb 100644 --- a/samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_start_migration_workflow_async.py +++ b/samples/generated_samples/bigquerymigration_v2_generated_migration_service_start_migration_workflow_async.py @@ -23,16 +23,16 @@ # python3 -m pip install google-cloud-bigquery-migration -# [START bigquerymigration_v2alpha_generated_MigrationService_StartMigrationWorkflow_async] -from google.cloud import bigquery_migration_v2alpha +# [START bigquerymigration_v2_generated_MigrationService_StartMigrationWorkflow_async] +from google.cloud import bigquery_migration_v2 async def sample_start_migration_workflow(): # Create a client - client = bigquery_migration_v2alpha.MigrationServiceAsyncClient() + client = bigquery_migration_v2.MigrationServiceAsyncClient() # Initialize request argument(s) - request = bigquery_migration_v2alpha.StartMigrationWorkflowRequest( + request = bigquery_migration_v2.StartMigrationWorkflowRequest( name="name_value", ) @@ -40,4 +40,4 @@ async def sample_start_migration_workflow(): await client.start_migration_workflow(request=request) -# [END bigquerymigration_v2alpha_generated_MigrationService_StartMigrationWorkflow_async] +# [END bigquerymigration_v2_generated_MigrationService_StartMigrationWorkflow_async] diff --git a/samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_start_migration_workflow_sync.py b/samples/generated_samples/bigquerymigration_v2_generated_migration_service_start_migration_workflow_sync.py similarity index 75% rename from samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_start_migration_workflow_sync.py rename to samples/generated_samples/bigquerymigration_v2_generated_migration_service_start_migration_workflow_sync.py index 6f8ad6b..d8179a9 100644 --- a/samples/generated_samples/bigquerymigration_v2alpha_generated_migration_service_start_migration_workflow_sync.py +++ b/samples/generated_samples/bigquerymigration_v2_generated_migration_service_start_migration_workflow_sync.py @@ -23,16 +23,16 @@ # python3 -m pip install google-cloud-bigquery-migration -# [START bigquerymigration_v2alpha_generated_MigrationService_StartMigrationWorkflow_sync] -from google.cloud import bigquery_migration_v2alpha +# [START bigquerymigration_v2_generated_MigrationService_StartMigrationWorkflow_sync] +from google.cloud import bigquery_migration_v2 def sample_start_migration_workflow(): # Create a client - client = bigquery_migration_v2alpha.MigrationServiceClient() + client = bigquery_migration_v2.MigrationServiceClient() # Initialize request argument(s) - request = bigquery_migration_v2alpha.StartMigrationWorkflowRequest( + request = bigquery_migration_v2.StartMigrationWorkflowRequest( name="name_value", ) @@ -40,4 +40,4 @@ def sample_start_migration_workflow(): client.start_migration_workflow(request=request) -# [END bigquerymigration_v2alpha_generated_MigrationService_StartMigrationWorkflow_sync] +# [END bigquerymigration_v2_generated_MigrationService_StartMigrationWorkflow_sync] diff --git a/samples/generated_samples/snippet_metadata_bigquery migration_v2alpha.json b/samples/generated_samples/snippet_metadata_bigquery migration_v2.json similarity index 80% rename from samples/generated_samples/snippet_metadata_bigquery migration_v2alpha.json rename to samples/generated_samples/snippet_metadata_bigquery migration_v2.json index 17dae71..f7ba68b 100644 --- a/samples/generated_samples/snippet_metadata_bigquery migration_v2alpha.json +++ b/samples/generated_samples/snippet_metadata_bigquery migration_v2.json @@ -10,8 +10,8 @@ "shortName": "CreateMigrationWorkflow" } }, - "file": "bigquerymigration_v2alpha_generated_migration_service_create_migration_workflow_async.py", - "regionTag": "bigquerymigration_v2alpha_generated_MigrationService_CreateMigrationWorkflow_async", + "file": "bigquerymigration_v2_generated_migration_service_create_migration_workflow_async.py", + "regionTag": "bigquerymigration_v2_generated_MigrationService_CreateMigrationWorkflow_async", "segments": [ { "end": 44, @@ -54,8 +54,8 @@ "shortName": "CreateMigrationWorkflow" } }, - "file": "bigquerymigration_v2alpha_generated_migration_service_create_migration_workflow_sync.py", - "regionTag": "bigquerymigration_v2alpha_generated_MigrationService_CreateMigrationWorkflow_sync", + "file": "bigquerymigration_v2_generated_migration_service_create_migration_workflow_sync.py", + "regionTag": "bigquerymigration_v2_generated_MigrationService_CreateMigrationWorkflow_sync", "segments": [ { "end": 44, @@ -99,8 +99,8 @@ "shortName": "DeleteMigrationWorkflow" } }, - "file": "bigquerymigration_v2alpha_generated_migration_service_delete_migration_workflow_async.py", - "regionTag": "bigquerymigration_v2alpha_generated_MigrationService_DeleteMigrationWorkflow_async", + "file": "bigquerymigration_v2_generated_migration_service_delete_migration_workflow_async.py", + "regionTag": "bigquerymigration_v2_generated_MigrationService_DeleteMigrationWorkflow_async", "segments": [ { "end": 42, @@ -141,8 +141,8 @@ "shortName": "DeleteMigrationWorkflow" } }, - "file": "bigquerymigration_v2alpha_generated_migration_service_delete_migration_workflow_sync.py", - "regionTag": "bigquerymigration_v2alpha_generated_MigrationService_DeleteMigrationWorkflow_sync", + "file": "bigquerymigration_v2_generated_migration_service_delete_migration_workflow_sync.py", + "regionTag": "bigquerymigration_v2_generated_MigrationService_DeleteMigrationWorkflow_sync", "segments": [ { "end": 42, @@ -184,8 +184,8 @@ "shortName": "GetMigrationSubtask" } }, - "file": "bigquerymigration_v2alpha_generated_migration_service_get_migration_subtask_async.py", - "regionTag": "bigquerymigration_v2alpha_generated_MigrationService_GetMigrationSubtask_async", + "file": "bigquerymigration_v2_generated_migration_service_get_migration_subtask_async.py", + "regionTag": "bigquerymigration_v2_generated_MigrationService_GetMigrationSubtask_async", "segments": [ { "end": 44, @@ -228,8 +228,8 @@ "shortName": "GetMigrationSubtask" } }, - "file": "bigquerymigration_v2alpha_generated_migration_service_get_migration_subtask_sync.py", - "regionTag": "bigquerymigration_v2alpha_generated_MigrationService_GetMigrationSubtask_sync", + "file": "bigquerymigration_v2_generated_migration_service_get_migration_subtask_sync.py", + "regionTag": "bigquerymigration_v2_generated_MigrationService_GetMigrationSubtask_sync", "segments": [ { "end": 44, @@ -273,8 +273,8 @@ "shortName": "GetMigrationWorkflow" } }, - "file": "bigquerymigration_v2alpha_generated_migration_service_get_migration_workflow_async.py", - "regionTag": "bigquerymigration_v2alpha_generated_MigrationService_GetMigrationWorkflow_async", + "file": "bigquerymigration_v2_generated_migration_service_get_migration_workflow_async.py", + "regionTag": "bigquerymigration_v2_generated_MigrationService_GetMigrationWorkflow_async", "segments": [ { "end": 44, @@ -317,8 +317,8 @@ "shortName": "GetMigrationWorkflow" } }, - "file": "bigquerymigration_v2alpha_generated_migration_service_get_migration_workflow_sync.py", - "regionTag": "bigquerymigration_v2alpha_generated_MigrationService_GetMigrationWorkflow_sync", + "file": "bigquerymigration_v2_generated_migration_service_get_migration_workflow_sync.py", + "regionTag": "bigquerymigration_v2_generated_MigrationService_GetMigrationWorkflow_sync", "segments": [ { "end": 44, @@ -362,8 +362,8 @@ "shortName": "ListMigrationSubtasks" } }, - "file": "bigquerymigration_v2alpha_generated_migration_service_list_migration_subtasks_async.py", - "regionTag": "bigquerymigration_v2alpha_generated_MigrationService_ListMigrationSubtasks_async", + "file": "bigquerymigration_v2_generated_migration_service_list_migration_subtasks_async.py", + "regionTag": "bigquerymigration_v2_generated_MigrationService_ListMigrationSubtasks_async", "segments": [ { "end": 45, @@ -406,8 +406,8 @@ "shortName": "ListMigrationSubtasks" } }, - "file": "bigquerymigration_v2alpha_generated_migration_service_list_migration_subtasks_sync.py", - "regionTag": "bigquerymigration_v2alpha_generated_MigrationService_ListMigrationSubtasks_sync", + "file": "bigquerymigration_v2_generated_migration_service_list_migration_subtasks_sync.py", + "regionTag": "bigquerymigration_v2_generated_MigrationService_ListMigrationSubtasks_sync", "segments": [ { "end": 45, @@ -451,8 +451,8 @@ "shortName": "ListMigrationWorkflows" } }, - "file": "bigquerymigration_v2alpha_generated_migration_service_list_migration_workflows_async.py", - "regionTag": "bigquerymigration_v2alpha_generated_MigrationService_ListMigrationWorkflows_async", + "file": "bigquerymigration_v2_generated_migration_service_list_migration_workflows_async.py", + "regionTag": "bigquerymigration_v2_generated_MigrationService_ListMigrationWorkflows_async", "segments": [ { "end": 45, @@ -495,8 +495,8 @@ "shortName": "ListMigrationWorkflows" } }, - "file": "bigquerymigration_v2alpha_generated_migration_service_list_migration_workflows_sync.py", - "regionTag": "bigquerymigration_v2alpha_generated_MigrationService_ListMigrationWorkflows_sync", + "file": "bigquerymigration_v2_generated_migration_service_list_migration_workflows_sync.py", + "regionTag": "bigquerymigration_v2_generated_MigrationService_ListMigrationWorkflows_sync", "segments": [ { "end": 45, @@ -540,8 +540,8 @@ "shortName": "StartMigrationWorkflow" } }, - "file": "bigquerymigration_v2alpha_generated_migration_service_start_migration_workflow_async.py", - "regionTag": "bigquerymigration_v2alpha_generated_MigrationService_StartMigrationWorkflow_async", + "file": "bigquerymigration_v2_generated_migration_service_start_migration_workflow_async.py", + "regionTag": "bigquerymigration_v2_generated_MigrationService_StartMigrationWorkflow_async", "segments": [ { "end": 42, @@ -582,8 +582,8 @@ "shortName": "StartMigrationWorkflow" } }, - "file": "bigquerymigration_v2alpha_generated_migration_service_start_migration_workflow_sync.py", - "regionTag": "bigquerymigration_v2alpha_generated_MigrationService_StartMigrationWorkflow_sync", + "file": "bigquerymigration_v2_generated_migration_service_start_migration_workflow_sync.py", + "regionTag": "bigquerymigration_v2_generated_MigrationService_StartMigrationWorkflow_sync", "segments": [ { "end": 42, diff --git a/scripts/fixup_migration_v2alpha_keywords.py b/scripts/fixup_bigquery_migration_v2_keywords.py similarity index 96% rename from scripts/fixup_migration_v2alpha_keywords.py rename to scripts/fixup_bigquery_migration_v2_keywords.py index 6ff8cc7..18f588a 100644 --- a/scripts/fixup_migration_v2alpha_keywords.py +++ b/scripts/fixup_bigquery_migration_v2_keywords.py @@ -1,6 +1,6 @@ #! /usr/bin/env python3 # -*- coding: utf-8 -*- -# Copyright 2020 Google LLC +# Copyright 2022 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -36,7 +36,7 @@ def partition( return results[1], results[0] -class migrationCallTransformer(cst.CSTTransformer): +class bigquery_migrationCallTransformer(cst.CSTTransformer): CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { 'create_migration_workflow': ('parent', 'migration_workflow', ), @@ -94,7 +94,7 @@ def fix_files( in_dir: pathlib.Path, out_dir: pathlib.Path, *, - transformer=migrationCallTransformer(), + transformer=bigquery_migrationCallTransformer(), ): """Duplicate the input dir to the output dir, fixing file method calls. @@ -127,7 +127,7 @@ def fix_files( if __name__ == '__main__': parser = argparse.ArgumentParser( - description="""Fix up source that uses the migration client library. + description="""Fix up source that uses the bigquery_migration client library. The existing sources are NOT overwritten but are copied to output_dir with changes made. diff --git a/setup.py b/setup.py index 7d88026..ece9e47 100644 --- a/setup.py +++ b/setup.py @@ -17,7 +17,7 @@ import os import setuptools # type: ignore -version = "0.3.1" +version = "0.4.0" package_root = os.path.abspath(os.path.dirname(__file__)) diff --git a/tests/unit/gapic/bigquery_migration_v2/__init__.py b/tests/unit/gapic/bigquery_migration_v2/__init__.py new file mode 100644 index 0000000..e8e1c38 --- /dev/null +++ b/tests/unit/gapic/bigquery_migration_v2/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/tests/unit/gapic/bigquery_migration_v2/test_migration_service.py b/tests/unit/gapic/bigquery_migration_v2/test_migration_service.py new file mode 100644 index 0000000..08dc9c1 --- /dev/null +++ b/tests/unit/gapic/bigquery_migration_v2/test_migration_service.py @@ -0,0 +1,3492 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +import mock + +import grpc +from grpc.experimental import aio +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule + + +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers +from google.api_core import grpc_helpers_async +from google.api_core import path_template +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.bigquery_migration_v2.services.migration_service import ( + MigrationServiceAsyncClient, +) +from google.cloud.bigquery_migration_v2.services.migration_service import ( + MigrationServiceClient, +) +from google.cloud.bigquery_migration_v2.services.migration_service import pagers +from google.cloud.bigquery_migration_v2.services.migration_service import transports +from google.cloud.bigquery_migration_v2.types import migration_entities +from google.cloud.bigquery_migration_v2.types import migration_error_details +from google.cloud.bigquery_migration_v2.types import migration_metrics +from google.cloud.bigquery_migration_v2.types import migration_service +from google.cloud.bigquery_migration_v2.types import translation_config +from google.oauth2 import service_account +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from google.rpc import error_details_pb2 # type: ignore +import google.auth + + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return ( + "foo.googleapis.com" + if ("localhost" in client.DEFAULT_ENDPOINT) + else client.DEFAULT_ENDPOINT + ) + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert MigrationServiceClient._get_default_mtls_endpoint(None) is None + assert ( + MigrationServiceClient._get_default_mtls_endpoint(api_endpoint) + == api_mtls_endpoint + ) + assert ( + MigrationServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) + == api_mtls_endpoint + ) + assert ( + MigrationServiceClient._get_default_mtls_endpoint(sandbox_endpoint) + == sandbox_mtls_endpoint + ) + assert ( + MigrationServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) + == sandbox_mtls_endpoint + ) + assert ( + MigrationServiceClient._get_default_mtls_endpoint(non_googleapi) + == non_googleapi + ) + + +@pytest.mark.parametrize( + "client_class", + [ + MigrationServiceClient, + MigrationServiceAsyncClient, + ], +) +def test_migration_service_client_from_service_account_info(client_class): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object( + service_account.Credentials, "from_service_account_info" + ) as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == "bigquerymigration.googleapis.com:443" + + +@pytest.mark.parametrize( + "transport_class,transport_name", + [ + (transports.MigrationServiceGrpcTransport, "grpc"), + (transports.MigrationServiceGrpcAsyncIOTransport, "grpc_asyncio"), + ], +) +def test_migration_service_client_service_account_always_use_jwt( + transport_class, transport_name +): + with mock.patch.object( + service_account.Credentials, "with_always_use_jwt_access", create=True + ) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=True) + use_jwt.assert_called_once_with(True) + + with mock.patch.object( + service_account.Credentials, "with_always_use_jwt_access", create=True + ) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=False) + use_jwt.assert_not_called() + + +@pytest.mark.parametrize( + "client_class", + [ + MigrationServiceClient, + MigrationServiceAsyncClient, + ], +) +def test_migration_service_client_from_service_account_file(client_class): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object( + service_account.Credentials, "from_service_account_file" + ) as factory: + factory.return_value = creds + client = client_class.from_service_account_file("dummy/file/path.json") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == "bigquerymigration.googleapis.com:443" + + +def test_migration_service_client_get_transport_class(): + transport = MigrationServiceClient.get_transport_class() + available_transports = [ + transports.MigrationServiceGrpcTransport, + ] + assert transport in available_transports + + transport = MigrationServiceClient.get_transport_class("grpc") + assert transport == transports.MigrationServiceGrpcTransport + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name", + [ + (MigrationServiceClient, transports.MigrationServiceGrpcTransport, "grpc"), + ( + MigrationServiceAsyncClient, + transports.MigrationServiceGrpcAsyncIOTransport, + "grpc_asyncio", + ), + ], +) +@mock.patch.object( + MigrationServiceClient, + "DEFAULT_ENDPOINT", + modify_default_endpoint(MigrationServiceClient), +) +@mock.patch.object( + MigrationServiceAsyncClient, + "DEFAULT_ENDPOINT", + modify_default_endpoint(MigrationServiceAsyncClient), +) +def test_migration_service_client_client_options( + client_class, transport_class, transport_name +): + # Check that if channel is provided we won't create a new one. + with mock.patch.object(MigrationServiceClient, "get_transport_class") as gtc: + transport = transport_class(credentials=ga_credentials.AnonymousCredentials()) + client = client_class(transport=transport) + gtc.assert_not_called() + + # Check that if channel is provided via str we will create a new one. + with mock.patch.object(MigrationServiceClient, "get_transport_class") as gtc: + client = client_class(transport=transport_name) + gtc.assert_called() + + # Check the case api_endpoint is provided. + options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(transport=transport_name, client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_MTLS_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError): + client = client_class(transport=transport_name) + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"} + ): + with pytest.raises(ValueError): + client = client_class(transport=transport_name) + + # Check the case quota_project_id is provided + options = client_options.ClientOptions(quota_project_id="octopus") + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name,use_client_cert_env", + [ + ( + MigrationServiceClient, + transports.MigrationServiceGrpcTransport, + "grpc", + "true", + ), + ( + MigrationServiceAsyncClient, + transports.MigrationServiceGrpcAsyncIOTransport, + "grpc_asyncio", + "true", + ), + ( + MigrationServiceClient, + transports.MigrationServiceGrpcTransport, + "grpc", + "false", + ), + ( + MigrationServiceAsyncClient, + transports.MigrationServiceGrpcAsyncIOTransport, + "grpc_asyncio", + "false", + ), + ], +) +@mock.patch.object( + MigrationServiceClient, + "DEFAULT_ENDPOINT", + modify_default_endpoint(MigrationServiceClient), +) +@mock.patch.object( + MigrationServiceAsyncClient, + "DEFAULT_ENDPOINT", + modify_default_endpoint(MigrationServiceAsyncClient), +) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_migration_service_client_mtls_env_auto( + client_class, transport_class, transport_name, use_client_cert_env +): + # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default + # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. + + # Check the case client_cert_source is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env} + ): + options = client_options.ClientOptions( + client_cert_source=client_cert_source_callback + ) + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client.DEFAULT_ENDPOINT + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env} + ): + with mock.patch.object(transport_class, "__init__") as patched: + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=True, + ): + with mock.patch( + "google.auth.transport.mtls.default_client_cert_source", + return_value=client_cert_source_callback, + ): + if use_client_cert_env == "false": + expected_host = client.DEFAULT_ENDPOINT + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case client_cert_source and ADC client cert are not provided. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env} + ): + with mock.patch.object(transport_class, "__init__") as patched: + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=False, + ): + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + +@pytest.mark.parametrize( + "client_class", [MigrationServiceClient, MigrationServiceAsyncClient] +) +@mock.patch.object( + MigrationServiceClient, + "DEFAULT_ENDPOINT", + modify_default_endpoint(MigrationServiceClient), +) +@mock.patch.object( + MigrationServiceAsyncClient, + "DEFAULT_ENDPOINT", + modify_default_endpoint(MigrationServiceAsyncClient), +) +def test_migration_service_client_get_mtls_endpoint_and_cert_source(client_class): + mock_client_cert_source = mock.Mock() + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + mock_api_endpoint = "foo" + options = client_options.ClientOptions( + client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint + ) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source( + options + ) + assert api_endpoint == mock_api_endpoint + assert cert_source == mock_client_cert_source + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "false". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + mock_client_cert_source = mock.Mock() + mock_api_endpoint = "foo" + options = client_options.ClientOptions( + client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint + ) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source( + options + ) + assert api_endpoint == mock_api_endpoint + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=False, + ): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=True, + ): + with mock.patch( + "google.auth.transport.mtls.default_client_cert_source", + return_value=mock_client_cert_source, + ): + ( + api_endpoint, + cert_source, + ) = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source == mock_client_cert_source + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name", + [ + (MigrationServiceClient, transports.MigrationServiceGrpcTransport, "grpc"), + ( + MigrationServiceAsyncClient, + transports.MigrationServiceGrpcAsyncIOTransport, + "grpc_asyncio", + ), + ], +) +def test_migration_service_client_client_options_scopes( + client_class, transport_class, transport_name +): + # Check the case scopes are provided. + options = client_options.ClientOptions( + scopes=["1", "2"], + ) + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name,grpc_helpers", + [ + ( + MigrationServiceClient, + transports.MigrationServiceGrpcTransport, + "grpc", + grpc_helpers, + ), + ( + MigrationServiceAsyncClient, + transports.MigrationServiceGrpcAsyncIOTransport, + "grpc_asyncio", + grpc_helpers_async, + ), + ], +) +def test_migration_service_client_client_options_credentials_file( + client_class, transport_class, transport_name, grpc_helpers +): + # Check the case credentials file is provided. + options = client_options.ClientOptions(credentials_file="credentials.json") + + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + +def test_migration_service_client_client_options_from_dict(): + with mock.patch( + "google.cloud.bigquery_migration_v2.services.migration_service.transports.MigrationServiceGrpcTransport.__init__" + ) as grpc_transport: + grpc_transport.return_value = None + client = MigrationServiceClient( + client_options={"api_endpoint": "squid.clam.whelk"} + ) + grpc_transport.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name,grpc_helpers", + [ + ( + MigrationServiceClient, + transports.MigrationServiceGrpcTransport, + "grpc", + grpc_helpers, + ), + ( + MigrationServiceAsyncClient, + transports.MigrationServiceGrpcAsyncIOTransport, + "grpc_asyncio", + grpc_helpers_async, + ), + ], +) +def test_migration_service_client_create_channel_credentials_file( + client_class, transport_class, transport_name, grpc_helpers +): + # Check the case credentials file is provided. + options = client_options.ClientOptions(credentials_file="credentials.json") + + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # test that the credentials from file are saved and used as the credentials. + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel" + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + file_creds = ga_credentials.AnonymousCredentials() + load_creds.return_value = (file_creds, None) + adc.return_value = (creds, None) + client = client_class(client_options=options, transport=transport_name) + create_channel.assert_called_with( + "bigquerymigration.googleapis.com:443", + credentials=file_creds, + credentials_file=None, + quota_project_id=None, + default_scopes=("https://www.googleapis.com/auth/cloud-platform",), + scopes=None, + default_host="bigquerymigration.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize( + "request_type", + [ + migration_service.CreateMigrationWorkflowRequest, + dict, + ], +) +def test_create_migration_workflow(request_type, transport: str = "grpc"): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_migration_workflow), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = migration_entities.MigrationWorkflow( + name="name_value", + display_name="display_name_value", + state=migration_entities.MigrationWorkflow.State.DRAFT, + ) + response = client.create_migration_workflow(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == migration_service.CreateMigrationWorkflowRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, migration_entities.MigrationWorkflow) + assert response.name == "name_value" + assert response.display_name == "display_name_value" + assert response.state == migration_entities.MigrationWorkflow.State.DRAFT + + +def test_create_migration_workflow_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_migration_workflow), "__call__" + ) as call: + client.create_migration_workflow() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == migration_service.CreateMigrationWorkflowRequest() + + +@pytest.mark.asyncio +async def test_create_migration_workflow_async( + transport: str = "grpc_asyncio", + request_type=migration_service.CreateMigrationWorkflowRequest, +): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_migration_workflow), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + migration_entities.MigrationWorkflow( + name="name_value", + display_name="display_name_value", + state=migration_entities.MigrationWorkflow.State.DRAFT, + ) + ) + response = await client.create_migration_workflow(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == migration_service.CreateMigrationWorkflowRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, migration_entities.MigrationWorkflow) + assert response.name == "name_value" + assert response.display_name == "display_name_value" + assert response.state == migration_entities.MigrationWorkflow.State.DRAFT + + +@pytest.mark.asyncio +async def test_create_migration_workflow_async_from_dict(): + await test_create_migration_workflow_async(request_type=dict) + + +def test_create_migration_workflow_field_headers(): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = migration_service.CreateMigrationWorkflowRequest() + + request.parent = "parent/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_migration_workflow), "__call__" + ) as call: + call.return_value = migration_entities.MigrationWorkflow() + client.create_migration_workflow(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "parent=parent/value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_create_migration_workflow_field_headers_async(): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = migration_service.CreateMigrationWorkflowRequest() + + request.parent = "parent/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_migration_workflow), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + migration_entities.MigrationWorkflow() + ) + await client.create_migration_workflow(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "parent=parent/value", + ) in kw["metadata"] + + +def test_create_migration_workflow_flattened(): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_migration_workflow), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = migration_entities.MigrationWorkflow() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_migration_workflow( + parent="parent_value", + migration_workflow=migration_entities.MigrationWorkflow(name="name_value"), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = "parent_value" + assert arg == mock_val + arg = args[0].migration_workflow + mock_val = migration_entities.MigrationWorkflow(name="name_value") + assert arg == mock_val + + +def test_create_migration_workflow_flattened_error(): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_migration_workflow( + migration_service.CreateMigrationWorkflowRequest(), + parent="parent_value", + migration_workflow=migration_entities.MigrationWorkflow(name="name_value"), + ) + + +@pytest.mark.asyncio +async def test_create_migration_workflow_flattened_async(): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_migration_workflow), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = migration_entities.MigrationWorkflow() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + migration_entities.MigrationWorkflow() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_migration_workflow( + parent="parent_value", + migration_workflow=migration_entities.MigrationWorkflow(name="name_value"), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = "parent_value" + assert arg == mock_val + arg = args[0].migration_workflow + mock_val = migration_entities.MigrationWorkflow(name="name_value") + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_create_migration_workflow_flattened_error_async(): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.create_migration_workflow( + migration_service.CreateMigrationWorkflowRequest(), + parent="parent_value", + migration_workflow=migration_entities.MigrationWorkflow(name="name_value"), + ) + + +@pytest.mark.parametrize( + "request_type", + [ + migration_service.GetMigrationWorkflowRequest, + dict, + ], +) +def test_get_migration_workflow(request_type, transport: str = "grpc"): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_migration_workflow), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = migration_entities.MigrationWorkflow( + name="name_value", + display_name="display_name_value", + state=migration_entities.MigrationWorkflow.State.DRAFT, + ) + response = client.get_migration_workflow(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == migration_service.GetMigrationWorkflowRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, migration_entities.MigrationWorkflow) + assert response.name == "name_value" + assert response.display_name == "display_name_value" + assert response.state == migration_entities.MigrationWorkflow.State.DRAFT + + +def test_get_migration_workflow_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_migration_workflow), "__call__" + ) as call: + client.get_migration_workflow() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == migration_service.GetMigrationWorkflowRequest() + + +@pytest.mark.asyncio +async def test_get_migration_workflow_async( + transport: str = "grpc_asyncio", + request_type=migration_service.GetMigrationWorkflowRequest, +): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_migration_workflow), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + migration_entities.MigrationWorkflow( + name="name_value", + display_name="display_name_value", + state=migration_entities.MigrationWorkflow.State.DRAFT, + ) + ) + response = await client.get_migration_workflow(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == migration_service.GetMigrationWorkflowRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, migration_entities.MigrationWorkflow) + assert response.name == "name_value" + assert response.display_name == "display_name_value" + assert response.state == migration_entities.MigrationWorkflow.State.DRAFT + + +@pytest.mark.asyncio +async def test_get_migration_workflow_async_from_dict(): + await test_get_migration_workflow_async(request_type=dict) + + +def test_get_migration_workflow_field_headers(): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = migration_service.GetMigrationWorkflowRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_migration_workflow), "__call__" + ) as call: + call.return_value = migration_entities.MigrationWorkflow() + client.get_migration_workflow(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name/value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_get_migration_workflow_field_headers_async(): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = migration_service.GetMigrationWorkflowRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_migration_workflow), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + migration_entities.MigrationWorkflow() + ) + await client.get_migration_workflow(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name/value", + ) in kw["metadata"] + + +def test_get_migration_workflow_flattened(): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_migration_workflow), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = migration_entities.MigrationWorkflow() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_migration_workflow( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +def test_get_migration_workflow_flattened_error(): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_migration_workflow( + migration_service.GetMigrationWorkflowRequest(), + name="name_value", + ) + + +@pytest.mark.asyncio +async def test_get_migration_workflow_flattened_async(): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_migration_workflow), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = migration_entities.MigrationWorkflow() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + migration_entities.MigrationWorkflow() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_migration_workflow( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_get_migration_workflow_flattened_error_async(): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_migration_workflow( + migration_service.GetMigrationWorkflowRequest(), + name="name_value", + ) + + +@pytest.mark.parametrize( + "request_type", + [ + migration_service.ListMigrationWorkflowsRequest, + dict, + ], +) +def test_list_migration_workflows(request_type, transport: str = "grpc"): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_migration_workflows), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = migration_service.ListMigrationWorkflowsResponse( + next_page_token="next_page_token_value", + ) + response = client.list_migration_workflows(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == migration_service.ListMigrationWorkflowsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListMigrationWorkflowsPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_migration_workflows_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_migration_workflows), "__call__" + ) as call: + client.list_migration_workflows() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == migration_service.ListMigrationWorkflowsRequest() + + +@pytest.mark.asyncio +async def test_list_migration_workflows_async( + transport: str = "grpc_asyncio", + request_type=migration_service.ListMigrationWorkflowsRequest, +): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_migration_workflows), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + migration_service.ListMigrationWorkflowsResponse( + next_page_token="next_page_token_value", + ) + ) + response = await client.list_migration_workflows(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == migration_service.ListMigrationWorkflowsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListMigrationWorkflowsAsyncPager) + assert response.next_page_token == "next_page_token_value" + + +@pytest.mark.asyncio +async def test_list_migration_workflows_async_from_dict(): + await test_list_migration_workflows_async(request_type=dict) + + +def test_list_migration_workflows_field_headers(): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = migration_service.ListMigrationWorkflowsRequest() + + request.parent = "parent/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_migration_workflows), "__call__" + ) as call: + call.return_value = migration_service.ListMigrationWorkflowsResponse() + client.list_migration_workflows(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "parent=parent/value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_list_migration_workflows_field_headers_async(): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = migration_service.ListMigrationWorkflowsRequest() + + request.parent = "parent/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_migration_workflows), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + migration_service.ListMigrationWorkflowsResponse() + ) + await client.list_migration_workflows(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "parent=parent/value", + ) in kw["metadata"] + + +def test_list_migration_workflows_flattened(): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_migration_workflows), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = migration_service.ListMigrationWorkflowsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_migration_workflows( + parent="parent_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = "parent_value" + assert arg == mock_val + + +def test_list_migration_workflows_flattened_error(): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_migration_workflows( + migration_service.ListMigrationWorkflowsRequest(), + parent="parent_value", + ) + + +@pytest.mark.asyncio +async def test_list_migration_workflows_flattened_async(): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_migration_workflows), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = migration_service.ListMigrationWorkflowsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + migration_service.ListMigrationWorkflowsResponse() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_migration_workflows( + parent="parent_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = "parent_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_list_migration_workflows_flattened_error_async(): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_migration_workflows( + migration_service.ListMigrationWorkflowsRequest(), + parent="parent_value", + ) + + +def test_list_migration_workflows_pager(transport_name: str = "grpc"): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_migration_workflows), "__call__" + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + migration_service.ListMigrationWorkflowsResponse( + migration_workflows=[ + migration_entities.MigrationWorkflow(), + migration_entities.MigrationWorkflow(), + migration_entities.MigrationWorkflow(), + ], + next_page_token="abc", + ), + migration_service.ListMigrationWorkflowsResponse( + migration_workflows=[], + next_page_token="def", + ), + migration_service.ListMigrationWorkflowsResponse( + migration_workflows=[ + migration_entities.MigrationWorkflow(), + ], + next_page_token="ghi", + ), + migration_service.ListMigrationWorkflowsResponse( + migration_workflows=[ + migration_entities.MigrationWorkflow(), + migration_entities.MigrationWorkflow(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", ""),)), + ) + pager = client.list_migration_workflows(request={}) + + assert pager._metadata == metadata + + results = [i for i in pager] + assert len(results) == 6 + assert all(isinstance(i, migration_entities.MigrationWorkflow) for i in results) + + +def test_list_migration_workflows_pages(transport_name: str = "grpc"): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_migration_workflows), "__call__" + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + migration_service.ListMigrationWorkflowsResponse( + migration_workflows=[ + migration_entities.MigrationWorkflow(), + migration_entities.MigrationWorkflow(), + migration_entities.MigrationWorkflow(), + ], + next_page_token="abc", + ), + migration_service.ListMigrationWorkflowsResponse( + migration_workflows=[], + next_page_token="def", + ), + migration_service.ListMigrationWorkflowsResponse( + migration_workflows=[ + migration_entities.MigrationWorkflow(), + ], + next_page_token="ghi", + ), + migration_service.ListMigrationWorkflowsResponse( + migration_workflows=[ + migration_entities.MigrationWorkflow(), + migration_entities.MigrationWorkflow(), + ], + ), + RuntimeError, + ) + pages = list(client.list_migration_workflows(request={}).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.asyncio +async def test_list_migration_workflows_async_pager(): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_migration_workflows), + "__call__", + new_callable=mock.AsyncMock, + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + migration_service.ListMigrationWorkflowsResponse( + migration_workflows=[ + migration_entities.MigrationWorkflow(), + migration_entities.MigrationWorkflow(), + migration_entities.MigrationWorkflow(), + ], + next_page_token="abc", + ), + migration_service.ListMigrationWorkflowsResponse( + migration_workflows=[], + next_page_token="def", + ), + migration_service.ListMigrationWorkflowsResponse( + migration_workflows=[ + migration_entities.MigrationWorkflow(), + ], + next_page_token="ghi", + ), + migration_service.ListMigrationWorkflowsResponse( + migration_workflows=[ + migration_entities.MigrationWorkflow(), + migration_entities.MigrationWorkflow(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_migration_workflows( + request={}, + ) + assert async_pager.next_page_token == "abc" + responses = [] + async for response in async_pager: + responses.append(response) + + assert len(responses) == 6 + assert all( + isinstance(i, migration_entities.MigrationWorkflow) for i in responses + ) + + +@pytest.mark.asyncio +async def test_list_migration_workflows_async_pages(): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_migration_workflows), + "__call__", + new_callable=mock.AsyncMock, + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + migration_service.ListMigrationWorkflowsResponse( + migration_workflows=[ + migration_entities.MigrationWorkflow(), + migration_entities.MigrationWorkflow(), + migration_entities.MigrationWorkflow(), + ], + next_page_token="abc", + ), + migration_service.ListMigrationWorkflowsResponse( + migration_workflows=[], + next_page_token="def", + ), + migration_service.ListMigrationWorkflowsResponse( + migration_workflows=[ + migration_entities.MigrationWorkflow(), + ], + next_page_token="ghi", + ), + migration_service.ListMigrationWorkflowsResponse( + migration_workflows=[ + migration_entities.MigrationWorkflow(), + migration_entities.MigrationWorkflow(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_migration_workflows(request={})).pages: + pages.append(page_) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize( + "request_type", + [ + migration_service.DeleteMigrationWorkflowRequest, + dict, + ], +) +def test_delete_migration_workflow(request_type, transport: str = "grpc"): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_migration_workflow), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.delete_migration_workflow(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == migration_service.DeleteMigrationWorkflowRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_migration_workflow_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_migration_workflow), "__call__" + ) as call: + client.delete_migration_workflow() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == migration_service.DeleteMigrationWorkflowRequest() + + +@pytest.mark.asyncio +async def test_delete_migration_workflow_async( + transport: str = "grpc_asyncio", + request_type=migration_service.DeleteMigrationWorkflowRequest, +): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_migration_workflow), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.delete_migration_workflow(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == migration_service.DeleteMigrationWorkflowRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +@pytest.mark.asyncio +async def test_delete_migration_workflow_async_from_dict(): + await test_delete_migration_workflow_async(request_type=dict) + + +def test_delete_migration_workflow_field_headers(): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = migration_service.DeleteMigrationWorkflowRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_migration_workflow), "__call__" + ) as call: + call.return_value = None + client.delete_migration_workflow(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name/value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_delete_migration_workflow_field_headers_async(): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = migration_service.DeleteMigrationWorkflowRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_migration_workflow), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_migration_workflow(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name/value", + ) in kw["metadata"] + + +def test_delete_migration_workflow_flattened(): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_migration_workflow), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = None + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_migration_workflow( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +def test_delete_migration_workflow_flattened_error(): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_migration_workflow( + migration_service.DeleteMigrationWorkflowRequest(), + name="name_value", + ) + + +@pytest.mark.asyncio +async def test_delete_migration_workflow_flattened_async(): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_migration_workflow), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = None + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_migration_workflow( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_delete_migration_workflow_flattened_error_async(): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.delete_migration_workflow( + migration_service.DeleteMigrationWorkflowRequest(), + name="name_value", + ) + + +@pytest.mark.parametrize( + "request_type", + [ + migration_service.StartMigrationWorkflowRequest, + dict, + ], +) +def test_start_migration_workflow(request_type, transport: str = "grpc"): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.start_migration_workflow), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.start_migration_workflow(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == migration_service.StartMigrationWorkflowRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +def test_start_migration_workflow_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.start_migration_workflow), "__call__" + ) as call: + client.start_migration_workflow() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == migration_service.StartMigrationWorkflowRequest() + + +@pytest.mark.asyncio +async def test_start_migration_workflow_async( + transport: str = "grpc_asyncio", + request_type=migration_service.StartMigrationWorkflowRequest, +): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.start_migration_workflow), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.start_migration_workflow(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == migration_service.StartMigrationWorkflowRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +@pytest.mark.asyncio +async def test_start_migration_workflow_async_from_dict(): + await test_start_migration_workflow_async(request_type=dict) + + +def test_start_migration_workflow_field_headers(): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = migration_service.StartMigrationWorkflowRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.start_migration_workflow), "__call__" + ) as call: + call.return_value = None + client.start_migration_workflow(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name/value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_start_migration_workflow_field_headers_async(): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = migration_service.StartMigrationWorkflowRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.start_migration_workflow), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.start_migration_workflow(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name/value", + ) in kw["metadata"] + + +def test_start_migration_workflow_flattened(): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.start_migration_workflow), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = None + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.start_migration_workflow( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +def test_start_migration_workflow_flattened_error(): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.start_migration_workflow( + migration_service.StartMigrationWorkflowRequest(), + name="name_value", + ) + + +@pytest.mark.asyncio +async def test_start_migration_workflow_flattened_async(): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.start_migration_workflow), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = None + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.start_migration_workflow( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_start_migration_workflow_flattened_error_async(): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.start_migration_workflow( + migration_service.StartMigrationWorkflowRequest(), + name="name_value", + ) + + +@pytest.mark.parametrize( + "request_type", + [ + migration_service.GetMigrationSubtaskRequest, + dict, + ], +) +def test_get_migration_subtask(request_type, transport: str = "grpc"): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_migration_subtask), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = migration_entities.MigrationSubtask( + name="name_value", + task_id="task_id_value", + type_="type__value", + state=migration_entities.MigrationSubtask.State.ACTIVE, + resource_error_count=2169, + ) + response = client.get_migration_subtask(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == migration_service.GetMigrationSubtaskRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, migration_entities.MigrationSubtask) + assert response.name == "name_value" + assert response.task_id == "task_id_value" + assert response.type_ == "type__value" + assert response.state == migration_entities.MigrationSubtask.State.ACTIVE + assert response.resource_error_count == 2169 + + +def test_get_migration_subtask_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_migration_subtask), "__call__" + ) as call: + client.get_migration_subtask() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == migration_service.GetMigrationSubtaskRequest() + + +@pytest.mark.asyncio +async def test_get_migration_subtask_async( + transport: str = "grpc_asyncio", + request_type=migration_service.GetMigrationSubtaskRequest, +): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_migration_subtask), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + migration_entities.MigrationSubtask( + name="name_value", + task_id="task_id_value", + type_="type__value", + state=migration_entities.MigrationSubtask.State.ACTIVE, + resource_error_count=2169, + ) + ) + response = await client.get_migration_subtask(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == migration_service.GetMigrationSubtaskRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, migration_entities.MigrationSubtask) + assert response.name == "name_value" + assert response.task_id == "task_id_value" + assert response.type_ == "type__value" + assert response.state == migration_entities.MigrationSubtask.State.ACTIVE + assert response.resource_error_count == 2169 + + +@pytest.mark.asyncio +async def test_get_migration_subtask_async_from_dict(): + await test_get_migration_subtask_async(request_type=dict) + + +def test_get_migration_subtask_field_headers(): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = migration_service.GetMigrationSubtaskRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_migration_subtask), "__call__" + ) as call: + call.return_value = migration_entities.MigrationSubtask() + client.get_migration_subtask(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name/value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_get_migration_subtask_field_headers_async(): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = migration_service.GetMigrationSubtaskRequest() + + request.name = "name/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_migration_subtask), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + migration_entities.MigrationSubtask() + ) + await client.get_migration_subtask(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name/value", + ) in kw["metadata"] + + +def test_get_migration_subtask_flattened(): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_migration_subtask), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = migration_entities.MigrationSubtask() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_migration_subtask( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +def test_get_migration_subtask_flattened_error(): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_migration_subtask( + migration_service.GetMigrationSubtaskRequest(), + name="name_value", + ) + + +@pytest.mark.asyncio +async def test_get_migration_subtask_flattened_async(): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_migration_subtask), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = migration_entities.MigrationSubtask() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + migration_entities.MigrationSubtask() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_migration_subtask( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_get_migration_subtask_flattened_error_async(): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_migration_subtask( + migration_service.GetMigrationSubtaskRequest(), + name="name_value", + ) + + +@pytest.mark.parametrize( + "request_type", + [ + migration_service.ListMigrationSubtasksRequest, + dict, + ], +) +def test_list_migration_subtasks(request_type, transport: str = "grpc"): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_migration_subtasks), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = migration_service.ListMigrationSubtasksResponse( + next_page_token="next_page_token_value", + ) + response = client.list_migration_subtasks(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == migration_service.ListMigrationSubtasksRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListMigrationSubtasksPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_migration_subtasks_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_migration_subtasks), "__call__" + ) as call: + client.list_migration_subtasks() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == migration_service.ListMigrationSubtasksRequest() + + +@pytest.mark.asyncio +async def test_list_migration_subtasks_async( + transport: str = "grpc_asyncio", + request_type=migration_service.ListMigrationSubtasksRequest, +): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_migration_subtasks), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + migration_service.ListMigrationSubtasksResponse( + next_page_token="next_page_token_value", + ) + ) + response = await client.list_migration_subtasks(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == migration_service.ListMigrationSubtasksRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListMigrationSubtasksAsyncPager) + assert response.next_page_token == "next_page_token_value" + + +@pytest.mark.asyncio +async def test_list_migration_subtasks_async_from_dict(): + await test_list_migration_subtasks_async(request_type=dict) + + +def test_list_migration_subtasks_field_headers(): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = migration_service.ListMigrationSubtasksRequest() + + request.parent = "parent/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_migration_subtasks), "__call__" + ) as call: + call.return_value = migration_service.ListMigrationSubtasksResponse() + client.list_migration_subtasks(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "parent=parent/value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_list_migration_subtasks_field_headers_async(): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = migration_service.ListMigrationSubtasksRequest() + + request.parent = "parent/value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_migration_subtasks), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + migration_service.ListMigrationSubtasksResponse() + ) + await client.list_migration_subtasks(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "parent=parent/value", + ) in kw["metadata"] + + +def test_list_migration_subtasks_flattened(): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_migration_subtasks), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = migration_service.ListMigrationSubtasksResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_migration_subtasks( + parent="parent_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = "parent_value" + assert arg == mock_val + + +def test_list_migration_subtasks_flattened_error(): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_migration_subtasks( + migration_service.ListMigrationSubtasksRequest(), + parent="parent_value", + ) + + +@pytest.mark.asyncio +async def test_list_migration_subtasks_flattened_async(): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_migration_subtasks), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = migration_service.ListMigrationSubtasksResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + migration_service.ListMigrationSubtasksResponse() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_migration_subtasks( + parent="parent_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = "parent_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_list_migration_subtasks_flattened_error_async(): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_migration_subtasks( + migration_service.ListMigrationSubtasksRequest(), + parent="parent_value", + ) + + +def test_list_migration_subtasks_pager(transport_name: str = "grpc"): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_migration_subtasks), "__call__" + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + migration_service.ListMigrationSubtasksResponse( + migration_subtasks=[ + migration_entities.MigrationSubtask(), + migration_entities.MigrationSubtask(), + migration_entities.MigrationSubtask(), + ], + next_page_token="abc", + ), + migration_service.ListMigrationSubtasksResponse( + migration_subtasks=[], + next_page_token="def", + ), + migration_service.ListMigrationSubtasksResponse( + migration_subtasks=[ + migration_entities.MigrationSubtask(), + ], + next_page_token="ghi", + ), + migration_service.ListMigrationSubtasksResponse( + migration_subtasks=[ + migration_entities.MigrationSubtask(), + migration_entities.MigrationSubtask(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", ""),)), + ) + pager = client.list_migration_subtasks(request={}) + + assert pager._metadata == metadata + + results = [i for i in pager] + assert len(results) == 6 + assert all(isinstance(i, migration_entities.MigrationSubtask) for i in results) + + +def test_list_migration_subtasks_pages(transport_name: str = "grpc"): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_migration_subtasks), "__call__" + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + migration_service.ListMigrationSubtasksResponse( + migration_subtasks=[ + migration_entities.MigrationSubtask(), + migration_entities.MigrationSubtask(), + migration_entities.MigrationSubtask(), + ], + next_page_token="abc", + ), + migration_service.ListMigrationSubtasksResponse( + migration_subtasks=[], + next_page_token="def", + ), + migration_service.ListMigrationSubtasksResponse( + migration_subtasks=[ + migration_entities.MigrationSubtask(), + ], + next_page_token="ghi", + ), + migration_service.ListMigrationSubtasksResponse( + migration_subtasks=[ + migration_entities.MigrationSubtask(), + migration_entities.MigrationSubtask(), + ], + ), + RuntimeError, + ) + pages = list(client.list_migration_subtasks(request={}).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.asyncio +async def test_list_migration_subtasks_async_pager(): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_migration_subtasks), + "__call__", + new_callable=mock.AsyncMock, + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + migration_service.ListMigrationSubtasksResponse( + migration_subtasks=[ + migration_entities.MigrationSubtask(), + migration_entities.MigrationSubtask(), + migration_entities.MigrationSubtask(), + ], + next_page_token="abc", + ), + migration_service.ListMigrationSubtasksResponse( + migration_subtasks=[], + next_page_token="def", + ), + migration_service.ListMigrationSubtasksResponse( + migration_subtasks=[ + migration_entities.MigrationSubtask(), + ], + next_page_token="ghi", + ), + migration_service.ListMigrationSubtasksResponse( + migration_subtasks=[ + migration_entities.MigrationSubtask(), + migration_entities.MigrationSubtask(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_migration_subtasks( + request={}, + ) + assert async_pager.next_page_token == "abc" + responses = [] + async for response in async_pager: + responses.append(response) + + assert len(responses) == 6 + assert all( + isinstance(i, migration_entities.MigrationSubtask) for i in responses + ) + + +@pytest.mark.asyncio +async def test_list_migration_subtasks_async_pages(): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_migration_subtasks), + "__call__", + new_callable=mock.AsyncMock, + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + migration_service.ListMigrationSubtasksResponse( + migration_subtasks=[ + migration_entities.MigrationSubtask(), + migration_entities.MigrationSubtask(), + migration_entities.MigrationSubtask(), + ], + next_page_token="abc", + ), + migration_service.ListMigrationSubtasksResponse( + migration_subtasks=[], + next_page_token="def", + ), + migration_service.ListMigrationSubtasksResponse( + migration_subtasks=[ + migration_entities.MigrationSubtask(), + ], + next_page_token="ghi", + ), + migration_service.ListMigrationSubtasksResponse( + migration_subtasks=[ + migration_entities.MigrationSubtask(), + migration_entities.MigrationSubtask(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_migration_subtasks(request={})).pages: + pages.append(page_) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.MigrationServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.MigrationServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = MigrationServiceClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.MigrationServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = MigrationServiceClient( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = mock.Mock() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = MigrationServiceClient( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.MigrationServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = MigrationServiceClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.MigrationServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = MigrationServiceClient(transport=transport) + assert client.transport is transport + + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.MigrationServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.MigrationServiceGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.MigrationServiceGrpcTransport, + transports.MigrationServiceGrpcAsyncIOTransport, + ], +) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, "default") as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.MigrationServiceGrpcTransport, + ) + + +def test_migration_service_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.MigrationServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json", + ) + + +def test_migration_service_base_transport(): + # Instantiate the base transport. + with mock.patch( + "google.cloud.bigquery_migration_v2.services.migration_service.transports.MigrationServiceTransport.__init__" + ) as Transport: + Transport.return_value = None + transport = transports.MigrationServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + "create_migration_workflow", + "get_migration_workflow", + "list_migration_workflows", + "delete_migration_workflow", + "start_migration_workflow", + "get_migration_subtask", + "list_migration_subtasks", + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + +def test_migration_service_base_transport_with_credentials_file(): + # Instantiate the base transport with a credentials file + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch( + "google.cloud.bigquery_migration_v2.services.migration_service.transports.MigrationServiceTransport._prep_wrapped_messages" + ) as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.MigrationServiceTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with( + "credentials.json", + scopes=None, + default_scopes=("https://www.googleapis.com/auth/cloud-platform",), + quota_project_id="octopus", + ) + + +def test_migration_service_base_transport_with_adc(): + # Test the default credentials are used if credentials and credentials_file are None. + with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch( + "google.cloud.bigquery_migration_v2.services.migration_service.transports.MigrationServiceTransport._prep_wrapped_messages" + ) as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.MigrationServiceTransport() + adc.assert_called_once() + + +def test_migration_service_auth_adc(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + MigrationServiceClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=("https://www.googleapis.com/auth/cloud-platform",), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.MigrationServiceGrpcTransport, + transports.MigrationServiceGrpcAsyncIOTransport, + ], +) +def test_migration_service_transport_auth_adc(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + adc.assert_called_once_with( + scopes=["1", "2"], + default_scopes=("https://www.googleapis.com/auth/cloud-platform",), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.MigrationServiceGrpcTransport, grpc_helpers), + (transports.MigrationServiceGrpcAsyncIOTransport, grpc_helpers_async), + ], +) +def test_migration_service_transport_create_channel(transport_class, grpc_helpers): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel", autospec=True + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + adc.return_value = (creds, None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + + create_channel.assert_called_with( + "bigquerymigration.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=("https://www.googleapis.com/auth/cloud-platform",), + scopes=["1", "2"], + default_host="bigquerymigration.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.MigrationServiceGrpcTransport, + transports.MigrationServiceGrpcAsyncIOTransport, + ], +) +def test_migration_service_grpc_transport_client_cert_source_for_mtls(transport_class): + cred = ga_credentials.AnonymousCredentials() + + # Check ssl_channel_credentials is used if provided. + with mock.patch.object(transport_class, "create_channel") as mock_create_channel: + mock_ssl_channel_creds = mock.Mock() + transport_class( + host="squid.clam.whelk", + credentials=cred, + ssl_channel_credentials=mock_ssl_channel_creds, + ) + mock_create_channel.assert_called_once_with( + "squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_channel_creds, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls + # is used. + with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): + with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: + transport_class( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback, + ) + expected_cert, expected_key = client_cert_source_callback() + mock_ssl_cred.assert_called_once_with( + certificate_chain=expected_cert, private_key=expected_key + ) + + +def test_migration_service_host_no_port(): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions( + api_endpoint="bigquerymigration.googleapis.com" + ), + ) + assert client.transport._host == "bigquerymigration.googleapis.com:443" + + +def test_migration_service_host_with_port(): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions( + api_endpoint="bigquerymigration.googleapis.com:8000" + ), + ) + assert client.transport._host == "bigquerymigration.googleapis.com:8000" + + +def test_migration_service_grpc_transport_channel(): + channel = grpc.secure_channel("http://localhost/", grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.MigrationServiceGrpcTransport( + host="squid.clam.whelk", + channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +def test_migration_service_grpc_asyncio_transport_channel(): + channel = aio.secure_channel("http://localhost/", grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.MigrationServiceGrpcAsyncIOTransport( + host="squid.clam.whelk", + channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize( + "transport_class", + [ + transports.MigrationServiceGrpcTransport, + transports.MigrationServiceGrpcAsyncIOTransport, + ], +) +def test_migration_service_transport_channel_mtls_with_client_cert_source( + transport_class, +): + with mock.patch( + "grpc.ssl_channel_credentials", autospec=True + ) as grpc_ssl_channel_cred: + with mock.patch.object( + transport_class, "create_channel" + ) as grpc_create_channel: + mock_ssl_cred = mock.Mock() + grpc_ssl_channel_cred.return_value = mock_ssl_cred + + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + + cred = ga_credentials.AnonymousCredentials() + with pytest.warns(DeprecationWarning): + with mock.patch.object(google.auth, "default") as adc: + adc.return_value = (cred, None) + transport = transport_class( + host="squid.clam.whelk", + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=client_cert_source_callback, + ) + adc.assert_called_once() + + grpc_ssl_channel_cred.assert_called_once_with( + certificate_chain=b"cert bytes", private_key=b"key bytes" + ) + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + assert transport._ssl_channel_credentials == mock_ssl_cred + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize( + "transport_class", + [ + transports.MigrationServiceGrpcTransport, + transports.MigrationServiceGrpcAsyncIOTransport, + ], +) +def test_migration_service_transport_channel_mtls_with_adc(transport_class): + mock_ssl_cred = mock.Mock() + with mock.patch.multiple( + "google.auth.transport.grpc.SslCredentials", + __init__=mock.Mock(return_value=None), + ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), + ): + with mock.patch.object( + transport_class, "create_channel" + ) as grpc_create_channel: + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + mock_cred = mock.Mock() + + with pytest.warns(DeprecationWarning): + transport = transport_class( + host="squid.clam.whelk", + credentials=mock_cred, + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=None, + ) + + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=mock_cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + + +def test_migration_subtask_path(): + project = "squid" + location = "clam" + workflow = "whelk" + subtask = "octopus" + expected = "projects/{project}/locations/{location}/workflows/{workflow}/subtasks/{subtask}".format( + project=project, + location=location, + workflow=workflow, + subtask=subtask, + ) + actual = MigrationServiceClient.migration_subtask_path( + project, location, workflow, subtask + ) + assert expected == actual + + +def test_parse_migration_subtask_path(): + expected = { + "project": "oyster", + "location": "nudibranch", + "workflow": "cuttlefish", + "subtask": "mussel", + } + path = MigrationServiceClient.migration_subtask_path(**expected) + + # Check that the path construction is reversible. + actual = MigrationServiceClient.parse_migration_subtask_path(path) + assert expected == actual + + +def test_migration_workflow_path(): + project = "winkle" + location = "nautilus" + workflow = "scallop" + expected = "projects/{project}/locations/{location}/workflows/{workflow}".format( + project=project, + location=location, + workflow=workflow, + ) + actual = MigrationServiceClient.migration_workflow_path(project, location, workflow) + assert expected == actual + + +def test_parse_migration_workflow_path(): + expected = { + "project": "abalone", + "location": "squid", + "workflow": "clam", + } + path = MigrationServiceClient.migration_workflow_path(**expected) + + # Check that the path construction is reversible. + actual = MigrationServiceClient.parse_migration_workflow_path(path) + assert expected == actual + + +def test_common_billing_account_path(): + billing_account = "whelk" + expected = "billingAccounts/{billing_account}".format( + billing_account=billing_account, + ) + actual = MigrationServiceClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "octopus", + } + path = MigrationServiceClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = MigrationServiceClient.parse_common_billing_account_path(path) + assert expected == actual + + +def test_common_folder_path(): + folder = "oyster" + expected = "folders/{folder}".format( + folder=folder, + ) + actual = MigrationServiceClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "nudibranch", + } + path = MigrationServiceClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = MigrationServiceClient.parse_common_folder_path(path) + assert expected == actual + + +def test_common_organization_path(): + organization = "cuttlefish" + expected = "organizations/{organization}".format( + organization=organization, + ) + actual = MigrationServiceClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "mussel", + } + path = MigrationServiceClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = MigrationServiceClient.parse_common_organization_path(path) + assert expected == actual + + +def test_common_project_path(): + project = "winkle" + expected = "projects/{project}".format( + project=project, + ) + actual = MigrationServiceClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "nautilus", + } + path = MigrationServiceClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = MigrationServiceClient.parse_common_project_path(path) + assert expected == actual + + +def test_common_location_path(): + project = "scallop" + location = "abalone" + expected = "projects/{project}/locations/{location}".format( + project=project, + location=location, + ) + actual = MigrationServiceClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "squid", + "location": "clam", + } + path = MigrationServiceClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = MigrationServiceClient.parse_common_location_path(path) + assert expected == actual + + +def test_client_with_default_client_info(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object( + transports.MigrationServiceTransport, "_prep_wrapped_messages" + ) as prep: + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object( + transports.MigrationServiceTransport, "_prep_wrapped_messages" + ) as prep: + transport_class = MigrationServiceClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + +@pytest.mark.asyncio +async def test_transport_close_async(): + client = MigrationServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc_asyncio", + ) + with mock.patch.object( + type(getattr(client.transport, "grpc_channel")), "close" + ) as close: + async with client: + close.assert_not_called() + close.assert_called_once() + + +def test_transport_close(): + transports = { + "grpc": "_grpc_channel", + } + + for transport, close_name in transports.items(): + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport + ) + with mock.patch.object( + type(getattr(client.transport, close_name)), "close" + ) as close: + with client: + close.assert_not_called() + close.assert_called_once() + + +def test_client_ctx(): + transports = [ + "grpc", + ] + for transport in transports: + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport + ) + # Test client calls underlying transport. + with mock.patch.object(type(client.transport), "close") as close: + close.assert_not_called() + with client: + pass + close.assert_called() + + +@pytest.mark.parametrize( + "client_class,transport_class", + [ + (MigrationServiceClient, transports.MigrationServiceGrpcTransport), + (MigrationServiceAsyncClient, transports.MigrationServiceGrpcAsyncIOTransport), + ], +) +def test_api_key_credentials(client_class, transport_class): + with mock.patch.object( + google.auth._default, "get_api_key_credentials", create=True + ) as get_api_key_credentials: + mock_cred = mock.Mock() + get_api_key_credentials.return_value = mock_cred + options = client_options.ClientOptions() + options.api_key = "api_key" + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=mock_cred, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) diff --git a/tests/unit/gapic/bigquery_migration_v2alpha/test_migration_service.py b/tests/unit/gapic/bigquery_migration_v2alpha/test_migration_service.py index 75788b3..598f95d 100644 --- a/tests/unit/gapic/bigquery_migration_v2alpha/test_migration_service.py +++ b/tests/unit/gapic/bigquery_migration_v2alpha/test_migration_service.py @@ -101,7 +101,11 @@ def test__get_default_mtls_endpoint(): @pytest.mark.parametrize( - "client_class", [MigrationServiceClient, MigrationServiceAsyncClient,] + "client_class", + [ + MigrationServiceClient, + MigrationServiceAsyncClient, + ], ) def test_migration_service_client_from_service_account_info(client_class): creds = ga_credentials.AnonymousCredentials() @@ -143,7 +147,11 @@ def test_migration_service_client_service_account_always_use_jwt( @pytest.mark.parametrize( - "client_class", [MigrationServiceClient, MigrationServiceAsyncClient,] + "client_class", + [ + MigrationServiceClient, + MigrationServiceAsyncClient, + ], ) def test_migration_service_client_from_service_account_file(client_class): creds = ga_credentials.AnonymousCredentials() @@ -517,7 +525,9 @@ def test_migration_service_client_client_options_scopes( client_class, transport_class, transport_name ): # Check the case scopes are provided. - options = client_options.ClientOptions(scopes=["1", "2"],) + options = client_options.ClientOptions( + scopes=["1", "2"], + ) with mock.patch.object(transport_class, "__init__") as patched: patched.return_value = None client = client_class(client_options=options, transport=transport_name) @@ -658,11 +668,16 @@ def test_migration_service_client_create_channel_credentials_file( @pytest.mark.parametrize( - "request_type", [migration_service.CreateMigrationWorkflowRequest, dict,] + "request_type", + [ + migration_service.CreateMigrationWorkflowRequest, + dict, + ], ) def test_create_migration_workflow(request_type, transport: str = "grpc"): client = MigrationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), transport=transport, + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) # Everything is optional in proto3 as far as the runtime is concerned, @@ -697,7 +712,8 @@ def test_create_migration_workflow_empty_call(): # This test is a coverage failsafe to make sure that totally empty calls, # i.e. request == None and no flattened fields passed, work. client = MigrationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", ) # Mock the actual call within the gRPC stub, and fake the request. @@ -716,7 +732,8 @@ async def test_create_migration_workflow_async( request_type=migration_service.CreateMigrationWorkflowRequest, ): client = MigrationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), transport=transport, + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) # Everything is optional in proto3 as far as the runtime is concerned, @@ -755,7 +772,9 @@ async def test_create_migration_workflow_async_from_dict(): def test_create_migration_workflow_field_headers(): - client = MigrationServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) # Any value that is part of the HTTP/1.1 URI should be sent as # a field header. Set these to a non-empty value. @@ -777,7 +796,10 @@ def test_create_migration_workflow_field_headers(): # Establish that the field header was sent. _, _, kw = call.mock_calls[0] - assert ("x-goog-request-params", "parent=parent/value",) in kw["metadata"] + assert ( + "x-goog-request-params", + "parent=parent/value", + ) in kw["metadata"] @pytest.mark.asyncio @@ -808,11 +830,16 @@ async def test_create_migration_workflow_field_headers_async(): # Establish that the field header was sent. _, _, kw = call.mock_calls[0] - assert ("x-goog-request-params", "parent=parent/value",) in kw["metadata"] + assert ( + "x-goog-request-params", + "parent=parent/value", + ) in kw["metadata"] def test_create_migration_workflow_flattened(): - client = MigrationServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object( @@ -840,7 +867,9 @@ def test_create_migration_workflow_flattened(): def test_create_migration_workflow_flattened_error(): - client = MigrationServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) # Attempting to call a method with both a request object and flattened # fields is an error. @@ -904,11 +933,16 @@ async def test_create_migration_workflow_flattened_error_async(): @pytest.mark.parametrize( - "request_type", [migration_service.GetMigrationWorkflowRequest, dict,] + "request_type", + [ + migration_service.GetMigrationWorkflowRequest, + dict, + ], ) def test_get_migration_workflow(request_type, transport: str = "grpc"): client = MigrationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), transport=transport, + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) # Everything is optional in proto3 as far as the runtime is concerned, @@ -943,7 +977,8 @@ def test_get_migration_workflow_empty_call(): # This test is a coverage failsafe to make sure that totally empty calls, # i.e. request == None and no flattened fields passed, work. client = MigrationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", ) # Mock the actual call within the gRPC stub, and fake the request. @@ -962,7 +997,8 @@ async def test_get_migration_workflow_async( request_type=migration_service.GetMigrationWorkflowRequest, ): client = MigrationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), transport=transport, + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) # Everything is optional in proto3 as far as the runtime is concerned, @@ -1001,7 +1037,9 @@ async def test_get_migration_workflow_async_from_dict(): def test_get_migration_workflow_field_headers(): - client = MigrationServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) # Any value that is part of the HTTP/1.1 URI should be sent as # a field header. Set these to a non-empty value. @@ -1023,7 +1061,10 @@ def test_get_migration_workflow_field_headers(): # Establish that the field header was sent. _, _, kw = call.mock_calls[0] - assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + assert ( + "x-goog-request-params", + "name=name/value", + ) in kw["metadata"] @pytest.mark.asyncio @@ -1054,11 +1095,16 @@ async def test_get_migration_workflow_field_headers_async(): # Establish that the field header was sent. _, _, kw = call.mock_calls[0] - assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + assert ( + "x-goog-request-params", + "name=name/value", + ) in kw["metadata"] def test_get_migration_workflow_flattened(): - client = MigrationServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object( @@ -1068,7 +1114,9 @@ def test_get_migration_workflow_flattened(): call.return_value = migration_entities.MigrationWorkflow() # Call the method with a truthy value for each flattened field, # using the keyword arguments to the method. - client.get_migration_workflow(name="name_value",) + client.get_migration_workflow( + name="name_value", + ) # Establish that the underlying call was made with the expected # request object values. @@ -1080,13 +1128,16 @@ def test_get_migration_workflow_flattened(): def test_get_migration_workflow_flattened_error(): - client = MigrationServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) # Attempting to call a method with both a request object and flattened # fields is an error. with pytest.raises(ValueError): client.get_migration_workflow( - migration_service.GetMigrationWorkflowRequest(), name="name_value", + migration_service.GetMigrationWorkflowRequest(), + name="name_value", ) @@ -1108,7 +1159,9 @@ async def test_get_migration_workflow_flattened_async(): ) # Call the method with a truthy value for each flattened field, # using the keyword arguments to the method. - response = await client.get_migration_workflow(name="name_value",) + response = await client.get_migration_workflow( + name="name_value", + ) # Establish that the underlying call was made with the expected # request object values. @@ -1129,16 +1182,22 @@ async def test_get_migration_workflow_flattened_error_async(): # fields is an error. with pytest.raises(ValueError): await client.get_migration_workflow( - migration_service.GetMigrationWorkflowRequest(), name="name_value", + migration_service.GetMigrationWorkflowRequest(), + name="name_value", ) @pytest.mark.parametrize( - "request_type", [migration_service.ListMigrationWorkflowsRequest, dict,] + "request_type", + [ + migration_service.ListMigrationWorkflowsRequest, + dict, + ], ) def test_list_migration_workflows(request_type, transport: str = "grpc"): client = MigrationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), transport=transport, + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) # Everything is optional in proto3 as far as the runtime is concerned, @@ -1169,7 +1228,8 @@ def test_list_migration_workflows_empty_call(): # This test is a coverage failsafe to make sure that totally empty calls, # i.e. request == None and no flattened fields passed, work. client = MigrationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", ) # Mock the actual call within the gRPC stub, and fake the request. @@ -1188,7 +1248,8 @@ async def test_list_migration_workflows_async( request_type=migration_service.ListMigrationWorkflowsRequest, ): client = MigrationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), transport=transport, + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) # Everything is optional in proto3 as far as the runtime is concerned, @@ -1223,7 +1284,9 @@ async def test_list_migration_workflows_async_from_dict(): def test_list_migration_workflows_field_headers(): - client = MigrationServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) # Any value that is part of the HTTP/1.1 URI should be sent as # a field header. Set these to a non-empty value. @@ -1245,7 +1308,10 @@ def test_list_migration_workflows_field_headers(): # Establish that the field header was sent. _, _, kw = call.mock_calls[0] - assert ("x-goog-request-params", "parent=parent/value",) in kw["metadata"] + assert ( + "x-goog-request-params", + "parent=parent/value", + ) in kw["metadata"] @pytest.mark.asyncio @@ -1276,11 +1342,16 @@ async def test_list_migration_workflows_field_headers_async(): # Establish that the field header was sent. _, _, kw = call.mock_calls[0] - assert ("x-goog-request-params", "parent=parent/value",) in kw["metadata"] + assert ( + "x-goog-request-params", + "parent=parent/value", + ) in kw["metadata"] def test_list_migration_workflows_flattened(): - client = MigrationServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object( @@ -1290,7 +1361,9 @@ def test_list_migration_workflows_flattened(): call.return_value = migration_service.ListMigrationWorkflowsResponse() # Call the method with a truthy value for each flattened field, # using the keyword arguments to the method. - client.list_migration_workflows(parent="parent_value",) + client.list_migration_workflows( + parent="parent_value", + ) # Establish that the underlying call was made with the expected # request object values. @@ -1302,13 +1375,16 @@ def test_list_migration_workflows_flattened(): def test_list_migration_workflows_flattened_error(): - client = MigrationServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) # Attempting to call a method with both a request object and flattened # fields is an error. with pytest.raises(ValueError): client.list_migration_workflows( - migration_service.ListMigrationWorkflowsRequest(), parent="parent_value", + migration_service.ListMigrationWorkflowsRequest(), + parent="parent_value", ) @@ -1330,7 +1406,9 @@ async def test_list_migration_workflows_flattened_async(): ) # Call the method with a truthy value for each flattened field, # using the keyword arguments to the method. - response = await client.list_migration_workflows(parent="parent_value",) + response = await client.list_migration_workflows( + parent="parent_value", + ) # Establish that the underlying call was made with the expected # request object values. @@ -1351,13 +1429,15 @@ async def test_list_migration_workflows_flattened_error_async(): # fields is an error. with pytest.raises(ValueError): await client.list_migration_workflows( - migration_service.ListMigrationWorkflowsRequest(), parent="parent_value", + migration_service.ListMigrationWorkflowsRequest(), + parent="parent_value", ) def test_list_migration_workflows_pager(transport_name: str = "grpc"): client = MigrationServiceClient( - credentials=ga_credentials.AnonymousCredentials, transport=transport_name, + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, ) # Mock the actual call within the gRPC stub, and fake the request. @@ -1375,10 +1455,13 @@ def test_list_migration_workflows_pager(transport_name: str = "grpc"): next_page_token="abc", ), migration_service.ListMigrationWorkflowsResponse( - migration_workflows=[], next_page_token="def", + migration_workflows=[], + next_page_token="def", ), migration_service.ListMigrationWorkflowsResponse( - migration_workflows=[migration_entities.MigrationWorkflow(),], + migration_workflows=[ + migration_entities.MigrationWorkflow(), + ], next_page_token="ghi", ), migration_service.ListMigrationWorkflowsResponse( @@ -1405,7 +1488,8 @@ def test_list_migration_workflows_pager(transport_name: str = "grpc"): def test_list_migration_workflows_pages(transport_name: str = "grpc"): client = MigrationServiceClient( - credentials=ga_credentials.AnonymousCredentials, transport=transport_name, + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, ) # Mock the actual call within the gRPC stub, and fake the request. @@ -1423,10 +1507,13 @@ def test_list_migration_workflows_pages(transport_name: str = "grpc"): next_page_token="abc", ), migration_service.ListMigrationWorkflowsResponse( - migration_workflows=[], next_page_token="def", + migration_workflows=[], + next_page_token="def", ), migration_service.ListMigrationWorkflowsResponse( - migration_workflows=[migration_entities.MigrationWorkflow(),], + migration_workflows=[ + migration_entities.MigrationWorkflow(), + ], next_page_token="ghi", ), migration_service.ListMigrationWorkflowsResponse( @@ -1465,10 +1552,13 @@ async def test_list_migration_workflows_async_pager(): next_page_token="abc", ), migration_service.ListMigrationWorkflowsResponse( - migration_workflows=[], next_page_token="def", + migration_workflows=[], + next_page_token="def", ), migration_service.ListMigrationWorkflowsResponse( - migration_workflows=[migration_entities.MigrationWorkflow(),], + migration_workflows=[ + migration_entities.MigrationWorkflow(), + ], next_page_token="ghi", ), migration_service.ListMigrationWorkflowsResponse( @@ -1479,7 +1569,9 @@ async def test_list_migration_workflows_async_pager(): ), RuntimeError, ) - async_pager = await client.list_migration_workflows(request={},) + async_pager = await client.list_migration_workflows( + request={}, + ) assert async_pager.next_page_token == "abc" responses = [] async for response in async_pager: @@ -1514,10 +1606,13 @@ async def test_list_migration_workflows_async_pages(): next_page_token="abc", ), migration_service.ListMigrationWorkflowsResponse( - migration_workflows=[], next_page_token="def", + migration_workflows=[], + next_page_token="def", ), migration_service.ListMigrationWorkflowsResponse( - migration_workflows=[migration_entities.MigrationWorkflow(),], + migration_workflows=[ + migration_entities.MigrationWorkflow(), + ], next_page_token="ghi", ), migration_service.ListMigrationWorkflowsResponse( @@ -1536,11 +1631,16 @@ async def test_list_migration_workflows_async_pages(): @pytest.mark.parametrize( - "request_type", [migration_service.DeleteMigrationWorkflowRequest, dict,] + "request_type", + [ + migration_service.DeleteMigrationWorkflowRequest, + dict, + ], ) def test_delete_migration_workflow(request_type, transport: str = "grpc"): client = MigrationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), transport=transport, + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) # Everything is optional in proto3 as far as the runtime is concerned, @@ -1568,7 +1668,8 @@ def test_delete_migration_workflow_empty_call(): # This test is a coverage failsafe to make sure that totally empty calls, # i.e. request == None and no flattened fields passed, work. client = MigrationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", ) # Mock the actual call within the gRPC stub, and fake the request. @@ -1587,7 +1688,8 @@ async def test_delete_migration_workflow_async( request_type=migration_service.DeleteMigrationWorkflowRequest, ): client = MigrationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), transport=transport, + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) # Everything is optional in proto3 as far as the runtime is concerned, @@ -1617,7 +1719,9 @@ async def test_delete_migration_workflow_async_from_dict(): def test_delete_migration_workflow_field_headers(): - client = MigrationServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) # Any value that is part of the HTTP/1.1 URI should be sent as # a field header. Set these to a non-empty value. @@ -1639,7 +1743,10 @@ def test_delete_migration_workflow_field_headers(): # Establish that the field header was sent. _, _, kw = call.mock_calls[0] - assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + assert ( + "x-goog-request-params", + "name=name/value", + ) in kw["metadata"] @pytest.mark.asyncio @@ -1668,11 +1775,16 @@ async def test_delete_migration_workflow_field_headers_async(): # Establish that the field header was sent. _, _, kw = call.mock_calls[0] - assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + assert ( + "x-goog-request-params", + "name=name/value", + ) in kw["metadata"] def test_delete_migration_workflow_flattened(): - client = MigrationServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object( @@ -1682,7 +1794,9 @@ def test_delete_migration_workflow_flattened(): call.return_value = None # Call the method with a truthy value for each flattened field, # using the keyword arguments to the method. - client.delete_migration_workflow(name="name_value",) + client.delete_migration_workflow( + name="name_value", + ) # Establish that the underlying call was made with the expected # request object values. @@ -1694,13 +1808,16 @@ def test_delete_migration_workflow_flattened(): def test_delete_migration_workflow_flattened_error(): - client = MigrationServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) # Attempting to call a method with both a request object and flattened # fields is an error. with pytest.raises(ValueError): client.delete_migration_workflow( - migration_service.DeleteMigrationWorkflowRequest(), name="name_value", + migration_service.DeleteMigrationWorkflowRequest(), + name="name_value", ) @@ -1720,7 +1837,9 @@ async def test_delete_migration_workflow_flattened_async(): call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) # Call the method with a truthy value for each flattened field, # using the keyword arguments to the method. - response = await client.delete_migration_workflow(name="name_value",) + response = await client.delete_migration_workflow( + name="name_value", + ) # Establish that the underlying call was made with the expected # request object values. @@ -1741,16 +1860,22 @@ async def test_delete_migration_workflow_flattened_error_async(): # fields is an error. with pytest.raises(ValueError): await client.delete_migration_workflow( - migration_service.DeleteMigrationWorkflowRequest(), name="name_value", + migration_service.DeleteMigrationWorkflowRequest(), + name="name_value", ) @pytest.mark.parametrize( - "request_type", [migration_service.StartMigrationWorkflowRequest, dict,] + "request_type", + [ + migration_service.StartMigrationWorkflowRequest, + dict, + ], ) def test_start_migration_workflow(request_type, transport: str = "grpc"): client = MigrationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), transport=transport, + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) # Everything is optional in proto3 as far as the runtime is concerned, @@ -1778,7 +1903,8 @@ def test_start_migration_workflow_empty_call(): # This test is a coverage failsafe to make sure that totally empty calls, # i.e. request == None and no flattened fields passed, work. client = MigrationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", ) # Mock the actual call within the gRPC stub, and fake the request. @@ -1797,7 +1923,8 @@ async def test_start_migration_workflow_async( request_type=migration_service.StartMigrationWorkflowRequest, ): client = MigrationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), transport=transport, + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) # Everything is optional in proto3 as far as the runtime is concerned, @@ -1827,7 +1954,9 @@ async def test_start_migration_workflow_async_from_dict(): def test_start_migration_workflow_field_headers(): - client = MigrationServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) # Any value that is part of the HTTP/1.1 URI should be sent as # a field header. Set these to a non-empty value. @@ -1849,7 +1978,10 @@ def test_start_migration_workflow_field_headers(): # Establish that the field header was sent. _, _, kw = call.mock_calls[0] - assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + assert ( + "x-goog-request-params", + "name=name/value", + ) in kw["metadata"] @pytest.mark.asyncio @@ -1878,11 +2010,16 @@ async def test_start_migration_workflow_field_headers_async(): # Establish that the field header was sent. _, _, kw = call.mock_calls[0] - assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + assert ( + "x-goog-request-params", + "name=name/value", + ) in kw["metadata"] def test_start_migration_workflow_flattened(): - client = MigrationServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object( @@ -1892,7 +2029,9 @@ def test_start_migration_workflow_flattened(): call.return_value = None # Call the method with a truthy value for each flattened field, # using the keyword arguments to the method. - client.start_migration_workflow(name="name_value",) + client.start_migration_workflow( + name="name_value", + ) # Establish that the underlying call was made with the expected # request object values. @@ -1904,13 +2043,16 @@ def test_start_migration_workflow_flattened(): def test_start_migration_workflow_flattened_error(): - client = MigrationServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) # Attempting to call a method with both a request object and flattened # fields is an error. with pytest.raises(ValueError): client.start_migration_workflow( - migration_service.StartMigrationWorkflowRequest(), name="name_value", + migration_service.StartMigrationWorkflowRequest(), + name="name_value", ) @@ -1930,7 +2072,9 @@ async def test_start_migration_workflow_flattened_async(): call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) # Call the method with a truthy value for each flattened field, # using the keyword arguments to the method. - response = await client.start_migration_workflow(name="name_value",) + response = await client.start_migration_workflow( + name="name_value", + ) # Establish that the underlying call was made with the expected # request object values. @@ -1951,16 +2095,22 @@ async def test_start_migration_workflow_flattened_error_async(): # fields is an error. with pytest.raises(ValueError): await client.start_migration_workflow( - migration_service.StartMigrationWorkflowRequest(), name="name_value", + migration_service.StartMigrationWorkflowRequest(), + name="name_value", ) @pytest.mark.parametrize( - "request_type", [migration_service.GetMigrationSubtaskRequest, dict,] + "request_type", + [ + migration_service.GetMigrationSubtaskRequest, + dict, + ], ) def test_get_migration_subtask(request_type, transport: str = "grpc"): client = MigrationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), transport=transport, + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) # Everything is optional in proto3 as far as the runtime is concerned, @@ -1999,7 +2149,8 @@ def test_get_migration_subtask_empty_call(): # This test is a coverage failsafe to make sure that totally empty calls, # i.e. request == None and no flattened fields passed, work. client = MigrationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", ) # Mock the actual call within the gRPC stub, and fake the request. @@ -2018,7 +2169,8 @@ async def test_get_migration_subtask_async( request_type=migration_service.GetMigrationSubtaskRequest, ): client = MigrationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), transport=transport, + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) # Everything is optional in proto3 as far as the runtime is concerned, @@ -2061,7 +2213,9 @@ async def test_get_migration_subtask_async_from_dict(): def test_get_migration_subtask_field_headers(): - client = MigrationServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) # Any value that is part of the HTTP/1.1 URI should be sent as # a field header. Set these to a non-empty value. @@ -2083,7 +2237,10 @@ def test_get_migration_subtask_field_headers(): # Establish that the field header was sent. _, _, kw = call.mock_calls[0] - assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + assert ( + "x-goog-request-params", + "name=name/value", + ) in kw["metadata"] @pytest.mark.asyncio @@ -2114,11 +2271,16 @@ async def test_get_migration_subtask_field_headers_async(): # Establish that the field header was sent. _, _, kw = call.mock_calls[0] - assert ("x-goog-request-params", "name=name/value",) in kw["metadata"] + assert ( + "x-goog-request-params", + "name=name/value", + ) in kw["metadata"] def test_get_migration_subtask_flattened(): - client = MigrationServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object( @@ -2128,7 +2290,9 @@ def test_get_migration_subtask_flattened(): call.return_value = migration_entities.MigrationSubtask() # Call the method with a truthy value for each flattened field, # using the keyword arguments to the method. - client.get_migration_subtask(name="name_value",) + client.get_migration_subtask( + name="name_value", + ) # Establish that the underlying call was made with the expected # request object values. @@ -2140,13 +2304,16 @@ def test_get_migration_subtask_flattened(): def test_get_migration_subtask_flattened_error(): - client = MigrationServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) # Attempting to call a method with both a request object and flattened # fields is an error. with pytest.raises(ValueError): client.get_migration_subtask( - migration_service.GetMigrationSubtaskRequest(), name="name_value", + migration_service.GetMigrationSubtaskRequest(), + name="name_value", ) @@ -2168,7 +2335,9 @@ async def test_get_migration_subtask_flattened_async(): ) # Call the method with a truthy value for each flattened field, # using the keyword arguments to the method. - response = await client.get_migration_subtask(name="name_value",) + response = await client.get_migration_subtask( + name="name_value", + ) # Establish that the underlying call was made with the expected # request object values. @@ -2189,16 +2358,22 @@ async def test_get_migration_subtask_flattened_error_async(): # fields is an error. with pytest.raises(ValueError): await client.get_migration_subtask( - migration_service.GetMigrationSubtaskRequest(), name="name_value", + migration_service.GetMigrationSubtaskRequest(), + name="name_value", ) @pytest.mark.parametrize( - "request_type", [migration_service.ListMigrationSubtasksRequest, dict,] + "request_type", + [ + migration_service.ListMigrationSubtasksRequest, + dict, + ], ) def test_list_migration_subtasks(request_type, transport: str = "grpc"): client = MigrationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), transport=transport, + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) # Everything is optional in proto3 as far as the runtime is concerned, @@ -2229,7 +2404,8 @@ def test_list_migration_subtasks_empty_call(): # This test is a coverage failsafe to make sure that totally empty calls, # i.e. request == None and no flattened fields passed, work. client = MigrationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), transport="grpc", + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", ) # Mock the actual call within the gRPC stub, and fake the request. @@ -2248,7 +2424,8 @@ async def test_list_migration_subtasks_async( request_type=migration_service.ListMigrationSubtasksRequest, ): client = MigrationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), transport=transport, + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) # Everything is optional in proto3 as far as the runtime is concerned, @@ -2283,7 +2460,9 @@ async def test_list_migration_subtasks_async_from_dict(): def test_list_migration_subtasks_field_headers(): - client = MigrationServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) # Any value that is part of the HTTP/1.1 URI should be sent as # a field header. Set these to a non-empty value. @@ -2305,7 +2484,10 @@ def test_list_migration_subtasks_field_headers(): # Establish that the field header was sent. _, _, kw = call.mock_calls[0] - assert ("x-goog-request-params", "parent=parent/value",) in kw["metadata"] + assert ( + "x-goog-request-params", + "parent=parent/value", + ) in kw["metadata"] @pytest.mark.asyncio @@ -2336,11 +2518,16 @@ async def test_list_migration_subtasks_field_headers_async(): # Establish that the field header was sent. _, _, kw = call.mock_calls[0] - assert ("x-goog-request-params", "parent=parent/value",) in kw["metadata"] + assert ( + "x-goog-request-params", + "parent=parent/value", + ) in kw["metadata"] def test_list_migration_subtasks_flattened(): - client = MigrationServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object( @@ -2350,7 +2537,9 @@ def test_list_migration_subtasks_flattened(): call.return_value = migration_service.ListMigrationSubtasksResponse() # Call the method with a truthy value for each flattened field, # using the keyword arguments to the method. - client.list_migration_subtasks(parent="parent_value",) + client.list_migration_subtasks( + parent="parent_value", + ) # Establish that the underlying call was made with the expected # request object values. @@ -2362,13 +2551,16 @@ def test_list_migration_subtasks_flattened(): def test_list_migration_subtasks_flattened_error(): - client = MigrationServiceClient(credentials=ga_credentials.AnonymousCredentials(),) + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) # Attempting to call a method with both a request object and flattened # fields is an error. with pytest.raises(ValueError): client.list_migration_subtasks( - migration_service.ListMigrationSubtasksRequest(), parent="parent_value", + migration_service.ListMigrationSubtasksRequest(), + parent="parent_value", ) @@ -2390,7 +2582,9 @@ async def test_list_migration_subtasks_flattened_async(): ) # Call the method with a truthy value for each flattened field, # using the keyword arguments to the method. - response = await client.list_migration_subtasks(parent="parent_value",) + response = await client.list_migration_subtasks( + parent="parent_value", + ) # Establish that the underlying call was made with the expected # request object values. @@ -2411,13 +2605,15 @@ async def test_list_migration_subtasks_flattened_error_async(): # fields is an error. with pytest.raises(ValueError): await client.list_migration_subtasks( - migration_service.ListMigrationSubtasksRequest(), parent="parent_value", + migration_service.ListMigrationSubtasksRequest(), + parent="parent_value", ) def test_list_migration_subtasks_pager(transport_name: str = "grpc"): client = MigrationServiceClient( - credentials=ga_credentials.AnonymousCredentials, transport=transport_name, + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, ) # Mock the actual call within the gRPC stub, and fake the request. @@ -2435,10 +2631,13 @@ def test_list_migration_subtasks_pager(transport_name: str = "grpc"): next_page_token="abc", ), migration_service.ListMigrationSubtasksResponse( - migration_subtasks=[], next_page_token="def", + migration_subtasks=[], + next_page_token="def", ), migration_service.ListMigrationSubtasksResponse( - migration_subtasks=[migration_entities.MigrationSubtask(),], + migration_subtasks=[ + migration_entities.MigrationSubtask(), + ], next_page_token="ghi", ), migration_service.ListMigrationSubtasksResponse( @@ -2465,7 +2664,8 @@ def test_list_migration_subtasks_pager(transport_name: str = "grpc"): def test_list_migration_subtasks_pages(transport_name: str = "grpc"): client = MigrationServiceClient( - credentials=ga_credentials.AnonymousCredentials, transport=transport_name, + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, ) # Mock the actual call within the gRPC stub, and fake the request. @@ -2483,10 +2683,13 @@ def test_list_migration_subtasks_pages(transport_name: str = "grpc"): next_page_token="abc", ), migration_service.ListMigrationSubtasksResponse( - migration_subtasks=[], next_page_token="def", + migration_subtasks=[], + next_page_token="def", ), migration_service.ListMigrationSubtasksResponse( - migration_subtasks=[migration_entities.MigrationSubtask(),], + migration_subtasks=[ + migration_entities.MigrationSubtask(), + ], next_page_token="ghi", ), migration_service.ListMigrationSubtasksResponse( @@ -2525,10 +2728,13 @@ async def test_list_migration_subtasks_async_pager(): next_page_token="abc", ), migration_service.ListMigrationSubtasksResponse( - migration_subtasks=[], next_page_token="def", + migration_subtasks=[], + next_page_token="def", ), migration_service.ListMigrationSubtasksResponse( - migration_subtasks=[migration_entities.MigrationSubtask(),], + migration_subtasks=[ + migration_entities.MigrationSubtask(), + ], next_page_token="ghi", ), migration_service.ListMigrationSubtasksResponse( @@ -2539,7 +2745,9 @@ async def test_list_migration_subtasks_async_pager(): ), RuntimeError, ) - async_pager = await client.list_migration_subtasks(request={},) + async_pager = await client.list_migration_subtasks( + request={}, + ) assert async_pager.next_page_token == "abc" responses = [] async for response in async_pager: @@ -2574,10 +2782,13 @@ async def test_list_migration_subtasks_async_pages(): next_page_token="abc", ), migration_service.ListMigrationSubtasksResponse( - migration_subtasks=[], next_page_token="def", + migration_subtasks=[], + next_page_token="def", ), migration_service.ListMigrationSubtasksResponse( - migration_subtasks=[migration_entities.MigrationSubtask(),], + migration_subtasks=[ + migration_entities.MigrationSubtask(), + ], next_page_token="ghi", ), migration_service.ListMigrationSubtasksResponse( @@ -2602,7 +2813,8 @@ def test_credentials_transport_error(): ) with pytest.raises(ValueError): client = MigrationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), transport=transport, + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) # It is an error to provide a credentials file and a transport instance. @@ -2622,7 +2834,10 @@ def test_credentials_transport_error(): options = client_options.ClientOptions() options.api_key = "api_key" with pytest.raises(ValueError): - client = MigrationServiceClient(client_options=options, transport=transport,) + client = MigrationServiceClient( + client_options=options, + transport=transport, + ) # It is an error to provide an api_key and a credential. options = mock.Mock() @@ -2638,7 +2853,8 @@ def test_credentials_transport_error(): ) with pytest.raises(ValueError): client = MigrationServiceClient( - client_options={"scopes": ["1", "2"]}, transport=transport, + client_options={"scopes": ["1", "2"]}, + transport=transport, ) @@ -2683,8 +2899,13 @@ def test_transport_adc(transport_class): def test_transport_grpc_default(): # A client should use the gRPC transport by default. - client = MigrationServiceClient(credentials=ga_credentials.AnonymousCredentials(),) - assert isinstance(client.transport, transports.MigrationServiceGrpcTransport,) + client = MigrationServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.MigrationServiceGrpcTransport, + ) def test_migration_service_base_transport_error(): @@ -2735,7 +2956,8 @@ def test_migration_service_base_transport_with_credentials_file(): Transport.return_value = None load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) transport = transports.MigrationServiceTransport( - credentials_file="credentials.json", quota_project_id="octopus", + credentials_file="credentials.json", + quota_project_id="octopus", ) load_creds.assert_called_once_with( "credentials.json", @@ -2893,7 +3115,8 @@ def test_migration_service_grpc_transport_channel(): # Check that channel is used if provided. transport = transports.MigrationServiceGrpcTransport( - host="squid.clam.whelk", channel=channel, + host="squid.clam.whelk", + channel=channel, ) assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" @@ -2905,7 +3128,8 @@ def test_migration_service_grpc_asyncio_transport_channel(): # Check that channel is used if provided. transport = transports.MigrationServiceGrpcAsyncIOTransport( - host="squid.clam.whelk", channel=channel, + host="squid.clam.whelk", + channel=channel, ) assert transport.grpc_channel == channel assert transport._host == "squid.clam.whelk:443" @@ -3018,7 +3242,10 @@ def test_migration_subtask_path(): workflow = "whelk" subtask = "octopus" expected = "projects/{project}/locations/{location}/workflows/{workflow}/subtasks/{subtask}".format( - project=project, location=location, workflow=workflow, subtask=subtask, + project=project, + location=location, + workflow=workflow, + subtask=subtask, ) actual = MigrationServiceClient.migration_subtask_path( project, location, workflow, subtask @@ -3045,7 +3272,9 @@ def test_migration_workflow_path(): location = "nautilus" workflow = "scallop" expected = "projects/{project}/locations/{location}/workflows/{workflow}".format( - project=project, location=location, workflow=workflow, + project=project, + location=location, + workflow=workflow, ) actual = MigrationServiceClient.migration_workflow_path(project, location, workflow) assert expected == actual @@ -3086,7 +3315,9 @@ def test_parse_common_billing_account_path(): def test_common_folder_path(): folder = "oyster" - expected = "folders/{folder}".format(folder=folder,) + expected = "folders/{folder}".format( + folder=folder, + ) actual = MigrationServiceClient.common_folder_path(folder) assert expected == actual @@ -3104,7 +3335,9 @@ def test_parse_common_folder_path(): def test_common_organization_path(): organization = "cuttlefish" - expected = "organizations/{organization}".format(organization=organization,) + expected = "organizations/{organization}".format( + organization=organization, + ) actual = MigrationServiceClient.common_organization_path(organization) assert expected == actual @@ -3122,7 +3355,9 @@ def test_parse_common_organization_path(): def test_common_project_path(): project = "winkle" - expected = "projects/{project}".format(project=project,) + expected = "projects/{project}".format( + project=project, + ) actual = MigrationServiceClient.common_project_path(project) assert expected == actual @@ -3142,7 +3377,8 @@ def test_common_location_path(): project = "scallop" location = "abalone" expected = "projects/{project}/locations/{location}".format( - project=project, location=location, + project=project, + location=location, ) actual = MigrationServiceClient.common_location_path(project, location) assert expected == actual @@ -3167,7 +3403,8 @@ def test_client_with_default_client_info(): transports.MigrationServiceTransport, "_prep_wrapped_messages" ) as prep: client = MigrationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), client_info=client_info, + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, ) prep.assert_called_once_with(client_info) @@ -3176,7 +3413,8 @@ def test_client_with_default_client_info(): ) as prep: transport_class = MigrationServiceClient.get_transport_class() transport = transport_class( - credentials=ga_credentials.AnonymousCredentials(), client_info=client_info, + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, ) prep.assert_called_once_with(client_info) @@ -3184,7 +3422,8 @@ def test_client_with_default_client_info(): @pytest.mark.asyncio async def test_transport_close_async(): client = MigrationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), transport="grpc_asyncio", + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc_asyncio", ) with mock.patch.object( type(getattr(client.transport, "grpc_channel")), "close"