Skip to content

Commit

Permalink
feat(dataplex): update the API
Browse files Browse the repository at this point in the history
#### dataplex:v1

The following keys were added:
- schemas.GoogleCloudDataplexV1DataScanExecutionStatus.properties.latestJobCreateTime.description
- schemas.GoogleCloudDataplexV1DataScanExecutionStatus.properties.latestJobCreateTime.format
- schemas.GoogleCloudDataplexV1DataScanExecutionStatus.properties.latestJobCreateTime.type
- schemas.GoogleCloudDataplexV1EntrySource.properties.location.description
- schemas.GoogleCloudDataplexV1EntrySource.properties.location.readOnly
- schemas.GoogleCloudDataplexV1EntrySource.properties.location.type

The following keys were changed:
- resources.projects.resources.locations.resources.dataScans.methods.generateDataQualityRules.description
- resources.projects.resources.locations.resources.dataScans.methods.generateDataQualityRules.parameters.name.description
- resources.projects.resources.locations.resources.dataScans.resources.jobs.methods.generateDataQualityRules.description
- resources.projects.resources.locations.resources.dataScans.resources.jobs.methods.generateDataQualityRules.parameters.name.description
- schemas.GoogleCloudDataplexV1GenerateDataQualityRulesRequest.description
- schemas.GoogleCloudDataplexV1GenerateDataQualityRulesResponse.description
- schemas.GoogleCloudDataplexV1GenerateDataQualityRulesResponse.properties.rule.description
  • Loading branch information
