Skip to content

Commit 9f0a2fd

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
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 PiperOrigin-RevId: 756928247
1 parent 2a33851 commit 9f0a2fd

5 files changed

Lines changed: 83 additions & 59 deletions

File tree

‎google/cloud/dataplex/v1/catalog.proto‎

Lines changed: 64 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1595,13 +1595,14 @@ message MetadataJob {
15951595
[(google.api.field_behavior) = OUTPUT_ONLY];
15961596
}
15971597

1598-
// Export Job Results. The result is based on the snapshot at the time when
1599-
// the job is created.
1598+
// Summary results from a metadata export job. The results are a snapshot of
1599+
// the metadata at the time when the job was created. The exported entries are
1600+
// saved to a Cloud Storage bucket.
16001601
message ExportJobResult {
1601-
// Output only. The number of entries that have been exported.
1602+
// Output only. The number of entries that were exported.
16021603
int64 exported_entries = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
16031604

1604-
// Output only. The error message if the export job failed.
1605+
// Output only. The error message if the metadata export job failed.
16051606
string error_message = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
16061607
}
16071608

@@ -1616,8 +1617,8 @@ message MetadataJob {
16161617
// both optional aspects and required aspects. For system entries, you can
16171618
// modify optional aspects.
16181619
message ImportJobSpec {
1619-
// Specifies how the entries and aspects in a metadata job are updated. For
1620-
// more information, see [Sync
1620+
// Specifies how the entries and aspects in a metadata import job are
1621+
// updated. For more information, see [Sync
16211622
// mode](https://cloud.google.com/dataplex/docs/import-metadata#sync-mode).
16221623
enum SyncMode {
16231624
// Sync mode unspecified.
@@ -1731,8 +1732,9 @@ message MetadataJob {
17311732
// this job.
17321733
//
17331734
// A metadata import file defines the values to set for each of the entries
1734-
// and aspects in a metadata job. For more information about how to create a
1735-
// metadata import file and the file requirements, see [Metadata import
1735+
// and aspects in a metadata import job. For more information about how to
1736+
// create a metadata import file and the file requirements, see [Metadata
1737+
// import
17361738
// file](https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).
17371739
//
17381740
// You can provide multiple metadata import files in the same metadata job.
@@ -1772,69 +1774,82 @@ message MetadataJob {
17721774
LogLevel log_level = 6 [(google.api.field_behavior) = OPTIONAL];
17731775
}
17741776

1775-
// Export job specification.
1777+
// Job specification for a metadata export job.
17761778
message ExportJobSpec {
1777-
// Scope of the export job.
1779+
// The scope of the export job.
17781780
message ExportJobScope {
1779-
// Indicating if it is an organization level export job.
1780-
// - When set to true, exports all entries from entry groups and projects
1781-
// sharing the same organization id of the Metadata Job. Only projects and
1782-
// entry groups in the VPC-SC perimeter will be exported. The projects and
1783-
// entry groups are ignored.
1784-
// - When set to false, one of the projects or entry groups must be
1785-
// specified.
1786-
// - Default to false.
1781+
// Whether the metadata export job is an organization-level export job.
1782+
//
1783+
// - If `true`, the job exports the entries from the same organization and
1784+
// VPC Service Controls perimeter as the job. The project that the job
1785+
// belongs to determines the VPC Service Controls perimeter. If you set
1786+
// the job scope to be at the organization level, then don't provide a
1787+
// list of projects or entry groups.
1788+
// - If `false`, you must specify a list of projects or a list of entry
1789+
// groups whose entries you want to export.
1790+
//
1791+
// The default is `false`.
17871792
bool organization_level = 1;
17881793

1789-
// The projects that are in the scope of the export job. Can either be
1790-
// project numbers or project IDs. If specified, only the entries from the
1791-
// specified projects will be exported. The projects must be in the same
1792-
// organization and in the VPC-SC perimeter. Either projects or
1793-
// entry_groups can be specified when organization_level_export is set to
1794-
// false.
1795-
// Must follow the format: "projects/<project_id_or_number>"
1794+
// The projects whose metadata you want to export, in the format
1795+
// `projects/{project_id_or_number}`. Only the entries from
1796+
// the specified projects are exported.
1797+
//
1798+
// The projects must be in the same organization and VPC Service Controls
1799+
// perimeter as the job.
1800+
//
1801+
// If you set the job scope to be a list of projects, then set the
1802+
// organization-level export flag to false and don't provide a list of
1803+
// entry groups.
17961804
repeated string projects = 2 [(google.api.resource_reference) = {
17971805
type: "cloudresourcemanager.googleapis.com/Project"
17981806
}];
17991807

1800-
// The entry groups that are in scope for the export job. Optional. If
1801-
// specified, only entries in the specified entry groups will be exported
1802-
// by the job. Must be in the VPC-SC perimeter of the job. The location of
1803-
// the entry groups must be the same as the job. Either projects or
1804-
// entry_groups can be specified when organization_level_export is set to
1805-
// false. Must follow the format:
1806-
// "projects/<project_id_or_number>/locations/<location>/entryGroups/<entry_group_id>"
1808+
// The entry groups whose metadata you want to export, in the format
1809+
// `projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
1810+
// Only the entries in the specified entry groups are exported.
1811+
//
1812+
// The entry groups must be in the same location and the same VPC Service
1813+
// Controls perimeter as the job.
1814+
//
1815+
// If you set the job scope to be a list of entry groups, then set the
1816+
// organization-level export flag to false and don't provide a list of
1817+
// projects.
18071818
repeated string entry_groups = 3 [(google.api.resource_reference) = {
18081819
type: "dataplex.googleapis.com/EntryGroup"
18091820
}];
18101821

1811-
// If specified, only entries of the specified types will be
1812-
// affected by the job.
1813-
// Must follow the format:
1814-
// "projects/<project_id_or_number>/locations/<location>/entryTypes/<entry_type_id>"
1822+
// The entry types that are in scope for the export job, specified as
1823+
// relative resource names in the format
1824+
// `projects/{project_id_or_number}/locations/{location}/entryTypes/{entry_type_id}`.
1825+
// Only entries that belong to the specified entry types are affected by
1826+
// the job.
18151827
repeated string entry_types = 4 [(google.api.resource_reference) = {
18161828
type: "dataplex.googleapis.com/EntryType"
18171829
}];
18181830

1819-
// The aspect types that are in scope for the export job.
1820-
// Optional. If specified, only aspects of the specified types will be
1821-
// affected by the job.
1822-
// Must follow the format:
1823-
// "projects/<project_id_or_number>/locations/<location>/aspectTypes/<aspect_type_id>"
1831+
// The aspect types that are in scope for the export job, specified as
1832+
// relative resource names in the format
1833+
// `projects/{project_id_or_number}/locations/{location}/aspectTypes/{aspect_type_id}`.
1834+
// Only aspects that belong to the specified aspect types are affected by
1835+
// the job.
18241836
repeated string aspect_types = 5 [(google.api.resource_reference) = {
18251837
type: "dataplex.googleapis.com/AspectType"
18261838
}];
18271839
}
18281840

1829-
// Required. Selects the entries to be exported by this job.
1841+
// Required. The scope of the export job.
18301842
ExportJobScope scope = 2 [(google.api.field_behavior) = REQUIRED];
18311843

1832-
// Required. The root path of the exported metadata.
1833-
// Must be in the format: "gs://<bucket_id>"
1834-
// Or specify a customized prefix after the bucket:
1835-
// "gs://<bucket_id>/<folder1>/<folder2>/.../".
1836-
// The length limit of the customized prefix is 128 characters.
1837-
// The bucket must be in the same VPC-SC perimeter with the job.
1844+
// Required. The root path of the Cloud Storage bucket to export the
1845+
// metadata to, in the format `gs://{bucket}/`. You can optionally specify a
1846+
// custom prefix after the bucket name, in the format
1847+
// `gs://{bucket}/{prefix}/`. The maximum length of the custom prefix is 128
1848+
// characters. Dataplex constructs the object path for the exported files by
1849+
// using the bucket name and prefix that you provide, followed by a
1850+
// system-generated path.
1851+
//
1852+
// The bucket must be in the same VPC Service Controls perimeter as the job.
18381853
string output_path = 3 [(google.api.field_behavior) = REQUIRED];
18391854
}
18401855

@@ -1846,7 +1861,7 @@ message MetadataJob {
18461861
// Import job.
18471862
IMPORT = 1;
18481863

1849-
// Export job type.
1864+
// Export job.
18501865
EXPORT = 2;
18511866
}
18521867

‎google/cloud/dataplex/v1/cmek.proto‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@ option java_outer_classname = "CmekProto";
3333
option java_package = "com.google.cloud.dataplex.v1";
3434
option php_namespace = "Google\\Cloud\\Dataplex\\V1";
3535
option ruby_package = "Google::Cloud::Dataplex::V1";
36-
3736
option (google.api.resource_definition) = {
3837
type: "dataplex.googleapis.com/OrganizationLocation"
3938
pattern: "organizations/{organization}/locations/{location}"
@@ -141,7 +140,7 @@ message EncryptionConfig {
141140
// The error code is not specified
142141
UNKNOWN = 0;
143142

144-
// Error because of internal server error, will be retried automatically..
143+
// Error because of internal server error, will be retried automatically.
145144
INTERNAL_ERROR = 1;
146145

147146
// User action is required to resolve the error.
@@ -202,12 +201,9 @@ message CreateEncryptionConfigRequest {
202201
}
203202
];
204203

205-
// Required. The ID of the EncryptionConfig to create.
206-
// The ID must contain only letters (a-z, A-Z), numbers (0-9),
207-
// and hyphens (-).
208-
// The maximum size is 63 characters.
209-
// The first character must be a letter.
210-
// The last character must be a letter or a number.
204+
// Required. The ID of the
205+
// [EncryptionConfig][google.cloud.dataplex.v1.EncryptionConfig] to create.
206+
// Currently, only a value of "default" is supported.
211207
string encryption_config_id = 2 [(google.api.field_behavior) = REQUIRED];
212208

213209
// Required. The EncryptionConfig to create.

‎google/cloud/dataplex/v1/data_discovery.proto‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ message DataDiscoveryResult {
177177
string location = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
178178
}
179179

180-
// Statistics of the DataDiscoveryScan.
180+
// Describes result statistics of a data scan discovery job.
181181
message ScanStatistics {
182182
// The number of files scanned.
183183
int32 scanned_file_count = 1;
@@ -211,7 +211,7 @@ message DataDiscoveryResult {
211211
BigQueryPublishing bigquery_publishing = 1
212212
[(google.api.field_behavior) = OUTPUT_ONLY];
213213

214-
// Output only. Statistics of the DataDiscoveryScan.
214+
// Output only. Describes result statistics of a data scan discovery job.
215215
ScanStatistics scan_statistics = 2
216216
[(google.api.field_behavior) = OUTPUT_ONLY];
217217
}

‎google/cloud/dataplex/v1/dataplex_grpc_service_config.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -296,6 +296,10 @@
296296
{
297297
"service": "google.cloud.dataplex.v1.CatalogService",
298298
"method": "LookupEntry"
299+
},
300+
{
301+
"service": "google.cloud.dataplex.v1.CatalogService",
302+
"method": "LookupEntryInternal"
299303
}
300304
],
301305
"timeout": "20s",
@@ -366,6 +370,10 @@
366370
"service": "google.cloud.dataplex.v1.CatalogService",
367371
"method": "SearchEntries"
368372
},
373+
{
374+
"service": "google.cloud.dataplex.v1.CatalogService",
375+
"method": "SearchEntriesInternal"
376+
},
369377
{
370378
"service": "google.cloud.dataplex.v1.CatalogService",
371379
"method": "SearchGatewayInternal"

‎google/cloud/dataplex/v1/dataplex_v1.yaml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ title: Cloud Dataplex API
55

66
apis:
77
- name: google.cloud.dataplex.v1.CatalogService
8+
- name: google.cloud.dataplex.v1.CmekService
89
- name: google.cloud.dataplex.v1.ContentService
910
- name: google.cloud.dataplex.v1.DataScanService
1011
- name: google.cloud.dataplex.v1.DataTaxonomyService
@@ -185,6 +186,10 @@ authentication:
185186
oauth:
186187
canonical_scopes: |-
187188
https://www.googleapis.com/auth/cloud-platform
189+
- selector: 'google.cloud.dataplex.v1.CmekService.*'
190+
oauth:
191+
canonical_scopes: |-
192+
https://www.googleapis.com/auth/cloud-platform
188193
- selector: 'google.cloud.dataplex.v1.ContentService.*'
189194
oauth:
190195
canonical_scopes: |-

0 commit comments

Comments
 (0)