From 8d43e4d3ad8a1087c75b873df3f3c92ac80716c1 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Thu, 2 Feb 2023 05:50:38 -0500 Subject: [PATCH] docs: Improvements to DataScan API documentation (#123) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: Improvements to DataScan API documentation PiperOrigin-RevId: 506348044 Source-Link: https://github.com/googleapis/googleapis/commit/4eb6d9e12b72bae548432230e85ee460641d7e5f Source-Link: https://github.com/googleapis/googleapis-gen/commit/830a4ab8c9836b377d43ff95b68d8372890e93c3 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiODMwYTRhYjhjOTgzNmIzNzdkNDNmZjk1YjY4ZDgzNzI4OTBlOTNjMyJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot --- .../data_scan_service/async_client.py | 75 ++++++----- .../services/data_scan_service/client.py | 75 ++++++----- .../data_scan_service/transports/grpc.py | 21 ++-- .../transports/grpc_asyncio.py | 21 ++-- .../cloud/dataplex_v1/types/datascans.py | 118 +++++++++--------- 5 files changed, 169 insertions(+), 141 deletions(-) diff --git a/packages/google-cloud-dataplex/google/cloud/dataplex_v1/services/data_scan_service/async_client.py b/packages/google-cloud-dataplex/google/cloud/dataplex_v1/services/data_scan_service/async_client.py index 3afead1e1226..53d8f4275361 100644 --- a/packages/google-cloud-dataplex/google/cloud/dataplex_v1/services/data_scan_service/async_client.py +++ b/packages/google-cloud-dataplex/google/cloud/dataplex_v1/services/data_scan_service/async_client.py @@ -68,7 +68,11 @@ class DataScanServiceAsyncClient: - """""" + """DataScanService manages DataScan resources which can be + configured to run various types of data scanning workload and + generate enriched metadata (e.g. Data Profile, Data Quality) for + the data source. + """ _client: DataScanServiceClient @@ -248,7 +252,7 @@ async def create_data_scan( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> operation_async.AsyncOperation: - r"""Creates a dataScan resource. + r"""Creates a DataScan resource. .. code-block:: python @@ -290,8 +294,8 @@ async def sample_create_data_scan(): The request object. Create dataScan request. parent (:class:`str`): Required. The resource name of the parent location: - projects/{project}/locations/{location_id} where - ``{project}`` refers to a project_id or project_number + ``projects/{project}/locations/{location_id}`` where + ``project`` refers to a *project_id* or *project_number* and ``location_id`` refers to a GCP region. This corresponds to the ``parent`` field @@ -404,7 +408,7 @@ async def update_data_scan( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> operation_async.AsyncOperation: - r"""Update the dataScan resource. + r"""Updates a DataScan resource. .. code-block:: python @@ -443,8 +447,9 @@ async def sample_update_data_scan(): request (Optional[Union[google.cloud.dataplex_v1.types.UpdateDataScanRequest, dict]]): The request object. Update dataScan request. data_scan (:class:`google.cloud.dataplex_v1.types.DataScan`): - Required. Update description. Only fields specified in - ``update_mask`` are updated. + Required. DataScan resource to be updated. + + Only fields specified in ``update_mask`` are updated. This corresponds to the ``data_scan`` field on the ``request`` instance; if ``request`` is provided, this @@ -541,7 +546,7 @@ async def delete_data_scan( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> operation_async.AsyncOperation: - r"""Delete the dataScan resource. + r"""Deletes a DataScan resource. .. code-block:: python @@ -578,9 +583,9 @@ async def sample_delete_data_scan(): The request object. Delete dataScan request. name (:class:`str`): Required. The resource name of the dataScan: - projects/{project}/locations/{location_id}/dataScans/{data_scan_id} - where ``{project}`` refers to a project_id or - project_number and ``location_id`` refers to a GCP + ``projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`` + where ``project`` refers to a *project_id* or + *project_number* and ``location_id`` refers to a GCP region. This corresponds to the ``name`` field @@ -667,7 +672,7 @@ async def get_data_scan( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> datascans.DataScan: - r"""Get dataScan resource. + r"""Gets a DataScan resource. .. code-block:: python @@ -700,9 +705,9 @@ async def sample_get_data_scan(): The request object. Get dataScan request. name (:class:`str`): Required. The resource name of the dataScan: - projects/{project}/locations/{location_id}/dataScans/{data_scan_id} - where ``{project}`` refers to a project_id or - project_number and ``location_id`` refers to a GCP + ``projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`` + where ``project`` refers to a *project_id* or + *project_number* and ``location_id`` refers to a GCP region. This corresponds to the ``name`` field @@ -781,7 +786,7 @@ async def list_data_scans( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> pagers.ListDataScansAsyncPager: - r"""Lists dataScans. + r"""Lists DataScans. .. code-block:: python @@ -814,10 +819,10 @@ async def sample_list_data_scans(): request (Optional[Union[google.cloud.dataplex_v1.types.ListDataScansRequest, dict]]): The request object. List dataScans request. parent (:class:`str`): - Required. projects/{project}/locations/{location_id} - where ``{project}`` refers to a project_id or - project_number and ``location_id`` refers to a GCP - region. + Required. The resource name of the parent location: + ``projects/{project}/locations/{location_id}`` where + ``project`` refers to a *project_id* or *project_number* + and ``location_id`` refers to a GCP region. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -896,7 +901,7 @@ async def run_data_scan( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> datascans.RunDataScanResponse: - r"""Run an on demand execution of a DataScan. + r"""Runs an on-demand execution of a DataScan .. code-block:: python @@ -929,10 +934,12 @@ async def sample_run_data_scan(): The request object. Run DataScan Request name (:class:`str`): Required. The resource name of the DataScan: - projects/{project}/locations/{location_id}/dataScans/{data_scan_id}. - where ``{project}`` refers to a project_id or - project_number and ``location_id`` refers to a GCP - region. Only on-demand DataScans are allowed. + ``projects/{project}/locations/{location_id}/dataScans/{data_scan_id}``. + where ``project`` refers to a *project_id* or + *project_number* and ``location_id`` refers to a GCP + region. + + Only **OnDemand** data scans are allowed. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -998,7 +1005,7 @@ async def get_data_scan_job( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> datascans.DataScanJob: - r"""Get DataScanJob resource. + r"""Gets a DataScanJob resource. .. code-block:: python @@ -1031,9 +1038,9 @@ async def sample_get_data_scan_job(): The request object. Get DataScanJob request. name (:class:`str`): Required. The resource name of the DataScanJob: - projects/{project}/locations/{location_id}/dataScans/{data_scan_id}/dataScanJobs/{data_scan_job_id} - where ``{project}`` refers to a project_id or - project_number and ``location_id`` refers to a GCP + ``projects/{project}/locations/{location_id}/dataScans/{data_scan_id}/dataScanJobs/{data_scan_job_id}`` + where ``project`` refers to a *project_id* or + *project_number* and ``location_id`` refers to a GCP region. This corresponds to the ``name`` field @@ -1048,7 +1055,7 @@ async def sample_get_data_scan_job(): Returns: google.cloud.dataplex_v1.types.DataScanJob: A DataScanJob represents an instance - of a data scan. + of DataScan execution. """ # Create or coerce a protobuf request object. @@ -1102,7 +1109,7 @@ async def list_data_scan_jobs( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> pagers.ListDataScanJobsAsyncPager: - r"""Lists DataScanJobs under the given dataScan. + r"""Lists DataScanJobs under the given DataScan. .. code-block:: python @@ -1136,9 +1143,9 @@ async def sample_list_data_scan_jobs(): The request object. List DataScanJobs request. parent (:class:`str`): Required. The resource name of the parent environment: - projects/{project}/locations/{location_id}/dataScans/{data_scan_id} - where ``{project}`` refers to a project_id or - project_number and ``location_id`` refers to a GCP + ``projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`` + where ``project`` refers to a *project_id* or + *project_number* and ``location_id`` refers to a GCP region. This corresponds to the ``parent`` field diff --git a/packages/google-cloud-dataplex/google/cloud/dataplex_v1/services/data_scan_service/client.py b/packages/google-cloud-dataplex/google/cloud/dataplex_v1/services/data_scan_service/client.py index 47ca8d83d5ba..33ccf05f6546 100644 --- a/packages/google-cloud-dataplex/google/cloud/dataplex_v1/services/data_scan_service/client.py +++ b/packages/google-cloud-dataplex/google/cloud/dataplex_v1/services/data_scan_service/client.py @@ -108,7 +108,11 @@ def get_transport_class( class DataScanServiceClient(metaclass=DataScanServiceClientMeta): - """""" + """DataScanService manages DataScan resources which can be + configured to run various types of data scanning workload and + generate enriched metadata (e.g. Data Profile, Data Quality) for + the data source. + """ @staticmethod def _get_default_mtls_endpoint(api_endpoint): @@ -519,7 +523,7 @@ def create_data_scan( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> operation.Operation: - r"""Creates a dataScan resource. + r"""Creates a DataScan resource. .. code-block:: python @@ -561,8 +565,8 @@ def sample_create_data_scan(): The request object. Create dataScan request. parent (str): Required. The resource name of the parent location: - projects/{project}/locations/{location_id} where - ``{project}`` refers to a project_id or project_number + ``projects/{project}/locations/{location_id}`` where + ``project`` refers to a *project_id* or *project_number* and ``location_id`` refers to a GCP region. This corresponds to the ``parent`` field @@ -675,7 +679,7 @@ def update_data_scan( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> operation.Operation: - r"""Update the dataScan resource. + r"""Updates a DataScan resource. .. code-block:: python @@ -714,8 +718,9 @@ def sample_update_data_scan(): request (Union[google.cloud.dataplex_v1.types.UpdateDataScanRequest, dict]): The request object. Update dataScan request. data_scan (google.cloud.dataplex_v1.types.DataScan): - Required. Update description. Only fields specified in - ``update_mask`` are updated. + Required. DataScan resource to be updated. + + Only fields specified in ``update_mask`` are updated. This corresponds to the ``data_scan`` field on the ``request`` instance; if ``request`` is provided, this @@ -812,7 +817,7 @@ def delete_data_scan( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> operation.Operation: - r"""Delete the dataScan resource. + r"""Deletes a DataScan resource. .. code-block:: python @@ -849,9 +854,9 @@ def sample_delete_data_scan(): The request object. Delete dataScan request. name (str): Required. The resource name of the dataScan: - projects/{project}/locations/{location_id}/dataScans/{data_scan_id} - where ``{project}`` refers to a project_id or - project_number and ``location_id`` refers to a GCP + ``projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`` + where ``project`` refers to a *project_id* or + *project_number* and ``location_id`` refers to a GCP region. This corresponds to the ``name`` field @@ -938,7 +943,7 @@ def get_data_scan( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> datascans.DataScan: - r"""Get dataScan resource. + r"""Gets a DataScan resource. .. code-block:: python @@ -971,9 +976,9 @@ def sample_get_data_scan(): The request object. Get dataScan request. name (str): Required. The resource name of the dataScan: - projects/{project}/locations/{location_id}/dataScans/{data_scan_id} - where ``{project}`` refers to a project_id or - project_number and ``location_id`` refers to a GCP + ``projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`` + where ``project`` refers to a *project_id* or + *project_number* and ``location_id`` refers to a GCP region. This corresponds to the ``name`` field @@ -1052,7 +1057,7 @@ def list_data_scans( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> pagers.ListDataScansPager: - r"""Lists dataScans. + r"""Lists DataScans. .. code-block:: python @@ -1085,10 +1090,10 @@ def sample_list_data_scans(): request (Union[google.cloud.dataplex_v1.types.ListDataScansRequest, dict]): The request object. List dataScans request. parent (str): - Required. projects/{project}/locations/{location_id} - where ``{project}`` refers to a project_id or - project_number and ``location_id`` refers to a GCP - region. + Required. The resource name of the parent location: + ``projects/{project}/locations/{location_id}`` where + ``project`` refers to a *project_id* or *project_number* + and ``location_id`` refers to a GCP region. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -1167,7 +1172,7 @@ def run_data_scan( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> datascans.RunDataScanResponse: - r"""Run an on demand execution of a DataScan. + r"""Runs an on-demand execution of a DataScan .. code-block:: python @@ -1200,10 +1205,12 @@ def sample_run_data_scan(): The request object. Run DataScan Request name (str): Required. The resource name of the DataScan: - projects/{project}/locations/{location_id}/dataScans/{data_scan_id}. - where ``{project}`` refers to a project_id or - project_number and ``location_id`` refers to a GCP - region. Only on-demand DataScans are allowed. + ``projects/{project}/locations/{location_id}/dataScans/{data_scan_id}``. + where ``project`` refers to a *project_id* or + *project_number* and ``location_id`` refers to a GCP + region. + + Only **OnDemand** data scans are allowed. This corresponds to the ``name`` field on the ``request`` instance; if ``request`` is provided, this @@ -1269,7 +1276,7 @@ def get_data_scan_job( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> datascans.DataScanJob: - r"""Get DataScanJob resource. + r"""Gets a DataScanJob resource. .. code-block:: python @@ -1302,9 +1309,9 @@ def sample_get_data_scan_job(): The request object. Get DataScanJob request. name (str): Required. The resource name of the DataScanJob: - projects/{project}/locations/{location_id}/dataScans/{data_scan_id}/dataScanJobs/{data_scan_job_id} - where ``{project}`` refers to a project_id or - project_number and ``location_id`` refers to a GCP + ``projects/{project}/locations/{location_id}/dataScans/{data_scan_id}/dataScanJobs/{data_scan_job_id}`` + where ``project`` refers to a *project_id* or + *project_number* and ``location_id`` refers to a GCP region. This corresponds to the ``name`` field @@ -1319,7 +1326,7 @@ def sample_get_data_scan_job(): Returns: google.cloud.dataplex_v1.types.DataScanJob: A DataScanJob represents an instance - of a data scan. + of DataScan execution. """ # Create or coerce a protobuf request object. @@ -1373,7 +1380,7 @@ def list_data_scan_jobs( timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> pagers.ListDataScanJobsPager: - r"""Lists DataScanJobs under the given dataScan. + r"""Lists DataScanJobs under the given DataScan. .. code-block:: python @@ -1407,9 +1414,9 @@ def sample_list_data_scan_jobs(): The request object. List DataScanJobs request. parent (str): Required. The resource name of the parent environment: - projects/{project}/locations/{location_id}/dataScans/{data_scan_id} - where ``{project}`` refers to a project_id or - project_number and ``location_id`` refers to a GCP + ``projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`` + where ``project`` refers to a *project_id* or + *project_number* and ``location_id`` refers to a GCP region. This corresponds to the ``parent`` field diff --git a/packages/google-cloud-dataplex/google/cloud/dataplex_v1/services/data_scan_service/transports/grpc.py b/packages/google-cloud-dataplex/google/cloud/dataplex_v1/services/data_scan_service/transports/grpc.py index 0b7a54120c4d..9f45b42337f0 100644 --- a/packages/google-cloud-dataplex/google/cloud/dataplex_v1/services/data_scan_service/transports/grpc.py +++ b/packages/google-cloud-dataplex/google/cloud/dataplex_v1/services/data_scan_service/transports/grpc.py @@ -34,6 +34,11 @@ class DataScanServiceGrpcTransport(DataScanServiceTransport): """gRPC backend transport for DataScanService. + DataScanService manages DataScan resources which can be + configured to run various types of data scanning workload and + generate enriched metadata (e.g. Data Profile, Data Quality) for + the data source. + This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation and call it. @@ -251,7 +256,7 @@ def create_data_scan( ) -> Callable[[datascans.CreateDataScanRequest], operations_pb2.Operation]: r"""Return a callable for the create data scan method over gRPC. - Creates a dataScan resource. + Creates a DataScan resource. Returns: Callable[[~.CreateDataScanRequest], @@ -277,7 +282,7 @@ def update_data_scan( ) -> Callable[[datascans.UpdateDataScanRequest], operations_pb2.Operation]: r"""Return a callable for the update data scan method over gRPC. - Update the dataScan resource. + Updates a DataScan resource. Returns: Callable[[~.UpdateDataScanRequest], @@ -303,7 +308,7 @@ def delete_data_scan( ) -> Callable[[datascans.DeleteDataScanRequest], operations_pb2.Operation]: r"""Return a callable for the delete data scan method over gRPC. - Delete the dataScan resource. + Deletes a DataScan resource. Returns: Callable[[~.DeleteDataScanRequest], @@ -329,7 +334,7 @@ def get_data_scan( ) -> Callable[[datascans.GetDataScanRequest], datascans.DataScan]: r"""Return a callable for the get data scan method over gRPC. - Get dataScan resource. + Gets a DataScan resource. Returns: Callable[[~.GetDataScanRequest], @@ -355,7 +360,7 @@ def list_data_scans( ) -> Callable[[datascans.ListDataScansRequest], datascans.ListDataScansResponse]: r"""Return a callable for the list data scans method over gRPC. - Lists dataScans. + Lists DataScans. Returns: Callable[[~.ListDataScansRequest], @@ -381,7 +386,7 @@ def run_data_scan( ) -> Callable[[datascans.RunDataScanRequest], datascans.RunDataScanResponse]: r"""Return a callable for the run data scan method over gRPC. - Run an on demand execution of a DataScan. + Runs an on-demand execution of a DataScan Returns: Callable[[~.RunDataScanRequest], @@ -407,7 +412,7 @@ def get_data_scan_job( ) -> Callable[[datascans.GetDataScanJobRequest], datascans.DataScanJob]: r"""Return a callable for the get data scan job method over gRPC. - Get DataScanJob resource. + Gets a DataScanJob resource. Returns: Callable[[~.GetDataScanJobRequest], @@ -435,7 +440,7 @@ def list_data_scan_jobs( ]: r"""Return a callable for the list data scan jobs method over gRPC. - Lists DataScanJobs under the given dataScan. + Lists DataScanJobs under the given DataScan. Returns: Callable[[~.ListDataScanJobsRequest], diff --git a/packages/google-cloud-dataplex/google/cloud/dataplex_v1/services/data_scan_service/transports/grpc_asyncio.py b/packages/google-cloud-dataplex/google/cloud/dataplex_v1/services/data_scan_service/transports/grpc_asyncio.py index 0c4b7677ee96..4edbc14e3377 100644 --- a/packages/google-cloud-dataplex/google/cloud/dataplex_v1/services/data_scan_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-dataplex/google/cloud/dataplex_v1/services/data_scan_service/transports/grpc_asyncio.py @@ -35,6 +35,11 @@ class DataScanServiceGrpcAsyncIOTransport(DataScanServiceTransport): """gRPC AsyncIO backend transport for DataScanService. + DataScanService manages DataScan resources which can be + configured to run various types of data scanning workload and + generate enriched metadata (e.g. Data Profile, Data Quality) for + the data source. + This class defines the same methods as the primary client, so the primary client can load the underlying transport implementation and call it. @@ -258,7 +263,7 @@ def create_data_scan( ]: r"""Return a callable for the create data scan method over gRPC. - Creates a dataScan resource. + Creates a DataScan resource. Returns: Callable[[~.CreateDataScanRequest], @@ -286,7 +291,7 @@ def update_data_scan( ]: r"""Return a callable for the update data scan method over gRPC. - Update the dataScan resource. + Updates a DataScan resource. Returns: Callable[[~.UpdateDataScanRequest], @@ -314,7 +319,7 @@ def delete_data_scan( ]: r"""Return a callable for the delete data scan method over gRPC. - Delete the dataScan resource. + Deletes a DataScan resource. Returns: Callable[[~.DeleteDataScanRequest], @@ -340,7 +345,7 @@ def get_data_scan( ) -> Callable[[datascans.GetDataScanRequest], Awaitable[datascans.DataScan]]: r"""Return a callable for the get data scan method over gRPC. - Get dataScan resource. + Gets a DataScan resource. Returns: Callable[[~.GetDataScanRequest], @@ -368,7 +373,7 @@ def list_data_scans( ]: r"""Return a callable for the list data scans method over gRPC. - Lists dataScans. + Lists DataScans. Returns: Callable[[~.ListDataScansRequest], @@ -396,7 +401,7 @@ def run_data_scan( ]: r"""Return a callable for the run data scan method over gRPC. - Run an on demand execution of a DataScan. + Runs an on-demand execution of a DataScan Returns: Callable[[~.RunDataScanRequest], @@ -422,7 +427,7 @@ def get_data_scan_job( ) -> Callable[[datascans.GetDataScanJobRequest], Awaitable[datascans.DataScanJob]]: r"""Return a callable for the get data scan job method over gRPC. - Get DataScanJob resource. + Gets a DataScanJob resource. Returns: Callable[[~.GetDataScanJobRequest], @@ -451,7 +456,7 @@ def list_data_scan_jobs( ]: r"""Return a callable for the list data scan jobs method over gRPC. - Lists DataScanJobs under the given dataScan. + Lists DataScanJobs under the given DataScan. Returns: Callable[[~.ListDataScanJobsRequest], diff --git a/packages/google-cloud-dataplex/google/cloud/dataplex_v1/types/datascans.py b/packages/google-cloud-dataplex/google/cloud/dataplex_v1/types/datascans.py index deb3ca229398..5e0373e80120 100644 --- a/packages/google-cloud-dataplex/google/cloud/dataplex_v1/types/datascans.py +++ b/packages/google-cloud-dataplex/google/cloud/dataplex_v1/types/datascans.py @@ -52,11 +52,11 @@ class DataScanType(proto.Enum): Values: DATA_SCAN_TYPE_UNSPECIFIED (0): - The DataScan Type is unspecified. + The DataScan type is unspecified. DATA_QUALITY (1): - Data Quality Scan. + Data Quality scan. DATA_PROFILE (2): - Data Profile Scan. + Data Profile scan. """ DATA_SCAN_TYPE_UNSPECIFIED = 0 DATA_QUALITY = 1 @@ -69,8 +69,8 @@ class CreateDataScanRequest(proto.Message): Attributes: parent (str): Required. The resource name of the parent location: - projects/{project}/locations/{location_id} where - ``{project}`` refers to a project_id or project_number and + ``projects/{project}/locations/{location_id}`` where + ``project`` refers to a *project_id* or *project_number* and ``location_id`` refers to a GCP region. data_scan (google.cloud.dataplex_v1.types.DataScan): Required. DataScan resource. @@ -104,8 +104,9 @@ class UpdateDataScanRequest(proto.Message): Attributes: data_scan (google.cloud.dataplex_v1.types.DataScan): - Required. Update description. Only fields specified in - ``update_mask`` are updated. + Required. DataScan resource to be updated. + + Only fields specified in ``update_mask`` are updated. update_mask (google.protobuf.field_mask_pb2.FieldMask): Required. Mask of fields to update. """ @@ -128,9 +129,9 @@ class DeleteDataScanRequest(proto.Message): Attributes: name (str): Required. The resource name of the dataScan: - projects/{project}/locations/{location_id}/dataScans/{data_scan_id} - where ``{project}`` refers to a project_id or project_number - and ``location_id`` refers to a GCP region. + ``projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`` + where ``project`` refers to a *project_id* or + *project_number* and ``location_id`` refers to a GCP region. """ name: str = proto.Field( @@ -145,23 +146,22 @@ class GetDataScanRequest(proto.Message): Attributes: name (str): Required. The resource name of the dataScan: - projects/{project}/locations/{location_id}/dataScans/{data_scan_id} - where ``{project}`` refers to a project_id or project_number - and ``location_id`` refers to a GCP region. + ``projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`` + where ``project`` refers to a *project_id* or + *project_number* and ``location_id`` refers to a GCP region. view (google.cloud.dataplex_v1.types.GetDataScanRequest.DataScanView): - Optional. Used to select the subset of DataScan information - to return. Defaults to ``BASIC``. + Optional. Select the DataScan view to return. Defaults to + ``BASIC``. """ class DataScanView(proto.Enum): - r"""DataScan views for getting a partial dataScan. + r"""DataScan view options. Values: DATA_SCAN_VIEW_UNSPECIFIED (0): The API will default to the ``BASIC`` view. BASIC (1): - Basic view that does not include spec and - result. + Basic view that does not include *spec* and *result*. FULL (10): Include everything. """ @@ -185,8 +185,9 @@ class ListDataScansRequest(proto.Message): Attributes: parent (str): - Required. projects/{project}/locations/{location_id} where - ``{project}`` refers to a project_id or project_number and + Required. The resource name of the parent location: + ``projects/{project}/locations/{location_id}`` where + ``project`` refers to a *project_id* or *project_number* and ``location_id`` refers to a GCP region. page_size (int): Optional. Maximum number of dataScans to @@ -203,8 +204,8 @@ class ListDataScansRequest(proto.Message): filter (str): Optional. Filter request. order_by (str): - Optional. Order by fields (name or create_time) for the - result. If not specified, the ordering is undefined. + Optional. Order by fields (``name`` or ``create_time``) for + the result. If not specified, the ordering is undefined. """ parent: str = proto.Field( @@ -234,8 +235,8 @@ class ListDataScansResponse(proto.Message): Attributes: data_scans (MutableSequence[google.cloud.dataplex_v1.types.DataScan]): - DataScans (metadata only) under the given - parent location. + DataScans (``BASIC`` view only) under the given parent + location. next_page_token (str): Token to retrieve the next page of results, or empty if there are no more results in the @@ -269,10 +270,11 @@ class RunDataScanRequest(proto.Message): Attributes: name (str): Required. The resource name of the DataScan: - projects/{project}/locations/{location_id}/dataScans/{data_scan_id}. - where ``{project}`` refers to a project_id or project_number - and ``location_id`` refers to a GCP region. Only on-demand - DataScans are allowed. + ``projects/{project}/locations/{location_id}/dataScans/{data_scan_id}``. + where ``project`` refers to a *project_id* or + *project_number* and ``location_id`` refers to a GCP region. + + Only **OnDemand** data scans are allowed. """ name: str = proto.Field( @@ -286,7 +288,7 @@ class RunDataScanResponse(proto.Message): Attributes: job (google.cloud.dataplex_v1.types.DataScanJob): - DataScanJob created by RunDataScan API. + DataScanJob created by RunDataScan request. """ job: "DataScanJob" = proto.Field( @@ -302,23 +304,22 @@ class GetDataScanJobRequest(proto.Message): Attributes: name (str): Required. The resource name of the DataScanJob: - projects/{project}/locations/{location_id}/dataScans/{data_scan_id}/dataScanJobs/{data_scan_job_id} - where ``{project}`` refers to a project_id or project_number - and ``location_id`` refers to a GCP region. + ``projects/{project}/locations/{location_id}/dataScans/{data_scan_id}/dataScanJobs/{data_scan_job_id}`` + where ``project`` refers to a *project_id* or + *project_number* and ``location_id`` refers to a GCP region. view (google.cloud.dataplex_v1.types.GetDataScanJobRequest.DataScanJobView): - Optional. Used to select the subset of DataScan information - to return. Defaults to ``BASIC``. + Optional. Select the DataScanJob view to return. Defaults to + ``BASIC``. """ class DataScanJobView(proto.Enum): - r"""DataScanJob views for getting a partial dataScanJob. + r"""DataScanJob view options. Values: DATA_SCAN_JOB_VIEW_UNSPECIFIED (0): The API will default to the ``BASIC`` view. BASIC (1): - Basic view that does not include spec and - result. + Basic view that does not include *spec* and *result*. FULL (10): Include everything. """ @@ -343,9 +344,9 @@ class ListDataScanJobsRequest(proto.Message): Attributes: parent (str): Required. The resource name of the parent environment: - projects/{project}/locations/{location_id}/dataScans/{data_scan_id} - where ``{project}`` refers to a project_id or project_number - and ``location_id`` refers to a GCP region. + ``projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`` + where ``project`` refers to a *project_id* or + *project_number* and ``location_id`` refers to a GCP region. page_size (int): Optional. Maximum number of DataScanJobs to return. The service may return fewer than this @@ -379,8 +380,7 @@ class ListDataScanJobsResponse(proto.Message): Attributes: data_scan_jobs (MutableSequence[google.cloud.dataplex_v1.types.DataScanJob]): - DataScanJobs (metadata only) under a given - dataScan. + DataScanJobs (``BASIC`` view only) under a given dataScan. next_page_token (str): Token to retrieve the next page of results, or empty if there are no more results in the @@ -425,9 +425,9 @@ class DataScan(proto.Message): name (str): Output only. The relative resource name of the scan, of the form: - projects/{project}/locations/{location_id}/dataScans/{datascan_id}. - where ``{project}`` refers to a project_id or project_number - and ``location_id`` refers to a GCP region. + ``projects/{project}/locations/{location_id}/dataScans/{datascan_id}``, + where ``project`` refers to a *project_id* or + *project_number* and ``location_id`` refers to a GCP region. uid (str): Output only. System generated globally unique ID for the scan. This ID will be different if @@ -455,7 +455,7 @@ class DataScan(proto.Message): Required. The data source for DataScan. execution_spec (google.cloud.dataplex_v1.types.DataScan.ExecutionSpec): Optional. DataScan execution settings. - If not specified, the fields under it will use + If not specified, the fields in it will use their default values. execution_status (google.cloud.dataplex_v1.types.DataScan.ExecutionStatus): Output only. Status of the data scan @@ -489,15 +489,19 @@ class ExecutionSpec(proto.Message): Attributes: trigger (google.cloud.dataplex_v1.types.Trigger): - Optional. Spec related to how often and when - a scan should be triggered. If not specified, - the default is OnDemand, which means the scan - will not run until the user calls RunDataScan + Optional. Spec related to how often and when a scan should + be triggered. + + If not specified, the default is ``OnDemand``, which means + the scan will not run until the user calls ``RunDataScan`` API. field (str): - Immutable. The unnested field (Date or - Timestamp) that contains values that - monotonically increase over time. + Immutable. The unnested field (of type *Date* or + *Timestamp*) that contains values which monotonically + increase over time. + + If not specified, a data scan will run for all data in the + table. This field is a member of `oneof`_ ``incremental``. """ @@ -617,7 +621,7 @@ class ExecutionStatus(proto.Message): class DataScanJob(proto.Message): - r"""A DataScanJob represents an instance of a data scan. + r"""A DataScanJob represents an instance of DataScan execution. This message has `oneof`_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. @@ -630,9 +634,9 @@ class DataScanJob(proto.Message): name (str): Output only. The relative resource name of the DataScanJob, of the form: - projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}. - where ``{project}`` refers to a project_id or project_number - and ``location_id`` refers to a GCP region. + ``projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}``, + where ``project`` refers to a *project_id* or + *project_number* and ``location_id`` refers to a GCP region. uid (str): Output only. System generated globally unique ID for the DataScanJob.