yoshi-automation authored and sofisl committed Jun 27, 2024
1 parent eba93e9 commit 393e29f
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 15 deletions.
26 changes: 18 additions & 8 deletions discovery/dataplex-v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -892,7 +892,7 @@
]
},
"generateDataQualityRules": {
"description": "Generates recommended DataQualityRule from a data profiling DataScan.",
"description": "Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}:generateDataQualityRules",
"httpMethod": "POST",
"id": "dataplex.projects.locations.dataScans.generateDataQualityRules",
Expand All @@ -901,7 +901,7 @@
],
"parameters": {
"name": {
"description": "Required. The name should be either * the name of a datascan with at least one successful completed data profiling job, or * the name of a successful completed data profiling datascan job.",
"description": "Required. The name must be one of the following: The name of a data scan with at least one successful, completed data profiling job The name of a successful, completed data profiling job (a data scan job where the job type is data profiling)",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$",
"required": true,
Expand Down Expand Up @@ -1164,7 +1164,7 @@
"jobs": {
"methods": {
"generateDataQualityRules": {
"description": "Generates recommended DataQualityRule from a data profiling DataScan.",
"description": "Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}/jobs/{jobsId}:generateDataQualityRules",
"httpMethod": "POST",
"id": "dataplex.projects.locations.dataScans.jobs.generateDataQualityRules",
Expand All @@ -1173,7 +1173,7 @@
],
"parameters": {
"name": {
"description": "Required. The name should be either * the name of a datascan with at least one successful completed data profiling job, or * the name of a successful completed data profiling datascan job.",
"description": "Required. The name must be one of the following: The name of a data scan with at least one successful, completed data profiling job The name of a successful, completed data profiling job (a data scan job where the job type is data profiling)",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+/jobs/[^/]+$",
"required": true,
Expand Down Expand Up @@ -5271,7 +5271,7 @@
}
}
},
"revision": "20240523",
"revision": "20240611",
"rootUrl": "https://dataplex.googleapis.com/",
"schemas": {
"Empty": {
Expand Down Expand Up @@ -7687,6 +7687,11 @@
"description": "Status of the data scan execution.",
"id": "GoogleCloudDataplexV1DataScanExecutionStatus",
"properties": {
"latestJobCreateTime": {
"description": "Optional. The time when the DataScanJob execution was created.",
"format": "google-datetime",
"type": "string"
},
"latestJobEndTime": {
"description": "The time when the latest DataScanJob ended.",
"format": "google-datetime",
Expand Down Expand Up @@ -8302,6 +8307,11 @@
"description": "User-defined labels. The maximum size of keys and values is 128 characters each.",
"type": "object"
},
"location": {
"description": "Output only. Location of the resource in the source system. Entry will be searchable by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing source location for data external to GCP.",
"readOnly": true,
"type": "string"
},
"platform": {
"description": "The platform containing the source system. The maximum size of the field is 64 characters.",
"type": "string"
Expand Down Expand Up @@ -8628,17 +8638,17 @@
"type": "object"
},
"GoogleCloudDataplexV1GenerateDataQualityRulesRequest": {
"description": "Generate recommended DataQualityRules request.",
"description": "Request details for generating data quality rule recommendations.",
"id": "GoogleCloudDataplexV1GenerateDataQualityRulesRequest",
"properties": {},
"type": "object"
},
"GoogleCloudDataplexV1GenerateDataQualityRulesResponse": {
"description": "Generate recommended DataQualityRules response.",
"description": "Response details for data quality rule recommendations.",
"id": "GoogleCloudDataplexV1GenerateDataQualityRulesResponse",
"properties": {
"rule": {
"description": "Generated recommended {@link DataQualityRule}s.",
"description": "The data quality rules that Dataplex generates based on the results of a data profiling scan.",
"items": {
"$ref": "GoogleCloudDataplexV1DataQualityRule"
},
Expand Down
22 changes: 15 additions & 7 deletions src/apis/dataplex/v1.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1836,6 +1836,10 @@ export namespace dataplex_v1 {
* Status of the data scan execution.
*/
export interface Schema$GoogleCloudDataplexV1DataScanExecutionStatus {
/**
* Optional. The time when the DataScanJob execution was created.
*/
latestJobCreateTime?: string | null;
/**
* The time when the latest DataScanJob ended.
*/
Expand Down Expand Up @@ -2254,6 +2258,10 @@ export namespace dataplex_v1 {
* User-defined labels. The maximum size of keys and values is 128 characters each.
*/
labels?: {[key: string]: string} | null;
/**
* Output only. Location of the resource in the source system. Entry will be searchable by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing source location for data external to GCP.
*/
location?: string | null;
/**
* The platform containing the source system. The maximum size of the field is 64 characters.
*/
Expand Down Expand Up @@ -2496,15 +2504,15 @@ export namespace dataplex_v1 {
active?: boolean | null;
}
/**
* Generate recommended DataQualityRules request.
* Request details for generating data quality rule recommendations.
*/
export interface Schema$GoogleCloudDataplexV1GenerateDataQualityRulesRequest {}
/**
* Generate recommended DataQualityRules response.
* Response details for data quality rule recommendations.
*/
export interface Schema$GoogleCloudDataplexV1GenerateDataQualityRulesResponse {
/**
* Generated recommended {@link DataQualityRule\}s.
* The data quality rules that Dataplex generates based on the results of a data profiling scan.
*/
rule?: Schema$GoogleCloudDataplexV1DataQualityRule[];
}
Expand Down Expand Up @@ -6479,7 +6487,7 @@ export namespace dataplex_v1 {
}

/**
* Generates recommended DataQualityRule from a data profiling DataScan.
* Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
Expand Down Expand Up @@ -7270,7 +7278,7 @@ export namespace dataplex_v1 {
export interface Params$Resource$Projects$Locations$Datascans$Generatedataqualityrules
extends StandardParameters {
/**
* Required. The name should be either * the name of a datascan with at least one successful completed data profiling job, or * the name of a successful completed data profiling datascan job.
* Required. The name must be one of the following: The name of a data scan with at least one successful, completed data profiling job The name of a successful, completed data profiling job (a data scan job where the job type is data profiling)
*/
name?: string;

Expand Down Expand Up @@ -7388,7 +7396,7 @@ export namespace dataplex_v1 {
}

/**
* Generates recommended DataQualityRule from a data profiling DataScan.
* Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
Expand Down Expand Up @@ -7677,7 +7685,7 @@ export namespace dataplex_v1 {
export interface Params$Resource$Projects$Locations$Datascans$Jobs$Generatedataqualityrules
extends StandardParameters {
/**
* Required. The name should be either * the name of a datascan with at least one successful completed data profiling job, or * the name of a successful completed data profiling datascan job.
* Required. The name must be one of the following: The name of a data scan with at least one successful, completed data profiling job The name of a successful, completed data profiling job (a data scan job where the job type is data profiling)
*/
name?: string;

Expand Down

0 comments on commit 393e29f

Please sign in to comment.