Skip to content

Commit

Permalink
docs: Improvements to DataScan API documentation (#123)
Browse files Browse the repository at this point in the history 
* docs: Improvements to DataScan API documentation

PiperOrigin-RevId: 506348044

Source-Link: googleapis/googleapis@4eb6d9e

Source-Link: googleapis/googleapis-gen@830a4ab
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 <gcf-owl-bot[bot]@users.noreply.github.com>
  • Loading branch information
@gcf-owl-bot
gcf-owl-bot[bot] and gcf-owl-bot[bot] authored Feb 2, 2023
1 parent 9843ac8 commit 8d43e4d
Show file tree
Hide file tree
Showing 5 changed files with 169 additions and 141 deletions.
75 changes: 41 additions & 34 deletions ...google-cloud-dataplex/google/cloud/dataplex_v1/services/data_scan_service/async_client.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Loading

0 comments on commit 8d43e4d

Please sign in to comment.