8000 docs: [google-cloud-dataplex] A comment for message `MetadataJob` is … · googleapis/google-cloud-python@6f6d015 · GitHub
[go: up one dir, main page]
Skip to content

Commit 6f6d015

Browse files
gcf-owl-bot[bot]parthea
gcf-owl-bot[bot]
and
parthea
authored
docs: [google-cloud-dataplex] A comment for message MetadataJob is changed (#13892)
BEGIN_COMMIT_OVERRIDE docs: A comment for message `MetadataJob` is changed docs: A comment for message `MetadataJob` is changed docs: A comment for message `MetadataJob` is changed docs: A comment for field `exported_entries` in message `.google.cloud.dataplex.v1.MetadataJob` is changed docs: A comment for field `error_message` in message `.google.cloud.dataplex.v1.MetadataJob` is changed docs: A comment for enum `SyncMode` is changed docs: A comment for field `source_storage_uri` in message `.google.cloud.dataplex.v1.MetadataJob` is changed docs: A comment for field `organization_level` in message `.google.cloud.dataplex.v1.MetadataJob` is changed docs: A comment for field `projects` in message `.google.cloud.dataplex.v1.MetadataJob` is changed docs: A comment for field `entry_groups` in message `.google.cloud.dataplex.v1.MetadataJob` is changed docs: A comment for field `entry_types` in message `.google.cloud.dataplex.v1.MetadataJob` is changed docs: A comment for field `aspect_types` in message `.google.cloud.dataplex.v1.MetadataJob` is changed docs: A comment for field `scope` in message `.google.cloud.dataplex.v1.MetadataJob` is changed docs: A comment for field `output_path` in message `.google.cloud.dataplex.v1.MetadataJob` is changed docs: A comment for enum value `EXPORT` in enum `Type` is changed docs: A comment for enum value `INTERNAL_ERROR` in enum `ErrorCode` is changed docs: A comment for field `encryption_config_id` in message `.google.cloud.dataplex.v1.CreateEncryptionConfigRequest` is changed docs: A comment for message `DataDiscoveryResult` is changed docs: A comment for field `scan_statistics` in message `.google.cloud.dataplex.v1.DataDiscoveryResult` is changed END_COMMIT_OVERRIDE - [ ] Regenerate this pull request now. docs: A comment for message `MetadataJob` is changed docs: A comment for message `MetadataJob` is changed docs: A comment for field `exported_entries` in message `.google.cloud.dataplex.v1.MetadataJob` is changed docs: A comment for field `error_message` in message `.google.cloud.dataplex.v1.MetadataJob` is changed docs: A comment for enum `SyncMode` is changed docs: A comment for field `source_storage_uri` in message `.google.cloud.dataplex.v1.MetadataJob` is changed docs: A comment for field `organization_level` in message `.google.cloud.dataplex.v1.MetadataJob` is changed docs: A comment for field `projects` in message `.google.cloud.dataplex.v1.MetadataJob` is changed docs: A comment for field `entry_groups` in message `.google.cloud.dataplex.v1.MetadataJob` is changed docs: A comment for field `entry_types` in message `.google.cloud.dataplex.v1.MetadataJob` is changed docs: A comment for field `aspect_types` in message `.google.cloud.dataplex.v1.MetadataJob` is changed docs: A comment for field `scope` in message `.google.cloud.dataplex.v1.MetadataJob` is changed docs: A comment for field `output_path` in message `.google.cloud.dataplex.v1.MetadataJob` is changed docs: A comment for enum value `EXPORT` in enum `Type` is changed docs: A comment for enum value `INTERNAL_ERROR` in enum `ErrorCode` is changed docs: A comment for field `encryption_config_id` in message `.google.cloud.datap 8000 lex.v1.CreateEncryptionConfigRequest` is changed docs: A comment for message `DataDiscoveryResult` is changed docs: A comment for field `scan_statistics` in message `.google.cloud.dataplex.v1.DataDiscoveryResult` is changed PiperOrigin-RevId: 756928247 Source-Link: googleapis/googleapis@9f0a2fd Source-Link: googleapis/googleapis-gen@b649ddc Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRhdGFwbGV4Ly5Pd2xCb3QueWFtbCIsImgiOiJiNjQ5ZGRjODMxN2IzMGQzZGFkYzYyYmQ4YmE5ZDQ1ZGUwMGU3YWFlIn0= --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Anthonios Partheniou <partheniou@google.com>
1 parent 115c506 commit 6f6d015

File tree

6 files changed

+81
-87
lines changed

6 files changed

+81
-87
lines changed

‎packages/google-cloud-dataplex/google/cloud/dataplex_v1/services/cmek_service/async_client.py

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -364,13 +364,9 @@ async def sample_create_encryption_config():
364364
should not be set.
365365
encryption_config_id (:class:`str`):
366366
Required. The ID of the
367-
EncryptionConfig to create. The ID must
368-
contain only letters (a-z, A-Z), numbers
369-
(0-9), and hyphens (-).
370-
The maximum size is 63 characters.
371-
The first character must be a letter.
372-
The last character must be a letter or a
373-
number.
367+
[EncryptionConfig][google.cloud.dataplex.v1.EncryptionConfig]
368+
to create. Currently, only a value of "default" is
369+
supported.
374370
375371
This corresponds to the ``encryption_config_id`` field
376372
on the ``request`` instance; if ``request`` is provided, this

‎packages/google-cloud-dataplex/google/cloud/dataplex_v1/services/cmek_service/client.py

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -797,13 +797,9 @@ def sample_create_encryption_config():
797797
should not be set.
798798
encryption_config_id (str):
799799
Required. The ID of the
800-
EncryptionConfig to create. The ID must
801-
contain only letters (a-z, A-Z), numbers
802-
(0-9), and hyphens (-).
803-
The maximum size is 63 characters.
804-
The first character must be a letter.
805-
The last character must be a letter or a
806-
number.
800+
[EncryptionConfig][google.cloud.dataplex.v1.EncryptionConfig]
801+
to create. Cu 8000 rrently, only a value of "default" is
802+
supported.
807803
808804
This corresponds to the ``encryption_config_id`` field
809805
on the ``request`` instance; if ``request`` is provided, this

‎packages/google-cloud-dataplex/google/cloud/dataplex_v1/types/catalog.py

Lines changed: 67 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -2296,7 +2296,7 @@ class Type(proto.Enum):
22962296
IMPORT (1):
22972297
Import job.
22982298
EXPORT (2):
2299-
Export job type.
2299+
Export job.
23002300
"""
23012301
TYPE_UNSPECIFIED = 0
23022302
IMPORT = 1
@@ -2353,16 +2353,17 @@ class ImportJobResult(proto.Message):
23532353
)
23542354

23552355
class ExportJobResult(proto.Message):
2356-
r"""Export Job Results. The result is based on the snapshot at
2357-
the time when the job is created.
2356+
r"""Summary results from a metadata export job. The results are a
2357+
snapshot of the metadata at the time when the job was created.
2358+
The exported entries are saved to a Cloud Storage bucket.
23582359
23592360
Attributes:
23602361
exported_entries (int):
2361-
Output only. The number of entries that have
2362-
been exported.
2362+
Output only. The number of entries that were
2363+
exported.
23632364
error_message (str):
2364-
Output only. The error message if the export
2365-
job failed.
2365+
Output only. The error message if the
2366+
metadata export job failed.
23662367
"""
23672368

23682369
exported_entries: int = proto.Field(
@@ -2393,7 +2394,7 @@ class ImportJobSpec(proto.Message):
23932394
contains the metadata import files for this job.
23942395
23952396
A metadata import file defines the values to set for each of
2396-
the entries and aspects in a metadata job. For more
2397+
the entries and aspects in a metadata import job. For more
23972398
information about how to create a metadata import file and
23982399
the file requirements, see `Metadata import
23992400
file <https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file>`__.
@@ -2433,8 +2434,8 @@ class ImportJobSpec(proto.Message):
24332434
"""
24342435

24352436
class SyncMode(proto.Enum):
2436-
r"""Specifies how the entries and aspects in a metadata job are updated.
2437-
For more information, see `Sync
2437+
r"""Specifies how the entries and aspects in a metadata import job are
2438+
updated. For more information, see `Sync
24382439
mode <https://cloud.google.com/dataplex/docs/import-metadata#sync-mode>`__.
24392440
24402441
Values:
@@ -2587,63 +2588,78 @@ class ImportJobScope(proto.Message):
25872588
)
25882589

25892590
class ExportJobSpec(proto.Message):
2590-
r"""Export job specification.
2591+
r"""Job specification for a metadata export job.
25912592
25922593
Attributes:
25932594
scope (google.cloud.dataplex_v1.types.MetadataJob.ExportJobSpec.ExportJobScope):
2594-
Required. Selects the entries to be exported
2595-
by this job.
2595+
Required. The scope of the export job.
25962596
output_path (str):
2597-
Required. The root path of the exported metadata. Must be in
2598-
the format: "gs://<bucket_id>" Or specify a customized
2599-
prefix after the bucket: "gs://<bucket_id>///.../". The
2600-
length limit of the customized prefix is 128 characters. The
2601-
bucket must be in the same VPC-SC perimeter with the job.
2597+
Required. The root path of the Cloud Storage bucket to
2598+
export the metadata to, in the format ``gs://{bucket}/``.
2599+
You can optionally specify a custom prefix after the bucket
2600+
name, in the format ``gs://{bucket}/{prefix}/``. The maximum
2601+
length of the custom prefix is 128 characters. Dataplex
2602+
constructs the object path for the exported files by using
2603+
the bucket name and prefix that you provide, followed by a
2604+
system-generated path.
2605+
2606+
The bucket must be in the same VPC Service Controls
2607+
perimeter as the job.
26022608
"""
26032609

26042610
class ExportJobScope(proto.Message):
2605-
r"""Scope of the export job.
2611+
r"""The scope of the export job.
26062612
26072613
Attributes:
26082614
organization_level (bool):
2609-
Indicating if it is an organization level
2615+
Whether the metadata export job is an organization-level
26102616
export job.
26112617
2612-
- When set to true, exports all entries from
2613-
entry groups and projects sharing the same
2614-
organization id of the Metadata Job. Only
2615-
projects and entry groups in the VPC-SC
2616-
perimeter will be exported. The projects and
2617-
entry groups are ignored.
2618-
- When set to false, one of the projects or
2619-
entry groups must be specified.
2620-
- Default to false.
2618+
- If ``true``, the job exports the entries from the same
2619+
organization and VPC Service Controls perimeter as the
2620+
job. The project that the job belongs to determines the
2621+
VPC Service Controls perimeter. If you set the job scope
2622+
to be at the organization level, then don't provide a
2623+
list of projects or entry groups.
2624+
- If ``false``, you must specify a list of projects or a
2625+
list of entry groups whose entries you want to export.
2626+
2627+
The default is ``false``.
26212628
projects (MutableSequence[str]):
2622-
The projects that are in the scope of the export job. Can
2623-
either be project numbers or project IDs. If specified, only
2624-
the entries from the specified projects will be exported.
2625-
The projects must be in the same organization and in the
2626-
VPC-SC perimeter. Either projects or entry_groups can be
2627-
specified when organization_level_export is set to false.
2628-
Must follow the format: "projects/<project_id_or_number>".
2629+
The projects whose metadata you want to export, in the
2630+
format ``projects/{project_id_or_number}``. Only the entries
2631+
from the specified projects are exported.
2632+
2633+
The projects must be in the same organization and VPC
2634+
Service Controls perimeter as the job.
2635+
2636+
If you set the job scope to be a list of projects, then set
2637+
the organization-level export flag to false and don't
2638+
provide a list of entry groups.
26292639
entry_groups (MutableSequence[str]):
2630-
The entry groups that are in scope for the export job.
2631-
Optional. If specified, only entries in the specified entry
2632-
groups will be exported by the job. Must be in the VPC-SC
2633-
perimeter of the job. The location of the entry groups must
2634-
be the same as the job. Either projects or entry_groups can
2635-
be specified when organization_level_export is set to false.
2636-
Must follow the format:
2637-
"projects/<project_id_or_number>/locations//entryGroups/<entry_group_id>".
2640+
The entry groups whose metadata you want to export, in the
2641+
format
2642+
``projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}``.
2643+
Only the entries in the specified entry groups are exported.
2644+
2645+
The entry groups must be in the same location and the same
2646+
VPC Service Contr F987 ols perimeter as the job.
2647+
2648+
If you set the job scope to be a list of entry groups, then
2649+
set the organization-level export flag to false and don't
2650+
provide a list of projects.
26382651
entry_types (MutableSequence[str]):
2639-
If specified, only entries of the specified types will be
2640-
affected by the job. Must follow the format:
2641-
"projects/<project_id_or_number>/locations//entryTypes/<entry_type_id>".
2652+
The entry types that are in scope for the export job,
2653+
specified as relative resource names in the format
2654+
``projects/{project_id_or_number}/locations/{location}/entryTypes/{entry_type_id}``.
2655+
Only entries that belong to the specified entry types are
2656+
affected by the job.
26422657
aspect_types (MutableSequence[str]):
2643-
The aspect types that are in scope for the export job.
2644-
Optional. If specified, only aspects of the specified types
2645-
will be affected by the job. Must follow the format:
2646-
"projects/<project_id_or_number>/locations//aspectTypes/<aspect_type_id>".
2658+
The aspect types that are in scope for the export job,
2659+
specified as relative resource names in the format
2660+
``projects/{project_id_or_number}/locations/{location}/aspectTypes/{aspect_type_id}``.
2661+
Only aspects that belong to the specified aspect types are
2662+
affected by the job.
26472663
"""
26482664

26492665
organization_level: bool = proto.Field(

‎packages/google-cloud-dataplex/google/cloud/dataplex_v1/types/cmek.py

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ class ErrorCode(proto.Enum):
113113
The error code is not specified
114114
INTERNAL_ERROR (1):
115115
Error because of internal server error, will
116-
be retried automatically..
116+
be retried automatically.
117117
REQUIRE_USER_ACTION (2):
118118
User action is required to resolve the error.
119119
"""
@@ -173,12 +173,10 @@ class CreateEncryptionConfigRequest(proto.Message):
173173
Required. The location at which the
174174
EncryptionConfig is to be created.
175175
encryption_config_id (str):
176-
Required. The ID of the EncryptionConfig to
177-
create. The ID must contain only letters (a-z,
178-
A-Z), numbers (0-9), and hyphens (-).
179-
The maximum size is 63 characters.
180-
The first character must be a letter.
181-
The last character must be a letter or a number.
176+
Required. The ID of the
177+
[EncryptionConfig][google.cloud.dataplex.v1.EncryptionConfig]
178+
to create. Currently, only a value of "default" is
179+
supported.
182180
encryption_config (google.cloud.dataplex_v1.types.EncryptionConfig):
183181
Required. The EncryptionConfig to create.
184182
"""

‎packages/google-cloud-dataplex/google/cloud/dataplex_v1/types/data_discovery.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -256,8 +256,8 @@ class DataDiscoveryResult(proto.Message):
256256
Output only. Configuration for metadata
257257
publishing.
258258
scan_statistics (google.cloud.dataplex_v1.types.DataDiscoveryResult.ScanStatistics):
259-
Output only. Statistics of the
260-
DataDiscoveryScan.
259+
Output only. Describes result statistics of a
260+
data scan discovery job.
261261
"""
262262

263263
class BigQueryPublishing(proto.Message):
@@ -282,7 +282,7 @@ class BigQueryPublishing(proto.Message):
282282
)
283283

284284
class ScanStatistics(proto.Message):
285-
r"""Statistics of the DataDiscoveryScan.
285+
r"""Describes result statistics of a data scan discovery job.
286286
287287
Attributes:
288288
scanned_file_count (int):

‎scripts/client-post-processing/doc-formatting.yaml

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -216,18 +216,6 @@ replacements:
216216
before: entry_type=projects\/another-project\/locations\/\*
217217
after: "entry_type=projects/another-project/locations/\\*"
218218
count: 1
219-
- paths: [
220-
packages/google-cloud-dataplex/google/cloud/dataplex_v1/types/catalog.py,
221-
]
222-
before: |
223-
Indicating if it is an organization level
224-
\ export job.
225-
\ - When set to true, exports all entries from
226-
after: |
227-
Indicating if it is an organization level
228-
export job.\n
229-
- When set to true, exports all entries from
230-
count: 1
231219
- paths: [
232220
packages/google-cloud-deploy/google/cloud/deploy_v1/types/cloud_deploy.py,
233221
]

0 commit comments

Comments
 (0)
0