diff --git a/package-lock.json b/package-lock.json index cb326d7a..024d59db 100755 --- a/package-lock.json +++ b/package-lock.json @@ -5513,12 +5513,12 @@ }, "packages/accessmanagement": { "name": "@databricks/sdk-accessmanagement", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -5529,12 +5529,12 @@ }, "packages/alerts": { "name": "@databricks/sdk-alerts", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -5545,12 +5545,12 @@ }, "packages/apps": { "name": "@databricks/sdk-apps", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -5578,10 +5578,10 @@ }, "packages/auth": { "name": "@databricks/sdk-auth", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-core": ">=0.10.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", "zod": "^4.3.6" }, "engines": { @@ -5590,12 +5590,12 @@ }, "packages/authentication": { "name": "@databricks/sdk-authentication", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -5623,12 +5623,12 @@ }, "packages/budgetpolicy": { "name": "@databricks/sdk-budgetpolicy", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -5639,12 +5639,12 @@ }, "packages/budgets": { "name": "@databricks/sdk-budgets", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -5706,12 +5706,12 @@ }, "packages/cleanrooms": { "name": "@databricks/sdk-cleanrooms", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -5722,12 +5722,12 @@ }, "packages/clusterlibraries": { "name": "@databricks/sdk-clusterlibraries", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -5738,12 +5738,12 @@ }, "packages/clusterpolicies": { "name": "@databricks/sdk-clusterpolicies", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -5754,12 +5754,12 @@ }, "packages/clusters": { "name": "@databricks/sdk-clusters", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -5770,12 +5770,12 @@ }, "packages/commandexecution": { "name": "@databricks/sdk-commandexecution", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -5803,7 +5803,7 @@ }, "packages/core": { "name": "@databricks/sdk-core", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { "json-bigint": "^1.0.0", @@ -5832,12 +5832,12 @@ }, "packages/customllms": { "name": "@databricks/sdk-customllms", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -5848,12 +5848,12 @@ }, "packages/database": { "name": "@databricks/sdk-database", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -5864,12 +5864,12 @@ }, "packages/dataclassification": { "name": "@databricks/sdk-dataclassification", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -5880,12 +5880,12 @@ }, "packages/dataquality": { "name": "@databricks/sdk-dataquality", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -5896,12 +5896,12 @@ }, "packages/disasterrecovery": { "name": "@databricks/sdk-disasterrecovery", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -5929,12 +5929,12 @@ }, "packages/environments": { "name": "@databricks/sdk-environments", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -5963,12 +5963,12 @@ }, "packages/experiments": { "name": "@databricks/sdk-experiments", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6030,12 +6030,12 @@ }, "packages/features": { "name": "@databricks/sdk-features", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6046,12 +6046,12 @@ }, "packages/featurestore": { "name": "@databricks/sdk-featurestore", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6062,12 +6062,12 @@ }, "packages/files": { "name": "@databricks/sdk-files", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6078,12 +6078,12 @@ }, "packages/forecasting": { "name": "@databricks/sdk-forecasting", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6111,12 +6111,12 @@ }, "packages/genie": { "name": "@databricks/sdk-genie", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6127,12 +6127,12 @@ }, "packages/gitcredentials": { "name": "@databricks/sdk-gitcredentials", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6143,12 +6143,12 @@ }, "packages/globalinitscripts": { "name": "@databricks/sdk-globalinitscripts", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6176,12 +6176,12 @@ }, "packages/instancepools": { "name": "@databricks/sdk-instancepools", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6192,12 +6192,12 @@ }, "packages/instanceprofiles": { "name": "@databricks/sdk-instanceprofiles", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6208,12 +6208,12 @@ }, "packages/jobs": { "name": "@databricks/sdk-jobs", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6224,12 +6224,12 @@ }, "packages/keyconfigurations": { "name": "@databricks/sdk-keyconfigurations", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6240,12 +6240,12 @@ }, "packages/knowledgeassistants": { "name": "@databricks/sdk-knowledgeassistants", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6256,12 +6256,12 @@ }, "packages/lakeview": { "name": "@databricks/sdk-lakeview", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6272,12 +6272,12 @@ }, "packages/logdelivery": { "name": "@databricks/sdk-logdelivery", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6288,12 +6288,12 @@ }, "packages/marketplaces": { "name": "@databricks/sdk-marketplaces", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6321,12 +6321,12 @@ }, "packages/modelregistry": { "name": "@databricks/sdk-modelregistry", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6337,12 +6337,12 @@ }, "packages/modelserving": { "name": "@databricks/sdk-modelserving", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6353,12 +6353,12 @@ }, "packages/modelservingquery": { "name": "@databricks/sdk-modelservingquery", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6369,12 +6369,12 @@ }, "packages/networking": { "name": "@databricks/sdk-networking", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6385,12 +6385,12 @@ }, "packages/notificationdestinations": { "name": "@databricks/sdk-notificationdestinations", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6401,12 +6401,12 @@ }, "packages/oauth": { "name": "@databricks/sdk-oauth", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6434,11 +6434,11 @@ }, "packages/options": { "name": "@databricks/sdk-options", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0" + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0" }, "engines": { "node": ">=22.0.0" @@ -6446,12 +6446,12 @@ }, "packages/pipelines": { "name": "@databricks/sdk-pipelines", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6462,12 +6462,12 @@ }, "packages/policyfamilies": { "name": "@databricks/sdk-policyfamilies", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6478,12 +6478,12 @@ }, "packages/postgres": { "name": "@databricks/sdk-postgres", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6494,12 +6494,12 @@ }, "packages/queries": { "name": "@databricks/sdk-queries", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6510,12 +6510,12 @@ }, "packages/queryhistory": { "name": "@databricks/sdk-queryhistory", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6543,12 +6543,12 @@ }, "packages/repos": { "name": "@databricks/sdk-repos", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6610,12 +6610,12 @@ }, "packages/scim": { "name": "@databricks/sdk-scim", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6643,12 +6643,12 @@ }, "packages/secrets": { "name": "@databricks/sdk-secrets", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6676,12 +6676,12 @@ }, "packages/settings": { "name": "@databricks/sdk-settings", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6692,12 +6692,12 @@ }, "packages/sharing": { "name": "@databricks/sdk-sharing", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6708,12 +6708,12 @@ }, "packages/statementexecution": { "name": "@databricks/sdk-statementexecution", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6724,12 +6724,12 @@ }, "packages/storageconfigurations": { "name": "@databricks/sdk-storageconfigurations", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6740,12 +6740,12 @@ }, "packages/supervisoragents": { "name": "@databricks/sdk-supervisoragents", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6790,12 +6790,12 @@ }, "packages/tagassignments": { "name": "@databricks/sdk-tagassignments", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6806,12 +6806,12 @@ }, "packages/tagpolicies": { "name": "@databricks/sdk-tagpolicies", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6822,12 +6822,12 @@ }, "packages/tokenmanagement": { "name": "@databricks/sdk-tokenmanagement", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6838,12 +6838,12 @@ }, "packages/tokens": { "name": "@databricks/sdk-tokens", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6854,12 +6854,12 @@ }, "packages/uc/abacpolicies": { "name": "@databricks/sdk-uc-abacpolicies", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6870,12 +6870,12 @@ }, "packages/uc/artifactallowlists": { "name": "@databricks/sdk-uc-artifactallowlists", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6886,12 +6886,12 @@ }, "packages/uc/catalogs": { "name": "@databricks/sdk-uc-catalogs", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6902,12 +6902,12 @@ }, "packages/uc/connections": { "name": "@databricks/sdk-uc-connections", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6918,12 +6918,12 @@ }, "packages/uc/credentials": { "name": "@databricks/sdk-uc-credentials", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6934,12 +6934,12 @@ }, "packages/uc/entitytagassignments": { "name": "@databricks/sdk-uc-entitytagassignments", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6950,12 +6950,12 @@ }, "packages/uc/externallineage": { "name": "@databricks/sdk-uc-externallineage", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6966,12 +6966,12 @@ }, "packages/uc/externallocations": { "name": "@databricks/sdk-uc-externallocations", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6982,12 +6982,12 @@ }, "packages/uc/externalmetadata": { "name": "@databricks/sdk-uc-externalmetadata", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -6998,12 +6998,12 @@ }, "packages/uc/functions": { "name": "@databricks/sdk-uc-functions", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -7014,12 +7014,12 @@ }, "packages/uc/grants": { "name": "@databricks/sdk-uc-grants", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -7030,12 +7030,12 @@ }, "packages/uc/metastores": { "name": "@databricks/sdk-uc-metastores", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -7046,12 +7046,12 @@ }, "packages/uc/onlinetables": { "name": "@databricks/sdk-uc-onlinetables", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -7079,12 +7079,12 @@ }, "packages/uc/registeredmodels": { "name": "@databricks/sdk-uc-registeredmodels", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -7095,12 +7095,12 @@ }, "packages/uc/resourcequotas": { "name": "@databricks/sdk-uc-resourcequotas", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -7111,12 +7111,12 @@ }, "packages/uc/rfa": { "name": "@databricks/sdk-uc-rfa", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -7127,12 +7127,12 @@ }, "packages/uc/schemas": { "name": "@databricks/sdk-uc-schemas", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -7143,12 +7143,12 @@ }, "packages/uc/secrets": { "name": "@databricks/sdk-uc-secrets", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -7159,12 +7159,12 @@ }, "packages/uc/systemschemas": { "name": "@databricks/sdk-uc-systemschemas", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -7175,12 +7175,12 @@ }, "packages/uc/tables": { "name": "@databricks/sdk-uc-tables", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -7191,12 +7191,12 @@ }, "packages/uc/volumes": { "name": "@databricks/sdk-uc-volumes", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -7207,12 +7207,12 @@ }, "packages/uc/workspacebindings": { "name": "@databricks/sdk-uc-workspacebindings", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -7223,12 +7223,12 @@ }, "packages/usagedashboards": { "name": "@databricks/sdk-usagedashboards", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -7256,12 +7256,12 @@ }, "packages/vectorsearch": { "name": "@databricks/sdk-vectorsearch", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -7289,12 +7289,12 @@ }, "packages/warehouses": { "name": "@databricks/sdk-warehouses", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" @@ -7339,12 +7339,12 @@ }, "packages/workspaces": { "name": "@databricks/sdk-workspaces", - "version": "0.10.0", + "version": "0.11.0", "license": "Apache-2.0", "dependencies": { - "@databricks/sdk-auth": ">=0.10.0 <1.0.0", - "@databricks/sdk-core": ">=0.10.0 <1.0.0", - "@databricks/sdk-options": ">=0.10.0 <1.0.0", + "@databricks/sdk-auth": ">=0.11.0 <1.0.0", + "@databricks/sdk-core": ">=0.11.0 <1.0.0", + "@databricks/sdk-options": ">=0.11.0 <1.0.0", "@js-temporal/polyfill": "^0.5.0", "json-bigint": "^1.0.0", "zod": "^4.3.6" diff --git a/packages/accessmanagement/src/v1/model.ts b/packages/accessmanagement/src/v1/model.ts index 7357d490..869b97c6 100755 --- a/packages/accessmanagement/src/v1/model.ts +++ b/packages/accessmanagement/src/v1/model.ts @@ -110,24 +110,32 @@ export interface Actor { } export interface CheckPolicyRequest { + /** Required. This field must be set in requests. */ actor?: Actor | undefined; + /** Required. This field must be set in requests. */ permission?: string | undefined; /** * Ex: (servicePrincipal/use, accounts//servicePrincipals/) * Ex: (servicePrincipal.ruleSet/update, accounts//servicePrincipals//ruleSets/default) + * + * Required. This field must be set in requests. */ resource?: string | undefined; + /** Required. This field must be set in requests. */ consistencyToken?: ConsistencyToken | undefined; + /** Required. This field must be set in requests. */ authzIdentity?: RequestAuthzIdentity | undefined; resourceInfo?: ResourceInfo | undefined; } export interface CheckPolicyResponse { isPermitted?: boolean | undefined; + /** Required. This field must be set in requests. */ consistencyToken?: ConsistencyToken | undefined; } export interface ConsistencyToken { + /** Required. This field must be set in requests. */ value?: string | undefined; } @@ -163,6 +171,8 @@ export interface GetRuleSetRequest { * `name=accounts//groups//ruleSets/default` | A name for a rule set on the group. * `name=accounts//servicePrincipals//ruleSets/default` | A name for a rule set on the service principal. * `name=accounts//tagPolicies//ruleSets/default` | A name for a rule set on the tag policy. + * + * Required. This field must be set in requests. */ name?: string | undefined; /** @@ -176,6 +186,8 @@ export interface GetRuleSetRequest { * :--- | :--- * `etag=` | An empty etag can only be used in GET to indicate no freshness requirements. * `etag=RENUAAABhSweA4NvVmmUYdiU717H3Tgy0UJdor3gE4a+mq/oj9NjAf8ZsQ==` | An etag encoded a specific version of the rule set to get or to be updated. + * + * Required. This field must be set in requests. */ etag?: string | undefined; } @@ -190,7 +202,11 @@ export interface GrantRule { * * servicePrincipals/ */ principals?: string[] | undefined; - /** Role that is assigned to the list of principals. */ + /** + * Role that is assigned to the list of principals. + * + * Required. This field must be set in requests. + */ role?: string | undefined; } @@ -206,6 +222,8 @@ export interface ListAssignableRolesForResourceRequest { * `resource=accounts//groups/` | A resource name for the group. * `resource=accounts//servicePrincipals/` | A resource name for the service principal. * `resource=accounts//tagPolicies/` | A resource name for the tag policy. + * + * Required. This field must be set in requests. */ resource?: string | undefined; } @@ -300,7 +318,11 @@ export interface PrincipalOutput { } export interface ResourceInfo { - /** Id of the current resource. */ + /** + * Id of the current resource. + * + * Required. This field must be set in requests. + */ id?: string | undefined; /** Parent resource info for the current resource. The parent may have another parent. */ parentResourceInfo?: ResourceInfo | undefined; @@ -309,12 +331,20 @@ export interface ResourceInfo { } export interface Role { - /** Role to assign to a principal or a list of principals on a resource. */ + /** + * Role to assign to a principal or a list of principals on a resource. + * + * Required. This field must be set in requests. + */ name?: string | undefined; } export interface RuleSet { - /** Name of the rule set. */ + /** + * Name of the rule set. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** * Identifies the version of the rule set returned. @@ -324,13 +354,19 @@ export interface RuleSet { * make use of the etag in the read -> modify -> write pattern to perform rule set updates in * order to avoid race conditions that is get an etag from a GET rule set request, and pass it * with the PUT update request to identify the rule set version you are updating. + * + * Required. This field must be set in requests. */ etag?: string | undefined; grantRules?: GrantRule[] | undefined; } export interface RuleSetUpdateRequest { - /** Name of the rule set. */ + /** + * Name of the rule set. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** * Identifies the version of the rule set returned. @@ -340,6 +376,8 @@ export interface RuleSetUpdateRequest { * make use of the etag in the read -> modify -> write pattern to perform rule set updates in * order to avoid race conditions that is get an etag from a GET rule set request, and pass it * with the PUT update request to identify the rule set version you are updating. + * + * Required. This field must be set in requests. */ etag?: string | undefined; grantRules?: GrantRule[] | undefined; @@ -364,8 +402,13 @@ export interface UpdateObjectPermissionsRequest { export interface UpdateRuleSetRequest { /** account ID. */ accountId?: string | undefined; - /** Name of the rule set. */ + /** + * Name of the rule set. + * + * Required. This field must be set in requests. + */ name?: string | undefined; + /** Required. This field must be set in requests. */ ruleSet?: RuleSetUpdateRequest | undefined; } diff --git a/packages/alerts/src/v1/model.ts b/packages/alerts/src/v1/model.ts index 2389f92d..239e6850 100644 --- a/packages/alerts/src/v1/model.ts +++ b/packages/alerts/src/v1/model.ts @@ -202,6 +202,7 @@ export interface TrashAlertRequest { export interface UpdateAlertRequest { alert?: UpdateAlertRequestAlert | undefined; + /** Required. This field must be set in requests. */ updateMask?: FieldMask | undefined; id?: string | undefined; /** If true, automatically resolve alert display name conflicts. Otherwise, fail the request if the alert's display name conflicts with an existing alert's display name. */ diff --git a/packages/alerts/src/v2/model.ts b/packages/alerts/src/v2/model.ts index 62058d18..de3fec8a 100644 --- a/packages/alerts/src/v2/model.ts +++ b/packages/alerts/src/v2/model.ts @@ -73,21 +73,49 @@ export type SchedulePauseStatus = | (string & {}); export interface Alert { - /** UUID identifying the alert. */ + /** + * UUID identifying the alert. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ id?: string | undefined; - /** The display name of the alert. */ + /** + * The display name of the alert. + * + * Required. This field must be set in requests. + */ displayName?: string | undefined; - /** The owner's username. This field is set to "Unavailable" if the user has been deleted. */ + /** + * The owner's username. This field is set to "Unavailable" if the user has been deleted. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ ownerUserName?: string | undefined; - /** The timestamp indicating when the alert was created. */ + /** + * The timestamp indicating when the alert was created. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createTime?: Temporal.Instant | undefined; - /** The timestamp indicating when the alert was updated. */ + /** + * The timestamp indicating when the alert was updated. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updateTime?: Temporal.Instant | undefined; /** The workspace path of the folder containing the alert. Can only be set on create, and cannot be updated. */ parentPath?: string | undefined; - /** Text of the query to be run. */ + /** + * Text of the query to be run. + * + * Required. This field must be set in requests. + */ queryText?: string | undefined; - /** ID of the SQL warehouse attached to the alert. */ + /** + * ID of the SQL warehouse attached to the alert. + * + * Required. This field must be set in requests. + */ warehouseId?: string | undefined; /** * The run as username or application ID of service principal. @@ -95,9 +123,15 @@ export interface Alert { * Deprecated: Use `run_as` field instead. This field will be removed in a future release. */ runAsUserName?: string | undefined; + /** Required. This field must be set in requests. */ evaluation?: AlertEvaluation | undefined; + /** Required. This field must be set in requests. */ schedule?: CronSchedule | undefined; - /** Indicates whether the query is trashed. */ + /** + * Indicates whether the query is trashed. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ lifecycleState?: AlertLifecycleState | undefined; /** Custom summary for the alert. support mustache template. */ customSummary?: string | undefined; @@ -115,22 +149,40 @@ export interface Alert { * The actual identity that will be used to execute the alert. * This is an output-only field that shows the resolved run-as identity after applying * permissions and defaults. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ effectiveRunAs?: AlertRunAs | undefined; } export interface AlertEvaluation { - /** Source column from result to use to evaluate alert */ + /** + * Source column from result to use to evaluate alert + * + * Required. This field must be set in requests. + */ source?: AlertOperandColumn | undefined; - /** Operator used for comparison in alert evaluation. */ + /** + * Operator used for comparison in alert evaluation. + * + * Required. This field must be set in requests. + */ comparisonOperator?: ComparisonOperator | undefined; /** Threshold to user for alert evaluation, can be a column or a value. */ threshold?: AlertOperand | undefined; /** User or Notification Destination to notify when alert is triggered. */ notification?: AlertNotification | undefined; - /** Latest state of alert evaluation. */ + /** + * Latest state of alert evaluation. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ state?: AlertEvaluationState | undefined; - /** Timestamp of the last evaluation. */ + /** + * Timestamp of the last evaluation. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ lastEvaluatedAt?: Temporal.Instant | undefined; /** Alert state if result is empty. Please avoid setting this field to be `UNKNOWN` because `UNKNOWN` state is planned to be deprecated. */ emptyResultState?: AlertEvaluationState | undefined; @@ -157,6 +209,7 @@ export interface AlertOperand { } export interface AlertOperandColumn { + /** Required. This field must be set in requests. */ name?: string | undefined; display?: string | undefined; /** If not set, the behavior is equivalent to using `First row` in the UI. */ @@ -202,12 +255,16 @@ export interface CronSchedule { /** * A cron expression using quartz syntax that specifies the schedule for this pipeline. * Should use the quartz format described here: http://www.quartz-scheduler.org/documentation/quartz-2.1.7/tutorials/tutorial-lesson-06.html + * + * Required. This field must be set in requests. */ quartzCronSchedule?: string | undefined; /** * A Java timezone id. The schedule will be resolved using this timezone. * This will be combined with the quartz_cron_schedule to determine the schedule. * See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details. + * + * Required. This field must be set in requests. */ timezoneId?: string | undefined; /** Indicate whether this schedule is paused or not. */ @@ -243,6 +300,7 @@ export interface TrashAlertRequest { export interface UpdateAlertRequest { alert?: Alert | undefined; + /** Required. This field must be set in requests. */ updateMask?: FieldMask | undefined; } diff --git a/packages/apps/src/v1/model.ts b/packages/apps/src/v1/model.ts index c705d9db..104276eb 100755 --- a/packages/apps/src/v1/model.ts +++ b/packages/apps/src/v1/model.ts @@ -833,53 +833,98 @@ export interface App { /** * The name of the app. The name must contain only lowercase alphanumeric characters and hyphens. * It must be unique within the workspace. + * + * Required. This field must be set in requests. */ name?: string | undefined; /** The description of the app. */ description?: string | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ computeStatus?: ComputeStatus | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ appStatus?: ApplicationStatus | undefined; - /** The URL of the app once it is deployed. */ + /** + * The URL of the app once it is deployed. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ url?: string | undefined; /** * The active deployment of the app. A deployment is considered active when it has been deployed * to the app compute. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ activeDeployment?: AppDeployment | undefined; - /** The creation time of the app. Formatted timestamp in ISO 6801. */ + /** + * The creation time of the app. Formatted timestamp in ISO 6801. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createTime?: Temporal.Instant | undefined; - /** The email of the user that created the app. */ + /** + * The email of the user that created the app. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ creator?: string | undefined; - /** The update time of the app. Formatted timestamp in ISO 6801. */ + /** + * The update time of the app. Formatted timestamp in ISO 6801. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updateTime?: Temporal.Instant | undefined; - /** The email of the user that last updated the app. */ + /** + * The email of the user that last updated the app. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updater?: string | undefined; /** * The pending deployment of the app. A deployment is considered pending when it is being prepared * for deployment to the app compute. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ pendingDeployment?: AppDeployment | undefined; /** Resources for the app. */ resources?: AppResource[] | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ servicePrincipalId?: bigint | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ servicePrincipalName?: string | undefined; /** * The default workspace file system path of the source code from which app deployment are * created. This field tracks the workspace source code path of the last active deployment. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ defaultSourceCodePath?: string | undefined; budgetPolicyId?: string | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ effectiveBudgetPolicyId?: string | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ servicePrincipalClientId?: string | undefined; userApiScopes?: string[] | undefined; - /** The unique identifier of the app. */ + /** + * The unique identifier of the app. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ id?: string | undefined; - /** The effective api scopes granted to the user access token. */ + /** + * The effective api scopes granted to the user access token. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ effectiveUserApiScopes?: string[] | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ oauth2AppIntegrationId?: string | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ oauth2AppClientId?: string | undefined; computeSize?: ComputeSize | undefined; usagePolicyId?: string | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ effectiveUsagePolicyId?: string | undefined; /** Minimum number of app instances. Must be set together with `compute_max_instances`. */ computeMinInstances?: number | undefined; @@ -891,7 +936,11 @@ export interface App { */ gitRepository?: GitRepository | undefined; telemetryExportDestinations?: TelemetryExportDestination[] | undefined; - /** The URL of the thumbnail image for the app. */ + /** + * The URL of the thumbnail image for the app. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ thumbnailUrl?: string | undefined; /** Name of the space this app belongs to. */ space?: string | undefined; @@ -911,15 +960,35 @@ export interface AppDeployment { gitSource?: GitSource | undefined; /** The mode of which the deployment will manage the source code. */ mode?: AppDeployment_Mode | undefined; - /** The deployment artifacts for an app. */ + /** + * The deployment artifacts for an app. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ deploymentArtifacts?: AppDeploymentArtifacts | undefined; - /** Status and status message of the deployment */ + /** + * Status and status message of the deployment + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ status?: AppDeploymentStatus | undefined; - /** The creation time of the deployment. Formatted timestamp in ISO 6801. */ + /** + * The creation time of the deployment. Formatted timestamp in ISO 6801. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createTime?: Temporal.Instant | undefined; - /** The email of the user creates the deployment. */ + /** + * The email of the user creates the deployment. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ creator?: string | undefined; - /** The update time of the deployment. Formatted timestamp in ISO 6801. */ + /** + * The update time of the deployment. Formatted timestamp in ISO 6801. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updateTime?: Temporal.Instant | undefined; /** The command with which to run the app. This will override the command specified in the app.yaml file. */ command?: string[] | undefined; @@ -933,17 +1002,33 @@ export interface AppDeploymentArtifacts { } export interface AppDeploymentStatus { - /** State of the deployment. */ + /** + * State of the deployment. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ state?: AppDeployment_State | undefined; - /** Message corresponding with the deployment state. */ + /** + * Message corresponding with the deployment state. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ message?: string | undefined; } /** App manifest definition */ export interface AppManifest { - /** The manifest schema version, for now only 1 is allowed */ + /** + * The manifest schema version, for now only 1 is allowed + * + * Required. This field must be set in requests. + */ version?: number | undefined; - /** Name of the app defined by manifest author / publisher */ + /** + * Name of the app defined by manifest author / publisher + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** Description of the app defined by manifest author / publisher */ description?: string | undefined; @@ -952,6 +1037,7 @@ export interface AppManifest { // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name. export interface AppManifest_AppResourceExperimentSpec { + /** Required. This field must be set in requests. */ permission?: | AppManifest_AppResourceExperimentSpec_ExperimentPermission | undefined; @@ -959,19 +1045,31 @@ export interface AppManifest_AppResourceExperimentSpec { // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name. export interface AppManifest_AppResourceJobSpec { - /** Permissions to grant on the Job. Supported permissions are: "CAN_MANAGE", "IS_OWNER", "CAN_MANAGE_RUN", "CAN_VIEW". */ + /** + * Permissions to grant on the Job. Supported permissions are: "CAN_MANAGE", "IS_OWNER", "CAN_MANAGE_RUN", "CAN_VIEW". + * + * Required. This field must be set in requests. + */ permission?: AppManifest_AppResourceJobSpec_JobPermission | undefined; } // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name. export interface AppManifest_AppResourceSecretSpec { - /** Permission to grant on the secret scope. For secrets, only one permission is allowed. Permission must be one of: "READ", "WRITE", "MANAGE". */ + /** + * Permission to grant on the secret scope. For secrets, only one permission is allowed. Permission must be one of: "READ", "WRITE", "MANAGE". + * + * Required. This field must be set in requests. + */ permission?: AppManifest_AppResourceSecretSpec_SecretPermission | undefined; } // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name. export interface AppManifest_AppResourceServingEndpointSpec { - /** Permission to grant on the serving endpoint. Supported permissions are: "CAN_MANAGE", "CAN_QUERY", "CAN_VIEW". */ + /** + * Permission to grant on the serving endpoint. Supported permissions are: "CAN_MANAGE", "CAN_QUERY", "CAN_VIEW". + * + * Required. This field must be set in requests. + */ permission?: | AppManifest_AppResourceServingEndpointSpec_ServingEndpointPermission | undefined; @@ -980,7 +1078,11 @@ export interface AppManifest_AppResourceServingEndpointSpec { /** AppResource related fields are copied from app.proto but excludes resource identifiers (e.g. name, id, key, scope, etc.) */ // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name. export interface AppManifest_AppResourceSpec { - /** Name of the App Resource. */ + /** + * Name of the App Resource. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** Description of the App Resource. */ description?: string | undefined; @@ -1008,7 +1110,11 @@ export interface AppManifest_AppResourceSpec { // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name. export interface AppManifest_AppResourceSqlWarehouseSpec { - /** Permission to grant on the SQL warehouse. Supported permissions are: "CAN_MANAGE", "CAN_USE", "IS_OWNER". */ + /** + * Permission to grant on the SQL warehouse. Supported permissions are: "CAN_MANAGE", "CAN_USE", "IS_OWNER". + * + * Required. This field must be set in requests. + */ permission?: | AppManifest_AppResourceSqlWarehouseSpec_SqlWarehousePermission | undefined; @@ -1016,16 +1122,22 @@ export interface AppManifest_AppResourceSqlWarehouseSpec { // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name. export interface AppManifest_AppResourceUcSecurableSpec { + /** Required. This field must be set in requests. */ securableType?: | AppManifest_AppResourceUcSecurableSpec_UcSecurableType | undefined; + /** Required. This field must be set in requests. */ permission?: | AppManifest_AppResourceUcSecurableSpec_UcSecurablePermission | undefined; } export interface AppResource { - /** Name of the App Resource. */ + /** + * Name of the App Resource. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** Description of the App Resource. */ description?: string | undefined; @@ -1049,26 +1161,42 @@ export interface AppResourceApp { } export interface AppResourceDatabase { + /** Required. This field must be set in requests. */ instanceName?: string | undefined; + /** Required. This field must be set in requests. */ databaseName?: string | undefined; + /** Required. This field must be set in requests. */ permission?: AppResourceDatabase_DatabasePermission | undefined; } export interface AppResourceExperiment { + /** Required. This field must be set in requests. */ experimentId?: string | undefined; + /** Required. This field must be set in requests. */ permission?: AppResourceExperiment_ExperimentPermission | undefined; } export interface AppResourceGenieSpace { + /** Required. This field must be set in requests. */ name?: string | undefined; + /** Required. This field must be set in requests. */ spaceId?: string | undefined; + /** Required. This field must be set in requests. */ permission?: AppResourceGenieSpace_GenieSpacePermission | undefined; } export interface AppResourceJob { - /** Id of the job to grant permission on. */ + /** + * Id of the job to grant permission on. + * + * Required. This field must be set in requests. + */ id?: string | undefined; - /** Permissions to grant on the Job. Supported permissions are: "CAN_MANAGE", "IS_OWNER", "CAN_MANAGE_RUN", "CAN_VIEW". */ + /** + * Permissions to grant on the Job. Supported permissions are: "CAN_MANAGE", "IS_OWNER", "CAN_MANAGE_RUN", "CAN_VIEW". + * + * Required. This field must be set in requests. + */ permission?: AppResourceJob_JobPermission | undefined; } @@ -1079,35 +1207,68 @@ export interface AppResourcePostgres { } export interface AppResourceSecret { - /** Scope of the secret to grant permission on. */ + /** + * Scope of the secret to grant permission on. + * + * Required. This field must be set in requests. + */ scope?: string | undefined; - /** Key of the secret to grant permission on. */ + /** + * Key of the secret to grant permission on. + * + * Required. This field must be set in requests. + */ key?: string | undefined; - /** Permission to grant on the secret scope. For secrets, only one permission is allowed. Permission must be one of: "READ", "WRITE", "MANAGE". */ + /** + * Permission to grant on the secret scope. For secrets, only one permission is allowed. Permission must be one of: "READ", "WRITE", "MANAGE". + * + * Required. This field must be set in requests. + */ permission?: AppResourceSecret_SecretPermission | undefined; } export interface AppResourceServingEndpoint { - /** Name of the serving endpoint to grant permission on. */ + /** + * Name of the serving endpoint to grant permission on. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Permission to grant on the serving endpoint. Supported permissions are: "CAN_MANAGE", "CAN_QUERY", "CAN_VIEW". */ + /** + * Permission to grant on the serving endpoint. Supported permissions are: "CAN_MANAGE", "CAN_QUERY", "CAN_VIEW". + * + * Required. This field must be set in requests. + */ permission?: AppResourceServingEndpoint_ServingEndpointPermission | undefined; } export interface AppResourceSqlWarehouse { - /** Id of the SQL warehouse to grant permission on. */ + /** + * Id of the SQL warehouse to grant permission on. + * + * Required. This field must be set in requests. + */ id?: string | undefined; - /** Permission to grant on the SQL warehouse. Supported permissions are: "CAN_MANAGE", "CAN_USE", "IS_OWNER". */ + /** + * Permission to grant on the SQL warehouse. Supported permissions are: "CAN_MANAGE", "CAN_USE", "IS_OWNER". + * + * Required. This field must be set in requests. + */ permission?: AppResourceSqlWarehouse_SqlWarehousePermission | undefined; } export interface AppResourceUcSecurable { + /** Required. This field must be set in requests. */ securableFullName?: string | undefined; + /** Required. This field must be set in requests. */ securableType?: AppResourceUcSecurable_UcSecurableType | undefined; + /** Required. This field must be set in requests. */ permission?: AppResourceUcSecurable_UcSecurablePermission | undefined; /** * The securable kind from Unity Catalog. * See https://docs.databricks.com/api/workspace/tables/get#securable_kind_manifest-securable_kind. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ securableKind?: string | undefined; } @@ -1119,6 +1280,7 @@ export interface AppThumbnail { } export interface AppUpdate { + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ status?: AppUpdate_UpdateStatus | undefined; description?: string | undefined; budgetPolicyId?: string | undefined; @@ -1135,34 +1297,59 @@ export interface AppUpdate { // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name. export interface AppUpdate_UpdateStatus { + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ state?: AppUpdate_UpdateStatus_UpdateState | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ message?: string | undefined; } export interface ApplicationStatus { - /** State of the application. */ + /** + * State of the application. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ state?: ApplicationStatus_ApplicationState | undefined; - /** Application status message */ + /** + * Application status message + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ message?: string | undefined; - /** The number of running instances of this application. */ + /** + * The number of running instances of this application. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ runningInstances?: number | undefined; } export interface AsyncUpdateAppRequest { app?: App | undefined; + /** Required. This field must be set in requests. */ updateMask?: FieldMask | undefined; appName?: string | undefined; } export interface ComputeStatus { - /** State of the app compute. */ + /** + * State of the app compute. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ state?: ComputeStatus_ComputeState | undefined; - /** Compute status message */ + /** + * Compute status message + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ message?: string | undefined; /** * The number of compute instances currently serving requests for this * application. An instance is considered active if it is reachable and ready * to handle requests. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ activeInstances?: number | undefined; } @@ -1185,6 +1372,7 @@ export interface CreateCustomTemplateRequest { } export interface CreateSpaceRequest { + /** Required. This field must be set in requests. */ space?: Space | undefined; } @@ -1192,18 +1380,37 @@ export interface CustomTemplate { /** * The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces. * It must be unique within the workspace. + * + * Required. This field must be set in requests. */ name?: string | undefined; /** The description of the template. */ description?: string | undefined; - /** The Git repository URL that the template resides in. */ + /** + * The Git repository URL that the template resides in. + * + * Required. This field must be set in requests. + */ gitRepo?: string | undefined; - /** The path to the template within the Git repository. */ + /** + * The path to the template within the Git repository. + * + * Required. This field must be set in requests. + */ path?: string | undefined; - /** The manifest of the template. It defines fields and default values when installing the template. */ + /** + * The manifest of the template. It defines fields and default values when installing the template. + * + * Required. This field must be set in requests. + */ manifest?: AppManifest | undefined; - /** The Git provider of the template. */ + /** + * The Git provider of the template. + * + * Required. This field must be set in requests. + */ gitProvider?: string | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ creator?: string | undefined; } @@ -1218,12 +1425,20 @@ export interface DeleteAppThumbnailRequest { } export interface DeleteCustomTemplateRequest { - /** The name of the custom template. */ + /** + * The name of the custom template. + * + * Required. This field must be set in requests. + */ name?: string | undefined; } export interface DeleteSpaceRequest { - /** The name of the app space. */ + /** + * The name of the app space. + * + * Required. This field must be set in requests. + */ name?: string | undefined; } @@ -1262,7 +1477,11 @@ export interface GetAppUpdateRequest { } export interface GetCustomTemplateRequest { - /** The name of the custom template. */ + /** + * The name of the custom template. + * + * Required. This field must be set in requests. + */ name?: string | undefined; } @@ -1279,18 +1498,28 @@ export interface GetSpaceRequest { /** Git repository configuration specifying the location of the repository. */ export interface GitRepository { - /** URL of the Git repository. */ + /** + * URL of the Git repository. + * + * Required. This field must be set in requests. + */ url?: string | undefined; /** * Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud, * bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit. + * + * Required. This field must be set in requests. */ provider?: string | undefined; } /** Complete git source specification including repository location and reference. */ export interface GitSource { - /** Git repository configuration. Populated from the app's git_repository configuration. */ + /** + * Git repository configuration. Populated from the app's git_repository configuration. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ gitRepository?: GitRepository | undefined; /** Git reference to checkout. Mutually exclusive: branch, tag, or commit. */ reference?: @@ -1320,6 +1549,8 @@ export interface GitSource { * system after resolving the reference (branch, tag, or commit). If commit is specified * directly, this will match commit. If a branch or tag is specified, this contains the * commit SHA that the branch or tag pointed to at deployment time. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ resolvedCommit?: string | undefined; } @@ -1429,49 +1660,104 @@ export interface Space { /** * The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens. * It must be unique within the workspace. + * + * Required. This field must be set in requests. */ name?: string | undefined; /** The description of the app space. */ description?: string | undefined; - /** The status of the app space. */ + /** + * The status of the app space. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ status?: SpaceStatus | undefined; - /** The unique identifier of the app space. */ + /** + * The unique identifier of the app space. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ id?: string | undefined; - /** The creation time of the app space. Formatted timestamp in ISO 6801. */ + /** + * The creation time of the app space. Formatted timestamp in ISO 6801. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createTime?: Temporal.Instant | undefined; - /** The email of the user that created the app space. */ + /** + * The email of the user that created the app space. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ creator?: string | undefined; - /** The update time of the app space. Formatted timestamp in ISO 6801. */ + /** + * The update time of the app space. Formatted timestamp in ISO 6801. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updateTime?: Temporal.Instant | undefined; - /** The email of the user that last updated the app space. */ + /** + * The email of the user that last updated the app space. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updater?: string | undefined; /** Resources for the app space. Resources configured at the space level are available to all apps in the space. */ resources?: AppResource[] | undefined; /** OAuth scopes for apps in the space. */ userApiScopes?: string[] | undefined; - /** The effective api scopes granted to the user access token. */ + /** + * The effective api scopes granted to the user access token. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ effectiveUserApiScopes?: string[] | undefined; - /** The service principal ID for the app space. */ + /** + * The service principal ID for the app space. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ servicePrincipalId?: bigint | undefined; - /** The service principal name for the app space. */ + /** + * The service principal name for the app space. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ servicePrincipalName?: string | undefined; - /** The service principal client ID for the app space. */ + /** + * The service principal client ID for the app space. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ servicePrincipalClientId?: string | undefined; /** The usage policy ID for managing cost at the space level. */ usagePolicyId?: string | undefined; - /** The effective usage policy ID used by apps in the space. */ + /** + * The effective usage policy ID used by apps in the space. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ effectiveUsagePolicyId?: string | undefined; } export interface SpaceStatus { - /** The state of the app space. */ + /** + * The state of the app space. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ state?: SpaceStatus_SpaceState | undefined; - /** Message providing context about the current state. */ + /** + * Message providing context about the current state. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ message?: string | undefined; } /** Tracks app space update information. */ export interface SpaceUpdate { + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ status?: SpaceUpdateStatus | undefined; description?: string | undefined; resources?: AppResource[] | undefined; @@ -1481,7 +1767,9 @@ export interface SpaceUpdate { /** Status of an app space update operation */ export interface SpaceUpdateStatus { + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ state?: SpaceUpdateState | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ message?: string | undefined; } @@ -1503,11 +1791,23 @@ export interface TelemetryExportDestination { /** Unity Catalog Destinations for OTEL telemetry export. */ export interface UnityCatalog { - /** Unity Catalog table for OTEL logs. */ + /** + * Unity Catalog table for OTEL logs. + * + * Required. This field must be set in requests. + */ logsTable?: string | undefined; - /** Unity Catalog table for OTEL metrics. */ + /** + * Unity Catalog table for OTEL metrics. + * + * Required. This field must be set in requests. + */ metricsTable?: string | undefined; - /** Unity Catalog table for OTEL traces (spans). */ + /** + * Unity Catalog table for OTEL traces (spans). + * + * Required. This field must be set in requests. + */ tracesTable?: string | undefined; } @@ -1527,7 +1827,9 @@ export interface UpdateCustomTemplateRequest { } export interface UpdateSpaceRequest { + /** Required. This field must be set in requests. */ space?: Space | undefined; + /** Required. This field must be set in requests. */ updateMask?: FieldMask | undefined; } diff --git a/packages/authentication/src/v1/model.ts b/packages/authentication/src/v1/model.ts index 661d703d..c58af6f3 100755 --- a/packages/authentication/src/v1/model.ts +++ b/packages/authentication/src/v1/model.ts @@ -6,9 +6,17 @@ import type {FieldMaskSchema} from '@databricks/sdk-core/wkt'; import {z} from 'zod'; export interface CreateAccountFederationPolicyRequest { - /** The account id for the federation policy. */ + /** + * The account id for the federation policy. + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; - /** The service principal id for the federation policy. */ + /** + * The service principal id for the federation policy. + * + * Required. This field must be set in requests. + */ servicePrincipalId?: bigint | undefined; /** * The identifier for the federation policy. The identifier must contain only lowercase @@ -16,13 +24,22 @@ export interface CreateAccountFederationPolicyRequest { * assigned by . */ policyId?: string | undefined; + /** Required. This field must be set in requests. */ policy?: FederationPolicy | undefined; } export interface CreateServicePrincipalFederationPolicyRequest { - /** The account id for the federation policy. */ + /** + * The account id for the federation policy. + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; - /** The service principal id for the federation policy. */ + /** + * The service principal id for the federation policy. + * + * Required. This field must be set in requests. + */ servicePrincipalId?: bigint | undefined; /** * The identifier for the federation policy. The identifier must contain only lowercase @@ -30,6 +47,7 @@ export interface CreateServicePrincipalFederationPolicyRequest { * assigned by . */ policyId?: string | undefined; + /** Required. This field must be set in requests. */ policy?: FederationPolicy | undefined; } @@ -60,20 +78,44 @@ export interface CreateServicePrincipalSecretResponse { } export interface DeleteAccountFederationPolicyRequest { - /** The account id for the federation policy. */ + /** + * The account id for the federation policy. + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; - /** The service principal id for the federation policy. */ + /** + * The service principal id for the federation policy. + * + * Required. This field must be set in requests. + */ servicePrincipalId?: bigint | undefined; - /** The identifier for the federation policy. */ + /** + * The identifier for the federation policy. + * + * Required. This field must be set in requests. + */ policyId?: string | undefined; } export interface DeleteServicePrincipalFederationPolicyRequest { - /** The account id for the federation policy. */ + /** + * The account id for the federation policy. + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; - /** The service principal id for the federation policy. */ + /** + * The service principal id for the federation policy. + * + * Required. This field must be set in requests. + */ servicePrincipalId?: bigint | undefined; - /** The identifier for the federation policy. */ + /** + * The identifier for the federation policy. + * + * Required. This field must be set in requests. + */ policyId?: string | undefined; } @@ -97,45 +139,99 @@ export interface FederationPolicy { * for Service Principal Federation Policies. Typically an output parameter, which does not need to be * specified in create or update requests. If specified in a request, must match the value in the * request URL. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. Immutable. Set this field when the resource is created; it cannot be changed afterward. */ name?: string | undefined; /** Description of the federation policy. */ description?: string | undefined; policy?: {$case: 'oidcPolicy'; oidcPolicy: OidcFederationPolicy} | undefined; - /** Creation time of the federation policy. */ + /** + * Creation time of the federation policy. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ createTime?: Temporal.Instant | undefined; - /** Last update time of the federation policy. */ + /** + * Last update time of the federation policy. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updateTime?: Temporal.Instant | undefined; - /** Unique, immutable id of the federation policy. */ + /** + * Unique, immutable id of the federation policy. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ uid?: string | undefined; - /** The service principal ID that this federation policy applies to. Output only. Only set for service principal federation policies. */ + /** + * The service principal ID that this federation policy applies to. Output only. Only set for service principal federation policies. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ servicePrincipalId?: bigint | undefined; - /** The ID of the federation policy. Output only. */ + /** + * The ID of the federation policy. Output only. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ policyId?: string | undefined; } export interface GetAccountFederationPolicyRequest { - /** The account id for the federation policy. */ + /** + * The account id for the federation policy. + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; - /** The service principal id for the federation policy. */ + /** + * The service principal id for the federation policy. + * + * Required. This field must be set in requests. + */ servicePrincipalId?: bigint | undefined; - /** The identifier for the federation policy. */ + /** + * The identifier for the federation policy. + * + * Required. This field must be set in requests. + */ policyId?: string | undefined; } export interface GetServicePrincipalFederationPolicyRequest { - /** The account id for the federation policy. */ + /** + * The account id for the federation policy. + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; - /** The service principal id for the federation policy. */ + /** + * The service principal id for the federation policy. + * + * Required. This field must be set in requests. + */ servicePrincipalId?: bigint | undefined; - /** The identifier for the federation policy. */ + /** + * The identifier for the federation policy. + * + * Required. This field must be set in requests. + */ policyId?: string | undefined; } export interface ListAccountFederationPoliciesRequest { - /** The account id for the federation policy. */ + /** + * The account id for the federation policy. + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; - /** The service principal id for the federation policy. */ + /** + * The service principal id for the federation policy. + * + * Required. This field must be set in requests. + */ servicePrincipalId?: bigint | undefined; pageSize?: number | undefined; pageToken?: string | undefined; @@ -147,9 +243,17 @@ export interface ListFederationPoliciesResponse { } export interface ListServicePrincipalFederationPoliciesRequest { - /** The account id for the federation policy. */ + /** + * The account id for the federation policy. + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; - /** The service principal id for the federation policy. */ + /** + * The service principal id for the federation policy. + * + * Required. This field must be set in requests. + */ servicePrincipalId?: bigint | undefined; pageSize?: number | undefined; pageToken?: string | undefined; @@ -236,12 +340,25 @@ export interface ServicePrincipalSecret { } export interface UpdateAccountFederationPolicyRequest { - /** The account id for the federation policy. */ + /** + * The account id for the federation policy. + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; - /** The service principal id for the federation policy. */ + /** + * The service principal id for the federation policy. + * + * Required. This field must be set in requests. + */ servicePrincipalId?: bigint | undefined; - /** The identifier for the federation policy. */ + /** + * The identifier for the federation policy. + * + * Required. This field must be set in requests. + */ policyId?: string | undefined; + /** Required. This field must be set in requests. */ policy?: FederationPolicy | undefined; /** * The field mask specifies which fields of the policy to update. To specify multiple fields @@ -254,12 +371,25 @@ export interface UpdateAccountFederationPolicyRequest { } export interface UpdateServicePrincipalFederationPolicyRequest { - /** The account id for the federation policy. */ + /** + * The account id for the federation policy. + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; - /** The service principal id for the federation policy. */ + /** + * The service principal id for the federation policy. + * + * Required. This field must be set in requests. + */ servicePrincipalId?: bigint | undefined; - /** The identifier for the federation policy. */ + /** + * The identifier for the federation policy. + * + * Required. This field must be set in requests. + */ policyId?: string | undefined; + /** Required. This field must be set in requests. */ policy?: FederationPolicy | undefined; /** * The field mask specifies which fields of the policy to update. To specify multiple fields diff --git a/packages/budgetpolicy/src/v1/model.ts b/packages/budgetpolicy/src/v1/model.ts index 9ce4408a..5a46e47a 100644 --- a/packages/budgetpolicy/src/v1/model.ts +++ b/packages/budgetpolicy/src/v1/model.ts @@ -58,6 +58,8 @@ export interface CustomPolicyTag { * - Must be unique among all custom tags of the same policy * - Cannot be “budget-policy-name”, “budget-policy-id” or "budget-policy-resolution-result" - * these tags are preserved. + * + * Required. This field must be set in requests. */ key?: string | undefined; /** The value of the tag. */ @@ -66,7 +68,11 @@ export interface CustomPolicyTag { /** Deletes a policy */ export interface DeleteBudgetPolicyRequest { - /** The Id of the policy. */ + /** + * The Id of the policy. + * + * Required. This field must be set in requests. + */ policyId?: string | undefined; /** The account Id of the customer */ accountId?: string | undefined; @@ -95,7 +101,11 @@ export interface Filter { } export interface GetBudgetPolicyRequest { - /** The Id of the policy. */ + /** + * The Id of the policy. + * + * Required. This field must be set in requests. + */ policyId?: string | undefined; /** The account Id of the customer */ accountId?: string | undefined; @@ -161,6 +171,8 @@ export interface UpdateBudgetPolicyRequest { * The policy to update. `creator_user_id` cannot be specified in the request. All other fields * must be specified even if not changed. The `policy_id` is used to identify the policy to * update. + * + * Required. This field must be set in requests. */ policy?: BudgetPolicy | undefined; /** The account Id of the customer */ diff --git a/packages/budgets/src/v1/model.ts b/packages/budgets/src/v1/model.ts index 9eabaf1d..61661aaa 100755 --- a/packages/budgets/src/v1/model.ts +++ b/packages/budgets/src/v1/model.ts @@ -137,7 +137,11 @@ export interface CreateBudgetConfigurationBudget { } export interface CreateBudgetConfigurationRequest { - /** Properties of the new budget configuration. */ + /** + * Properties of the new budget configuration. + * + * Required. This field must be set in requests. + */ budget?: CreateBudgetConfigurationBudget | undefined; } @@ -151,9 +155,17 @@ export interface CreateBudgetConfigurationResponse { * Delete budget */ export interface DeleteBudgetConfigurationRequest { - /** The budget configuration ID. */ + /** + * The budget configuration ID. + * + * Required. This field must be set in requests. + */ budgetId?: string | undefined; - /** account ID. */ + /** + * account ID. + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; } @@ -161,9 +173,17 @@ export interface DeleteBudgetConfigurationRequest { export interface DeleteBudgetConfigurationResponse {} export interface GetBudgetConfigurationRequest { - /** The budget configuration ID */ + /** + * The budget configuration ID + * + * Required. This field must be set in requests. + */ budgetId?: string | undefined; - /** account ID. */ + /** + * account ID. + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; includeSpendStatus?: boolean | undefined; } @@ -173,7 +193,11 @@ export interface GetBudgetConfigurationResponse { } export interface ListBudgetConfigurationsRequest { - /** account ID. */ + /** + * account ID. + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; /** * A page token received from a previous get all budget configurations call. This token can be used to retrieve the subsequent page. @@ -211,9 +235,17 @@ export interface UpdateBudgetConfigurationBudget { } export interface UpdateBudgetConfigurationRequest { - /** The budget configuration ID. */ + /** + * The budget configuration ID. + * + * Required. This field must be set in requests. + */ budgetId?: string | undefined; - /** The updated budget. This will overwrite the budget specified by the budget ID. */ + /** + * The updated budget. This will overwrite the budget specified by the budget ID. + * + * Required. This field must be set in requests. + */ budget?: UpdateBudgetConfigurationBudget | undefined; } diff --git a/packages/cleanrooms/src/v1/model.ts b/packages/cleanrooms/src/v1/model.ts index 4dcb9225..399166fc 100755 --- a/packages/cleanrooms/src/v1/model.ts +++ b/packages/cleanrooms/src/v1/model.ts @@ -333,6 +333,8 @@ export interface CleanRoom { /** * The name of the clean room. * It should follow [UC securable naming requirements](https://docs.databricks.com/en/data-governance/unity-catalog/index.html#securable-object-naming-requirements). + * + * Immutable. Set this field when the resource is created; it cannot be changed afterward. */ name?: string | undefined; /** @@ -344,20 +346,42 @@ export interface CleanRoom { /** This is the username of the owner of the local clean room securable for permission management. */ owner?: string | undefined; comment?: string | undefined; - /** When the clean room was created, in epoch milliseconds. */ + /** + * When the clean room was created, in epoch milliseconds. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdAt?: bigint | undefined; - /** When the clean room was last updated, in epoch milliseconds. */ + /** + * When the clean room was last updated, in epoch milliseconds. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updatedAt?: bigint | undefined; - /** Clean room status. */ + /** + * Clean room status. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ status?: CleanRoom_Status_Enum | undefined; - /** The alias of the collaborator tied to the local clean room. */ + /** + * The alias of the collaborator tied to the local clean room. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ localCollaboratorAlias?: string | undefined; /** * Output catalog of the clean room. It is an output only field. Output catalog is manipulated * using the separate CreateCleanRoomOutputCatalog API. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ outputCatalog?: CleanRoomOutputCatalog | undefined; - /** Whether clean room access is restricted due to [CSP](https://docs.databricks.com/en/security/privacy/security-profile.html) */ + /** + * Whether clean room access is restricted due to [CSP](https://docs.databricks.com/en/security/privacy/security-profile.html) + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ accessRestricted?: CleanRoom_AccessRestricted | undefined; } @@ -380,15 +404,33 @@ export interface CleanRoomAsset { * * For notebooks, the name is the notebook file name. * For jar analyses, the name is the jar analysis name. + * + * Required. This field must be set in requests. */ name?: string | undefined; - /** The type of the asset. */ + /** + * The type of the asset. + * + * Required. This field must be set in requests. + */ assetType?: CleanRoomAsset_AssetType | undefined; - /** When the asset is added to the clean room, in epoch milliseconds. */ + /** + * When the asset is added to the clean room, in epoch milliseconds. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ addedAt?: bigint | undefined; - /** Status of the asset */ + /** + * Status of the asset + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ status?: CleanRoomAsset_Status_Enum | undefined; - /** The alias of the collaborator who owns this asset */ + /** + * The alias of the collaborator who owns this asset + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ ownerCollaboratorAlias?: string | undefined; /** asset-type specific local information of the asset */ localDetails?: @@ -464,7 +506,11 @@ export interface CleanRoomAsset { // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name. export interface CleanRoomAsset_ForeignTable { - /** The metadata information of the columns in the foreign table */ + /** + * The metadata information of the columns in the foreign table + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ columns?: ColumnInfo[] | undefined; } @@ -473,6 +519,8 @@ export interface CleanRoomAsset_ForeignTableLocalDetails { /** * The fully qualified name of the foreign table in its owner's local metastore, * in the format of *catalog*.*schema*.*foreign_table_name* + * + * Required. This field must be set in requests. */ localName?: string | undefined; } @@ -482,15 +530,29 @@ export interface CleanRoomAsset_Notebook { /** * Base 64 representation of the notebook contents. * This is the same format as returned by [workspace/export](https://docs.databricks.com/api/workspace/workspace/export) with the format of **HTML**. + * + * Required. This field must be set in requests. */ notebookContent?: string | undefined; - /** Server generated etag that represents the notebook version. */ + /** + * Server generated etag that represents the notebook version. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ etag?: string | undefined; /** Aliases of collaborators that can run the notebook. */ runnerCollaboratorAliases?: string[] | undefined; - /** All existing approvals or rejections */ + /** + * All existing approvals or rejections + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ reviews?: CleanRoomNotebookReview[] | undefined; - /** Top-level status derived from all reviews */ + /** + * Top-level status derived from all reviews + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ reviewState?: CleanRoomNotebookReview_NotebookReviewState | undefined; } @@ -499,7 +561,11 @@ export interface CleanRoomAsset_Status {} // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name. export interface CleanRoomAsset_Table { - /** The metadata information of the columns in the table */ + /** + * The metadata information of the columns in the table + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ columns?: ColumnInfo[] | undefined; } @@ -508,6 +574,8 @@ export interface CleanRoomAsset_TableLocalDetails { /** * The fully qualified name of the table in its owner's local metastore, * in the format of *catalog*.*schema*.*table_name* + * + * Required. This field must be set in requests. */ localName?: string | undefined; /** Partition filtering specification for a shared table. */ @@ -516,7 +584,11 @@ export interface CleanRoomAsset_TableLocalDetails { // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name. export interface CleanRoomAsset_View { - /** The metadata information of the columns in the view */ + /** + * The metadata information of the columns in the view + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ columns?: ColumnInfo[] | undefined; } @@ -525,6 +597,8 @@ export interface CleanRoomAsset_ViewLocalDetails { /** * The fully qualified name of the view in its owner's local metastore, * in the format of *catalog*.*schema*.*view_name* + * + * Required. This field must be set in requests. */ localName?: string | undefined; } @@ -534,6 +608,8 @@ export interface CleanRoomAsset_VolumeLocalDetails { /** * The fully qualified name of the volume in its owner's local metastore, * in the format of *catalog*.*schema*.*volume_name* + * + * Required. This field must be set in requests. */ localName?: string | undefined; } @@ -541,9 +617,17 @@ export interface CleanRoomAsset_VolumeLocalDetails { export interface CleanRoomAutoApprovalRule { /** The name of the clean room this auto-approval rule belongs to. */ cleanRoomName?: string | undefined; - /** A generated UUID identifying the rule. */ + /** + * A generated UUID identifying the rule. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ ruleId?: string | undefined; - /** The owner of the rule to whom the rule applies. */ + /** + * The owner of the rule to whom the rule applies. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ ruleOwnerCollaboratorAlias?: string | undefined; /** The auto-approved notebook authors. For 2P, this can only be the other collaborator. */ authors?: @@ -572,7 +656,11 @@ export interface CleanRoomAutoApprovalRule { runnerCollaboratorAlias: string; } | undefined; - /** Timestamp of when the rule was created, in epoch milliseconds. */ + /** + * Timestamp of when the rule was created, in epoch milliseconds. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdAt?: bigint | undefined; } @@ -583,30 +671,40 @@ export interface CleanRoomCollaborator { /** * [Organization name](:method:metastores/list#metastores-delta_sharing_organization_name) * configured in the metastore + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ organizationName?: string | undefined; /** * Workspace ID of the user who is receiving the clean room "invitation". Must be specified if * invite_recipient_email is specified. * It should be empty when the collaborator is the creator of the clean room. + * + * Input only. Provide this field in requests; it is never returned in responses. */ inviteRecipientWorkspaceId?: bigint | undefined; /** * Email of the user who is receiving the clean room "invitation". It should be empty * for the creator of the clean room, and non-empty for the invitees of the clean room. * It is only returned in the output when clean room creator calls GET + * + * Immutable. Set this field when the resource is created; it cannot be changed afterward. */ inviteRecipientEmail?: string | undefined; /** * Collaborator alias specified by the clean room creator. It is unique across all collaborators of this clean room, and used to derive * multiple values internally such as catalog alias and clean room name for single metastore clean rooms. * It should follow [UC securable naming requirements](https://docs.databricks.com/en/data-governance/unity-catalog/index.html#securable-object-naming-requirements). + * + * Required. This field must be set in requests. Immutable. Set this field when the resource is created; it cannot be changed afterward. */ collaboratorAlias?: string | undefined; /** * Generated display name for the collaborator. In the case of a single metastore clean room, it is the clean * room name. For x-metastore clean rooms, it is the organization name of the metastore. It is not restricted to * these values and could change in the future + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ displayName?: string | undefined; } @@ -652,6 +750,7 @@ export interface CleanRoomNotebookTaskRun { } export interface CleanRoomOutputCatalog { + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ status?: CleanRoomOutputCatalog_OutputCatalogStatus | undefined; /** * The name of the output catalog in UC. @@ -663,11 +762,23 @@ export interface CleanRoomOutputCatalog { /** Publicly visible central clean room details. */ export interface CleanRoomRemoteDetail { - /** Central clean room ID. */ + /** + * Central clean room ID. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ centralCleanRoomId?: string | undefined; - /** Cloud vendor (aws,azure,gcp) of the central clean room. */ + /** + * Cloud vendor (aws,azure,gcp) of the central clean room. + * + * Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ cloudVendor?: string | undefined; - /** Region of the central clean room. */ + /** + * Region of the central clean room. + * + * Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ region?: string | undefined; /** * Collaborators in the central clean room. There should one and only one collaborator @@ -676,12 +787,23 @@ export interface CleanRoomRemoteDetail { * 1. It has the creator's global_metastore_id (determined by caller of CreateCleanRoom). * * 2. Its invite_recipient_email is empty. + * + * Immutable. Set this field when the resource is created; it cannot be changed afterward. */ collaborators?: CleanRoomCollaborator[] | undefined; - /** Collaborator who creates the clean room. */ + /** + * Collaborator who creates the clean room. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ creator?: CleanRoomCollaborator | undefined; - /** Egress network policy to apply to the central clean room workspace. */ + /** + * Egress network policy to apply to the central clean room workspace. + * + * Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ egressNetworkPolicy?: EgressNetworkPolicy | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ complianceSecurityProfile?: ComplianceSecurityProfile | undefined; } @@ -757,15 +879,28 @@ export interface ComplianceSecurityProfile { } export interface CreateCleanRoomAssetRequest { + /** Required. This field must be set in requests. */ asset?: CleanRoomAsset | undefined; } export interface CreateCleanRoomAssetReviewRequest { - /** Name of the clean room */ + /** + * Name of the clean room + * + * Required. This field must be set in requests. + */ cleanRoomName?: string | undefined; - /** Name of the asset */ + /** + * Name of the asset + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Asset type. Can either be NOTEBOOK_FILE or JAR_ANALYSIS. */ + /** + * Asset type. Can either be NOTEBOOK_FILE or JAR_ANALYSIS. + * + * Required. This field must be set in requests. + */ assetType?: CleanRoomAsset_AssetType | undefined; review?: | {$case: 'notebookReview'; notebookReview: NotebookVersionReview} @@ -785,16 +920,23 @@ export interface CreateCleanRoomAssetReviewResponse { } export interface CreateCleanRoomAutoApprovalRuleRequest { + /** Required. This field must be set in requests. */ autoApprovalRule?: CleanRoomAutoApprovalRule | undefined; } export interface CreateCleanRoomOutputCatalogRequest { - /** Name of the clean room. */ + /** + * Name of the clean room. + * + * Required. This field must be set in requests. + */ cleanRoomName?: string | undefined; + /** Required. This field must be set in requests. */ outputCatalog?: CleanRoomOutputCatalog | undefined; } export interface CreateCleanRoomOutputCatalogResponse { + /** Required. This field must be set in requests. */ outputCatalog?: CleanRoomOutputCatalog | undefined; } @@ -803,11 +945,23 @@ export interface CreateCleanRoomRequest { } export interface DeleteCleanRoomAssetRequest { - /** Name of the clean room. */ + /** + * Name of the clean room. + * + * Required. This field must be set in requests. + */ cleanRoomName?: string | undefined; - /** The type of the asset. */ + /** + * The type of the asset. + * + * Required. This field must be set in requests. + */ assetType?: CleanRoomAsset_AssetType | undefined; - /** The fully qualified name of the asset, it is same as the name field in CleanRoomAsset. */ + /** + * The fully qualified name of the asset, it is same as the name field in CleanRoomAsset. + * + * Required. This field must be set in requests. + */ name?: string | undefined; } @@ -819,12 +973,18 @@ export interface DeleteCleanRoomAssetRequest { export interface DeleteCleanRoomAssetResponse {} export interface DeleteCleanRoomAutoApprovalRuleRequest { + /** Required. This field must be set in requests. */ cleanRoomName?: string | undefined; + /** Required. This field must be set in requests. */ ruleId?: string | undefined; } export interface DeleteCleanRoomRequest { - /** Name of the clean room. */ + /** + * Name of the clean room. + * + * Required. This field must be set in requests. + */ name?: string | undefined; } @@ -898,40 +1058,79 @@ export interface EgressNetworkPolicy_InternetAccessPolicy_StorageDestination { } export interface GetCleanRoomAssetRequest { - /** Name of the clean room. */ + /** + * Name of the clean room. + * + * Required. This field must be set in requests. + */ cleanRoomName?: string | undefined; - /** The type of the asset. */ + /** + * The type of the asset. + * + * Required. This field must be set in requests. + */ assetType?: CleanRoomAsset_AssetType | undefined; - /** The fully qualified name of the asset, it is same as the name field in CleanRoomAsset. */ + /** + * The fully qualified name of the asset, it is same as the name field in CleanRoomAsset. + * + * Required. This field must be set in requests. + */ name?: string | undefined; } export interface GetCleanRoomAssetRevisionRequest { - /** Name of the clean room. */ + /** + * Name of the clean room. + * + * Required. This field must be set in requests. + */ cleanRoomName?: string | undefined; - /** Name of the asset. */ + /** + * Name of the asset. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Asset type. Only NOTEBOOK_FILE is supported. */ + /** + * Asset type. Only NOTEBOOK_FILE is supported. + * + * Required. This field must be set in requests. + */ assetType?: CleanRoomAsset_AssetType | undefined; /** Revision etag to fetch. If not provided, the latest revision will be returned. */ etag?: string | undefined; } export interface GetCleanRoomAutoApprovalRuleRequest { + /** Required. This field must be set in requests. */ cleanRoomName?: string | undefined; + /** Required. This field must be set in requests. */ ruleId?: string | undefined; } export interface GetCleanRoomRequest { + /** Required. This field must be set in requests. */ name?: string | undefined; } export interface ListCleanRoomAssetRevisionsRequest { - /** Name of the clean room. */ + /** + * Name of the clean room. + * + * Required. This field must be set in requests. + */ cleanRoomName?: string | undefined; - /** Name of the asset. */ + /** + * Name of the asset. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Asset type. Only NOTEBOOK_FILE is supported. */ + /** + * Asset type. Only NOTEBOOK_FILE is supported. + * + * Required. This field must be set in requests. + */ assetType?: CleanRoomAsset_AssetType | undefined; /** Maximum number of asset revisions to return. Defaults to 10. */ pageSize?: number | undefined; @@ -945,7 +1144,11 @@ export interface ListCleanRoomAssetRevisionsResponse { } export interface ListCleanRoomAssetsRequest { - /** Name of the clean room. */ + /** + * Name of the clean room. + * + * Required. This field must be set in requests. + */ cleanRoomName?: string | undefined; /** Opaque pagination token to go to next page based on previous query. */ pageToken?: string | undefined; @@ -962,6 +1165,7 @@ export interface ListCleanRoomAssetsResponse { } export interface ListCleanRoomAutoApprovalRulesRequest { + /** Required. This field must be set in requests. */ cleanRoomName?: string | undefined; /** Maximum number of auto-approval rules to return. Defaults to 100. */ pageSize?: number | undefined; @@ -979,7 +1183,11 @@ export interface ListCleanRoomAutoApprovalRulesResponse { } export interface ListCleanRoomNotebookTaskRunsRequest { - /** Name of the clean room. */ + /** + * Name of the clean room. + * + * Required. This field must be set in requests. + */ cleanRoomName?: string | undefined; /** Notebook name */ notebookName?: string | undefined; @@ -1016,9 +1224,17 @@ export interface ListCleanRoomsResponse { } export interface NotebookVersionReview { - /** Etag identifying the notebook version */ + /** + * Etag identifying the notebook version + * + * Required. This field must be set in requests. + */ etag?: string | undefined; - /** Review outcome */ + /** + * Review outcome + * + * Required. This field must be set in requests. + */ reviewState?: CleanRoomNotebookReview_NotebookReviewState | undefined; /** Review comment */ comment?: string | undefined; @@ -1085,6 +1301,8 @@ export interface UpdateCleanRoomAssetRequest { /** * The asset to update. * The asset's `name` and `asset_type` fields are used to identify the asset to update. + * + * Required. This field must be set in requests. */ asset?: CleanRoomAsset | undefined; } @@ -1095,7 +1313,11 @@ export interface UpdateCleanRoomAutoApprovalRuleRequest { } export interface UpdateCleanRoomRequest { - /** Name of the clean room. */ + /** + * Name of the clean room. + * + * Required. This field must be set in requests. + */ name?: string | undefined; cleanRoom?: CleanRoom | undefined; } diff --git a/packages/clusterlibraries/src/v2/model.ts b/packages/clusterlibraries/src/v2/model.ts index be0e5a8c..7e1ead10 100755 --- a/packages/clusterlibraries/src/v2/model.ts +++ b/packages/clusterlibraries/src/v2/model.ts @@ -47,14 +47,26 @@ export interface ClusterLibraryStatuses { } export interface ClusterStatusRequest { - /** Unique identifier of the cluster whose status should be retrieved. */ + /** + * Unique identifier of the cluster whose status should be retrieved. + * + * Required. This field must be set in requests. + */ clusterId?: string | undefined; } export interface InstallLibrariesRequest { - /** Unique identifier for the cluster on which to install these libraries. */ + /** + * Unique identifier for the cluster on which to install these libraries. + * + * Required. This field must be set in requests. + */ clusterId?: string | undefined; - /** The libraries to install. */ + /** + * The libraries to install. + * + * Required. This field must be set in requests. + */ libraries?: Library[] | undefined; } @@ -143,7 +155,11 @@ export interface ListAllClusterLibraryStatusesResponse { } export interface MavenLibrary { - /** Gradle-style maven coordinates. For example: "org.jsoup:jsoup:1.7.2". */ + /** + * Gradle-style maven coordinates. For example: "org.jsoup:jsoup:1.7.2". + * + * Required. This field must be set in requests. + */ coordinates?: string | undefined; /** * Maven repo to install the Maven package from. If omitted, both Maven Central Repository @@ -163,6 +179,8 @@ export interface PythonPyPiLibrary { /** * The name of the pypi package to install. An optional exact version specification is also * supported. Examples: "simplejson" and "simplejson==3.8.0". + * + * Required. This field must be set in requests. */ package?: string | undefined; /** @@ -173,16 +191,28 @@ export interface PythonPyPiLibrary { } export interface RCranLibrary { - /** The name of the CRAN package to install. */ + /** + * The name of the CRAN package to install. + * + * Required. This field must be set in requests. + */ package?: string | undefined; /** The repository where the package can be found. If not specified, the default CRAN repo is used. */ repo?: string | undefined; } export interface UninstallLibrariesRequest { - /** Unique identifier for the cluster on which to uninstall these libraries. */ + /** + * Unique identifier for the cluster on which to uninstall these libraries. + * + * Required. This field must be set in requests. + */ clusterId?: string | undefined; - /** The libraries to uninstall. */ + /** + * The libraries to uninstall. + * + * Required. This field must be set in requests. + */ libraries?: Library[] | undefined; } diff --git a/packages/clusterpolicies/src/v2/model.ts b/packages/clusterpolicies/src/v2/model.ts index 24c4aff8..a9934a73 100755 --- a/packages/clusterpolicies/src/v2/model.ts +++ b/packages/clusterpolicies/src/v2/model.ts @@ -60,7 +60,11 @@ export interface CreatePolicyResponse { } export interface DeletePolicyRequest { - /** The ID of the policy to delete. */ + /** + * The ID of the policy to delete. + * + * Required. This field must be set in requests. + */ policyId?: string | undefined; } @@ -68,7 +72,11 @@ export interface DeletePolicyRequest { export interface DeletePolicyResponse {} export interface EditPolicyRequest { - /** The ID of the policy to update. */ + /** + * The ID of the policy to update. + * + * Required. This field must be set in requests. + */ policyId?: string | undefined; /** * Cluster Policy name requested by the user. This has to be unique. Length must be between 1 and 100 @@ -105,7 +113,11 @@ export interface EditPolicyRequest { export interface EditPolicyResponse {} export interface GetPolicyRequest { - /** Canonical unique identifier for the Cluster Policy. */ + /** + * Canonical unique identifier for the Cluster Policy. + * + * Required. This field must be set in requests. + */ policyId?: string | undefined; } @@ -191,7 +203,11 @@ export interface ListPoliciesResponse { } export interface MavenLibrary { - /** Gradle-style maven coordinates. For example: "org.jsoup:jsoup:1.7.2". */ + /** + * Gradle-style maven coordinates. For example: "org.jsoup:jsoup:1.7.2". + * + * Required. This field must be set in requests. + */ coordinates?: string | undefined; /** * Maven repo to install the Maven package from. If omitted, both Maven Central Repository @@ -258,6 +274,8 @@ export interface PythonPyPiLibrary { /** * The name of the pypi package to install. An optional exact version specification is also * supported. Examples: "simplejson" and "simplejson==3.8.0". + * + * Required. This field must be set in requests. */ package?: string | undefined; /** @@ -268,7 +286,11 @@ export interface PythonPyPiLibrary { } export interface RCranLibrary { - /** The name of the CRAN package to install. */ + /** + * The name of the CRAN package to install. + * + * Required. This field must be set in requests. + */ package?: string | undefined; /** The repository where the package can be found. If not specified, the default CRAN repo is used. */ repo?: string | undefined; diff --git a/packages/clusters/src/v2/model.ts b/packages/clusters/src/v2/model.ts index a53ff1e8..ba92eb31 100755 --- a/packages/clusters/src/v2/model.ts +++ b/packages/clusters/src/v2/model.ts @@ -1084,7 +1084,11 @@ export type ResizeCause_ResizeCause = /** A storage location in Adls Gen2 */ export interface Adlsgen2Info { - /** abfss destination, e.g. `abfss://@.dfs.core.windows.net/`. */ + /** + * abfss destination, e.g. `abfss://@.dfs.core.windows.net/`. + * + * Required. This field must be set in requests. + */ destination?: string | undefined; } @@ -1226,7 +1230,11 @@ export interface AzureAttributes { /** Request to cancel the pending enforcement for a cluster. */ export interface CancelPendingClusterEnforcementRequest { - /** The ID of the cluster to cancel the pending enforcement for. */ + /** + * The ID of the cluster to cancel the pending enforcement for. + * + * Required. This field must be set in requests. + */ clusterId?: string | undefined; /** * If true and no pending enforcement exists, the request will succeed but no action @@ -1244,8 +1252,13 @@ export interface CancelPendingClusterEnforcementRequest { export interface CancelPendingClusterEnforcementResponse {} export interface ChangeClusterOwnerRequest { + /** Required. This field must be set in requests. */ clusterId?: string | undefined; - /** New owner of the cluster_id after this RPC. */ + /** + * New owner of the cluster_id after this RPC. + * + * Required. This field must be set in requests. + */ ownerUsername?: string | undefined; } @@ -1253,7 +1266,11 @@ export interface ChangeClusterOwnerRequest { export interface ChangeClusterOwnerResponse {} export interface CloneCluster { - /** The cluster that is being cloned. */ + /** + * The cluster that is being cloned. + * + * Required. This field must be set in requests. + */ sourceClusterId?: string | undefined; } @@ -1423,7 +1440,11 @@ export interface ClusterAttributes { } export interface ClusterCompliance { - /** Canonical unique identifier for a cluster. */ + /** + * Canonical unique identifier for a cluster. + * + * Required. This field must be set in requests. + */ clusterId?: string | undefined; /** Whether this cluster is in compliance with the latest version of its policy. */ isCompliant?: boolean | undefined; @@ -1441,6 +1462,7 @@ export interface ClusterCompliance { } export interface ClusterEvent { + /** Required. This field must be set in requests. */ clusterId?: string | undefined; /** * The timestamp when the event occurred, stored as the number of milliseconds since @@ -2162,12 +2184,20 @@ export interface DataPlaneEventDetails { /** A storage location in DBFS */ export interface DbfsStorageInfo { - /** dbfs destination, e.g. `dbfs:/my/path` */ + /** + * dbfs destination, e.g. `dbfs:/my/path` + * + * Required. This field must be set in requests. + */ destination?: string | undefined; } export interface DeleteClusterRequest { - /** The cluster to be terminated. */ + /** + * The cluster to be terminated. + * + * Required. This field must be set in requests. + */ clusterId?: string | undefined; } @@ -2194,7 +2224,11 @@ export interface DockerImage { } export interface EditClusterRequest { - /** ID of the cluster */ + /** + * ID of the cluster + * + * Required. This field must be set in requests. + */ clusterId?: string | undefined; /** When set to true, fixed and default values from the policy will be used for fields that are omitted. When set to false, only fixed values from the policy will be applied. */ applyPolicyDefaultValues?: boolean | undefined; @@ -2381,7 +2415,11 @@ export interface EditClusterRequest { export interface EditClusterResponse {} export interface EnforcePolicyComplianceForClusterRequest { - /** The ID of the cluster you want to enforce policy compliance on. */ + /** + * The ID of the cluster you want to enforce policy compliance on. + * + * Required. This field must be set in requests. + */ clusterId?: string | undefined; /** * If set, previews the changes that would be made to a cluster @@ -2739,12 +2777,20 @@ export interface GcpAttributes { /** A storage location in Google Cloud Platform's GCS */ export interface GcsStorageInfo { - /** GCS destination/URI, e.g. `gs://my-bucket/some-prefix` */ + /** + * GCS destination/URI, e.g. `gs://my-bucket/some-prefix` + * + * Required. This field must be set in requests. + */ destination?: string | undefined; } export interface GetClusterRequest { - /** The cluster about which to retrieve information. */ + /** + * The cluster about which to retrieve information. + * + * Required. This field must be set in requests. + */ clusterId?: string | undefined; } @@ -2776,7 +2822,11 @@ export interface GetEventsResponse { } export interface GetPolicyComplianceForClusterRequest { - /** The ID of the cluster to get the compliance status */ + /** + * The ID of the cluster to get the compliance status + * + * Required. This field must be set in requests. + */ clusterId?: string | undefined; } @@ -2985,7 +3035,11 @@ export interface ListAvailableZonesResponse { } export interface ListClusterComplianceForPolicyRequest { - /** Canonical unique identifier for the cluster policy. */ + /** + * Canonical unique identifier for the cluster policy. + * + * Required. This field must be set in requests. + */ policyId?: string | undefined; /** * A page token that can be used to navigate to the next page or previous page as @@ -3037,7 +3091,11 @@ export interface ListClustersResponse { } export interface ListEventsRequest { - /** The ID of the cluster to retrieve events about. */ + /** + * The ID of the cluster to retrieve events about. + * + * Required. This field must be set in requests. + */ clusterId?: string | undefined; /** * The start time in epoch milliseconds. @@ -3093,7 +3151,11 @@ export interface ListNodeTypesResponse { } export interface LocalFileInfo { - /** local file destination, e.g. `file:/my/local/file.sh` */ + /** + * local file destination, e.g. `file:/my/local/file.sh` + * + * Required. This field must be set in requests. + */ destination?: string | undefined; } @@ -3122,7 +3184,11 @@ export interface LogSyncStatus { * It is defined in proto in case we want to send it over the wire in the future (which is likely) */ export interface NodeInstanceType { - /** Unique identifier across instance types */ + /** + * Unique identifier across instance types + * + * Required. This field must be set in requests. + */ instanceTypeId?: string | undefined; /** Number of local disks that are present on this instance. */ localDisks?: number | undefined; @@ -3139,25 +3205,45 @@ export interface NodeInstanceType { * instance type on which it will be hosted. */ export interface NodeType { - /** Unique identifier for this node type. */ + /** + * Unique identifier for this node type. + * + * Required. This field must be set in requests. + */ nodeTypeId?: string | undefined; - /** Memory (in MB) available for this node type. */ + /** + * Memory (in MB) available for this node type. + * + * Required. This field must be set in requests. + */ memoryMb?: number | undefined; /** * Number of CPU cores available for this node type. * Note that this can be fractional, e.g., 2.5 cores, if the number of cores on a * machine instance is not divisible by the number of Spark nodes on that machine. + * + * Required. This field must be set in requests. */ numCores?: number | undefined; - /** A string description associated with this node type, e.g., "r3.xlarge". */ + /** + * A string description associated with this node type, e.g., "r3.xlarge". + * + * Required. This field must be set in requests. + */ description?: string | undefined; - /** An identifier for the type of hardware that this node runs on, e.g., "r3.2xlarge" in AWS. */ + /** + * An identifier for the type of hardware that this node runs on, e.g., "r3.2xlarge" in AWS. + * + * Required. This field must be set in requests. + */ instanceTypeId?: string | undefined; /** Whether the node type is deprecated. Non-deprecated node types offer greater performance. */ isDeprecated?: boolean | undefined; /** * A descriptive category for this node type. Examples include "Memory Optimized" and * "Compute Optimized". + * + * Required. This field must be set in requests. */ category?: string | undefined; /** @@ -3230,7 +3316,11 @@ export interface PendingEnforcement { } export interface PermanentDeleteClusterRequest { - /** The cluster to be deleted. */ + /** + * The cluster to be deleted. + * + * Required. This field must be set in requests. + */ clusterId?: string | undefined; } @@ -3238,6 +3328,7 @@ export interface PermanentDeleteClusterRequest { export interface PermanentDeleteClusterResponse {} export interface PinClusterRequest { + /** Required. This field must be set in requests. */ clusterId?: string | undefined; } @@ -3248,7 +3339,11 @@ export interface PinClusterResponse {} export interface ResizeCause {} export interface ResizeClusterRequest { - /** The cluster to be resized. */ + /** + * The cluster to be resized. + * + * Required. This field must be set in requests. + */ clusterId?: string | undefined; size?: | { @@ -3280,7 +3375,11 @@ export interface ResizeClusterRequest { export interface ResizeClusterResponse {} export interface RestartClusterRequest { - /** The cluster to be started. */ + /** + * The cluster to be started. + * + * Required. This field must be set in requests. + */ clusterId?: string | undefined; restartUser?: string | undefined; } @@ -3294,6 +3393,8 @@ export interface S3StorageInfo { * S3 destination, e.g. `s3://my-bucket/some-prefix` Note that logs will be delivered using * cluster iam role, please make sure you set cluster iam role and the role has write access to the * destination. Please also note that you cannot use AWS keys to deliver logs. + * + * Required. This field must be set in requests. */ destination?: string | undefined; /** @@ -3381,7 +3482,11 @@ export interface SparkVersion { } export interface StartClusterRequest { - /** The cluster to be started. */ + /** + * The cluster to be started. + * + * Required. This field must be set in requests. + */ clusterId?: string | undefined; } @@ -3398,6 +3503,7 @@ export interface TerminationReason { } export interface UnpinClusterRequest { + /** Required. This field must be set in requests. */ clusterId?: string | undefined; } @@ -3405,11 +3511,19 @@ export interface UnpinClusterRequest { export interface UnpinClusterResponse {} export interface UpdateClusterRequest { - /** ID of the cluster. */ + /** + * ID of the cluster. + * + * Required. This field must be set in requests. + */ clusterId?: string | undefined; /** The cluster to be updated. */ cluster?: UpdateClusterRequest_UpdateClusterResource | undefined; - /** Used to specify which cluster attributes and size fields to update. See https://google.aip.dev/161 for more details. */ + /** + * Used to specify which cluster attributes and size fields to update. See https://google.aip.dev/161 for more details. + * + * Required. This field must be set in requests. + */ updateMask?: | FieldMask | undefined; @@ -3604,13 +3718,19 @@ export interface VolumesStorageInfo { /** * UC Volumes destination, e.g. `/Volumes/catalog/schema/vol1/init-scripts/setup-datadog.sh` * or `dbfs:/Volumes/catalog/schema/vol1/init-scripts/setup-datadog.sh` + * + * Required. This field must be set in requests. */ destination?: string | undefined; } /** Cluster Attributes showing for clusters workload types. */ export interface WorkloadType { - /** defined what type of clients can use the cluster. E.g. Notebooks, Jobs */ + /** + * defined what type of clients can use the cluster. E.g. Notebooks, Jobs + * + * Required. This field must be set in requests. + */ clients?: WorkloadType_ClientsTypes | undefined; } @@ -3624,7 +3744,11 @@ export interface WorkloadType_ClientsTypes { /** A storage location in Workspace Filesystem (WSFS) */ export interface WorkspaceStorageInfo { - /** wsfs destination, e.g. `workspace:/cluster-init-scripts/setup-datadog.sh` */ + /** + * wsfs destination, e.g. `workspace:/cluster-init-scripts/setup-datadog.sh` + * + * Required. This field must be set in requests. + */ destination?: string | undefined; } diff --git a/packages/commandexecution/src/v2/model.ts b/packages/commandexecution/src/v2/model.ts index 6b8ae91d..ea3b1cd3 100644 --- a/packages/commandexecution/src/v2/model.ts +++ b/packages/commandexecution/src/v2/model.ts @@ -86,7 +86,9 @@ export interface CreateResponse { } export interface DestroyContextRequest { + /** Required. This field must be set in requests. */ clusterId?: string | undefined; + /** Required. This field must be set in requests. */ contextId?: string | undefined; } @@ -105,8 +107,11 @@ export interface ExecuteCommandRequest { /** Request to get the status of a previously submitted command. */ export interface GetCommandStatusRequest { + /** Required. This field must be set in requests. */ clusterId?: string | undefined; + /** Required. This field must be set in requests. */ contextId?: string | undefined; + /** Required. This field must be set in requests. */ commandId?: string | undefined; } @@ -118,7 +123,9 @@ export interface GetCommandStatusResponse { /** Request to retrieve the status of an execution context. */ export interface GetContextStatusRequest { + /** Required. This field must be set in requests. */ clusterId?: string | undefined; + /** Required. This field must be set in requests. */ contextId?: string | undefined; } diff --git a/packages/customllms/src/v1/model.ts b/packages/customllms/src/v1/model.ts index ffac99e1..e9c8ce95 100644 --- a/packages/customllms/src/v1/model.ts +++ b/packages/customllms/src/v1/model.ts @@ -19,13 +19,22 @@ export const State = { export type State = (typeof State)[keyof typeof State] | (string & {}); export interface CancelCustomLlmOptimizationRunRequest { + /** Required. This field must be set in requests. */ id?: string | undefined; } export interface CreateCustomLlmRequest { - /** Name of the custom LLM. Only alphanumeric characters and dashes allowed. */ + /** + * Name of the custom LLM. Only alphanumeric characters and dashes allowed. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Instructions for the custom LLM to follow */ + /** + * Instructions for the custom LLM to follow + * + * Required. This field must be set in requests. + */ instructions?: string | undefined; /** * Datasets used for training and evaluating the model, not for inference. @@ -44,48 +53,93 @@ export interface CreateCustomLlmRequest { export interface CustomLlm { id?: string | undefined; - /** Name of the custom LLM */ + /** + * Name of the custom LLM + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Name of the endpoint that will be used to serve the custom LLM */ + /** + * Name of the endpoint that will be used to serve the custom LLM + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ endpointName?: string | undefined; - /** Instructions for the custom LLM to follow */ + /** + * Instructions for the custom LLM to follow + * + * Required. This field must be set in requests. + */ instructions?: string | undefined; /** Datasets used for training and evaluating the model, not for inference */ datasets?: Dataset[] | undefined; /** Guidelines for the custom LLM to adhere to */ guidelines?: string[] | undefined; - /** If optimization is kicked off, tracks the state of the custom LLM */ + /** + * If optimization is kicked off, tracks the state of the custom LLM + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ optimizationState?: State | undefined; - /** Creator of the custom LLM */ + /** + * Creator of the custom LLM + * + * Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ creator?: string | undefined; - /** Creation timestamp of the custom LLM */ + /** + * Creation timestamp of the custom LLM + * + * Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ creationTime?: Temporal.Instant | undefined; agentArtifactPath?: string | undefined; } export interface Dataset { + /** Required. This field must be set in requests. */ table?: Table | undefined; } export interface DeleteCustomLlmRequest { - /** The id of the custom llm */ + /** + * The id of the custom llm + * + * Required. This field must be set in requests. + */ id?: string | undefined; } export interface GetCustomLlmRequest { - /** The id of the custom llm */ + /** + * The id of the custom llm + * + * Required. This field must be set in requests. + */ id?: string | undefined; } export interface StartCustomLlmOptimizationRunRequest { - /** The Id of the tile. */ + /** + * The Id of the tile. + * + * Required. This field must be set in requests. + */ id?: string | undefined; } export interface Table { - /** Full UC table path in catalog.schema.table_name format */ + /** + * Full UC table path in catalog.schema.table_name format + * + * Required. This field must be set in requests. + */ tablePath?: string | undefined; - /** Name of the request column */ + /** + * Name of the request column + * + * Required. This field must be set in requests. + */ requestCol?: string | undefined; /** Optional: Name of the response column if the data is labeled */ responseCol?: string | undefined; @@ -94,9 +148,17 @@ export interface Table { export interface UpdateCustomLlmRequest { /** The id of the custom llm */ id?: string | undefined; - /** The CustomLlm containing the fields which should be updated. */ + /** + * The CustomLlm containing the fields which should be updated. + * + * Required. This field must be set in requests. + */ customLlm?: CustomLlm | undefined; - /** The list of the CustomLlm fields to update. These should correspond to the values (or lack thereof) present in `custom_llm`. */ + /** + * The list of the CustomLlm fields to update. These should correspond to the values (or lack thereof) present in `custom_llm`. + * + * Required. This field must be set in requests. + */ updateMask?: FieldMask | undefined; } diff --git a/packages/database/src/v1/model.ts b/packages/database/src/v1/model.ts index 7acbb119..150c3c0c 100755 --- a/packages/database/src/v1/model.ts +++ b/packages/database/src/v1/model.ts @@ -197,25 +197,33 @@ export type SyncedTableSpec_PgSpecificType = | (string & {}); export interface CreateDatabaseCatalogRequest { + /** Required. This field must be set in requests. */ catalog?: DatabaseCatalog | undefined; } export interface CreateDatabaseInstanceRequest { - /** Instance to create. */ + /** + * Instance to create. + * + * Required. This field must be set in requests. + */ databaseInstance?: DatabaseInstance | undefined; } export interface CreateDatabaseInstanceRoleRequest { instanceName?: string | undefined; + /** Required. This field must be set in requests. */ databaseInstanceRole?: DatabaseInstanceRole | undefined; databaseInstanceName?: string | undefined; } export interface CreateDatabaseTableRequest { + /** Required. This field must be set in requests. */ table?: DatabaseTable | undefined; } export interface CreateSyncedDatabaseTableRequest { + /** Required. This field must be set in requests. */ syncedTable?: SyncedDatabaseTable | undefined; } @@ -227,13 +235,27 @@ export interface CustomTag { } export interface DatabaseCatalog { - /** The name of the catalog in UC. */ + /** + * The name of the catalog in UC. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** The name of the DatabaseInstance housing the database. */ + /** + * The name of the DatabaseInstance housing the database. + * + * Required. This field must be set in requests. + */ databaseInstanceName?: string | undefined; - /** The name of the database (in an instance) associated with the catalog. */ + /** + * The name of the database (in an instance) associated with the catalog. + * + * Required. This field must be set in requests. + */ databaseName?: string | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ uid?: string | undefined; + /** Input only. Provide this field in requests; it is never returned in responses. */ createDatabaseIfNotExists?: boolean | undefined; } @@ -244,19 +266,47 @@ export interface DatabaseCredential { /** A DatabaseInstance represents a logical Postgres instance, comprised of both compute and storage. */ export interface DatabaseInstance { - /** An immutable UUID identifier for the instance. */ + /** + * An immutable UUID identifier for the instance. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ uid?: string | undefined; - /** The name of the instance. This is the unique identifier for the instance. */ + /** + * The name of the instance. This is the unique identifier for the instance. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** The email of the creator of the instance. */ + /** + * The email of the creator of the instance. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ creator?: string | undefined; - /** The DNS endpoint to connect to the instance for read+write access. */ + /** + * The DNS endpoint to connect to the instance for read+write access. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ readWriteDns?: string | undefined; - /** The timestamp when the instance was created. */ + /** + * The timestamp when the instance was created. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ creationTime?: Temporal.Instant | undefined; - /** The current state of the instance. */ + /** + * The current state of the instance. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ state?: DatabaseInstance_State | undefined; - /** The version of Postgres running on the instance. */ + /** + * The version of Postgres running on the instance. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ pgVersion?: string | undefined; /** The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8". */ capacity?: string | undefined; @@ -264,19 +314,29 @@ export interface DatabaseInstance { * Deprecated. The sku of the instance; this field will always match the value of capacity. * This is an output only field that contains the value computed from the input field combined with * server side defaults. Use the field without the effective_ prefix to set the value. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ effectiveCapacity?: string | undefined; - /** Whether to stop the instance. An input only param, see effective_stopped for the output. */ + /** + * Whether to stop the instance. An input only param, see effective_stopped for the output. + * + * Input only. Provide this field in requests; it is never returned in responses. + */ stopped?: boolean | undefined; /** * Whether the instance is stopped. * This is an output only field that contains the value computed from the input field combined with * server side defaults. Use the field without the effective_ prefix to set the value. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ effectiveStopped?: boolean | undefined; /** * The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to * 1 primary and 0 secondaries. This field is input only, see effective_node_count for the output. + * + * Input only. Provide this field in requests; it is never returned in responses. */ nodeCount?: number | undefined; /** @@ -284,25 +344,37 @@ export interface DatabaseInstance { * 1 primary and 0 secondaries. * This is an output only field that contains the value computed from the input field combined with * server side defaults. Use the field without the effective_ prefix to set the value. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ effectiveNodeCount?: number | undefined; - /** Whether to enable secondaries to serve read-only traffic. Defaults to false. */ + /** + * Whether to enable secondaries to serve read-only traffic. Defaults to false. + * + * Input only. Provide this field in requests; it is never returned in responses. + */ enableReadableSecondaries?: boolean | undefined; /** * Whether secondaries serving read-only traffic are enabled. Defaults to false. * This is an output only field that contains the value computed from the input field combined with * server side defaults. Use the field without the effective_ prefix to set the value. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ effectiveEnableReadableSecondaries?: boolean | undefined; /** * The DNS endpoint to connect to the instance for read only access. This is only available if * enable_readable_secondaries is true. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ readOnlyDns?: string | undefined; /** * The retention window for the instance. This is the time window in days * for which the historical data is retained. The default value is 7 days. * Valid values are 2 to 35 days. + * + * Input only. Provide this field in requests; it is never returned in responses. */ retentionWindowInDays?: number | undefined; /** @@ -310,6 +382,8 @@ export interface DatabaseInstance { * for which the historical data is retained. * This is an output only field that contains the value computed from the input field combined with * server side defaults. Use the field without the effective_ prefix to set the value. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ effectiveRetentionWindowInDays?: number | undefined; /** @@ -317,35 +391,57 @@ export interface DatabaseInstance { * child instance. * Input: For specifying the parent instance to create a child instance. Optional. * Output: Only populated if provided as input to create a child instance. + * + * Immutable. Set this field when the resource is created; it cannot be changed afterward. */ parentInstanceRef?: DatabaseInstanceRef | undefined; /** * The refs of the child instances. This is only available if the instance is * parent instance. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ childInstanceRefs?: DatabaseInstanceRef[] | undefined; - /** Whether to enable PG native password login on the instance. Defaults to false. */ + /** + * Whether to enable PG native password login on the instance. Defaults to false. + * + * Input only. Provide this field in requests; it is never returned in responses. + */ enablePgNativeLogin?: boolean | undefined; /** * Whether the instance has PG native password login enabled. * This is an output only field that contains the value computed from the input field combined with * server side defaults. Use the field without the effective_ prefix to set the value. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ effectiveEnablePgNativeLogin?: boolean | undefined; - /** The desired usage policy to associate with the instance. */ + /** + * The desired usage policy to associate with the instance. + * + * Input only. Provide this field in requests; it is never returned in responses. + */ usagePolicyId?: string | undefined; /** * The policy that is applied to the instance. * This is an output only field that contains the value computed from the input field combined with * server side defaults. Use the field without the effective_ prefix to set the value. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ effectiveUsagePolicyId?: string | undefined; - /** Custom tags associated with the instance. This field is only included on create and update responses. */ + /** + * Custom tags associated with the instance. This field is only included on create and update responses. + * + * Input only. Provide this field in requests; it is never returned in responses. + */ customTags?: CustomTag[] | undefined; /** * The recorded custom tags associated with the instance. * This is an output only field that contains the value computed from the input field combined with * server side defaults. Use the field without the effective_ prefix to set the value. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ effectiveCustomTags?: CustomTag[] | undefined; } @@ -361,7 +457,11 @@ export interface DatabaseInstance { * the child instance. */ export interface DatabaseInstanceRef { - /** Id of the ref database instance. */ + /** + * Id of the ref database instance. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ uid?: string | undefined; /** Name of the ref database instance. */ name?: string | undefined; @@ -370,6 +470,8 @@ export interface DatabaseInstanceRef { * * Input: For specifying the WAL LSN to create a child instance. Optional. * Output: Only populated if provided as input to create a child instance. + * + * Input only. Provide this field in requests; it is never returned in responses. */ lsn?: string | undefined; /** @@ -379,6 +481,8 @@ export interface DatabaseInstanceRef { * was created. * This is an output only field that contains the value computed from the input field combined with * server side defaults. Use the field without the effective_ prefix to set the value. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ effectiveLsn?: string | undefined; /** @@ -395,7 +499,11 @@ export interface DatabaseInstanceRef { /** A DatabaseInstanceRole represents a Postgres role in a database instance. */ export interface DatabaseInstanceRole { - /** The name of the role. This is the unique identifier for the role in an instance. */ + /** + * The name of the role. This is the unique identifier for the role in an instance. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** The type of the role. */ identityType?: DatabaseInstanceRole_IdentityType | undefined; @@ -407,6 +515,8 @@ export interface DatabaseInstanceRole { * The attributes that are applied to the role. * This is an output only field that contains the value computed from the input field combined with * server side defaults. Use the field without the effective_ prefix to set the value. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ effectiveAttributes?: DatabaseInstanceRole_Attributes | undefined; instanceName?: string | undefined; @@ -427,7 +537,11 @@ export interface DatabaseInstanceRole_Attributes { } export interface DatabaseTable { - /** Full three-part (catalog, schema, table) name of the table. */ + /** + * Full three-part (catalog, schema, table) name of the table. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** * Name of the target database instance. This is required when creating database tables in standard catalogs. @@ -448,6 +562,7 @@ export interface DatabaseTable { } export interface DeleteDatabaseCatalogRequest { + /** Required. This field must be set in requests. */ name?: string | undefined; } @@ -467,7 +582,9 @@ export interface DeleteDatabaseInstanceRequest { } export interface DeleteDatabaseInstanceRoleRequest { + /** Required. This field must be set in requests. */ instanceName?: string | undefined; + /** Required. This field must be set in requests. */ name?: string | undefined; reassignOwnedTo?: string | undefined; /** This is the AIP standard name for the equivalent of Postgres' `IF EXISTS` option */ @@ -475,21 +592,29 @@ export interface DeleteDatabaseInstanceRoleRequest { } export interface DeleteDatabaseTableRequest { + /** Required. This field must be set in requests. */ name?: string | undefined; } export interface DeleteSyncedDatabaseTableRequest { + /** Required. This field must be set in requests. */ name?: string | undefined; /** Optional. When set to true, the actual PostgreSQL table will be dropped from the database. */ purgeData?: boolean | undefined; } export interface DeltaTableSyncInfo { - /** The Delta Lake commit version that was last successfully synced. */ + /** + * The Delta Lake commit version that was last successfully synced. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ deltaCommitVersion?: bigint | undefined; /** * The timestamp when the above Delta version was committed in the source Delta table. * Note: This is the Delta commit time, not the time the data was written to the synced table. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ deltaCommitTimestamp?: Temporal.Instant | undefined; } @@ -515,6 +640,7 @@ export interface GenerateDatabaseCredentialRequest { } export interface GetDatabaseCatalogRequest { + /** Required. This field must be set in requests. */ name?: string | undefined; } @@ -529,10 +655,12 @@ export interface GetDatabaseInstanceRoleRequest { } export interface GetDatabaseTableRequest { + /** Required. This field must be set in requests. */ name?: string | undefined; } export interface GetSyncedDatabaseTableRequest { + /** Required. This field must be set in requests. */ name?: string | undefined; } @@ -560,9 +688,17 @@ export interface ListDatabaseInstanceRolesRequest { } export interface ListDatabaseInstanceRolesResponse { - /** List of database instance roles. */ + /** + * List of database instance roles. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ databaseInstanceRoles?: DatabaseInstanceRole[] | undefined; - /** Pagination token to request the next page of instances. */ + /** + * Pagination token to request the next page of instances. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ nextPageToken?: string | undefined; } @@ -639,13 +775,19 @@ export interface RequestedResource { } export interface SyncedDatabaseTable { - /** Full three-part (catalog, schema, table) name of the table. */ + /** + * Full three-part (catalog, schema, table) name of the table. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** * Name of the target database instance. This is required when creating synced database tables in standard catalogs. * This is optional when creating synced database tables in registered catalogs. If this field is specified * when creating synced database tables in registered catalogs, the database instance name MUST * match that of the registered catalog (or the request will be rejected). + * + * Input only. Provide this field in requests; it is never returned in responses. */ databaseInstanceName?: string | undefined; /** @@ -653,6 +795,8 @@ export interface SyncedDatabaseTable { * tables inside database catalogs is inferred database instance associated with the catalog. * This is an output only field that contains the value computed from the input field combined with * server side defaults. Use the field without the effective_ prefix to set the value. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ effectiveDatabaseInstanceName?: string | undefined; /** @@ -666,12 +810,16 @@ export interface SyncedDatabaseTable { * When creating a synced table in a standard catalog, this field is required. * In this scenario, specifying this field will allow targeting an arbitrary postgres database. * Note that this has implications for the `create_database_objects_is_missing` field in `spec`. + * + * Input only. Provide this field in requests; it is never returned in responses. */ logicalDatabaseName?: string | undefined; /** * The name of the logical database that this table is registered to. * This is an output only field that contains the value computed from the input field combined with * server side defaults. Use the field without the effective_ prefix to set the value. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ effectiveLogicalDatabaseName?: string | undefined; spec?: SyncedTableSpec | undefined; @@ -679,9 +827,15 @@ export interface SyncedDatabaseTable { * The provisioning state of the synced table entity in Unity Catalog. This is distinct from the * state of the data synchronization pipeline (i.e. the table may be in "ACTIVE" but the pipeline * may be in "PROVISIONING" as it runs asynchronously). + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ unityCatalogProvisioningState?: ProvisioningInfo_State | undefined; - /** Synced Table data synchronization status */ + /** + * Synced Table data synchronization status + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ dataSynchronizationStatus?: SyncedTableStatus | undefined; } @@ -690,14 +844,24 @@ export interface SyncedDatabaseTable { * or the SYNCED_UPDATING_PIPELINE_RESOURCES state. */ export interface SyncedTableContinuousUpdateStatus { - /** The last source table Delta version that was successfully synced to the synced table. */ + /** + * The last source table Delta version that was successfully synced to the synced table. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ lastProcessedCommitVersion?: bigint | undefined; /** * The end timestamp of the last time any data was synchronized from the source table to the synced * table. This is when the data is available in the synced table. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ timestamp?: Temporal.Instant | undefined; - /** Progress of the initial data synchronization. */ + /** + * Progress of the initial data synchronization. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ initialPipelineSyncProgress?: SyncedTablePipelineProgress | undefined; } @@ -711,11 +875,15 @@ export interface SyncedTableFailedStatus { * The last source table Delta version that was synced to the synced table. * Only populated if the table is still * synced and available for serving. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ lastProcessedCommitVersion?: bigint | undefined; /** * The end timestamp of the last time any data was synchronized from the source table to the synced * table. Only populated if the table is still synced and available for serving. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ timestamp?: Temporal.Instant | undefined; } @@ -725,17 +893,39 @@ export interface SyncedTablePipelineProgress { /** * The source table Delta version that was last processed by the pipeline. The pipeline may not * have completely processed this version yet. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ latestVersionCurrentlyProcessing?: bigint | undefined; - /** The number of rows that have been synced in this update. */ + /** + * The number of rows that have been synced in this update. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ syncedRowCount?: bigint | undefined; - /** The total number of rows that need to be synced in this update. This number may be an estimate. */ + /** + * The total number of rows that need to be synced in this update. This number may be an estimate. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ totalRowCount?: bigint | undefined; - /** The completion ratio of this update. This is a number between 0 and 1. */ + /** + * The completion ratio of this update. This is a number between 0 and 1. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ syncProgressCompletion?: number | undefined; - /** The estimated time remaining to complete this update in seconds. */ + /** + * The estimated time remaining to complete this update in seconds. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ estimatedCompletionTimeSeconds?: number | undefined; - /** The current phase of the data synchronization pipeline. */ + /** + * The current phase of the data synchronization pipeline. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ provisioningPhase?: ProvisioningPhase | undefined; } @@ -745,16 +935,24 @@ export interface SyncedTablePosition { * to the destination (synced) table. * Note this is the starting timestamp of the sync operation, not the end time. * E.g., for a batch, this is the time when the sync operation started. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ syncStartTimestamp?: Temporal.Instant | undefined; /** * The end timestamp of the most recent successful synchronization. * This is the time when the data is available in the synced table. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ syncEndTimestamp?: Temporal.Instant | undefined; /** Information about the source system at the time of the last sync. */ sourceSyncInfo?: - | {$case: 'deltaTableSyncInfo'; deltaTableSyncInfo: DeltaTableSyncInfo} + | { + $case: 'deltaTableSyncInfo'; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ + deltaTableSyncInfo: DeltaTableSyncInfo; + } | undefined; } @@ -766,6 +964,8 @@ export interface SyncedTableProvisioningStatus { /** * Details about initial data synchronization. Only populated when in the * PROVISIONING_INITIAL_SNAPSHOT state. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ initialPipelineSyncProgress?: SyncedTablePipelineProgress | undefined; } @@ -786,11 +986,15 @@ export interface SyncedTableSpec { * If existing_pipeline_id is defined, the synced table will be bin packed into the existing pipeline * referenced. This avoids creating a new pipeline and allows sharing existing compute. * In this case, the scheduling_policy of this synced table must match the scheduling policy of the existing pipeline. + * + * Input only. Provide this field in requests; it is never returned in responses. */ existingPipelineId?: string | undefined; /** * If true, the synced table's logical database and schema resources in PG * will be created if they do not already exist. + * + * Input only. Provide this field in requests; it is never returned in responses. */ createDatabaseObjectsIfMissing?: boolean | undefined; /** @@ -800,12 +1004,16 @@ export interface SyncedTableSpec { * to store intermediate files (checkpoints, event logs etc). The caller must have write permissions to create Delta * tables in the specified catalog and schema. Again, note this requires write permissions, whereas the source table * only requires read permissions. + * + * Input only. Provide this field in requests; it is never returned in responses. */ newPipelineSpec?: NewPipelineSpec | undefined; /** * When true, enables accelerated sync mode for the initial data load. * This significantly improves performance for large tables. * Requires workspace-level enablement. + * + * Input only. Provide this field in requests; it is never returned in responses. */ acceleratedSync?: boolean | undefined; /** @@ -818,9 +1026,17 @@ export interface SyncedTableSpec { /** Overrides the default Delta-to-PostgreSQL type mapping for a single column. */ // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name. export interface SyncedTableSpec_TypeOverride { - /** Name of the source column whose target PostgreSQL type should be overridden. */ + /** + * Name of the source column whose target PostgreSQL type should be overridden. + * + * Required. This field must be set in requests. + */ columnName?: string | undefined; - /** PostgreSQL-specific target type to use for the column. */ + /** + * PostgreSQL-specific target type to use for the column. + * + * Required. This field must be set in requests. + */ pgType?: SyncedTableSpec_PgSpecificType | undefined; /** * Size parameter for the target type. Required when pg_type is PG_SPECIFIC_TYPE_VECTOR @@ -831,9 +1047,17 @@ export interface SyncedTableSpec_TypeOverride { /** Status of a synced table. */ export interface SyncedTableStatus { - /** The state of the synced table. */ + /** + * The state of the synced table. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ detailedState?: SyncedTableState | undefined; - /** A text description of the current state of the synced table. */ + /** + * A text description of the current state of the synced table. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ message?: string | undefined; /** The detailed status based on the synced table state. */ detailedStatus?: @@ -854,6 +1078,8 @@ export interface SyncedTableStatus { /** * ID of the associated pipeline. The pipeline ID may have been provided by the client * (in the case of bin packing), or generated by the server (when creating a new pipeline). + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ pipelineId?: string | undefined; /** @@ -867,6 +1093,8 @@ export interface SyncedTableStatus { * * This top-level field is a convenience for consumers who want easy access to last sync information * without having to traverse detailed_status. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ lastSync?: SyncedTablePosition | undefined; } @@ -876,37 +1104,66 @@ export interface SyncedTableStatus { * or the SYNCED_NO_PENDING_UPDATE state. */ export interface SyncedTableTriggeredUpdateStatus { - /** The last source table Delta version that was successfully synced to the synced table. */ + /** + * The last source table Delta version that was successfully synced to the synced table. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ lastProcessedCommitVersion?: bigint | undefined; /** * The end timestamp of the last time any data was synchronized from the source table to the synced * table. This is when the data is available in the synced table. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ timestamp?: Temporal.Instant | undefined; - /** Progress of the active data synchronization pipeline. */ + /** + * Progress of the active data synchronization pipeline. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ triggeredUpdateProgress?: SyncedTablePipelineProgress | undefined; } export interface UpdateDatabaseCatalogRequest { - /** Note that updating a database catalog is not yet supported. */ + /** + * Note that updating a database catalog is not yet supported. + * + * Required. This field must be set in requests. + */ databaseCatalog?: DatabaseCatalog | undefined; - /** The list of fields to update. Setting this field is not yet supported. */ + /** + * The list of fields to update. Setting this field is not yet supported. + * + * Required. This field must be set in requests. + */ updateMask?: FieldMask | undefined; } export interface UpdateDatabaseInstanceRequest { + /** Required. This field must be set in requests. */ databaseInstance?: DatabaseInstance | undefined; /** * The list of fields to update. If unspecified, all fields will be updated when possible. To wipe out custom_tags, * specify custom_tags in the update_mask with an empty custom_tags map. + * + * Required. This field must be set in requests. */ updateMask?: FieldMask | undefined; } export interface UpdateSyncedDatabaseTableRequest { - /** Note that updating a synced database table is not yet supported. */ + /** + * Note that updating a synced database table is not yet supported. + * + * Required. This field must be set in requests. + */ syncedTable?: SyncedDatabaseTable | undefined; - /** The list of fields to update. Setting this field is not yet supported. */ + /** + * The list of fields to update. Setting this field is not yet supported. + * + * Required. This field must be set in requests. + */ updateMask?: FieldMask | undefined; } diff --git a/packages/dataclassification/src/v1/model.ts b/packages/dataclassification/src/v1/model.ts index 135b34d7..823c3a05 100755 --- a/packages/dataclassification/src/v1/model.ts +++ b/packages/dataclassification/src/v1/model.ts @@ -25,9 +25,15 @@ export interface AutoTaggingConfig { /** * The Classification Tag. For built-in classes this is a system tag (e.g., "class.name", * "class.location"); for custom classes it is a user-defined governance tag key. + * + * Required. This field must be set in requests. */ classificationTag?: string | undefined; - /** Whether auto-tagging is enabled or disabled for this classification tag. */ + /** + * Whether auto-tagging is enabled or disabled for this classification tag. + * + * Required. This field must be set in requests. + */ autoTaggingMode?: AutoTaggingConfig_AutoTaggingMode | undefined; } @@ -61,7 +67,11 @@ export interface CatalogConfig { /** Wrapper message for a list of schema names. */ // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name. export interface CatalogConfig_SchemaNames { - /** Schema names, each relative to the parent catalog. Must not be empty. */ + /** + * Schema names, each relative to the parent catalog. Must not be empty. + * + * Required. This field must be set in requests. + */ names?: string[] | undefined; } @@ -70,7 +80,11 @@ export interface CatalogConfig_SchemaNames { * Creating a config enables Data Classification for the catalog. */ export interface CreateCatalogConfigRequest { - /** Parent resource in the format: catalogs/{catalog_name} */ + /** + * Parent resource in the format: catalogs/{catalog_name} + * + * Required. This field must be set in requests. + */ parent?: string | undefined; /** The configuration to create. */ catalogConfig?: CatalogConfig | undefined; @@ -81,13 +95,21 @@ export interface CreateCatalogConfigRequest { * Deleting the config disables Data Classification for the catalog. */ export interface DeleteCatalogConfigRequest { - /** Resource name in the format: catalogs/{catalog_name}/config */ + /** + * Resource name in the format: catalogs/{catalog_name}/config + * + * Required. This field must be set in requests. + */ name?: string | undefined; } /** Get Data Classification configuration for a catalog. */ export interface GetCatalogConfigRequest { - /** Resource name in the format: catalogs/{catalog_name}/config */ + /** + * Resource name in the format: catalogs/{catalog_name}/config + * + * Required. This field must be set in requests. + */ name?: string | undefined; } @@ -101,9 +123,15 @@ export interface UpdateCatalogConfigRequest { /** * The configuration to apply to the catalog. * The name field in catalog_config identifies which resource to update. + * + * Required. This field must be set in requests. */ catalogConfig?: CatalogConfig | undefined; - /** Field mask specifying which fields to update. */ + /** + * Field mask specifying which fields to update. + * + * Required. This field must be set in requests. + */ updateMask?: FieldMask | undefined; } diff --git a/packages/dataquality/src/v1/model.ts b/packages/dataquality/src/v1/model.ts index 0b3f2712..66e309de 100755 --- a/packages/dataquality/src/v1/model.ts +++ b/packages/dataquality/src/v1/model.ts @@ -136,7 +136,11 @@ export interface AnomalyDetectionConfig { /** Request to cancel a refresh. */ export interface CancelRefreshRequest { - /** The type of the monitored object. Can be one of the following: `schema` or `table`. */ + /** + * The type of the monitored object. Can be one of the following: `schema` or `table`. + * + * Required. This field must be set in requests. + */ objectType?: string | undefined; /** * The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`. @@ -148,15 +152,25 @@ export interface CancelRefreshRequest { * Find the `table_id` from either: * 1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource. * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field. + * + * Required. This field must be set in requests. */ objectId?: string | undefined; - /** Unique id of the refresh operation. */ + /** + * Unique id of the refresh operation. + * + * Required. This field must be set in requests. + */ refreshId?: bigint | undefined; } /** Response to cancelling a refresh. */ export interface CancelRefreshResponse { - /** The refresh to cancel. */ + /** + * The refresh to cancel. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ refresh?: Refresh | undefined; } @@ -174,21 +188,35 @@ export interface CreateRefreshRequest { /** The data quality monitoring workflow cron schedule. */ export interface CronSchedule { - /** The expression that determines when to run the monitor. See [examples](https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html). */ + /** + * The expression that determines when to run the monitor. See [examples](https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html). + * + * Required. This field must be set in requests. + */ quartzCronExpression?: string | undefined; /** * A Java timezone id. The schedule for a job will be resolved with respect to this timezone. * See `Java TimeZone `_ for details. * The timezone id (e.g., ``America/Los_Angeles``) in which to evaluate the quartz expression. + * + * Required. This field must be set in requests. */ timezoneId?: string | undefined; - /** Read only field that indicates whether the schedule is paused or not. */ + /** + * Read only field that indicates whether the schedule is paused or not. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ pauseStatus?: CronSchedulePauseStatus | undefined; } /** Data Profiling Configurations. */ export interface DataProfilingConfig { - /** ID of the schema where output tables are created. */ + /** + * ID of the schema where output tables are created. + * + * Required. This field must be set in requests. + */ outputSchemaId?: string | undefined; /** * Field for specifying the absolute path to a custom directory to store data-monitoring @@ -241,51 +269,101 @@ export interface DataProfilingConfig { * warehouse will be used. */ warehouseId?: string | undefined; - /** Unity Catalog table to monitor. Format: `catalog.schema.table_name` */ + /** + * Unity Catalog table to monitor. Format: `catalog.schema.table_name` + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ monitoredTableName?: string | undefined; - /** The data profiling monitor status. */ + /** + * The data profiling monitor status. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ status?: DataProfilingStatus | undefined; - /** The latest error message for a monitor failure. */ + /** + * The latest error message for a monitor failure. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ latestMonitorFailureMessage?: string | undefined; - /** Table that stores profile metrics data. Format: `catalog.schema.table_name`. */ + /** + * Table that stores profile metrics data. Format: `catalog.schema.table_name`. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ profileMetricsTableName?: string | undefined; - /** Table that stores drift metrics data. Format: `catalog.schema.table_name`. */ + /** + * Table that stores drift metrics data. Format: `catalog.schema.table_name`. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ driftMetricsTableName?: string | undefined; /** * Id of dashboard that visualizes the computed metrics. * This can be empty if the monitor is in PENDING state. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ dashboardId?: string | undefined; /** * Represents the current monitor configuration version in use. The version will be represented in a * numeric fashion (1,2,3...). The field has flexibility to take on negative values, which can indicate corrupted * monitor_version numbers. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ monitorVersion?: bigint | undefined; - /** The warehouse for dashboard creation */ + /** + * The warehouse for dashboard creation + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ effectiveWarehouseId?: string | undefined; } /** Custom metric definition. */ export interface DataProfilingCustomMetric { - /** Name of the metric in the output tables. */ + /** + * Name of the metric in the output tables. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Jinja template for a SQL expression that specifies how to compute the metric. See [create metric definition](https://docs.databricks.com/en/lakehouse-monitoring/custom-metrics.html#create-definition). */ + /** + * Jinja template for a SQL expression that specifies how to compute the metric. See [create metric definition](https://docs.databricks.com/en/lakehouse-monitoring/custom-metrics.html#create-definition). + * + * Required. This field must be set in requests. + */ definition?: string | undefined; /** * A list of column names in the input table the metric should be computed for. * Can use ``":table"`` to indicate that the metric needs information from multiple columns. + * + * Required. This field must be set in requests. */ inputColumns?: string[] | undefined; - /** The output type of the custom metric. */ + /** + * The output type of the custom metric. + * + * Required. This field must be set in requests. + */ outputDataType?: string | undefined; - /** The type of the custom metric. */ + /** + * The type of the custom metric. + * + * Required. This field must be set in requests. + */ type?: DataProfilingCustomMetricType | undefined; } /** Request to delete a Monitor. */ export interface DeleteMonitorRequest { - /** The type of the monitored object. Can be one of the following: `schema` or `table`. */ + /** + * The type of the monitored object. Can be one of the following: `schema` or `table`. + * + * Required. This field must be set in requests. + */ objectType?: string | undefined; /** * The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`. @@ -297,13 +375,19 @@ export interface DeleteMonitorRequest { * Find the `table_id` from either: * 1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource. * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field. + * + * Required. This field must be set in requests. */ objectId?: string | undefined; } /** Request to delete a ronitor. */ export interface DeleteRefreshRequest { - /** The type of the monitored object. Can be one of the following: `schema` or `table`. */ + /** + * The type of the monitored object. Can be one of the following: `schema` or `table`. + * + * Required. This field must be set in requests. + */ objectType?: string | undefined; /** * The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`. @@ -315,15 +399,25 @@ export interface DeleteRefreshRequest { * Find the `table_id` from either: * 1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource. * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field. + * + * Required. This field must be set in requests. */ objectId?: string | undefined; - /** Unique id of the refresh operation. */ + /** + * Unique id of the refresh operation. + * + * Required. This field must be set in requests. + */ refreshId?: bigint | undefined; } /** Request to get a Monitor. */ export interface GetMonitorRequest { - /** The type of the monitored object. Can be one of the following: `schema` or `table`. */ + /** + * The type of the monitored object. Can be one of the following: `schema` or `table`. + * + * Required. This field must be set in requests. + */ objectType?: string | undefined; /** * The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`. @@ -335,13 +429,19 @@ export interface GetMonitorRequest { * Find the `table_id` from either: * 1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource. * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field. + * + * Required. This field must be set in requests. */ objectId?: string | undefined; } /** Request to get a refresh. */ export interface GetRefreshRequest { - /** The type of the monitored object. Can be one of the following: `schema` or `table`. */ + /** + * The type of the monitored object. Can be one of the following: `schema` or `table`. + * + * Required. This field must be set in requests. + */ objectType?: string | undefined; /** * The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`. @@ -353,25 +453,51 @@ export interface GetRefreshRequest { * Find the `table_id` from either: * 1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource. * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field. + * + * Required. This field must be set in requests. */ objectId?: string | undefined; - /** Unique id of the refresh operation. */ + /** + * Unique id of the refresh operation. + * + * Required. This field must be set in requests. + */ refreshId?: bigint | undefined; } /** Inference log configuration. */ export interface InferenceLogConfig { - /** Problem type the model aims to solve. */ + /** + * Problem type the model aims to solve. + * + * Required. This field must be set in requests. + */ problemType?: InferenceProblemType | undefined; - /** Column for the timestamp. */ + /** + * Column for the timestamp. + * + * Required. This field must be set in requests. + */ timestampColumn?: string | undefined; - /** List of granularities to use when aggregating data into time windows based on their timestamp. */ + /** + * List of granularities to use when aggregating data into time windows based on their timestamp. + * + * Required. This field must be set in requests. + */ granularities?: AggregationGranularity[] | undefined; - /** Column for the prediction. */ + /** + * Column for the prediction. + * + * Required. This field must be set in requests. + */ predictionColumn?: string | undefined; /** Column for the label. */ labelColumn?: string | undefined; - /** Column for the model identifier. */ + /** + * Column for the model identifier. + * + * Required. This field must be set in requests. + */ modelIdColumn?: string | undefined; } @@ -389,7 +515,11 @@ export interface ListMonitorResponse { /** Request to list refreshes. */ export interface ListRefreshRequest { - /** The type of the monitored object. Can be one of the following: `schema` or `table`. */ + /** + * The type of the monitored object. Can be one of the following: `schema` or `table`. + * + * Required. This field must be set in requests. + */ objectType?: string | undefined; /** * The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`. @@ -401,6 +531,8 @@ export interface ListRefreshRequest { * Find the `table_id` from either: * 1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource. * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field. + * + * Required. This field must be set in requests. */ objectId?: string | undefined; pageToken?: string | undefined; @@ -415,7 +547,11 @@ export interface ListRefreshResponse { /** Monitor for the data quality of unity catalog entities such as schema or table. */ export interface Monitor { - /** The type of the monitored object. Can be one of the following: `schema` or `table`. */ + /** + * The type of the monitored object. Can be one of the following: `schema` or `table`. + * + * Required. This field must be set in requests. + */ objectType?: string | undefined; /** * The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`. @@ -427,6 +563,8 @@ export interface Monitor { * Find the `table_id` from either: * 1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource. * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field. + * + * Required. This field must be set in requests. */ objectId?: string | undefined; /** Anomaly Detection Configuration, applicable to `schema` object types. */ @@ -452,7 +590,11 @@ export interface NotificationSettings { /** The Refresh object gives information on a refresh of the data quality monitoring pipeline. */ export interface Refresh { - /** The type of the monitored object. Can be one of the following: `schema` or `table`. */ + /** + * The type of the monitored object. Can be one of the following: `schema` or `table`. + * + * Required. This field must be set in requests. + */ objectType?: string | undefined; /** * The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`. @@ -464,19 +606,45 @@ export interface Refresh { * Find the `table_id` from either: * 1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource. * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field. + * + * Required. This field must be set in requests. */ objectId?: string | undefined; - /** Unique id of the refresh operation. */ + /** + * Unique id of the refresh operation. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ refreshId?: bigint | undefined; - /** The current state of the refresh. */ + /** + * The current state of the refresh. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ state?: RefreshState | undefined; - /** An optional message to give insight into the current state of the refresh (e.g. FAILURE messages). */ + /** + * An optional message to give insight into the current state of the refresh (e.g. FAILURE messages). + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ message?: string | undefined; - /** Time when the refresh started (milliseconds since 1/1/1970 UTC). */ + /** + * Time when the refresh started (milliseconds since 1/1/1970 UTC). + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ startTimeMs?: bigint | undefined; - /** Time when the refresh ended (milliseconds since 1/1/1970 UTC). */ + /** + * Time when the refresh ended (milliseconds since 1/1/1970 UTC). + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ endTimeMs?: bigint | undefined; - /** What triggered the refresh. */ + /** + * What triggered the refresh. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ trigger?: RefreshTrigger | undefined; } @@ -486,15 +654,27 @@ export interface SnapshotConfig {} /** Time series analysis configuration. */ export interface TimeSeriesConfig { - /** Column for the timestamp. */ + /** + * Column for the timestamp. + * + * Required. This field must be set in requests. + */ timestampColumn?: string | undefined; - /** List of granularities to use when aggregating data into time windows based on their timestamp. */ + /** + * List of granularities to use when aggregating data into time windows based on their timestamp. + * + * Required. This field must be set in requests. + */ granularities?: AggregationGranularity[] | undefined; } /** Request to update a Monitor. */ export interface UpdateMonitorRequest { - /** The type of the monitored object. Can be one of the following: `schema` or `table`. */ + /** + * The type of the monitored object. Can be one of the following: `schema` or `table`. + * + * Required. This field must be set in requests. + */ objectType?: string | undefined; /** * The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`. @@ -506,6 +686,8 @@ export interface UpdateMonitorRequest { * Find the `table_id` from either: * 1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource. * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field. + * + * Required. This field must be set in requests. */ objectId?: string | undefined; /** The monitor to update. */ @@ -513,13 +695,19 @@ export interface UpdateMonitorRequest { /** * The field mask to specify which fields to update as a comma-separated list. * Example value: `data_profiling_config.custom_metrics,data_profiling_config.schedule.quartz_cron_expression` + * + * Required. This field must be set in requests. */ updateMask?: FieldMask | undefined; } /** Request to update a refresh. */ export interface UpdateRefreshRequest { - /** The type of the monitored object. Can be one of the following: `schema` or `table`. */ + /** + * The type of the monitored object. Can be one of the following: `schema` or `table`. + * + * Required. This field must be set in requests. + */ objectType?: string | undefined; /** * The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`. @@ -531,13 +719,23 @@ export interface UpdateRefreshRequest { * Find the `table_id` from either: * 1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource. * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field. + * + * Required. This field must be set in requests. */ objectId?: string | undefined; - /** Unique id of the refresh operation. */ + /** + * Unique id of the refresh operation. + * + * Required. This field must be set in requests. + */ refreshId?: bigint | undefined; /** The refresh to update. */ refresh?: Refresh | undefined; - /** The field mask to specify which fields to update. */ + /** + * The field mask to specify which fields to update. + * + * Required. This field must be set in requests. + */ updateMask?: FieldMask | undefined; } diff --git a/packages/disasterrecovery/src/v1/model.ts b/packages/disasterrecovery/src/v1/model.ts index d93f85dd..e7145895 100755 --- a/packages/disasterrecovery/src/v1/model.ts +++ b/packages/disasterrecovery/src/v1/model.ts @@ -44,30 +44,50 @@ export type FailoverGroup_State = /** Request to create a new failover group. */ export interface CreateFailoverGroupRequest { - /** The parent resource. Format: accounts/{account_id}. */ + /** + * The parent resource. Format: accounts/{account_id}. + * + * Required. This field must be set in requests. + */ parent?: string | undefined; - /** The failover group to create. */ + /** + * The failover group to create. + * + * Required. This field must be set in requests. + */ failoverGroup?: FailoverGroup | undefined; /** When true, validates the request without creating the failover group. */ validateOnly?: boolean | undefined; /** * Client-provided identifier for the failover group. Used to construct the * resource name as {parent}/failover-groups/{failover_group_id}. + * + * Required. This field must be set in requests. */ failoverGroupId?: string | undefined; } /** Request to create a new stable URL for failover-aware workspace access. */ export interface CreateStableUrlRequest { - /** The parent resource. Format: accounts/{account_id}. */ + /** + * The parent resource. Format: accounts/{account_id}. + * + * Required. This field must be set in requests. + */ parent?: string | undefined; - /** The stable URL to create. */ + /** + * The stable URL to create. + * + * Required. This field must be set in requests. + */ stableUrl?: StableUrl | undefined; /** When true, validates the request without creating the stable URL. */ validateOnly?: boolean | undefined; /** * Client-provided identifier for the stable URL. Used to construct the * resource name as {parent}/stable-urls/{stable_url_id}. + * + * Required. This field must be set in requests. */ stableUrlId?: string | undefined; } @@ -77,6 +97,8 @@ export interface DeleteFailoverGroupRequest { /** * The fully qualified resource name of the failover group to delete. * Format: accounts/{account_id}/failover-groups/{failover_group_id}. + * + * Required. This field must be set in requests. */ name?: string | undefined; /** @@ -91,6 +113,8 @@ export interface DeleteStableUrlRequest { /** * The fully qualified resource name. * Format: accounts/{account_id}/stable-urls/{stable_url_id}. + * + * Required. This field must be set in requests. */ name?: string | undefined; } @@ -100,11 +124,15 @@ export interface FailoverFailoverGroupRequest { /** * The fully qualified resource name of the failover group to failover. * Format: accounts/{account_id}/failover-groups/{failover_group_id}. + * + * Required. This field must be set in requests. */ name?: string | undefined; /** * The target primary region. Must be one of the participating regions and different * from the current effective_primary_region. Serves as an idempotency check. + * + * Required. This field must be set in requests. */ targetPrimaryRegion?: string | undefined; /** @@ -112,7 +140,11 @@ export interface FailoverFailoverGroupRequest { * current etag. If omitted, the failover proceeds regardless of current state. */ etag?: string | undefined; - /** The type of failover to perform. */ + /** + * The type of failover to perform. + * + * Required. This field must be set in requests. + */ failoverType?: FailoverFailoverGroupRequest_FailoverType | undefined; } @@ -124,32 +156,66 @@ export interface FailoverGroup { /** * Fully qualified resource name in the format * accounts/{account_id}/failover-groups/{failover_group_id}. + * + * Immutable. Set this field when the resource is created; it cannot be changed afterward. */ name?: string | undefined; /** * Current effective primary region. Replication flows FROM workspaces in this region. * Changes after a successful failover. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ effectivePrimaryRegion?: string | undefined; - /** List of all regions participating in this failover group. */ + /** + * List of all regions participating in this failover group. + * + * Required. This field must be set in requests. Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ regions?: string[] | undefined; - /** Workspace sets, each containing workspaces that replicate to each other. */ + /** + * Workspace sets, each containing workspaces that replicate to each other. + * + * Required. This field must be set in requests. + */ workspaceSets?: WorkspaceSet[] | undefined; /** Unity Catalog replication configuration. */ unityCatalogAssets?: UcReplicationConfig | undefined; - /** Aggregate state of the failover group. */ + /** + * Aggregate state of the failover group. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ state?: FailoverGroup_State | undefined; - /** Opaque version string for optimistic locking. Server-generated and returned in responses. */ + /** + * Opaque version string for optimistic locking. Server-generated and returned in responses. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ etag?: string | undefined; - /** Time at which this failover group was created. */ + /** + * Time at which this failover group was created. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createTime?: Temporal.Instant | undefined; - /** Time at which this failover group was last modified. */ + /** + * Time at which this failover group was last modified. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updateTime?: Temporal.Instant | undefined; - /** The latest point in time to which data has been replicated. */ + /** + * The latest point in time to which data has been replicated. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ replicationPoint?: Temporal.Instant | undefined; /** * Initial primary region. Used only in Create requests to set the starting * primary region. Not returned in responses. + * + * Required. This field must be set in requests. Input only. Provide this field in requests; it is never returned in responses. Immutable. Set this field when the resource is created; it cannot be changed afterward. */ initialPrimaryRegion?: string | undefined; } @@ -159,6 +225,8 @@ export interface GetFailoverGroupRequest { /** * The fully qualified resource name of the failover group. * Format: accounts/{account_id}/failover-groups/{failover_group_id}. + * + * Required. This field must be set in requests. */ name?: string | undefined; } @@ -168,13 +236,19 @@ export interface GetStableUrlRequest { /** * The fully qualified resource name. * Format: accounts/{account_id}/stable-urls/{stable_url_id}. + * + * Required. This field must be set in requests. */ name?: string | undefined; } /** Request to list failover groups for an account. */ export interface ListFailoverGroupsRequest { - /** The parent resource. Format: accounts/{account_id}. */ + /** + * The parent resource. Format: accounts/{account_id}. + * + * Required. This field must be set in requests. + */ parent?: string | undefined; /** * Maximum number of failover groups to return per page: @@ -205,7 +279,11 @@ export interface ListFailoverGroupsResponse { /** Request to list stable URLs for an account. */ export interface ListStableUrlsRequest { - /** The parent resource. Format: accounts/{account_id}. */ + /** + * The parent resource. Format: accounts/{account_id}. + * + * Required. This field must be set in requests. + */ parent?: string | undefined; /** * Maximum number of stable URLs to return per page: @@ -239,9 +317,17 @@ export interface ListStableUrlsResponse { * The system derives replication direction from effective_primary_region. */ export interface LocationMapping { - /** Resource name for this location. */ + /** + * Resource name for this location. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** URI for each region. Each entry maps a region name to a storage URI. */ + /** + * URI for each region. Each entry maps a region name to a storage URI. + * + * Required. This field must be set in requests. + */ uriByRegion?: LocationMappingEntry[] | undefined; } @@ -250,9 +336,17 @@ export interface LocationMapping { * Used instead of map for proto2 compatibility. */ export interface LocationMappingEntry { - /** The region name. */ + /** + * The region name. + * + * Required. This field must be set in requests. + */ region?: string | undefined; - /** The storage URI for this region. */ + /** + * The storage URI for this region. + * + * Required. This field must be set in requests. + */ uri?: string | undefined; } @@ -264,6 +358,8 @@ export interface StableUrl { /** * Fully qualified resource name. * Format: accounts/{account_id}/stable-urls/{stable_url_id}. + * + * Immutable. Set this field when the resource is created; it cannot be changed afterward. */ name?: string | undefined; /** @@ -271,12 +367,16 @@ export interface StableUrl { * immutable thereafter. For non-Private-Link workspaces this is * `https:///?w=`. For Private-Link workspaces * this is the per-connection hostname. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. Immutable. Set this field when the resource is created; it cannot be changed afterward. */ url?: string | undefined; /** * The workspace this stable URL is initially bound to. Used only in Create * requests to associate the stable URL with a workspace. Not returned in * responses. + * + * Required. This field must be set in requests. Input only. Provide this field in requests; it is never returned in responses. Immutable. Set this field when the resource is created; it cannot be changed afterward. */ initialWorkspaceId?: string | undefined; /** @@ -284,13 +384,19 @@ export interface StableUrl { * currently linked to, in the format * `accounts/{account_id}/failover-groups/{failover_group_id}`. Empty when * the stable URL is not attached to any failover group. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ failoverGroupName?: string | undefined; } /** A Unity Catalog catalog to replicate. */ export interface UcCatalog { - /** The name of the UC catalog to replicate. */ + /** + * The name of the UC catalog to replicate. + * + * Required. This field must be set in requests. + */ name?: string | undefined; } @@ -298,11 +404,17 @@ export interface UcCatalog { export interface UcReplicationConfig { /** Location mappings - storage URI per region for each location. */ locationMappings?: LocationMapping[] | undefined; - /** UC catalogs to replicate. */ + /** + * UC catalogs to replicate. + * + * Required. This field must be set in requests. + */ catalogs?: UcCatalog[] | undefined; /** * The workspace set whose workspaces will be used for data replication * of all UC catalogs' underlying storage. + * + * Required. This field must be set in requests. */ dataReplicationWorkspaceSet?: string | undefined; } @@ -312,9 +424,15 @@ export interface UpdateFailoverGroupRequest { /** * The failover group with updated fields. The name field identifies the resource * and is populated from the URL path. + * + * Required. This field must be set in requests. */ failoverGroup?: FailoverGroup | undefined; - /** Comma-separated list of fields to update. */ + /** + * Comma-separated list of fields to update. + * + * Required. This field must be set in requests. + */ updateMask?: FieldMask | undefined; /** * Optional opaque version string for optimistic locking, obtained from a prior read of @@ -326,11 +444,17 @@ export interface UpdateFailoverGroupRequest { /** A set of workspaces that replicate to each other across regions. */ export interface WorkspaceSet { - /** Resource name for this workspace set. */ + /** + * Resource name for this workspace set. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** * Workspace IDs in this set. The system derives and validates regions. * All workspaces must be in the Mission Critical tier. + * + * Required. This field must be set in requests. */ workspaceIds?: string[] | undefined; /** diff --git a/packages/environments/src/v1/model.ts b/packages/environments/src/v1/model.ts index 0a9b14c6..e82c3f00 100755 --- a/packages/environments/src/v1/model.ts +++ b/packages/environments/src/v1/model.ts @@ -554,7 +554,11 @@ export interface ApiError { /** Request message for CreateWorkspaceBaseEnvironment. */ export interface CreateWorkspaceBaseEnvironmentRequest { - /** Required. The workspace base environment to create. */ + /** + * Required. The workspace base environment to create. + * + * Required. This field must be set in requests. + */ workspaceBaseEnvironment?: WorkspaceBaseEnvironment | undefined; /** * The ID to use for the workspace base environment, which will become the final component of @@ -578,6 +582,8 @@ export interface DefaultWorkspaceBaseEnvironment { /** * The resource name of this singleton resource. * Format: default-workspace-base-environment + * + * Immutable. Set this field when the resource is created; it cannot be changed afterward. */ name?: string | undefined; /** @@ -597,6 +603,8 @@ export interface DeleteWorkspaceBaseEnvironmentRequest { /** * Required. The resource name of the workspace base environment to delete. * Format: workspace-base-environments/{workspace_base_environment} + * + * Required. This field must be set in requests. */ name?: string | undefined; } @@ -625,6 +633,8 @@ export interface GetDefaultWorkspaceBaseEnvironmentRequest { /** * A static resource name of the default workspace base environment. * Format: default-workspace-base-environment + * + * Required. This field must be set in requests. */ name?: string | undefined; } @@ -640,6 +650,8 @@ export interface GetWorkspaceBaseEnvironmentRequest { /** * Required. The resource name of the workspace base environment to retrieve. * Format: workspace-base-environments/{workspace_base_environment} + * + * Required. This field must be set in requests. */ name?: string | undefined; } @@ -714,13 +726,19 @@ export interface RefreshWorkspaceBaseEnvironmentRequest { /** * Required. The resource name of the workspace base environment to delete. * Format: workspace-base-environments/{workspace_base_environment} + * + * Required. This field must be set in requests. */ name?: string | undefined; } /** Request message for UpdateDefaultWorkspaceBaseEnvironment. */ export interface UpdateDefaultWorkspaceBaseEnvironmentRequest { - /** Required. The default workspace base environment configuration to update. */ + /** + * Required. The default workspace base environment configuration to update. + * + * Required. This field must be set in requests. + */ defaultWorkspaceBaseEnvironment?: DefaultWorkspaceBaseEnvironment | undefined; /** * Field mask specifying which fields to update. Use comma as the separator for multiple fields (no space). @@ -729,16 +747,21 @@ export interface UpdateDefaultWorkspaceBaseEnvironmentRequest { * * To unset one or both defaults, include the field path(s) in the mask and omit them from the request body. * To unset both, you must list both paths explicitly — the wildcard '*' cannot be used to unset fields. + * + * Required. This field must be set in requests. */ updateMask?: FieldMask | undefined; } /** Request message for UpdateWorkspaceBaseEnvironment. */ export interface UpdateWorkspaceBaseEnvironmentRequest { + /** Required. This field must be set in requests. */ name?: string | undefined; /** * Required. The workspace base environment with updated fields. * The name field is used to identify the environment to update. + * + * Required. This field must be set in requests. */ workspaceBaseEnvironment?: WorkspaceBaseEnvironment | undefined; } @@ -753,27 +776,63 @@ export interface WorkspaceBaseEnvironment { * Format: workspace-base-environments/{workspace-base-environment} */ name?: string | undefined; - /** Human-readable display name for the workspace base environment. */ + /** + * Human-readable display name for the workspace base environment. + * + * Required. This field must be set in requests. + */ displayName?: string | undefined; /** The WSFS or UC Volumes path to the environment YAML file. */ filepath?: string | undefined; - /** User ID of the creator. */ + /** + * User ID of the creator. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ creatorUserId?: string | undefined; - /** Timestamp when the environment was created. */ + /** + * Timestamp when the environment was created. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createTime?: Temporal.Instant | undefined; - /** User ID of the last user who updated the environment. */ + /** + * User ID of the last user who updated the environment. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ lastUpdatedUserId?: string | undefined; - /** Timestamp when the environment was last updated. */ + /** + * Timestamp when the environment was last updated. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updateTime?: Temporal.Instant | undefined; - /** The status of the materialized workspace base environment. */ + /** + * The status of the materialized workspace base environment. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ status?: WorkspaceBaseEnvironmentCache_Status | undefined; - /** Status message providing additional details about the environment status. */ + /** + * Status message providing additional details about the environment status. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ message?: string | undefined; - /** Whether this is the default environment for the workspace. */ + /** + * Whether this is the default environment for the workspace. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ isDefault?: boolean | undefined; /** The type of base environment (CPU or GPU). */ baseEnvironmentType?: BaseEnvironmentType | undefined; - /** The environment specification containing version and dependencies. */ + /** + * The environment specification containing version and dependencies. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ spec?: EnvironmentSpec | undefined; } diff --git a/packages/experiments/src/v1/model.ts b/packages/experiments/src/v1/model.ts index 2f309f9c..dd64f7f6 100755 --- a/packages/experiments/src/v1/model.ts +++ b/packages/experiments/src/v1/model.ts @@ -57,7 +57,11 @@ export const ViewType = { export type ViewType = (typeof ViewType)[keyof typeof ViewType] | (string & {}); export interface CreateExperimentRequest { - /** Experiment name. */ + /** + * Experiment name. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** * Location where all artifacts for the experiment are stored. @@ -79,7 +83,11 @@ export interface CreateExperimentResponse { } export interface CreateLoggedModelRequest { - /** The ID of the experiment that owns the model. */ + /** + * The ID of the experiment that owns the model. + * + * Required. This field must be set in requests. + */ experimentId?: string | undefined; /** The name of the model (optional). If not specified one will be generated. */ name?: string | undefined; @@ -125,15 +133,29 @@ export interface CreateRunResponse { * the model development process. */ export interface Dataset { - /** The name of the dataset. E.g. “my.uc.table@2” “nyc-taxi-dataset”, “fantastic-elk-3” */ + /** + * The name of the dataset. E.g. “my.uc.table@2” “nyc-taxi-dataset”, “fantastic-elk-3” + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Dataset digest, e.g. an md5 hash of the dataset that uniquely identifies it within datasets of the same name. */ + /** + * Dataset digest, e.g. an md5 hash of the dataset that uniquely identifies it within datasets of the same name. + * + * Required. This field must be set in requests. + */ digest?: string | undefined; - /** The type of the dataset source, e.g. ‘databricks-uc-table’, ‘DBFS’, ‘S3’, ... */ + /** + * The type of the dataset source, e.g. ‘databricks-uc-table’, ‘DBFS’, ‘S3’, ... + * + * Required. This field must be set in requests. + */ sourceType?: string | undefined; /** * Source information for the dataset. Note that the source may not exactly reproduce the * dataset if it was transformed / modified before use with MLflow. + * + * Required. This field must be set in requests. */ source?: string | undefined; /** @@ -153,12 +175,20 @@ export interface Dataset { export interface DatasetInput { /** A list of tags for the dataset input, e.g. a “context” tag with value “training” */ tags?: InputTag[] | undefined; - /** The dataset being used as a Run input. */ + /** + * The dataset being used as a Run input. + * + * Required. This field must be set in requests. + */ dataset?: Dataset | undefined; } export interface DeleteExperimentRequest { - /** ID of the associated experiment. */ + /** + * ID of the associated experiment. + * + * Required. This field must be set in requests. + */ experimentId?: string | undefined; } @@ -166,7 +196,11 @@ export interface DeleteExperimentRequest { export interface DeleteExperimentResponse {} export interface DeleteLoggedModelRequest { - /** The ID of the logged model to delete. */ + /** + * The ID of the logged model to delete. + * + * Required. This field must be set in requests. + */ modelId?: string | undefined; } @@ -174,9 +208,17 @@ export interface DeleteLoggedModelRequest { export interface DeleteLoggedModelResponse {} export interface DeleteLoggedModelTagRequest { - /** The ID of the logged model to delete the tag from. */ + /** + * The ID of the logged model to delete the tag from. + * + * Required. This field must be set in requests. + */ modelId?: string | undefined; - /** The tag key. */ + /** + * The tag key. + * + * Required. This field must be set in requests. + */ tagKey?: string | undefined; } @@ -184,7 +226,11 @@ export interface DeleteLoggedModelTagRequest { export interface DeleteLoggedModelTagResponse {} export interface DeleteRunRequest { - /** ID of the run to delete. */ + /** + * ID of the run to delete. + * + * Required. This field must be set in requests. + */ runId?: string | undefined; } @@ -192,11 +238,17 @@ export interface DeleteRunRequest { export interface DeleteRunResponse {} export interface DeleteRunsRequest { - /** The ID of the experiment containing the runs to delete. */ + /** + * The ID of the experiment containing the runs to delete. + * + * Required. This field must be set in requests. + */ experimentId?: string | undefined; /** * The maximum creation timestamp in milliseconds since the UNIX epoch for deleting runs. Only runs created prior to * or at this timestamp are deleted. + * + * Required. This field must be set in requests. */ maxTimestampMillis?: bigint | undefined; /** @@ -212,9 +264,17 @@ export interface DeleteRunsResponse { } export interface DeleteTagRequest { - /** ID of the run that the tag was logged under. Must be provided. */ + /** + * ID of the run that the tag was logged under. Must be provided. + * + * Required. This field must be set in requests. + */ runId?: string | undefined; - /** Name of the tag. Maximum size is 255 bytes. Must be provided. */ + /** + * Name of the tag. Maximum size is 255 bytes. Must be provided. + * + * Required. This field must be set in requests. + */ key?: string | undefined; } @@ -261,11 +321,17 @@ export interface FileInfo { } export interface FinalizeLoggedModelRequest { - /** The ID of the logged model to finalize. */ + /** + * The ID of the logged model to finalize. + * + * Required. This field must be set in requests. + */ modelId?: string | undefined; /** * Whether or not the model is ready for use. ``"LOGGED_MODEL_UPLOAD_FAILED"`` indicates that something went wrong * when logging the model weights / agent code. + * + * Required. This field must be set in requests. */ status?: LoggedModelStatus | undefined; } @@ -276,7 +342,11 @@ export interface FinalizeLoggedModelResponse { } export interface GetExperimentByNameRequest { - /** Name of the associated experiment. */ + /** + * Name of the associated experiment. + * + * Required. This field must be set in requests. + */ experimentName?: string | undefined; } @@ -286,7 +356,11 @@ export interface GetExperimentByNameResponse { } export interface GetExperimentRequest { - /** ID of the associated experiment. */ + /** + * ID of the associated experiment. + * + * Required. This field must be set in requests. + */ experimentId?: string | undefined; } @@ -304,7 +378,11 @@ export interface GetExperimentResponse { } export interface GetLoggedModelRequest { - /** The ID of the logged model to retrieve. */ + /** + * The ID of the logged model to retrieve. + * + * Required. This field must be set in requests. + */ modelId?: string | undefined; } @@ -327,7 +405,11 @@ export interface GetMetricHistoryResponse { } export interface GetRunRequest { - /** ID of the run to fetch. Must be provided. */ + /** + * ID of the run to fetch. Must be provided. + * + * Required. This field must be set in requests. + */ runId?: string | undefined; /** * [Deprecated, use `run_id` instead] ID of the run to fetch. This field will @@ -343,9 +425,17 @@ export interface GetRunResponse { /** Tag for a dataset input. */ export interface InputTag { - /** The tag key. */ + /** + * The tag key. + * + * Required. This field must be set in requests. + */ key?: string | undefined; - /** The tag value. */ + /** + * The tag value. + * + * Required. This field must be set in requests. + */ value?: string | undefined; } @@ -413,7 +503,11 @@ export interface ListMetricHistoryRequest { * will be removed in a future MLflow version. */ runUuid?: string | undefined; - /** Name of the metric. */ + /** + * Name of the metric. + * + * Required. This field must be set in requests. + */ metricKey?: string | undefined; /** Token indicating the page of metric histories to fetch. */ pageToken?: string | undefined; @@ -448,7 +542,11 @@ export interface LogBatchRequest { export interface LogBatchResponse {} export interface LogInputsRequest { - /** ID of the run to log under */ + /** + * ID of the run to log under + * + * Required. This field must be set in requests. + */ runId?: string | undefined; /** Dataset inputs */ datasets?: DatasetInput[] | undefined; @@ -460,7 +558,11 @@ export interface LogInputsRequest { export interface LogInputsResponse {} export interface LogLoggedModelParamsRequest { - /** The ID of the logged model to log params for. */ + /** + * The ID of the logged model to log params for. + * + * Required. This field must be set in requests. + */ modelId?: string | undefined; /** Parameters to attach to the model. */ params?: LoggedModelParameter[] | undefined; @@ -477,11 +579,23 @@ export interface LogMetricRequest { * be removed in a future MLflow version. */ runUuid?: string | undefined; - /** Name of the metric. */ + /** + * Name of the metric. + * + * Required. This field must be set in requests. + */ key?: string | undefined; - /** Double value of the metric being logged. */ + /** + * Double value of the metric being logged. + * + * Required. This field must be set in requests. + */ value?: number | undefined; - /** Unix timestamp in milliseconds at the time metric was logged. */ + /** + * Unix timestamp in milliseconds at the time metric was logged. + * + * Required. This field must be set in requests. + */ timestamp?: bigint | undefined; /** Step at which to log the metric */ step?: bigint | undefined; @@ -514,7 +628,11 @@ export interface LogModelRequest { export interface LogModelResponse {} export interface LogOutputsRequest { - /** The ID of the Run from which to log outputs. */ + /** + * The ID of the Run from which to log outputs. + * + * Required. This field must be set in requests. + */ runId?: string | undefined; /** The model outputs from the Run. */ models?: ModelOutput[] | undefined; @@ -531,9 +649,17 @@ export interface LogParamRequest { * be removed in a future MLflow version. */ runUuid?: string | undefined; - /** Name of the param. Maximum size is 255 bytes. */ + /** + * Name of the param. Maximum size is 255 bytes. + * + * Required. This field must be set in requests. + */ key?: string | undefined; - /** String value of the param being logged. Maximum size is 500 bytes. */ + /** + * String value of the param being logged. Maximum size is 500 bytes. + * + * Required. This field must be set in requests. + */ value?: string | undefined; } @@ -638,15 +764,27 @@ export interface Metric { /** Represents a LoggedModel or Registered Model Version input to a Run. */ export interface ModelInput { - /** The unique identifier of the model. */ + /** + * The unique identifier of the model. + * + * Required. This field must be set in requests. + */ modelId?: string | undefined; } /** Represents a LoggedModel output of a Run. */ export interface ModelOutput { - /** The unique identifier of the model. */ + /** + * The unique identifier of the model. + * + * Required. This field must be set in requests. + */ modelId?: string | undefined; - /** The step at which the model was produced. */ + /** + * The step at which the model was produced. + * + * Required. This field must be set in requests. + */ step?: bigint | undefined; } @@ -659,7 +797,11 @@ export interface Param { } export interface RestoreExperimentRequest { - /** ID of the associated experiment. */ + /** + * ID of the associated experiment. + * + * Required. This field must be set in requests. + */ experimentId?: string | undefined; } @@ -667,7 +809,11 @@ export interface RestoreExperimentRequest { export interface RestoreExperimentResponse {} export interface RestoreRunRequest { - /** ID of the run to restore. */ + /** + * ID of the run to restore. + * + * Required. This field must be set in requests. + */ runId?: string | undefined; } @@ -675,11 +821,17 @@ export interface RestoreRunRequest { export interface RestoreRunResponse {} export interface RestoreRunsRequest { - /** The ID of the experiment containing the runs to restore. */ + /** + * The ID of the experiment containing the runs to restore. + * + * Required. This field must be set in requests. + */ experimentId?: string | undefined; /** * The minimum deletion timestamp in milliseconds since the UNIX epoch for restoring runs. Only runs deleted no * earlier than this timestamp are restored. + * + * Required. This field must be set in requests. */ minTimestampMillis?: bigint | undefined; /** @@ -824,7 +976,11 @@ export interface SearchLoggedModelsRequest { // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name. export interface SearchLoggedModelsRequest_Dataset { - /** The name of the dataset. */ + /** + * The name of the dataset. + * + * Required. This field must be set in requests. + */ datasetName?: string | undefined; /** The digest of the dataset. */ datasetDigest?: string | undefined; @@ -832,7 +988,11 @@ export interface SearchLoggedModelsRequest_Dataset { // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name. export interface SearchLoggedModelsRequest_OrderBy { - /** The name of the field to order by, e.g. "metrics.accuracy". */ + /** + * The name of the field to order by, e.g. "metrics.accuracy". + * + * Required. This field must be set in requests. + */ fieldName?: string | undefined; /** Whether the search results order is ascending or not. */ ascending?: boolean | undefined; @@ -901,11 +1061,23 @@ export interface SearchRunsResponse { } export interface SetExperimentTagRequest { - /** ID of the experiment under which to log the tag. Must be provided. */ + /** + * ID of the experiment under which to log the tag. Must be provided. + * + * Required. This field must be set in requests. + */ experimentId?: string | undefined; - /** Name of the tag. Keys up to 250 bytes in size are supported. */ + /** + * Name of the tag. Keys up to 250 bytes in size are supported. + * + * Required. This field must be set in requests. + */ key?: string | undefined; - /** String value of the tag being logged. Values up to 64KB in size are supported. */ + /** + * String value of the tag being logged. Values up to 64KB in size are supported. + * + * Required. This field must be set in requests. + */ value?: string | undefined; } @@ -913,7 +1085,11 @@ export interface SetExperimentTagRequest { export interface SetExperimentTagResponse {} export interface SetLoggedModelTagsRequest { - /** The ID of the logged model to set the tags on. */ + /** + * The ID of the logged model to set the tags on. + * + * Required. This field must be set in requests. + */ modelId?: string | undefined; /** The tags to set on the logged model. */ tags?: LoggedModelTag[] | undefined; @@ -930,9 +1106,17 @@ export interface SetTagRequest { * be removed in a future MLflow version. */ runUuid?: string | undefined; - /** Name of the tag. Keys up to 250 bytes in size are supported. */ + /** + * Name of the tag. Keys up to 250 bytes in size are supported. + * + * Required. This field must be set in requests. + */ key?: string | undefined; - /** String value of the tag being logged. Values up to 64KB in size are supported. */ + /** + * String value of the tag being logged. Values up to 64KB in size are supported. + * + * Required. This field must be set in requests. + */ value?: string | undefined; } @@ -940,7 +1124,11 @@ export interface SetTagRequest { export interface SetTagResponse {} export interface UpdateExperimentRequest { - /** ID of the associated experiment. */ + /** + * ID of the associated experiment. + * + * Required. This field must be set in requests. + */ experimentId?: string | undefined; /** If provided, the experiment's name is changed to the new name. The new name must be unique. */ newName?: string | undefined; diff --git a/packages/features/src/v1/model.ts b/packages/features/src/v1/model.ts index ad383f47..3ebb1119 100755 --- a/packages/features/src/v1/model.ts +++ b/packages/features/src/v1/model.ts @@ -119,7 +119,11 @@ export interface AggregationFunction { /** Computes the approximate count of distinct values. */ export interface ApproxCountDistinctFunction { - /** The input column from which the approximate count of distinct values is computed. */ + /** + * The input column from which the approximate count of distinct values is computed. + * + * Required. This field must be set in requests. + */ input?: string | undefined; /** The maximum relative standard deviation allowed (default defined by Spark). */ relativeSd?: number | undefined; @@ -127,9 +131,17 @@ export interface ApproxCountDistinctFunction { /** Computes the approximate percentile of values. */ export interface ApproxPercentileFunction { - /** The input column from which the approximate percentile is computed. */ + /** + * The input column from which the approximate percentile is computed. + * + * Required. This field must be set in requests. + */ input?: string | undefined; - /** The percentile value to compute (between 0 and 1). */ + /** + * The percentile value to compute (between 0 and 1). + * + * Required. This field must be set in requests. + */ percentile?: number | undefined; /** The accuracy parameter (higher is more accurate but slower). */ accuracy?: bigint | undefined; @@ -157,6 +169,8 @@ export interface AvgFunction { * notation (e.g., "value.amount"). For nested fields, the leaf node name is used. * Colon-prefixed notation (e.g., "value:amount") is supported for backwards * compatibility but is deprecated; migrate to dot notation. + * + * Required. This field must be set in requests. */ input?: string | undefined; } @@ -181,7 +195,11 @@ export interface BackfillSource { } export interface BatchCreateMaterializedFeaturesRequest { - /** The requests to create materialized features. */ + /** + * The requests to create materialized features. + * + * Required. This field must be set in requests. + */ requests?: CreateMaterializedFeatureRequest[] | undefined; } @@ -194,19 +212,29 @@ export interface ColumnIdentifier { /** * String representation of the column name using dot-prefixed path notation. For nested fields, the leaf value is what will be present in materialized tables * and expected to match at query time. For example, the leaf node of value.trip_details.location_details.pickup_zip is pickup_zip. + * + * Required. This field must be set in requests. */ variantExprPath?: string | undefined; } /** A ColumnSelection function, equivalent to the LAST() record of an entity over a lifetime ContinuousWindow */ export interface ColumnSelection { - /** Column name from source to select as the feature value. */ + /** + * Column name from source to select as the feature value. + * + * Required. This field must be set in requests. + */ column?: string | undefined; } /** Deprecated: use RollingWindow with `delay` instead. */ export interface ContinuousWindow { - /** The duration of the continuous window (must be positive). */ + /** + * The duration of the continuous window (must be positive). + * + * Required. This field must be set in requests. + */ windowDuration?: Temporal.Duration | undefined; /** The offset of the continuous window (must be non-positive). */ offset?: Temporal.Duration | undefined; @@ -219,27 +247,42 @@ export interface CountFunction { * notation (e.g., "value.amount"). For nested fields, the leaf node name is used. * Colon-prefixed notation (e.g., "value:amount") is supported for backwards * compatibility but is deprecated; migrate to dot notation. + * + * Required. This field must be set in requests. */ input?: string | undefined; } export interface CreateFeatureRequest { - /** Feature to create. */ + /** + * Feature to create. + * + * Required. This field must be set in requests. + */ feature?: Feature | undefined; } export interface CreateKafkaConfigRequest { + /** Required. This field must be set in requests. */ kafkaConfig?: KafkaConfig | undefined; } export interface CreateMaterializedFeatureRequest { - /** The materialized feature to create. */ + /** + * The materialized feature to create. + * + * Required. This field must be set in requests. + */ materializedFeature?: MaterializedFeature | undefined; } /** Create a Stream, a governed UC entity representing an external streaming data source. */ export interface CreateStreamRequest { - /** The Stream to create. */ + /** + * The Stream to create. + * + * Required. This field must be set in requests. + */ stream?: Stream | undefined; } @@ -276,28 +319,48 @@ export interface DataSource { } export interface DeleteFeatureRequest { - /** Name of the feature to delete. */ + /** + * Name of the feature to delete. + * + * Required. This field must be set in requests. + */ fullName?: string | undefined; } export interface DeleteKafkaConfigRequest { - /** Name of the Kafka config to delete. */ + /** + * Name of the Kafka config to delete. + * + * Required. This field must be set in requests. + */ name?: string | undefined; } export interface DeleteMaterializedFeatureRequest { - /** The ID of the materialized feature to delete. */ + /** + * The ID of the materialized feature to delete. + * + * Required. This field must be set in requests. + */ materializedFeatureId?: string | undefined; } /** Delete a Stream by its full three-part name (catalog.schema.stream). */ export interface DeleteStreamRequest { - /** Full three-part name (catalog.schema.stream) of the Stream to delete. */ + /** + * Full three-part name (catalog.schema.stream) of the Stream to delete. + * + * Required. This field must be set in requests. + */ name?: string | undefined; } export interface DeltaTableSource { - /** The full three-part (catalog, schema, table) name of the Delta table. */ + /** + * The full three-part (catalog, schema, table) name of the Delta table. + * + * Required. This field must be set in requests. + */ fullName?: string | undefined; /** * Deprecated: Use Feature.entity instead. Kept for backwards compatibility. @@ -330,9 +393,17 @@ export interface DeltaTableSource { * Temporarily used until UC Kafka Connections gain mTLS support. */ export interface DirectMtlsConfig { - /** A comma-separated list of host:port pairs for the Kafka bootstrap servers. */ + /** + * A comma-separated list of host:port pairs for the Kafka bootstrap servers. + * + * Required. This field must be set in requests. + */ bootstrapServers?: string | undefined; - /** Mutual-TLS authentication configuration. */ + /** + * Mutual-TLS authentication configuration. + * + * Required. This field must be set in requests. + */ mtlsConfig?: MtlsConfig | undefined; } @@ -361,6 +432,8 @@ export interface EntityColumn { * be present in materialized tables and expected to match at query time. * Colon-prefixed notation (e.g., "value:user_id") is supported for backwards * compatibility but is deprecated; migrate to dot notation. + * + * Required. This field must be set in requests. */ name?: string | undefined; } @@ -370,20 +443,34 @@ export interface Feature { * The full three-part name (catalog, schema, name) of the feature. This is the * feature's resource identifier; the catalog_name, schema_name, and name fields * below are OUTPUT_ONLY decomposed views of this value. + * + * Required. This field must be set in requests. Immutable. Set this field when the resource is created; it cannot be changed afterward. */ fullName?: string | undefined; - /** The data source of the feature. */ + /** + * The data source of the feature. + * + * Required. This field must be set in requests. Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ source?: DataSource | undefined; /** * Deprecated: Use AggregationFunction.inputs instead. Kept for backwards compatibility. * The input columns from which the feature is computed. + * + * Immutable. Set this field when the resource is created; it cannot be changed afterward. */ inputs?: string[] | undefined; - /** The function by which the feature is computed. */ + /** + * The function by which the feature is computed. + * + * Required. This field must be set in requests. Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ function?: Function | undefined; /** * Deprecated: Use Function.aggregation_function.time_window instead. Kept for backwards compatibility. * The time window in which the feature is computed. + * + * Immutable. Set this field when the resource is created; it cannot be changed afterward. */ timeWindow?: TimeWindow | undefined; /** The description of the feature. */ @@ -405,15 +492,35 @@ export interface Feature { entities?: EntityColumn[] | undefined; /** Column recording time, used for point-in-time joins, backfills, and aggregations. */ timeseriesColumn?: TimeseriesColumn | undefined; - /** Name of parent catalog. */ + /** + * Name of parent catalog. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ catalogName?: string | undefined; - /** Name of parent schema relative to its parent catalog. */ + /** + * Name of parent schema relative to its parent catalog. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ schemaName?: string | undefined; - /** Name of the feature, extracted from the full three-part name (catalog.schema.name). */ + /** + * Name of the feature, extracted from the full three-part name (catalog.schema.name). + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ name?: string | undefined; - /** Time at which this feature was created. */ + /** + * Time at which this feature was created. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdAt?: Temporal.Instant | undefined; - /** Username of the feature creator. */ + /** + * Username of the feature creator. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdBy?: string | undefined; } @@ -422,31 +529,59 @@ export interface Feature { * Does not support nested or complex types (arrays, maps, structs). */ export interface FieldDefinition { - /** The name of the field. */ + /** + * The name of the field. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** The scalar data type of the field. */ + /** + * The scalar data type of the field. + * + * Required. This field must be set in requests. + */ dataType?: ScalarDataType | undefined; } /** Returns the first N distinct values, ordered by the feature's timeseries column. */ export interface FirstDistinctNFunction { - /** The input column from which the first N distinct values are returned. */ + /** + * The input column from which the first N distinct values are returned. + * + * Required. This field must be set in requests. + */ input?: string | undefined; - /** The number of distinct values to return. */ + /** + * The number of distinct values to return. + * + * Required. This field must be set in requests. + */ n?: bigint | undefined; } /** Returns the first value. */ export interface FirstFunction { - /** The input column from which the first value is returned. */ + /** + * The input column from which the first value is returned. + * + * Required. This field must be set in requests. + */ input?: string | undefined; } /** Returns the first N values, ordered by the feature's timeseries column. */ export interface FirstNFunction { - /** The input column from which the first N values are returned. */ + /** + * The input column from which the first N values are returned. + * + * Required. This field must be set in requests. + */ input?: string | undefined; - /** The number of values to return. */ + /** + * The number of values to return. + * + * Required. This field must be set in requests. + */ n?: bigint | undefined; } @@ -455,7 +590,11 @@ export interface FirstNFunction { * This schema only supports scalar types. */ export interface FlatSchema { - /** The list of fields in this schema. */ + /** + * The list of fields in this schema. + * + * Required. This field must be set in requests. + */ fields?: FieldDefinition[] | undefined; } @@ -490,30 +629,54 @@ export interface Function { */ // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name. export interface Function_ExtraParameter { - /** The name of the parameter. */ + /** + * The name of the parameter. + * + * Required. This field must be set in requests. + */ key?: string | undefined; - /** The value of the parameter. */ + /** + * The value of the parameter. + * + * Required. This field must be set in requests. + */ value?: string | undefined; } export interface GetFeatureRequest { - /** Name of the feature to get. */ + /** + * Name of the feature to get. + * + * Required. This field must be set in requests. + */ fullName?: string | undefined; } export interface GetKafkaConfigRequest { - /** Name of the Kafka config to get. */ + /** + * Name of the Kafka config to get. + * + * Required. This field must be set in requests. + */ name?: string | undefined; } export interface GetMaterializedFeatureRequest { - /** The ID of the materialized feature. */ + /** + * The ID of the materialized feature. + * + * Required. This field must be set in requests. + */ materializedFeatureId?: string | undefined; } /** Get a Stream by its full three-part name (catalog.schema.stream). */ export interface GetStreamRequest { - /** Full three-part name (catalog.schema.stream) of the Stream to get. */ + /** + * Full three-part name (catalog.schema.stream) of the Stream to get. + * + * Required. This field must be set in requests. + */ name?: string | undefined; } @@ -526,6 +689,8 @@ export interface IngestionConfig { * Destination for the -managed Delta table that holds an offline copy of the streaming data for querying and training. * This table contains both 1) forward-filled data from the Stream and 2) backfilled data from the BackfillSource (if provided). * This table is created and managed by and is deleted when the Stream is deleted. + * + * Required. This field must be set in requests. */ ingestionDestination?: IngestionDestination | undefined; /** @@ -543,11 +708,21 @@ export interface IngestionConfig { /** * The ID of the SDP pipeline that continuously copies new events from the streaming source * into the ingestion Delta table. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ ingestionPipelineId?: string | undefined; - /** The ID of the Databricks Job that performs the forward-fill ingestion. */ + /** + * The ID of the Databricks Job that performs the forward-fill ingestion. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ ingestionJobId?: bigint | undefined; - /** The ID of the Databricks Job that performs the historical backfill of the ingestion Delta table. */ + /** + * The ID of the Databricks Job that performs the historical backfill of the ingestion Delta table. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ backfillJobId?: bigint | undefined; } @@ -573,13 +748,27 @@ export interface KafkaConfig { /** * Name that uniquely identifies this Kafka config within the metastore. This will be the identifier used from the Feature object to reference these configs for a feature. * Can be distinct from topic name. + * + * Required. This field must be set in requests. */ name?: string | undefined; - /** A comma-separated list of host/port pairs pointing to Kafka cluster. */ + /** + * A comma-separated list of host/port pairs pointing to Kafka cluster. + * + * Required. This field must be set in requests. + */ bootstrapServers?: string | undefined; - /** Options to configure which Kafka topics to pull data from. */ + /** + * Options to configure which Kafka topics to pull data from. + * + * Required. This field must be set in requests. + */ subscriptionMode?: SubscriptionMode | undefined; - /** Authentication configuration for connection to topics. */ + /** + * Authentication configuration for connection to topics. + * + * Required. This field must be set in requests. + */ authConfig?: AuthConfig | undefined; /** Schema configuration for extracting message keys from topics. At least one of key_schema and value_schema must be provided. */ keySchema?: SchemaConfig | undefined; @@ -601,7 +790,11 @@ export interface KafkaConfig { } export interface KafkaSource { - /** Name of the Kafka source, used to identify it. This is used to look up the corresponding KafkaConfig object. Can be distinct from topic name. */ + /** + * Name of the Kafka source, used to identify it. This is used to look up the corresponding KafkaConfig object. Can be distinct from topic name. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** * Deprecated: Use Feature.entity instead. Kept for backwards compatibility. @@ -619,7 +812,11 @@ export interface KafkaSource { /** Kafka-specific configuration for a Stream. */ export interface KafkaStreamConfig { - /** Options to configure which Kafka topics to pull data from. */ + /** + * Options to configure which Kafka topics to pull data from. + * + * Required. This field must be set in requests. + */ subscriptionMode?: KafkaSubscriptionMode | undefined; /** * Optional Kafka source or consumer options, validated against a server-side @@ -665,23 +862,43 @@ export interface KafkaSubscriptionMode { /** Returns the last N distinct values, ordered by the feature's timeseries column. */ export interface LastDistinctNFunction { - /** The input column from which the last N distinct values are returned. */ + /** + * The input column from which the last N distinct values are returned. + * + * Required. This field must be set in requests. + */ input?: string | undefined; - /** The number of distinct values to return. */ + /** + * The number of distinct values to return. + * + * Required. This field must be set in requests. + */ n?: bigint | undefined; } /** Returns the last value. */ export interface LastFunction { - /** The input column from which the last value is returned. */ + /** + * The input column from which the last value is returned. + * + * Required. This field must be set in requests. + */ input?: string | undefined; } /** Returns the last N values, ordered by the feature's timeseries column. */ export interface LastNFunction { - /** The input column from which the last N values are returned. */ + /** + * The input column from which the last N values are returned. + * + * Required. This field must be set in requests. + */ input?: string | undefined; - /** The number of values to return. */ + /** + * The number of values to return. + * + * Required. This field must be set in requests. + */ n?: bigint | undefined; } @@ -702,9 +919,17 @@ export interface ListFeaturesRequest { pageToken?: string | undefined; /** The maximum number of results to return. */ pageSize?: number | undefined; - /** Name of parent catalog for features of interest. */ + /** + * Name of parent catalog for features of interest. + * + * Required. This field must be set in requests. + */ catalogName?: string | undefined; - /** Name of parent schema relative to its parent catalog. */ + /** + * Name of parent schema relative to its parent catalog. + * + * Required. This field must be set in requests. + */ schemaName?: string | undefined; } @@ -723,7 +948,11 @@ export interface ListKafkaConfigsRequest { } export interface ListKafkaConfigsResponse { - /** List of Kafka configs. Schemas are not included in the response. */ + /** + * List of Kafka configs. Schemas are not included in the response. + * + * Required. This field must be set in requests. + */ kafkaConfigs?: KafkaConfig[] | undefined; /** Pagination token to request the next page of results for this query. */ nextPageToken?: string | undefined; @@ -785,9 +1014,17 @@ export interface ListStreamsResponse { /** A materialized feature represents a feature that is continuously computed and stored. */ export interface MaterializedFeature { - /** Server-assigned unique identifier for the materialized feature. */ + /** + * Server-assigned unique identifier for the materialized feature. + * + * Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ materializedFeatureId?: string | undefined; - /** The full name of the feature in Unity Catalog. */ + /** + * The full name of the feature in Unity Catalog. + * + * Required. This field must be set in requests. + */ featureName?: string | undefined; destination?: | { @@ -801,7 +1038,11 @@ export interface MaterializedFeature { onlineStoreConfig: OnlineStoreConfig; } | undefined; - /** The fully qualified Unity Catalog path to the table containing the materialized feature (Delta table or Lakebase table). Output only. */ + /** + * The fully qualified Unity Catalog path to the table containing the materialized feature (Delta table or Lakebase table). Output only. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ tableName?: string | undefined; /** * The schedule state of the materialization pipeline. @@ -811,6 +1052,8 @@ export interface MaterializedFeature { /** * The timestamp when the pipeline last ran and updated the materialized feature values. * If the pipeline has not run yet, this field will be null. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ lastMaterializationTime?: Temporal.Instant | undefined; /** @@ -818,7 +1061,11 @@ export interface MaterializedFeature { * Hidden from GraphQL: superseded by the `trigger` oneof (cron_schedule_trigger), so not exposed to Catalog Explorer. */ cronSchedule?: string | undefined; - /** True if this is an online materialized feature. False if it is an offline materialized feature. */ + /** + * True if this is an online materialized feature. False if it is an offline materialized feature. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ isOnline?: boolean | undefined; /** The trigger configuration for the materialization pipeline. */ trigger?: @@ -846,13 +1093,21 @@ export interface MaterializedFeature { /** Computes the maximum value. */ export interface MaxFunction { - /** The input column from which the maximum is computed. */ + /** + * The input column from which the maximum is computed. + * + * Required. This field must be set in requests. + */ input?: string | undefined; } /** Computes the minimum value. */ export interface MinFunction { - /** The input column from which the minimum is computed. */ + /** + * The input column from which the minimum is computed. + * + * Required. This field must be set in requests. + */ input?: string | undefined; } @@ -874,23 +1129,37 @@ export interface MtlsConfig { * Unity Catalog volume path to the JKS keystore file containing the client certificate * and private key. e.g. "/Volumes////client.jks". The * materialization compute must have read permission on this volume. + * + * Required. This field must be set in requests. */ keystoreLocation?: string | undefined; - /** Secret-scope reference for the JKS keystore password. */ + /** + * Secret-scope reference for the JKS keystore password. + * + * Required. This field must be set in requests. + */ keystorePasswordRef?: SecretScopeReference | undefined; /** * Secret-scope reference for the private key password. Often the same value as the * keystore password (keytool's default), but provided as a separate field because * Apache Kafka requires it as a distinct option (kafka.ssl.key.password). + * + * Required. This field must be set in requests. */ keyPasswordRef?: SecretScopeReference | undefined; /** * Unity Catalog volume path to the JKS truststore file containing the CA certificate(s) * trusted to verify the Kafka broker's server certificate. * e.g. "/Volumes////truststore.jks". + * + * Required. This field must be set in requests. */ truststoreLocation?: string | undefined; - /** Secret-scope reference for the JKS truststore password. */ + /** + * Secret-scope reference for the JKS truststore password. + * + * Required. This field must be set in requests. + */ truststorePasswordRef?: SecretScopeReference | undefined; /** * Set to true only when the broker certificate's SAN intentionally does not match @@ -907,13 +1176,23 @@ export interface MtlsConfig { /** Configuration for offline store destination. */ export interface OfflineStoreConfig { - /** The Unity Catalog catalog name. */ + /** + * The Unity Catalog catalog name. + * + * Required. This field must be set in requests. + */ catalogName?: string | undefined; - /** The Unity Catalog schema name. */ + /** + * The Unity Catalog schema name. + * + * Required. This field must be set in requests. + */ schemaName?: string | undefined; /** * Prefix for Unity Catalog table name. * The materialized feature will be stored in a table with this prefix and a generated postfix. + * + * Required. This field must be set in requests. */ tableNamePrefix?: string | undefined; } @@ -923,19 +1202,29 @@ export interface OnlineStoreConfig { /** * The Unity Catalog catalog name. This name is also used as the Lakebase logical database name. * Quoting is handled by the backend where needed, do not pre-quote it. + * + * Required. This field must be set in requests. */ catalogName?: string | undefined; /** * The Unity Catalog schema name. This name is also used as the Lakebase schema name under the database. * Quoting is handled by the backend where needed, do not pre-quote it. + * + * Required. This field must be set in requests. */ schemaName?: string | undefined; /** * Prefix for Unity Catalog table name. * The materialized feature will be stored in a Lakebase table with this prefix and a generated postfix. + * + * Required. This field must be set in requests. */ tableNamePrefix?: string | undefined; - /** The name of the target online store. */ + /** + * The name of the target online store. + * + * Required. This field must be set in requests. + */ onlineStoreName?: string | undefined; } @@ -957,7 +1246,11 @@ export interface RequestSource { * of the legacy non-positive `ContinuousWindow.offset`. */ export interface RollingWindow { - /** The duration of the rolling window (must be positive). */ + /** + * The duration of the rolling window (must be positive). + * + * Required. This field must be set in requests. + */ windowDuration?: Temporal.Duration | undefined; /** * The delay applied to the end of the rolling window (must be non-negative). @@ -981,16 +1274,32 @@ export interface SchemaConfig { * on the Spark cluster at materialization time via dbutils.secrets.get(scope, key). */ export interface SecretScopeReference { - /** The secret scope name. */ + /** + * The secret scope name. + * + * Required. This field must be set in requests. + */ scope?: string | undefined; - /** The key within the scope. */ + /** + * The key within the scope. + * + * Required. This field must be set in requests. + */ key?: string | undefined; } export interface SlidingWindow { - /** The duration of the sliding window. */ + /** + * The duration of the sliding window. + * + * Required. This field must be set in requests. + */ windowDuration?: Temporal.Duration | undefined; - /** The slide duration (interval by which windows advance, must be positive and less than duration). */ + /** + * The slide duration (interval by which windows advance, must be positive and less than duration). + * + * Required. This field must be set in requests. + */ slideDuration?: Temporal.Duration | undefined; } @@ -1001,13 +1310,19 @@ export interface StddevPopFunction { * use dot-prefixed path notation (e.g., "value.amount"). For nested fields, the leaf node name is used. * Colon-prefixed notation (e.g., "value:amount") is supported for backwards * compatibility but is deprecated; migrate to dot notation. + * + * Required. This field must be set in requests. */ input?: string | undefined; } /** Computes the sample standard deviation. */ export interface StddevSampFunction { - /** The input column from which the sample standard deviation is computed. */ + /** + * The input column from which the sample standard deviation is computed. + * + * Required. This field must be set in requests. + */ input?: string | undefined; } @@ -1016,32 +1331,68 @@ export interface StddevSampFunction { * The source_config oneof determines the streaming platform source (e.g. Kafka, Kinesis, etc.). */ export interface Stream { - /** Full three-part (catalog.schema.stream) name of the stream. */ + /** + * Full three-part (catalog.schema.stream) name of the stream. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** User-provided description. */ description?: string | undefined; - /** Source-specific configuration. Determines the streaming platform source. */ + /** + * Source-specific configuration. Determines the streaming platform source. + * + * Required. This field must be set in requests. + */ sourceConfig?: StreamSourceConfig | undefined; - /** Specifies how to connect and authenticate to the stream platform. */ + /** + * Specifies how to connect and authenticate to the stream platform. + * + * Required. This field must be set in requests. + */ connectionConfig?: StreamConnectionConfig | undefined; /** * Schema definitions for the stream. Currently only direct schemas are supported. * In a future milestone, we will support schema registries through a UC Connection. + * + * Required. This field must be set in requests. */ schemaConfig?: StreamSchemaConfig | undefined; - /** Configuration for streaming data ingestion: the managed table storing an offline copy of forward fill data and optional historical backfill. */ + /** + * Configuration for streaming data ingestion: the managed table storing an offline copy of forward fill data and optional historical backfill. + * + * Required. This field must be set in requests. + */ ingestionConfig?: IngestionConfig | undefined; - /** Time at which this Stream was created. */ + /** + * Time at which this Stream was created. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createTime?: Temporal.Instant | undefined; - /** Username of the Stream creator. */ + /** + * Username of the Stream creator. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdBy?: string | undefined; - /** Time at which this Stream was last modified. */ + /** + * Time at which this Stream was last modified. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updateTime?: Temporal.Instant | undefined; - /** Username of user who last modified the Stream. */ + /** + * Username of user who last modified the Stream. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updatedBy?: string | undefined; /** * Indicates whether the principal is limited to retrieving metadata for the * associated object through the BROWSE privilege when include_browse is enabled in the request. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ browseOnly?: boolean | undefined; } @@ -1084,7 +1435,11 @@ export interface StreamSchemaConfig { /** A Stream entity used as a data source for a feature. */ export interface StreamSource { - /** Three-part full name of the Stream (catalog.schema.stream). */ + /** + * Three-part full name of the Stream (catalog.schema.stream). + * + * Required. This field must be set in requests. + */ fullName?: string | undefined; /** The filter condition applied to the source data before aggregation. */ filterCondition?: string | undefined; @@ -1139,6 +1494,8 @@ export interface SumFunction { * notation (e.g., "value.amount"). For nested fields, the leaf node name is used. * Colon-prefixed notation (e.g., "value:amount") is supported for backwards * compatibility but is deprecated; migrate to dot notation. + * + * Required. This field must be set in requests. */ input?: string | undefined; } @@ -1164,56 +1521,100 @@ export interface TimeseriesColumn { * is what will be present in materialized tables and expected to match at query time. * Colon-prefixed notation (e.g., "value:event_timestamp") is supported for * backwards compatibility but is deprecated; migrate to dot notation. + * + * Required. This field must be set in requests. */ name?: string | undefined; } export interface TumblingWindow { - /** The duration of each tumbling window (non-overlapping, fixed-duration windows). */ + /** + * The duration of each tumbling window (non-overlapping, fixed-duration windows). + * + * Required. This field must be set in requests. + */ windowDuration?: Temporal.Duration | undefined; } export interface UpdateFeatureRequest { - /** Feature to update. */ + /** + * Feature to update. + * + * Required. This field must be set in requests. + */ feature?: Feature | undefined; - /** The list of fields to update. */ + /** + * The list of fields to update. + * + * Required. This field must be set in requests. + */ updateMask?: FieldMask | undefined; } export interface UpdateKafkaConfigRequest { - /** The Kafka config to update. */ + /** + * The Kafka config to update. + * + * Required. This field must be set in requests. + */ kafkaConfig?: KafkaConfig | undefined; - /** The list of fields to update. */ + /** + * The list of fields to update. + * + * Required. This field must be set in requests. + */ updateMask?: FieldMask | undefined; } export interface UpdateMaterializedFeatureRequest { - /** The materialized feature to update. */ + /** + * The materialized feature to update. + * + * Required. This field must be set in requests. + */ materializedFeature?: MaterializedFeature | undefined; /** * Provide the materialization feature fields which should be updated. * Currently, only the pipeline_state field can be updated. + * + * Required. This field must be set in requests. */ updateMask?: FieldMask | undefined; } /** Update a Stream. Only fields listed in `update_mask` are mutated. */ export interface UpdateStreamRequest { - /** The Stream to update. */ + /** + * The Stream to update. + * + * Required. This field must be set in requests. + */ stream?: Stream | undefined; - /** The list of fields to update. */ + /** + * The list of fields to update. + * + * Required. This field must be set in requests. + */ updateMask?: FieldMask | undefined; } /** Computes the population variance. */ export interface VarPopFunction { - /** The input column from which the population variance is computed. */ + /** + * The input column from which the population variance is computed. + * + * Required. This field must be set in requests. + */ input?: string | undefined; } /** Computes the sample variance. */ export interface VarSampFunction { - /** The input column from which the sample variance is computed. */ + /** + * The input column from which the sample variance is computed. + * + * Required. This field must be set in requests. + */ input?: string | undefined; } diff --git a/packages/featurestore/src/v1/model.ts b/packages/featurestore/src/v1/model.ts index f2bf0fdf..f8c37fc6 100644 --- a/packages/featurestore/src/v1/model.ts +++ b/packages/featurestore/src/v1/model.ts @@ -53,22 +53,38 @@ export type PublishSpec_PublishMode = | (string & {}); export interface CreateOnlineStoreRequest { - /** Online store to create. */ + /** + * Online store to create. + * + * Required. This field must be set in requests. + */ onlineStore?: OnlineStore | undefined; } export interface DeleteOnlineStoreRequest { - /** Name of the online store to delete. */ + /** + * Name of the online store to delete. + * + * Required. This field must be set in requests. + */ name?: string | undefined; } export interface DeleteOnlineTableRequest { - /** The full three-part (catalog, schema, table) name of the online table. */ + /** + * The full three-part (catalog, schema, table) name of the online table. + * + * Required. This field must be set in requests. + */ onlineTableName?: string | undefined; } export interface GetOnlineStoreRequest { - /** Name of the online store to get. */ + /** + * Name of the online store to get. + * + * Required. This field must be set in requests. + */ name?: string | undefined; } @@ -88,15 +104,35 @@ export interface ListOnlineStoresResponse { /** An OnlineStore is a logical database instance that stores and serves features online. */ export interface OnlineStore { - /** The name of the online store. This is the unique identifier for the online store. */ + /** + * The name of the online store. This is the unique identifier for the online store. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** The email of the creator of the online store. */ + /** + * The email of the creator of the online store. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ creator?: string | undefined; - /** The timestamp when the online store was created. */ + /** + * The timestamp when the online store was created. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ creationTime?: Temporal.Instant | undefined; - /** The current state of the online store. */ + /** + * The current state of the online store. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ state?: OnlineStore_State | undefined; - /** The capacity of the online store. Valid values are "CU_1", "CU_2", "CU_4", "CU_8". */ + /** + * The capacity of the online store. Valid values are "CU_1", "CU_2", "CU_4", "CU_8". + * + * Required. This field must be set in requests. + */ capacity?: string | undefined; /** The number of read replicas for the online store. Defaults to 0. */ readReplicaCount?: number | undefined; @@ -105,18 +141,38 @@ export interface OnlineStore { } export interface PublishSpec { - /** The name of the target online store. */ + /** + * The name of the target online store. + * + * Required. This field must be set in requests. + */ onlineStore?: string | undefined; - /** The full three-part (catalog, schema, table) name of the online table. */ + /** + * The full three-part (catalog, schema, table) name of the online table. + * + * Required. This field must be set in requests. + */ onlineTableName?: string | undefined; - /** The publish mode of the pipeline that syncs the online table with the source table. */ + /** + * The publish mode of the pipeline that syncs the online table with the source table. + * + * Required. This field must be set in requests. + */ publishMode?: PublishSpec_PublishMode | undefined; } export interface PublishTableRequest { - /** The full three-part (catalog, schema, table) name of the source table. */ + /** + * The full three-part (catalog, schema, table) name of the source table. + * + * Required. This field must be set in requests. + */ sourceTableName?: string | undefined; - /** The specification for publishing the online table from the source table. */ + /** + * The specification for publishing the online table from the source table. + * + * Required. This field must be set in requests. + */ publishSpec?: PublishSpec | undefined; } @@ -128,9 +184,17 @@ export interface PublishTableResponse { } export interface UpdateOnlineStoreRequest { - /** Online store to update. */ + /** + * Online store to update. + * + * Required. This field must be set in requests. + */ onlineStore?: OnlineStore | undefined; - /** The list of fields to update. */ + /** + * The list of fields to update. + * + * Required. This field must be set in requests. + */ updateMask?: FieldMask | undefined; } diff --git a/packages/files/src/v2/model.ts b/packages/files/src/v2/model.ts index 89eec1de..bcb85dd4 100755 --- a/packages/files/src/v2/model.ts +++ b/packages/files/src/v2/model.ts @@ -3,9 +3,17 @@ import {z} from 'zod'; export interface AddBlockRequest { - /** The handle on an open stream. */ + /** + * The handle on an open stream. + * + * Required. This field must be set in requests. + */ handle?: bigint | undefined; - /** The base64-encoded data to append to the stream. This has a limit of 1 MB. */ + /** + * The base64-encoded data to append to the stream. This has a limit of 1 MB. + * + * Required. This field must be set in requests. + */ data?: Uint8Array | undefined; } @@ -13,7 +21,11 @@ export interface AddBlockRequest { export interface AddBlockResponse {} export interface CloseRequest { - /** The handle on an open stream. */ + /** + * The handle on an open stream. + * + * Required. This field must be set in requests. + */ handle?: bigint | undefined; } @@ -22,7 +34,11 @@ export interface CloseResponse {} /** Create a directory */ export interface CreateDirectoryRequest { - /** The absolute path of a directory. */ + /** + * The absolute path of a directory. + * + * Required. This field must be set in requests. + */ directoryPath?: string | undefined; } @@ -30,7 +46,11 @@ export interface CreateDirectoryRequest { export interface CreateDirectoryResponse {} export interface CreateRequest { - /** The path of the new file. The path should be the absolute DBFS path. */ + /** + * The path of the new file. The path should be the absolute DBFS path. + * + * Required. This field must be set in requests. + */ path?: string | undefined; /** The flag that specifies whether to overwrite existing file/files. */ overwrite?: boolean | undefined; @@ -43,7 +63,11 @@ export interface CreateResponse { /** Delete a directory */ export interface DeleteDirectoryRequest { - /** The absolute path of a directory. */ + /** + * The absolute path of a directory. + * + * Required. This field must be set in requests. + */ directoryPath?: string | undefined; } @@ -52,7 +76,11 @@ export interface DeleteDirectoryResponse {} /** Delete a file */ export interface DeleteFileRequest { - /** The absolute path of the file. */ + /** + * The absolute path of the file. + * + * Required. This field must be set in requests. + */ filePath?: string | undefined; } @@ -60,7 +88,11 @@ export interface DeleteFileRequest { export interface DeleteFileResponse {} export interface DeleteRequest { - /** The path of the file or directory to delete. The path should be the absolute DBFS path. */ + /** + * The path of the file or directory to delete. The path should be the absolute DBFS path. + * + * Required. This field must be set in requests. + */ path?: string | undefined; /** Whether or not to recursively delete the directory's contents. Deleting empty directories can be done without providing the recursive flag. */ recursive?: boolean | undefined; @@ -84,7 +116,11 @@ export interface DirectoryEntry { /** Download a file */ export interface DownloadFileRequest { - /** The absolute path of the file. */ + /** + * The absolute path of the file. + * + * Required. This field must be set in requests. + */ filePath?: string | undefined; /** * The range of bytes to retrieve. @@ -123,7 +159,11 @@ export interface FileInfo { /** Get directory metadata */ export interface GetDirectoryMetadataRequest { - /** The absolute path of a directory. */ + /** + * The absolute path of a directory. + * + * Required. This field must be set in requests. + */ directoryPath?: string | undefined; } @@ -132,7 +172,11 @@ export interface GetDirectoryMetadataResponse {} /** Get file metadata */ export interface GetFileMetadataRequest { - /** The absolute path of the file. */ + /** + * The absolute path of the file. + * + * Required. This field must be set in requests. + */ filePath?: string | undefined; /** * The range of bytes to retrieve. @@ -157,7 +201,11 @@ export interface GetFileMetadataResponse { } export interface GetStatusRequest { - /** The path of the file or directory. The path should be the absolute DBFS path. */ + /** + * The path of the file or directory. The path should be the absolute DBFS path. + * + * Required. This field must be set in requests. + */ path?: string | undefined; } @@ -174,7 +222,11 @@ export interface GetStatusResponse { /** List directory contents */ export interface ListDirectoryContentsRequest { - /** The absolute path of a directory. */ + /** + * The absolute path of a directory. + * + * Required. This field must be set in requests. + */ directoryPath?: string | undefined; /** * The maximum number of directory entries to return. The response may contain fewer @@ -209,7 +261,11 @@ export interface ListDirectoryResponse { } export interface ListStatusRequest { - /** The path of the file or directory. The path should be the absolute DBFS path. */ + /** + * The path of the file or directory. The path should be the absolute DBFS path. + * + * Required. This field must be set in requests. + */ path?: string | undefined; } @@ -219,7 +275,11 @@ export interface ListStatusResponse { } export interface MkDirsRequest { - /** The path of the new directory. The path should be the absolute DBFS path. */ + /** + * The path of the new directory. The path should be the absolute DBFS path. + * + * Required. This field must be set in requests. + */ path?: string | undefined; } @@ -227,9 +287,17 @@ export interface MkDirsRequest { export interface MkDirsResponse {} export interface MoveRequest { - /** The source path of the file or directory. The path should be the absolute DBFS path. */ + /** + * The source path of the file or directory. The path should be the absolute DBFS path. + * + * Required. This field must be set in requests. + */ sourcePath?: string | undefined; - /** The destination path of the file or directory. The path should be the absolute DBFS path. */ + /** + * The destination path of the file or directory. The path should be the absolute DBFS path. + * + * Required. This field must be set in requests. + */ destinationPath?: string | undefined; } @@ -237,7 +305,11 @@ export interface MoveRequest { export interface MoveResponse {} export interface PutRequest { - /** The path of the new file. The path should be the absolute DBFS path. */ + /** + * The path of the new file. The path should be the absolute DBFS path. + * + * Required. This field must be set in requests. + */ path?: string | undefined; /** This parameter might be absent, and instead a posted file will be used. */ contents?: Uint8Array | undefined; @@ -249,7 +321,11 @@ export interface PutRequest { export interface PutResponse {} export interface ReadRequest { - /** The path of the file to read. The path should be the absolute DBFS path. */ + /** + * The path of the file to read. The path should be the absolute DBFS path. + * + * Required. This field must be set in requests. + */ path?: string | undefined; /** The offset to read from in bytes. */ offset?: bigint | undefined; @@ -272,7 +348,11 @@ export interface ReadResponse { /** Upload a file */ export interface UploadFileRequest { - /** The absolute path of the file. */ + /** + * The absolute path of the file. + * + * Required. This field must be set in requests. + */ filePath?: string | undefined; contents?: ReadableStream | undefined; /** If true or unspecified, an existing file will be overwritten. If false, an error will be returned if the path points to an existing file. */ diff --git a/packages/forecasting/src/v1/model.ts b/packages/forecasting/src/v1/model.ts index ac8a8705..b03b2366 100644 --- a/packages/forecasting/src/v1/model.ts +++ b/packages/forecasting/src/v1/model.ts @@ -21,18 +21,36 @@ export type ForecastingExperiment_State = | (string & {}); export interface CreateForecastingExperimentRequest { - /** The fully qualified path of a Unity Catalog table, formatted as catalog_name.schema_name.table_name, used as training data for the forecasting model. */ + /** + * The fully qualified path of a Unity Catalog table, formatted as catalog_name.schema_name.table_name, used as training data for the forecasting model. + * + * Required. This field must be set in requests. + */ trainDataPath?: string | undefined; - /** The column in the input training table used as the prediction target for model training. The values in this column are used as the ground truth for model training. */ + /** + * The column in the input training table used as the prediction target for model training. The values in this column are used as the ground truth for model training. + * + * Required. This field must be set in requests. + */ targetColumn?: string | undefined; - /** The column in the input training table that represents each row's timestamp. */ + /** + * The column in the input training table that represents each row's timestamp. + * + * Required. This field must be set in requests. + */ timeColumn?: string | undefined; /** * The time interval between consecutive rows in the time series data. * Possible values include: '1 second', '1 minute', '5 minutes', '10 minutes', '15 minutes', '30 minutes', 'Hourly', 'Daily', 'Weekly', 'Monthly', 'Quarterly', 'Yearly'. + * + * Required. This field must be set in requests. */ forecastGranularity?: string | undefined; - /** The number of time steps into the future to make predictions, calculated as a multiple of forecast_granularity. This value represents how far ahead the model should forecast. */ + /** + * The number of time steps into the future to make predictions, calculated as a multiple of forecast_granularity. This value represents how far ahead the model should forecast. + * + * Required. This field must be set in requests. + */ forecastHorizon?: bigint | undefined; /** The evaluation metric used to optimize the forecasting model. */ primaryMetric?: string | undefined; @@ -83,7 +101,11 @@ export interface ForecastingExperiment { } export interface GetForecastingExperimentRequest { - /** The unique ID of a forecasting experiment */ + /** + * The unique ID of a forecasting experiment + * + * Required. This field must be set in requests. + */ experimentId?: string | undefined; } diff --git a/packages/genie/src/v1/model.ts b/packages/genie/src/v1/model.ts index d3771e8b..d048ec52 100755 --- a/packages/genie/src/v1/model.ts +++ b/packages/genie/src/v1/model.ts @@ -923,6 +923,8 @@ export interface DownloadMessageAttachmentVisualizationRequest { /** * The resource name of the attachment to render, in the format * `spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}/attachments/{attachment_id}`. + * + * Required. This field must be set in requests. */ name?: string | undefined; } @@ -989,26 +991,44 @@ export interface GenieAttachment { /** * Text Attachment if Genie responds with text * This also contains the final summary when available. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ text: TextAttachment; } | { $case: 'query'; - /** Query Attachment if Genie responds with a SQL query */ + /** + * Query Attachment if Genie responds with a SQL query + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ query: GenieQueryAttachment; } | { $case: 'suggestedQuestions'; - /** Follow-up questions suggested by Genie */ + /** + * Follow-up questions suggested by Genie + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ suggestedQuestions: GenieSuggestedQuestionsAttachment; } | { $case: 'viz'; - /** Visualization generated by Genie, if requested via `enable_visualization` */ + /** + * Visualization generated by Genie, if requested via `enable_visualization` + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ viz: GenieVizAttachment; } | undefined; - /** Attachment ID */ + /** + * Attachment ID + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ attachmentId?: string | undefined; } @@ -1016,59 +1036,124 @@ export interface GenieConversation { /** * Conversation ID. * Legacy identifier, use conversation_id instead + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ id?: string | undefined; - /** Genie space ID */ + /** + * Genie space ID + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; - /** ID of the user who created the conversation */ + /** + * ID of the user who created the conversation + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ userId?: bigint | undefined; - /** Timestamp when the message was created */ + /** + * Timestamp when the message was created + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdTimestamp?: bigint | undefined; - /** Timestamp when the message was last updated */ + /** + * Timestamp when the message was last updated + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ lastUpdatedTimestamp?: bigint | undefined; - /** Conversation title */ + /** + * Conversation title + * + * Required. This field must be set in requests. + */ title?: string | undefined; - /** Conversation ID */ + /** + * Conversation ID + * + * Required. This field must be set in requests. + */ conversationId?: string | undefined; } export interface GenieConversationSummary { + /** Required. This field must be set in requests. */ conversationId?: string | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ title?: string | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ createdTimestamp?: bigint | undefined; } export interface GenieCreateConversationMessageRequest { - /** The ID associated with the Genie space where the conversation is started. */ + /** + * The ID associated with the Genie space where the conversation is started. + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; - /** The ID associated with the conversation. */ + /** + * The ID associated with the conversation. + * + * Required. This field must be set in requests. + */ conversationId?: string | undefined; - /** User message content. */ + /** + * User message content. + * + * Required. This field must be set in requests. + */ content?: string | undefined; /** Enable visualization generation. */ enableVisualization?: boolean | undefined; } export interface GenieCreateEvalRunRequest { - /** The ID associated with the Genie space where the evaluations will be executed. */ + /** + * The ID associated with the Genie space where the evaluations will be executed. + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; /** List of benchmark question IDs to evaluate. These questions must exist in the specified Genie space. If none are specified, then all benchmark questions are evaluated. */ benchmarkQuestionIds?: string[] | undefined; } export interface GenieCreateMessageCommentRequest { - /** The ID associated with the Genie space. */ + /** + * The ID associated with the Genie space. + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; - /** The ID associated with the conversation. */ + /** + * The ID associated with the conversation. + * + * Required. This field must be set in requests. + */ conversationId?: string | undefined; - /** The ID associated with the message. */ + /** + * The ID associated with the message. + * + * Required. This field must be set in requests. + */ messageId?: string | undefined; - /** Comment text content. */ + /** + * Comment text content. + * + * Required. This field must be set in requests. + */ content?: string | undefined; } export interface GenieCreateSpaceRequest { - /** Warehouse to associate with the new space */ + /** + * Warehouse to associate with the new space + * + * Required. This field must be set in requests. + */ warehouseId?: string | undefined; /** Parent folder path where the space will be registered */ parentPath?: string | undefined; @@ -1076,6 +1161,8 @@ export interface GenieCreateSpaceRequest { * The contents of the Genie Space in serialized string form. * Use the [Get Genie Space](:method:genie/getspace) API to retrieve an example response, which includes the `serialized_space` field. * This field provides the structure of the JSON string that represents the space's layout and components. + * + * Required. This field must be set in requests. */ serializedSpace?: string | undefined; /** Optional title override */ @@ -1085,27 +1172,59 @@ export interface GenieCreateSpaceRequest { } export interface GenieDeleteConversationMessageRequest { - /** The ID associated with the Genie space where the message is located. */ + /** + * The ID associated with the Genie space where the message is located. + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; - /** The ID associated with the conversation. */ + /** + * The ID associated with the conversation. + * + * Required. This field must be set in requests. + */ conversationId?: string | undefined; - /** The ID associated with the message to delete. */ + /** + * The ID associated with the message to delete. + * + * Required. This field must be set in requests. + */ messageId?: string | undefined; } export interface GenieDeleteConversationRequest { - /** The ID associated with the Genie space where the conversation is located. */ + /** + * The ID associated with the Genie space where the conversation is located. + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; - /** The ID of the conversation to delete. */ + /** + * The ID of the conversation to delete. + * + * Required. This field must be set in requests. + */ conversationId?: string | undefined; } export interface GenieEvalResponse { - /** The response content (either text or SQL query). */ + /** + * The response content (either text or SQL query). + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ response?: string | undefined; - /** SQL Statement Execution response. */ + /** + * SQL Statement Execution response. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ sqlExecutionResult?: StatementResponse | undefined; - /** Type of response */ + /** + * Type of response + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ responseType?: GenieEvalResponseType | undefined; } @@ -1114,35 +1233,87 @@ export interface GenieEvalResponse { * For detailed information including SQL execution results, actual/expected responses, and assessment scores, use GenieGetEvalResultDetails. */ export interface GenieEvalResult { - /** Unique identifier for this evaluation result. */ + /** + * Unique identifier for this evaluation result. + * + * Required. This field must be set in requests. + */ resultId?: string | undefined; - /** The ID of the space the evaluation result belongs to. */ + /** + * The ID of the space the evaluation result belongs to. + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; - /** The ID of the benchmark question that was evaluated. */ + /** + * The ID of the benchmark question that was evaluated. + * + * Required. This field must be set in requests. + */ benchmarkQuestionId?: string | undefined; - /** Current status of this evaluation result. */ + /** + * Current status of this evaluation result. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ status?: EvaluationStatusType | undefined; - /** Stored snapshot of original benchmark question text. */ + /** + * Stored snapshot of original benchmark question text. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ question?: string | undefined; - /** Stored snapshot of original benchmark answer text. */ + /** + * Stored snapshot of original benchmark answer text. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ benchmarkAnswer?: string | undefined; - /** User ID who created evaluation result. */ + /** + * User ID who created evaluation result. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdByUser?: bigint | undefined; } /** Shows detailed information for an evaluation result. */ export interface GenieEvalResultDetails { - /** The unique identifier for the evaluation result. */ + /** + * The unique identifier for the evaluation result. + * + * Required. This field must be set in requests. + */ resultId?: string | undefined; - /** The ID of the space the evaluation result belongs to. */ + /** + * The ID of the space the evaluation result belongs to. + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; - /** The ID of the benchmark question that was evaluated. */ + /** + * The ID of the benchmark question that was evaluated. + * + * Required. This field must be set in requests. + */ benchmarkQuestionId?: string | undefined; - /** Current status of the evaluation run. */ + /** + * Current status of the evaluation run. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ evalRunStatus?: EvaluationStatusType | undefined; - /** Assessment of the evaluation result: good, bad, or needs review */ + /** + * Assessment of the evaluation result: good, bad, or needs review + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ assessment?: GenieEvalAssessment | undefined; - /** Whether this evaluation was manually assessed. */ + /** + * Whether this evaluation was manually assessed. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ manualAssessment?: boolean | undefined; /** * Reasons for the assessment score. @@ -1179,16 +1350,30 @@ export interface GenieEvalResultDetails { * - LLM_JUDGE_WRONG_COLUMNS (deprecated) * - LLM_JUDGE_SYNTAX_ERROR (deprecated) * - LLM_JUDGE_SEMANTIC_ERROR (deprecated) + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ assessmentReasons?: ScoreReason[] | undefined; - /** The actual response generated by Genie. */ + /** + * The actual response generated by Genie. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ actualResponse?: GenieEvalResponse[] | undefined; - /** The expected responses from the benchmark. */ + /** + * The expected responses from the benchmark. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ expectedResponse?: GenieEvalResponse[] | undefined; } export interface GenieEvalRunResponse { - /** The unique identifier for the evaluation run. */ + /** + * The unique identifier for the evaluation run. + * + * Required. This field must be set in requests. + */ evalRunId?: string | undefined; /** Current status of the evaluation run. */ evalRunStatus?: EvaluationStatusType | undefined; @@ -1209,22 +1394,50 @@ export interface GenieEvalRunResponse { } export interface GenieExecuteMessageAttachmentQueryRequest { - /** Message ID */ + /** + * Message ID + * + * Required. This field must be set in requests. + */ messageId?: string | undefined; - /** Genie space ID */ + /** + * Genie space ID + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; - /** Conversation ID */ + /** + * Conversation ID + * + * Required. This field must be set in requests. + */ conversationId?: string | undefined; - /** Attachment ID */ + /** + * Attachment ID + * + * Required. This field must be set in requests. + */ attachmentId?: string | undefined; } export interface GenieExecuteMessageQueryRequest { - /** Message ID */ + /** + * Message ID + * + * Required. This field must be set in requests. + */ messageId?: string | undefined; - /** Genie space ID */ + /** + * Genie space ID + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; - /** Conversation ID */ + /** + * Conversation ID + * + * Required. This field must be set in requests. + */ conversationId?: string | undefined; } @@ -1237,13 +1450,29 @@ export interface GenieFeedback { } export interface GenieGenerateDownloadFullQueryResultRequest { - /** Genie space ID */ + /** + * Genie space ID + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; - /** Conversation ID */ + /** + * Conversation ID + * + * Required. This field must be set in requests. + */ conversationId?: string | undefined; - /** Message ID */ + /** + * Message ID + * + * Required. This field must be set in requests. + */ messageId?: string | undefined; - /** Attachment ID */ + /** + * Attachment ID + * + * Required. This field must be set in requests. + */ attachmentId?: string | undefined; } @@ -1255,26 +1484,62 @@ export interface GenieGenerateDownloadFullQueryResultResponse { } export interface GenieGetConversationMessageRequest { - /** The ID associated with the Genie space where the target conversation is located. */ + /** + * The ID associated with the Genie space where the target conversation is located. + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; - /** The ID associated with the target conversation. */ + /** + * The ID associated with the target conversation. + * + * Required. This field must be set in requests. + */ conversationId?: string | undefined; - /** The ID associated with the target message from the identified conversation. */ + /** + * The ID associated with the target message from the identified conversation. + * + * Required. This field must be set in requests. + */ messageId?: string | undefined; } export interface GenieGetDownloadFullQueryResultRequest { - /** Genie space ID */ + /** + * Genie space ID + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; - /** Conversation ID */ + /** + * Conversation ID + * + * Required. This field must be set in requests. + */ conversationId?: string | undefined; - /** Message ID */ + /** + * Message ID + * + * Required. This field must be set in requests. + */ messageId?: string | undefined; - /** Attachment ID */ + /** + * Attachment ID + * + * Required. This field must be set in requests. + */ attachmentId?: string | undefined; - /** Download ID. This ID is provided by the [Generate Download endpoint](:method:genie/generateDownloadFullQueryResult) */ + /** + * Download ID. This ID is provided by the [Generate Download endpoint](:method:genie/generateDownloadFullQueryResult) + * + * Required. This field must be set in requests. + */ downloadId?: string | undefined; - /** JWT signature for the download_id to ensure secure access to query results */ + /** + * JWT signature for the download_id to ensure secure access to query results + * + * Required. This field must be set in requests. + */ downloadIdSignature?: string | undefined; } @@ -1284,37 +1549,82 @@ export interface GenieGetDownloadFullQueryResultResponse { } export interface GenieGetEvalResultDetailsRequest { - /** The ID associated with the Genie space where the evaluation run is located. */ + /** + * The ID associated with the Genie space where the evaluation run is located. + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; - /** The unique identifier for the evaluation run. */ + /** + * The unique identifier for the evaluation run. + * + * Required. This field must be set in requests. + */ evalRunId?: string | undefined; - /** The unique identifier for the evaluation result. */ + /** + * The unique identifier for the evaluation result. + * + * Required. This field must be set in requests. + */ resultId?: string | undefined; } export interface GenieGetEvalRunRequest { - /** The ID associated with the Genie space where the evaluation run is located. */ + /** + * The ID associated with the Genie space where the evaluation run is located. + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; + /** Required. This field must be set in requests. */ evalRunId?: string | undefined; } export interface GenieGetMessageAttachmentQueryResultRequest { - /** Message ID */ + /** + * Message ID + * + * Required. This field must be set in requests. + */ messageId?: string | undefined; - /** Genie space ID */ + /** + * Genie space ID + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; - /** Conversation ID */ + /** + * Conversation ID + * + * Required. This field must be set in requests. + */ conversationId?: string | undefined; - /** Attachment ID */ + /** + * Attachment ID + * + * Required. This field must be set in requests. + */ attachmentId?: string | undefined; } export interface GenieGetMessageQueryResultRequest { - /** Message ID */ + /** + * Message ID + * + * Required. This field must be set in requests. + */ messageId?: string | undefined; - /** Genie space ID */ + /** + * Genie space ID + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; - /** Conversation ID */ + /** + * Conversation ID + * + * Required. This field must be set in requests. + */ conversationId?: string | undefined; } @@ -1324,18 +1634,38 @@ export interface GenieGetMessageQueryResultResponse { } export interface GenieGetQueryResultByAttachmentRequest { - /** Message ID */ + /** + * Message ID + * + * Required. This field must be set in requests. + */ messageId?: string | undefined; - /** Genie space ID */ + /** + * Genie space ID + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; - /** Conversation ID */ + /** + * Conversation ID + * + * Required. This field must be set in requests. + */ conversationId?: string | undefined; - /** Attachment ID */ + /** + * Attachment ID + * + * Required. This field must be set in requests. + */ attachmentId?: string | undefined; } export interface GenieGetSpaceRequest { - /** The ID associated with the Genie space */ + /** + * The ID associated with the Genie space + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; /** * Whether to include the serialized space export in the response. @@ -1345,9 +1675,17 @@ export interface GenieGetSpaceRequest { } export interface GenieListConversationCommentsRequest { - /** The ID associated with the Genie space. */ + /** + * The ID associated with the Genie space. + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; - /** The ID associated with the conversation. */ + /** + * The ID associated with the conversation. + * + * Required. This field must be set in requests. + */ conversationId?: string | undefined; /** Maximum number of comments to return per page. */ pageSize?: number | undefined; @@ -1363,9 +1701,17 @@ export interface GenieListConversationCommentsResponse { } export interface GenieListConversationMessagesRequest { - /** The ID associated with the Genie space where the conversation is located */ + /** + * The ID associated with the Genie space where the conversation is located + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; - /** The ID of the conversation to list messages from */ + /** + * The ID of the conversation to list messages from + * + * Required. This field must be set in requests. + */ conversationId?: string | undefined; /** Maximum number of messages to return per page */ pageSize?: number | undefined; @@ -1381,7 +1727,11 @@ export interface GenieListConversationMessagesResponse { } export interface GenieListConversationsRequest { - /** The ID of the Genie space to retrieve conversations from. */ + /** + * The ID of the Genie space to retrieve conversations from. + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; /** Maximum number of conversations to return per page */ pageSize?: number | undefined; @@ -1402,9 +1752,17 @@ export interface GenieListConversationsResponse { } export interface GenieListEvalResultsRequest { - /** The ID associated with the Genie space where the evaluation run is located. */ + /** + * The ID associated with the Genie space where the evaluation run is located. + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; - /** The unique identifier for the evaluation run. */ + /** + * The unique identifier for the evaluation run. + * + * Required. This field must be set in requests. + */ evalRunId?: string | undefined; /** Maximum number of eval results to return per page. */ pageSize?: number | undefined; @@ -1420,7 +1778,11 @@ export interface GenieListEvalResultsResponse { } export interface GenieListEvalRunsRequest { - /** The ID associated with the Genie space where the evaluation run is located. */ + /** + * The ID associated with the Genie space where the evaluation run is located. + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; /** Maximum number of evaluation runs to return per page */ pageSize?: number | undefined; @@ -1436,11 +1798,23 @@ export interface GenieListEvalRunsResponse { } export interface GenieListMessageCommentsRequest { - /** The ID associated with the Genie space. */ + /** + * The ID associated with the Genie space. + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; - /** The ID associated with the conversation. */ + /** + * The ID associated with the conversation. + * + * Required. This field must be set in requests. + */ conversationId?: string | undefined; - /** The ID associated with the message. */ + /** + * The ID associated with the message. + * + * Required. This field must be set in requests. + */ messageId?: string | undefined; /** Maximum number of comments to return per page. */ pageSize?: number | undefined; @@ -1473,51 +1847,124 @@ export interface GenieMessage { /** * Message ID. * Legacy identifier, use message_id instead + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ id?: string | undefined; - /** Genie space ID */ + /** + * Genie space ID + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; - /** Conversation ID */ + /** + * Conversation ID + * + * Required. This field must be set in requests. + */ conversationId?: string | undefined; - /** ID of the user who created the message */ + /** + * ID of the user who created the message + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ userId?: bigint | undefined; - /** Timestamp when the message was created */ + /** + * Timestamp when the message was created + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdTimestamp?: bigint | undefined; - /** Timestamp when the message was last updated */ + /** + * Timestamp when the message was last updated + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ lastUpdatedTimestamp?: bigint | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ status?: MessageStatus_MessageStatus | undefined; - /** User message content */ + /** + * User message content + * + * Required. This field must be set in requests. + */ content?: string | undefined; - /** AI-generated response to the message */ + /** + * AI-generated response to the message + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ attachments?: GenieAttachment[] | undefined; /** * The result of SQL query if the message includes a query attachment. * Deprecated. Use `query_result_metadata` in `GenieQueryAttachment` instead. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ queryResult?: Result | undefined; - /** Error message if Genie failed to respond to the message */ + /** + * Error message if Genie failed to respond to the message + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ error?: MessageError | undefined; - /** Message ID */ + /** + * Message ID + * + * Required. This field must be set in requests. + */ messageId?: string | undefined; - /** User feedback for the message if provided */ + /** + * User feedback for the message if provided + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ feedback?: GenieFeedback | undefined; } /** A comment on a Genie conversation message. */ export interface GenieMessageComment { - /** Genie space ID */ + /** + * Genie space ID + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; - /** Conversation ID */ + /** + * Conversation ID + * + * Required. This field must be set in requests. + */ conversationId?: string | undefined; - /** Message ID */ + /** + * Message ID + * + * Required. This field must be set in requests. + */ messageId?: string | undefined; - /** Comment ID */ + /** + * Comment ID + * + * Required. This field must be set in requests. + */ messageCommentId?: string | undefined; - /** ID of the user who created the comment */ + /** + * ID of the user who created the comment + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ userId?: bigint | undefined; - /** Comment text content */ + /** + * Comment text content + * + * Required. This field must be set in requests. + */ content?: string | undefined; - /** Timestamp when the comment was created */ + /** + * Timestamp when the comment was created + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdTimestamp?: bigint | undefined; } @@ -1528,42 +1975,91 @@ export interface GenieQueryAttachment { query?: string | undefined; /** Description of the query */ description?: string | undefined; - /** Time when the user updated the query last */ + /** + * Time when the user updated the query last + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ lastUpdatedTimestamp?: bigint | undefined; parameters?: QueryAttachmentParameter[] | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ id?: string | undefined; - /** Statement Execution API statement id. Use [Get status, manifest, and result first chunk](:method:statementexecution/getstatement) to get the full result data. */ + /** + * Statement Execution API statement id. Use [Get status, manifest, and result first chunk](:method:statementexecution/getstatement) to get the full result data. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ statementId?: string | undefined; - /** Metadata associated with the query result. */ + /** + * Metadata associated with the query result. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ queryResultMetadata?: GenieResultMetadata | undefined; - /** Insights into how Genie came to generate the SQL. */ + /** + * Insights into how Genie came to generate the SQL. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ thoughts?: Thought[] | undefined; } export interface GenieResultMetadata { - /** The number of rows in the result set. */ + /** + * The number of rows in the result set. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ rowCount?: bigint | undefined; - /** Indicates whether the result set is truncated. */ + /** + * Indicates whether the result set is truncated. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ isTruncated?: boolean | undefined; } export interface GenieSendMessageFeedbackRequest { - /** The ID associated with the Genie space where the message is located. */ + /** + * The ID associated with the Genie space where the message is located. + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; - /** The ID associated with the conversation. */ + /** + * The ID associated with the conversation. + * + * Required. This field must be set in requests. + */ conversationId?: string | undefined; - /** The ID associated with the message to provide feedback for. */ + /** + * The ID associated with the message to provide feedback for. + * + * Required. This field must be set in requests. + */ messageId?: string | undefined; - /** The rating (POSITIVE, NEGATIVE, or NONE). */ + /** + * The rating (POSITIVE, NEGATIVE, or NONE). + * + * Required. This field must be set in requests. + */ rating?: GenieFeedbackRating | undefined; /** Optional text feedback that will be stored as a comment. */ comment?: string | undefined; } export interface GenieSpace { - /** Genie space ID */ + /** + * Genie space ID + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; - /** Title of the Genie Space */ + /** + * Title of the Genie Space + * + * Required. This field must be set in requests. + */ title?: string | undefined; /** Description of the Genie Space */ description?: string | undefined; @@ -1581,41 +2077,71 @@ export interface GenieSpace { /** * ETag for this space. Pass this value back in the update request to prevent overwriting * concurrent changes. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ etag?: string | undefined; } export interface GenieStartConversationRequest { - /** The ID associated with the Genie space where you want to start a conversation. */ + /** + * The ID associated with the Genie space where you want to start a conversation. + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; - /** The text of the message that starts the conversation. */ + /** + * The text of the message that starts the conversation. + * + * Required. This field must be set in requests. + */ content?: string | undefined; /** Enable visualization generation. */ enableVisualization?: boolean | undefined; } export interface GenieStartConversationResponse { - /** Message ID */ + /** + * Message ID + * + * Required. This field must be set in requests. + */ messageId?: string | undefined; message?: GenieMessage | undefined; - /** Conversation ID */ + /** + * Conversation ID + * + * Required. This field must be set in requests. + */ conversationId?: string | undefined; conversation?: GenieConversation | undefined; } /** Follow-up questions suggested by Genie */ export interface GenieSuggestedQuestionsAttachment { - /** The suggested follow-up questions */ + /** + * The suggested follow-up questions + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ questions?: string[] | undefined; } export interface GenieTrashSpaceRequest { - /** The ID associated with the Genie space to be sent to the trash. */ + /** + * The ID associated with the Genie space to be sent to the trash. + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; } export interface GenieUpdateSpaceRequest { - /** Genie space ID */ + /** + * Genie space ID + * + * Required. This field must be set in requests. + */ spaceId?: string | undefined; /** * The contents of the Genie Space in serialized string form (full replacement). @@ -1643,9 +2169,17 @@ export interface GenieUpdateSpaceRequest { * with the download visualization API to retrieve the rendered image. */ export interface GenieVizAttachment { - /** Name of the visualization */ + /** + * Name of the visualization + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ title?: string | undefined; - /** The ID of the query attachment the visualization was generated from */ + /** + * The ID of the query attachment the visualization was generated from + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ queryAttachmentId?: string | undefined; } @@ -1846,9 +2380,15 @@ export interface Thought { * * `THOUGHT_TYPE_DATA_SOURCING`: Which tables or datasets were identified as relevant. * * `THOUGHT_TYPE_INSTRUCTIONS`: Which author-defined instructions were referenced. * * `THOUGHT_TYPE_STEPS`: The logical steps taken to compute the answer. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ thoughtType?: ThoughtType | undefined; - /** The md formatted content for this thought. */ + /** + * The md formatted content for this thought. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ content?: string | undefined; } diff --git a/packages/gitcredentials/src/v1/model.ts b/packages/gitcredentials/src/v1/model.ts index 32c665d1..8af1604f 100755 --- a/packages/gitcredentials/src/v1/model.ts +++ b/packages/gitcredentials/src/v1/model.ts @@ -9,6 +9,8 @@ export interface CreateCredentialsRequest { * Microsoft Entra ID authentication), `gitHubEnterprise`, `bitbucketServer` (Bitbucket * Data Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit` * (deprecated by AWS, not accepting new customers). + * + * Required. This field must be set in requests. */ gitProvider?: string | undefined; /** @@ -40,9 +42,17 @@ export interface CreateCredentialsRequest { } export interface CreateCredentialsResponse { - /** ID of the credential object in the workspace. */ + /** + * ID of the credential object in the workspace. + * + * Required. This field must be set in requests. + */ credentialId?: bigint | undefined; - /** The Git provider associated with the credential. */ + /** + * The Git provider associated with the credential. + * + * Required. This field must be set in requests. + */ gitProvider?: string | undefined; /** * The username provided with your Git provider account and associated with the @@ -65,7 +75,11 @@ export interface CreateCredentialsResponse { } export interface Credential { - /** ID of the credential object in the workspace. */ + /** + * ID of the credential object in the workspace. + * + * Required. This field must be set in requests. + */ credentialId?: bigint | undefined; /** * The Git provider associated with the credential. One of `gitHub`, `bitbucketCloud`, @@ -95,7 +109,11 @@ export interface Credential { } export interface DeleteCredentialsRequest { - /** The ID for the corresponding credential to access. */ + /** + * The ID for the corresponding credential to access. + * + * Required. This field must be set in requests. + */ id?: bigint | undefined; /** The ID of the service principal whose credentials will be modified. Only service principal managers can perform this action. */ principalId?: bigint | undefined; @@ -105,14 +123,22 @@ export interface DeleteCredentialsRequest { export interface DeleteCredentialsResponse {} export interface GetCredentialsRequest { - /** The ID for the corresponding credential to access. */ + /** + * The ID for the corresponding credential to access. + * + * Required. This field must be set in requests. + */ id?: bigint | undefined; /** The ID of the service principal whose credentials will be modified. Only service principal managers can perform this action. */ principalId?: bigint | undefined; } export interface GetCredentialsResponse { - /** ID of the credential object in the workspace. */ + /** + * ID of the credential object in the workspace. + * + * Required. This field must be set in requests. + */ credentialId?: bigint | undefined; /** The Git provider associated with the credential. */ gitProvider?: string | undefined; @@ -147,7 +173,11 @@ export interface ListCredentialsResponse { } export interface UpdateCredentialsRequest { - /** The ID for the corresponding credential to access. */ + /** + * The ID for the corresponding credential to access. + * + * Required. This field must be set in requests. + */ id?: bigint | undefined; /** * The personal access token used to authenticate to the corresponding Git provider. @@ -161,6 +191,8 @@ export interface UpdateCredentialsRequest { * Microsoft Entra ID authentication), `gitHubEnterprise`, `bitbucketServer` (Bitbucket * Data Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit` * (deprecated by AWS, not accepting new customers). + * + * Required. This field must be set in requests. */ gitProvider?: string | undefined; /** diff --git a/packages/globalinitscripts/src/v2/model.ts b/packages/globalinitscripts/src/v2/model.ts index 9b8471ab..344ddb84 100755 --- a/packages/globalinitscripts/src/v2/model.ts +++ b/packages/globalinitscripts/src/v2/model.ts @@ -3,9 +3,17 @@ import {z} from 'zod'; export interface CreateGlobalInitScriptRequest { - /** The name of the script */ + /** + * The name of the script + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** The Base64-encoded content of the script. */ + /** + * The Base64-encoded content of the script. + * + * Required. This field must be set in requests. + */ script?: Uint8Array | undefined; /** * The position of a global init script, where 0 represents the first script to run, 1 is the second script to run, in ascending order. @@ -25,7 +33,11 @@ export interface CreateGlobalInitScriptResponse { } export interface DeleteGlobalInitScriptRequest { - /** The ID of the global init script. */ + /** + * The ID of the global init script. + * + * Required. This field must be set in requests. + */ scriptId?: string | undefined; } @@ -33,7 +45,11 @@ export interface DeleteGlobalInitScriptRequest { export interface DeleteGlobalInitScriptResponse {} export interface GetGlobalInitScriptRequest { - /** The ID of the global init script. */ + /** + * The ID of the global init script. + * + * Required. This field must be set in requests. + */ scriptId?: string | undefined; } @@ -64,11 +80,23 @@ export interface ListGlobalInitScriptsResponse { } export interface UpdateGlobalInitScriptRequest { - /** The ID of the global init script. */ + /** + * The ID of the global init script. + * + * Required. This field must be set in requests. + */ scriptId?: string | undefined; - /** The name of the script */ + /** + * The name of the script + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** The Base64-encoded content of the script. */ + /** + * The Base64-encoded content of the script. + * + * Required. This field must be set in requests. + */ script?: Uint8Array | undefined; /** * The position of a script, where 0 represents the first script to run, diff --git a/packages/instancepools/src/v2/model.ts b/packages/instancepools/src/v2/model.ts index f54e4f3c..aa9427f2 100755 --- a/packages/instancepools/src/v2/model.ts +++ b/packages/instancepools/src/v2/model.ts @@ -194,7 +194,11 @@ export interface CreateInstancePoolResponse { } export interface DeleteInstancePoolRequest { - /** The instance pool to be terminated. */ + /** + * The instance pool to be terminated. + * + * Required. This field must be set in requests. + */ instancePoolId?: string | undefined; } @@ -275,7 +279,11 @@ export interface DockerImage { } export interface EditInstancePoolRequest { - /** Instance pool ID */ + /** + * Instance pool ID + * + * Required. This field must be set in requests. + */ instancePoolId?: string | undefined; /** * Pool name requested by the user. Pool name must be unique. Length must be between 1 and 100 @@ -357,7 +365,11 @@ export interface EditInstancePoolRequest { export interface EditInstancePoolResponse {} export interface GetInstancePoolRequest { - /** The canonical unique identifier for the instance pool. */ + /** + * The canonical unique identifier for the instance pool. + * + * Required. This field must be set in requests. + */ instancePoolId?: string | undefined; } diff --git a/packages/instanceprofiles/src/v2/model.ts b/packages/instanceprofiles/src/v2/model.ts index c08e593e..d5b3173d 100755 --- a/packages/instanceprofiles/src/v2/model.ts +++ b/packages/instanceprofiles/src/v2/model.ts @@ -12,7 +12,11 @@ export interface AddInstanceProfileRequest { * you can pass this flag to skip the validation and forcibly add the instance profile. */ skipValidation?: boolean | undefined; - /** The AWS ARN of the instance profile to register with . This field is required. */ + /** + * The AWS ARN of the instance profile to register with . This field is required. + * + * Required. This field must be set in requests. + */ instanceProfileArn?: string | undefined; /** * Boolean flag indicating whether the instance profile should only be used in credential @@ -37,7 +41,11 @@ export interface AddInstanceProfileRequest { export interface AddInstanceProfileResponse {} export interface EditInstanceProfileRequest { - /** The AWS ARN of the instance profile to register with . This field is required. */ + /** + * The AWS ARN of the instance profile to register with . This field is required. + * + * Required. This field must be set in requests. + */ instanceProfileArn?: string | undefined; /** * Boolean flag indicating whether the instance profile should only be used in credential @@ -62,7 +70,11 @@ export interface EditInstanceProfileRequest { export interface EditInstanceProfileResponse {} export interface InstanceProfile { - /** The AWS ARN of the instance profile to register with . This field is required. */ + /** + * The AWS ARN of the instance profile to register with . This field is required. + * + * Required. This field must be set in requests. + */ instanceProfileArn?: string | undefined; /** * Boolean flag indicating whether the instance profile should only be used in credential @@ -92,7 +104,11 @@ export interface ListInstanceProfilesResponse { } export interface RemoveInstanceProfileRequest { - /** The ARN of the instance profile to remove. This field is required. */ + /** + * The ARN of the instance profile to remove. This field is required. + * + * Required. This field must be set in requests. + */ instanceProfileArn?: string | undefined; } diff --git a/packages/jobs/src/v2/model.ts b/packages/jobs/src/v2/model.ts index d9a045f9..5e5730a3 100755 --- a/packages/jobs/src/v2/model.ts +++ b/packages/jobs/src/v2/model.ts @@ -892,7 +892,11 @@ export interface AccessControlRequest { /** A storage location in Adls Gen2 */ export interface Adlsgen2Info { - /** abfss destination, e.g. `abfss://@.dfs.core.windows.net/`. */ + /** + * abfss destination, e.g. `abfss://@.dfs.core.windows.net/`. + * + * Required. This field must be set in requests. + */ destination?: string | undefined; } @@ -913,6 +917,8 @@ export interface AiRuntimeTask { * otherwise a new experiment is created. To target a specific MLflow * storage location (for example, when running as a service principal), set * `mlflow_experiment_directory`. + * + * Required. This field must be set in requests. */ experiment?: string | undefined; /** @@ -921,6 +927,8 @@ export interface AiRuntimeTask { * is a current-Preview constraint. Role-split workloads (driver + worker, * parameter server, separate eval node, etc.) with multiple entries are the * eventual intent but not yet supported. + * + * Required. This field must be set in requests. */ deployments?: DeploymentSpec[] | undefined; /** @@ -959,13 +967,25 @@ export interface AiRuntimeTaskOutput { /** * MLflow experiment ID the run was logged to. Use it to look up the * experiment in MLflow APIs or the workspace MLflow UI. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ mlflowExperimentId?: string | undefined; /** * MLflow run ID for this task execution. Use it to look up the run in * MLflow APIs or the workspace MLflow UI. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ mlflowRunId?: string | undefined; + /** + * Human-readable status message for this run, suitable for display to the + * user (for example, that the run is still waiting for GPU compute). Set by + * the server only when there is something to surface; empty otherwise. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ + statusMessage?: string | undefined; } // eslint-disable-next-line @typescript-eslint/no-empty-object-type @@ -1160,7 +1180,11 @@ export interface BaseJob { settings?: JobSettings | undefined; /** The time at which this job was created in epoch milliseconds (milliseconds since 1/1/1970 UTC). */ createdTime?: bigint | undefined; - /** State of the trigger associated with the job. */ + /** + * State of the trigger associated with the job. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ triggerState?: TriggerState | undefined; /** * Indicates if the job has more array properties (`tasks`, `job_clusters`) that are not shown. They can be accessed via :method:jobs/get endpoint. @@ -1173,9 +1197,15 @@ export interface BaseJob { * 1. Budget admins through the account or workspace console * 2. Jobs UI in the job details page and Jobs API using `budget_policy_id` * 3. Inferred default based on accessible budget policies of the run_as identity on job creation or modification. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ effectiveBudgetPolicyId?: string | undefined; - /** The id of the usage policy used by this job for cost attribution purposes. */ + /** + * The id of the usage policy used by this job for cost attribution purposes. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ effectiveUsagePolicyId?: string | undefined; } @@ -1252,7 +1282,11 @@ export interface BaseRun { * * `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance. */ effectivePerformanceTarget?: PerformanceTarget_PerformanceTarget | undefined; - /** The id of the usage policy used by this run for cost attribution purposes. */ + /** + * The id of the usage policy used by this run for cost attribution purposes. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ effectiveUsagePolicyId?: string | undefined; /** The time at which this run was started in epoch milliseconds (milliseconds since 1/1/1970 UTC). This may not be the time when the job task starts executing, for example, if the job is scheduled to run on a new cluster, this is the time the cluster creation call is issued. */ startTime?: bigint | undefined; @@ -1282,7 +1316,11 @@ export interface CancelAllRunsRequest { export interface CancelAllRunsResponse {} export interface CancelRunRequest { - /** This field is required. */ + /** + * This field is required. + * + * Required. This field must be set in requests. + */ runId?: bigint | undefined; } @@ -1313,9 +1351,17 @@ export interface CleanRoomTaskRunState { * Replaces the deprecated CleanRoomNotebookTask (defined above) which was for V0 service. */ export interface CleanRoomsNotebookTask { - /** The clean room that the notebook belongs to. */ + /** + * The clean room that the notebook belongs to. + * + * Required. This field must be set in requests. + */ cleanRoomName?: string | undefined; - /** Name of the notebook being run. */ + /** + * Name of the notebook being run. + * + * Required. This field must be set in requests. + */ notebookName?: string | undefined; /** * Checksum to validate the freshness of the notebook resource (i.e. the notebook being run is the latest version). @@ -1601,7 +1647,11 @@ export interface Compute { } export interface ComputeConfig { - /** Number of GPUs. */ + /** + * Number of GPUs. + * + * Required. This field must be set in requests. + */ numGpus?: number | undefined; /** IDof the GPU pool to use. */ gpuNodePoolId?: string | undefined; @@ -1618,6 +1668,8 @@ export interface ComputeSpec { * Hardware accelerator type (for example, `GPU_1xA10` or `GPU_8xH100`). * The number of accelerators per node is encoded in the enum value — * `GPU_8xH100` means 8 H100 GPUs per node. + * + * Required. This field must be set in requests. */ acceleratorType?: ComputeSpec_AcceleratorType | undefined; /** @@ -1625,6 +1677,8 @@ export interface ComputeSpec { * multiple of the per-node accelerator count encoded in `accelerator_type`. * For example, `GPU_8xH100` with `accelerator_count: 16` allocates 2 nodes * (8 GPUs per node). + * + * Required. This field must be set in requests. */ acceleratorCount?: number | undefined; } @@ -1635,11 +1689,21 @@ export interface ConditionTask { * * `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN`, `LESS_THAN_OR_EQUAL` operators perform numeric comparison of their operands. `“12.0” >= “12”` will evaluate to `true`, `“10.0” >= “12”` will evaluate to `false`. * * The boolean comparison to task values can be implemented with operators `EQUAL_TO`, `NOT_EQUAL`. If a task value was set to a boolean value, it will be serialized to `“true”` or `“false”` for the comparison. + * + * Required. This field must be set in requests. */ op?: ConditionTask_ConditionTaskOperator | undefined; - /** The left operand of the condition task. Can be either a string value or a job state or parameter reference. */ + /** + * The left operand of the condition task. Can be either a string value or a job state or parameter reference. + * + * Required. This field must be set in requests. + */ left?: string | undefined; - /** The right operand of the condition task. Can be either a string value or a job state or parameter reference. */ + /** + * The right operand of the condition task. Can be either a string value or a job state or parameter reference. + * + * Required. This field must be set in requests. + */ right?: string | undefined; /** The condition expression evaluation result. Filled in if the task was successfully completed. Can be `"true"` or `"false"` */ outcome?: string | undefined; @@ -1768,9 +1832,17 @@ export interface CreateJobResponse { } export interface CronSchedule { - /** A Cron expression using Quartz syntax that describes the schedule for a job. See [Cron Trigger](http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html) for details. This field is required. */ + /** + * A Cron expression using Quartz syntax that describes the schedule for a job. See [Cron Trigger](http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html) for details. This field is required. + * + * Required. This field must be set in requests. + */ quartzCronExpression?: string | undefined; - /** A Java timezone ID. The schedule for a job is resolved with respect to this timezone. See [Java TimeZone](https://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html) for details. This field is required. */ + /** + * A Java timezone ID. The schedule for a job is resolved with respect to this timezone. See [Java TimeZone](https://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html) for details. This field is required. + * + * Required. This field must be set in requests. + */ timezoneId?: string | undefined; /** Indicate whether this schedule is paused or not. */ pauseStatus?: SchedulePauseStatus | undefined; @@ -1810,7 +1882,11 @@ export interface DashboardTaskOutput { /** A storage location in DBFS */ export interface DbfsStorageInfo { - /** dbfs destination, e.g. `dbfs:/my/path` */ + /** + * dbfs destination, e.g. `dbfs:/my/path` + * + * Required. This field must be set in requests. + */ destination?: string | undefined; } @@ -1887,7 +1963,11 @@ export interface DbtTask { * case if no value is provided, the root of the Git repository is used. */ projectDirectory?: string | undefined; - /** A list of dbt commands to execute. All commands must start with `dbt`. This parameter must not be empty. A maximum of up to 10 commands can be provided. */ + /** + * A list of dbt commands to execute. All commands must start with `dbt`. This parameter must not be empty. A maximum of up to 10 commands can be provided. + * + * Required. This field must be set in requests. + */ commands?: string[] | undefined; /** Optional schema to write to. This parameter is only used when a warehouse_id is also provided. If not provided, the `default` schema is used. */ schema?: string | undefined; @@ -1917,7 +1997,11 @@ export interface DbtTask_DbtTaskOutput { } export interface DeleteJobRequest { - /** The canonical identifier of the job to delete. This field is required. */ + /** + * The canonical identifier of the job to delete. This field is required. + * + * Required. This field must be set in requests. + */ jobId?: bigint | undefined; } @@ -1926,7 +2010,11 @@ export interface DeleteJobRequest { export interface DeleteJobResponse {} export interface DeleteRunRequest { - /** ID of the run to delete. */ + /** + * ID of the run to delete. + * + * Required. This field must be set in requests. + */ runId?: bigint | undefined; } @@ -1948,9 +2036,15 @@ export interface DeploymentSpec { * deployment. The CLI uploads the user's script and populates this. * Customers calling the Jobs API directly should upload their script to * the workspace first and supply the resulting path here. + * + * Required. This field must be set in requests. */ commandPath?: string | undefined; - /** Compute resources allocated to each node in this deployment. */ + /** + * Compute resources allocated to each node in this deployment. + * + * Required. This field must be set in requests. + */ compute?: ComputeSpec | undefined; /** * Optional human-readable name for this deployment (for example, `driver`, @@ -1981,7 +2075,11 @@ export interface DockerImage { } export interface EnforcePolicyComplianceForJob { - /** The ID of the job you want to enforce policy compliance on. */ + /** + * The ID of the job you want to enforce policy compliance on. + * + * Required. This field must be set in requests. + */ jobId?: bigint | undefined; /** * If set, previews changes made to the job to comply with its policy, but @@ -2075,7 +2173,11 @@ export interface Environment { /** Retrieves the export of a job run task. */ export interface ExportRunRequest { - /** The canonical identifier for the run. This field is required. */ + /** + * The canonical identifier for the run. This field is required. + * + * Required. This field must be set in requests. + */ runId?: bigint | undefined; /** Which views to export (CODE, DASHBOARDS, or ALL). Defaults to CODE. */ viewsToExport?: ViewsToExport | undefined; @@ -2088,7 +2190,11 @@ export interface ExportRunResponse { } export interface FileArrivalTriggerConfiguration { - /** URL to be monitored for file arrivals. The path must point to the root or a subpath of the external location. */ + /** + * URL to be monitored for file arrivals. The path must point to the root or a subpath of the external location. + * + * Required. This field must be set in requests. + */ url?: string | undefined; /** * If set, the trigger starts a run only after the specified amount of time passed since @@ -2112,6 +2218,8 @@ export interface ForEachTask { /** * Array for task to iterate on. This can be a JSON string or a reference to * an array parameter. + * + * Required. This field must be set in requests. */ inputs?: string | undefined; /** @@ -2119,7 +2227,11 @@ export interface ForEachTask { * Set this value if you want to be able to execute multiple runs of the task concurrently. */ concurrency?: number | undefined; - /** Configuration for the task that will be run for each element in the array */ + /** + * Configuration for the task that will be run for each element in the array + * + * Required. This field must be set in requests. + */ task?: TaskSettings | undefined; } @@ -2182,7 +2294,11 @@ export interface GcpAttributes { /** A storage location in Google Cloud Platform's GCS */ export interface GcsStorageInfo { - /** GCS destination/URI, e.g. `gs://my-bucket/some-prefix` */ + /** + * GCS destination/URI, e.g. `gs://my-bucket/some-prefix` + * + * Required. This field must be set in requests. + */ destination?: string | undefined; } @@ -2195,7 +2311,11 @@ export interface GcsStorageInfo { * PuPr). */ export interface GenAiComputeTask { - /** Runtime image */ + /** + * Runtime image + * + * Required. This field must be set in requests. + */ dlRuntimeImage?: string | undefined; compute?: ComputeConfig | undefined; /** Command launcher to run the actual script, e.g. bash, python etc. */ @@ -2225,7 +2345,11 @@ export interface GenAiComputeTask { /** Retrieves information about a single job. */ export interface GetJobRequest { - /** The canonical identifier of the job to retrieve information about. This field is required. */ + /** + * The canonical identifier of the job to retrieve information about. This field is required. + * + * Required. This field must be set in requests. + */ jobId?: bigint | undefined; /** Flag that indicates that trigger state should be included in the response. */ includeTriggerState?: boolean | undefined; @@ -2251,7 +2375,11 @@ export interface GetJobResponse { settings?: JobSettings | undefined; /** The time at which this job was created in epoch milliseconds (milliseconds since 1/1/1970 UTC). */ createdTime?: bigint | undefined; - /** State of the trigger associated with the job. */ + /** + * State of the trigger associated with the job. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ triggerState?: TriggerState | undefined; /** * Indicates if the job has more array properties (`tasks`, `job_clusters`) that are not shown. They can be accessed via :method:jobs/get endpoint. @@ -2264,14 +2392,24 @@ export interface GetJobResponse { * 1. Budget admins through the account or workspace console * 2. Jobs UI in the job details page and Jobs API using `budget_policy_id` * 3. Inferred default based on accessible budget policies of the run_as identity on job creation or modification. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ effectiveBudgetPolicyId?: string | undefined; - /** The id of the usage policy used by this job for cost attribution purposes. */ + /** + * The id of the usage policy used by this job for cost attribution purposes. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ effectiveUsagePolicyId?: string | undefined; } export interface GetPolicyComplianceForJobRequest { - /** The ID of the job whose compliance status you are requesting. */ + /** + * The ID of the job whose compliance status you are requesting. + * + * Required. This field must be set in requests. + */ jobId?: bigint | undefined; } @@ -2295,7 +2433,11 @@ export interface GetPolicyComplianceForJobResponse { /** Retrieves both the output and the metadata of a run. */ export interface GetRunOutputRequest { - /** The canonical identifier for the run. */ + /** + * The canonical identifier for the run. + * + * Required. This field must be set in requests. + */ runId?: bigint | undefined; } @@ -2385,6 +2527,8 @@ export interface GetRunRequest { /** * The canonical identifier of the run for which to retrieve the metadata. * This field is required. + * + * Required. This field must be set in requests. */ runId?: bigint | undefined; /** Whether to include the repair history in the response. */ @@ -2471,7 +2615,11 @@ export interface GetRunResponse { * * `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance. */ effectivePerformanceTarget?: PerformanceTarget_PerformanceTarget | undefined; - /** The id of the usage policy used by this run for cost attribution purposes. */ + /** + * The id of the usage policy used by this run for cost attribution purposes. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ effectiveUsagePolicyId?: string | undefined; /** The time at which this run was started in epoch milliseconds (milliseconds since 1/1/1970 UTC). This may not be the time when the job task starts executing, for example, if the job is scheduled to run on a new cluster, this is the time the cluster creation call is issued. */ startTime?: bigint | undefined; @@ -2503,9 +2651,17 @@ export interface GitMetadataSnapshot { * Note: dbt and SQL File tasks support only version-controlled sources. If dbt or SQL File tasks are used, `git_source` must be defined on the job. */ export interface GitSource { - /** URL of the repository to be cloned by this job. */ + /** + * URL of the repository to be cloned by this job. + * + * Required. This field must be set in requests. + */ gitUrl?: string | undefined; - /** Unique identifier of the service used to host the Git repository. The value is case insensitive. */ + /** + * Unique identifier of the service used to host the Git repository. The value is case insensitive. + * + * Required. This field must be set in requests. + */ gitProvider?: string | undefined; gitReference?: | { @@ -2598,9 +2754,15 @@ export interface JobCluster { /** * A unique name for the job cluster. This field is required and must be unique within the job. * `JobTaskSettings` may refer to this field to determine which cluster to launch for the task execution. + * + * Required. This field must be set in requests. */ jobClusterKey?: string | undefined; - /** If new_cluster, a description of a cluster that is created for each task. */ + /** + * If new_cluster, a description of a cluster that is created for each task. + * + * Required. This field must be set in requests. + */ newCluster?: ClusterSpec_NewCluster | undefined; } @@ -2610,6 +2772,8 @@ export interface JobDeployment { * * * `BUNDLE`: The job is managed by Databricks Asset Bundle. * * `SYSTEM_MANAGED`: The job is managed by and is read-only. + * + * Required. This field must be set in requests. */ kind?: JobDeployment_DeploymentKind | undefined; /** Path of the file that contains deployment metadata. */ @@ -2651,15 +2815,27 @@ export interface JobEmailNotifications { } export interface JobEnvironment { - /** The key of an environment. It has to be unique within a job. */ + /** + * The key of an environment. It has to be unique within a job. + * + * Required. This field must be set in requests. + */ environmentKey?: string | undefined; spec?: Environment | undefined; } export interface JobLevelParameter { - /** The name of the defined parameter. May only contain alphanumeric characters, `_`, `-`, and `.` */ + /** + * The name of the defined parameter. May only contain alphanumeric characters, `_`, `-`, and `.` + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Default value of the parameter. */ + /** + * Default value of the parameter. + * + * Required. This field must be set in requests. + */ default?: string | undefined; } @@ -2797,12 +2973,20 @@ export interface JobSettings { /** The source of the job specification in the remote repository when the job is source controlled. */ export interface JobSource { - /** Path of the job YAML file that contains the job specification. */ + /** + * Path of the job YAML file that contains the job specification. + * + * Required. This field must be set in requests. + */ jobConfigPath?: string | undefined; importFromGitReference?: | { $case: 'importFromGitBranch'; - /** Name of the branch which the job is imported from. */ + /** + * Name of the branch which the job is imported from. + * + * Required. This field must be set in requests. + */ importFromGitBranch: string; } | undefined; @@ -2817,9 +3001,15 @@ export interface JobSource { } export interface JobsHealthRule { + /** Required. This field must be set in requests. */ metric?: JobsHealthMetric | undefined; + /** Required. This field must be set in requests. */ op?: JobsHealthOperator | undefined; - /** Specifies the threshold value that the health metric should obey to satisfy the health rule. */ + /** + * Specifies the threshold value that the health metric should obey to satisfy the health rule. + * + * Required. This field must be set in requests. + */ value?: bigint | undefined; } @@ -2890,7 +3080,11 @@ export interface Library { } export interface ListJobComplianceForPolicy { - /** Canonical unique identifier for the cluster policy. */ + /** + * Canonical unique identifier for the cluster policy. + * + * Required. This field must be set in requests. + */ policyId?: string | undefined; /** * A page token that can be used to navigate to the next page or previous page as @@ -2907,7 +3101,11 @@ export interface ListJobComplianceForPolicy { // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name. export interface ListJobComplianceForPolicy_JobCompliance { - /** Canonical unique identifier for a job. */ + /** + * Canonical unique identifier for a job. + * + * Required. This field must be set in requests. + */ jobId?: bigint | undefined; /** Whether this job is in compliance with the latest version of its policy. */ isCompliant?: boolean | undefined; @@ -3037,7 +3235,11 @@ export interface ListRunsResponse { } export interface LocalFileInfo { - /** local file destination, e.g. `file:/my/local/file.sh` */ + /** + * local file destination, e.g. `file:/my/local/file.sh` + * + * Required. This field must be set in requests. + */ destination?: string | undefined; } @@ -3047,7 +3249,11 @@ export interface LogAnalyticsInfo { } export interface MavenLibrary { - /** Gradle-style maven coordinates. For example: "org.jsoup:jsoup:1.7.2". */ + /** + * Gradle-style maven coordinates. For example: "org.jsoup:jsoup:1.7.2". + * + * Required. This field must be set in requests. + */ coordinates?: string | undefined; /** * Maven repo to install the Maven package from. If omitted, both Maven Central Repository @@ -3071,7 +3277,11 @@ export interface ModelTriggerConfiguration { securableName?: string | undefined; /** Aliases of the model versions to monitor. Can only be used in conjunction with condition MODEL_ALIAS_SET. */ aliases?: string[] | undefined; - /** The condition based on which to trigger a job run. */ + /** + * The condition based on which to trigger a job run. + * + * Required. This field must be set in requests. + */ condition?: ModelTriggerConfiguration_ModelTriggerCondition | undefined; /** * If set, the trigger starts a run only after the specified amount of time has passed since @@ -3097,6 +3307,8 @@ export interface NotebookTask { * The path of the notebook to be run in the workspace or remote repository. * For notebooks stored in the workspace, the path must be absolute and begin with a slash. * For notebooks stored in a remote repository, the path must be relative. This field is required. + * + * Required. This field must be set in requests. */ notebookPath?: string | undefined; /** @@ -3161,9 +3373,17 @@ export interface OutputSchemaInfo { export interface PerformanceTarget {} export interface PeriodicTriggerConfiguration { - /** The interval at which the trigger should run. */ + /** + * The interval at which the trigger should run. + * + * Required. This field must be set in requests. + */ interval?: number | undefined; - /** The unit of time for the interval. */ + /** + * The unit of time for the interval. + * + * Required. This field must be set in requests. + */ unit?: PeriodicTriggerConfiguration_TimeUnit | undefined; } @@ -3184,7 +3404,11 @@ export interface PipelineParameters { } export interface PipelineTask { - /** The full name of the pipeline task to execute. */ + /** + * The full name of the pipeline task to execute. + * + * Required. This field must be set in requests. + */ pipelineId?: string | undefined; /** * Key/value-map of parameters passed to the pipeline execution. @@ -3266,6 +3490,8 @@ export interface PythonPyPiLibrary { /** * The name of the pypi package to install. An optional exact version specification is also * supported. Examples: "simplejson" and "simplejson==3.8.0". + * + * Required. This field must be set in requests. */ package?: string | undefined; /** @@ -3276,9 +3502,17 @@ export interface PythonPyPiLibrary { } export interface PythonWheelTask { - /** Name of the package to execute */ + /** + * Name of the package to execute + * + * Required. This field must be set in requests. + */ packageName?: string | undefined; - /** Named entry point to use, if it does not exist in the metadata of the package it executes the function from the package directly using `$packageName.$entryPoint()` */ + /** + * Named entry point to use, if it does not exist in the metadata of the package it executes the function from the package directly using `$packageName.$entryPoint()` + * + * Required. This field must be set in requests. + */ entryPoint?: string | undefined; /** Command-line parameters passed to Python wheel task. Leave it empty if `named_parameters` is not null. */ parameters?: string[] | undefined; @@ -3299,12 +3533,20 @@ export interface QueueDetails { export interface QueueDetailsCode {} export interface QueueSettings { - /** If true, enable queueing for the job. This is a required field. */ + /** + * If true, enable queueing for the job. This is a required field. + * + * Required. This field must be set in requests. + */ enabled?: boolean | undefined; } export interface RCranLibrary { - /** The name of the CRAN package to install. */ + /** + * The name of the CRAN package to install. + * + * Required. This field must be set in requests. + */ package?: string | undefined; /** The repository where the package can be found. If not specified, the default CRAN repo is used. */ repo?: string | undefined; @@ -3334,7 +3576,11 @@ export interface Repair { } export interface RepairRunRequest { - /** The job run ID of the run to repair. The run must not be in progress. */ + /** + * The job run ID of the run to repair. The run must not be in progress. + * + * Required. This field must be set in requests. + */ runId?: bigint | undefined; /** The ID of the latest repair. This parameter is not required when repairing a run for the first time, but must be provided on subsequent requests to repair the same run. */ latestRepairId?: bigint | undefined; @@ -3428,12 +3674,18 @@ export interface RepairRunResponse { } export interface ResetJobRequest { - /** The canonical identifier of the job to reset. This field is required. */ + /** + * The canonical identifier of the job to reset. This field is required. + * + * Required. This field must be set in requests. + */ jobId?: bigint | undefined; /** * The new settings of the job. These settings completely replace the old settings. * * Changes to the field `JobBaseSettings.timeout_seconds` are applied to active runs. Changes to other fields are applied to future runs only. + * + * Required. This field must be set in requests. */ newSettings?: JobSettings | undefined; } @@ -3520,6 +3772,8 @@ export interface ResolvedValues_PipelineTaskResolvedValues { /** * Key/value-map of parameters passed to the pipeline execution. * Limited to 10k characters in total. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ pipelineTaskParameters?: Record | undefined; } @@ -3630,7 +3884,11 @@ export interface Run { * * `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance. */ effectivePerformanceTarget?: PerformanceTarget_PerformanceTarget | undefined; - /** The id of the usage policy used by this run for cost attribution purposes. */ + /** + * The id of the usage policy used by this run for cost attribution purposes. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ effectiveUsagePolicyId?: string | undefined; /** The time at which this run was started in epoch milliseconds (milliseconds since 1/1/1970 UTC). This may not be the time when the job task starts executing, for example, if the job is scheduled to run on a new cluster, this is the time the cluster creation call is issued. */ startTime?: bigint | undefined; @@ -3659,7 +3917,11 @@ export interface Run_JobLevelParameters { } export interface RunJobTask { - /** ID of the job to trigger. */ + /** + * ID of the job to trigger. + * + * Required. This field must be set in requests. + */ jobId?: bigint | undefined; /** Job-level parameters used to trigger the job. */ jobParameters?: Record | undefined; @@ -3744,7 +4006,11 @@ export interface RunLifeCycleState {} export interface RunLifecycleStateV2 {} export interface RunNowRequest { - /** The ID of the job to be executed */ + /** + * The ID of the job to be executed + * + * Required. This field must be set in requests. + */ jobId?: bigint | undefined; /** Job-level parameters used in the run. for example `"param": "overriding_val"` */ jobParameters?: Record | undefined; @@ -3964,12 +4230,16 @@ export interface RunTask { * * * `STANDARD`: Enables cost-efficient execution of serverless workloads. * * `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ effectivePerformanceTarget?: PerformanceTarget_PerformanceTarget | undefined; /** * A unique name for the task. This field is used to refer to this task from other tasks. * This field is required and must be unique within its parent job. * On Update or Reset, this field is used to reference the tasks to be updated or reset. + * + * Required. This field must be set in requests. */ taskKey?: string | undefined; /** An optional description for this task. */ @@ -3999,7 +4269,11 @@ export interface RunTask { | undefined; /** An optional flag to disable the task. If set to true, the task will not run even if it is part of a job. */ disabled?: boolean | undefined; - /** Task level compute configuration. */ + /** + * Task level compute configuration. + * + * Input only. Provide this field in requests; it is never returned in responses. + */ compute?: Compute | undefined; /** DO NOT ADD ANY NEW FIELDS TO JobTask OUTSIDE OF THIS ONEOF as it will break the TaskRegistry */ task?: @@ -4167,6 +4441,8 @@ export interface RunTaskSettings { * A unique name for the task. This field is used to refer to this task from other tasks. * This field is required and must be unique within its parent job. * On Update or Reset, this field is used to reference the tasks to be updated or reset. + * + * Required. This field must be set in requests. */ taskKey?: string | undefined; /** An optional description for this task. */ @@ -4196,7 +4472,11 @@ export interface RunTaskSettings { | undefined; /** An optional flag to disable the task. If set to true, the task will not run even if it is part of a job. */ disabled?: boolean | undefined; - /** Task level compute configuration. */ + /** + * Task level compute configuration. + * + * Input only. Provide this field in requests; it is never returned in responses. + */ compute?: Compute | undefined; /** DO NOT ADD ANY NEW FIELDS TO JobTask OUTSIDE OF THIS ONEOF as it will break the TaskRegistry */ task?: @@ -4357,6 +4637,8 @@ export interface S3StorageInfo { * S3 destination, e.g. `s3://my-bucket/some-prefix` Note that logs will be delivered using * cluster iam role, please make sure you set cluster iam role and the role has write access to the * destination. Please also note that you cannot use AWS keys to deliver logs. + * + * Required. This field must be set in requests. */ destination?: string | undefined; /** @@ -4414,7 +4696,11 @@ export interface SparkJarTask { } export interface SparkPythonTask { - /** The Python file to be executed. Cloud file URIs (such as dbfs:/, s3:/, adls:/, gcs:/) and workspace paths are supported. For python files stored in the workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required. */ + /** + * The Python file to be executed. Cloud file URIs (such as dbfs:/, s3:/, adls:/, gcs:/) and workspace paths are supported. For python files stored in the workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required. + * + * Required. This field must be set in requests. + */ pythonFile?: string | undefined; /** * Command line parameters passed to the Python file. @@ -4475,7 +4761,11 @@ export interface SqlTask { file: SqlTaskFile; } | undefined; - /** The canonical identifier of the SQL warehouse. Recommended to use with serverless or pro SQL warehouses. Classic SQL warehouses are only supported for SQL alert, dashboard and query tasks and are limited to scheduled single-task jobs. */ + /** + * The canonical identifier of the SQL warehouse. Recommended to use with serverless or pro SQL warehouses. Classic SQL warehouses are only supported for SQL alert, dashboard and query tasks and are limited to scheduled single-task jobs. + * + * Required. This field must be set in requests. + */ warehouseId?: string | undefined; } @@ -4565,7 +4855,11 @@ export interface SqlTask_SqlStatementOutput { } export interface SqlTaskAlert { - /** The canonical identifier of the SQL alert. */ + /** + * The canonical identifier of the SQL alert. + * + * Required. This field must be set in requests. + */ alertId?: string | undefined; /** If specified, alert notifications are sent to subscribers. */ subscriptions?: SqlTaskSubscription[] | undefined; @@ -4574,7 +4868,11 @@ export interface SqlTaskAlert { } export interface SqlTaskDashboard { - /** The canonical identifier of the SQL dashboard. */ + /** + * The canonical identifier of the SQL dashboard. + * + * Required. This field must be set in requests. + */ dashboardId?: string | undefined; /** If specified, dashboard snapshots are sent to subscriptions. */ subscriptions?: SqlTaskSubscription[] | undefined; @@ -4585,7 +4883,11 @@ export interface SqlTaskDashboard { } export interface SqlTaskFile { - /** Path of the SQL file. Must be relative if the source is a remote Git repository and absolute for workspace paths. */ + /** + * Path of the SQL file. Must be relative if the source is a remote Git repository and absolute for workspace paths. + * + * Required. This field must be set in requests. + */ path?: string | undefined; /** * Optional location type of the SQL file. When set to `WORKSPACE`, the SQL file will be retrieved @@ -4602,7 +4904,11 @@ export interface SqlTaskQuery { queryType?: | { $case: 'queryId'; - /** The canonical identifier of the SQL query. */ + /** + * The canonical identifier of the SQL query. + * + * Required. This field must be set in requests. + */ queryId: string; } | undefined; @@ -4668,11 +4974,15 @@ export interface SubmitRunRequest { /** * The user specified id of the budget policy to use for this one-time run. * If not specified, the run will be not be attributed to any budget policy. + * + * Input only. Provide this field in requests; it is never returned in responses. */ budgetPolicyId?: string | undefined; /** * The user specified id of the usage policy to use for this one-time run. * If not specified, a default usage policy may be applied when creating or modifying the job. + * + * Input only. Provide this field in requests; it is never returned in responses. */ usagePolicyId?: string | undefined; } @@ -4722,7 +5032,11 @@ export interface TableState { } export interface TableTriggerConfiguration { - /** A list of tables to monitor for changes. The table name must be in the format `catalog_name.schema_name.table_name`. */ + /** + * A list of tables to monitor for changes. The table name must be in the format `catalog_name.schema_name.table_name`. + * + * Required. This field must be set in requests. + */ tableNames?: string[] | undefined; /** * If set, the trigger starts a run only after the specified amount of time has passed since @@ -4746,7 +5060,11 @@ export interface TableTriggerState { } export interface TaskDependency { - /** The name of the task this task depends on. */ + /** + * The name of the task this task depends on. + * + * Required. This field must be set in requests. + */ taskKey?: string | undefined; /** Can only be specified on condition task dependencies. The outcome of the dependent task that must be met for this task to run. */ outcome?: string | undefined; @@ -4757,6 +5075,8 @@ export interface TaskSettings { * A unique name for the task. This field is used to refer to this task from other tasks. * This field is required and must be unique within its parent job. * On Update or Reset, this field is used to reference the tasks to be updated or reset. + * + * Required. This field must be set in requests. */ taskKey?: string | undefined; /** @@ -4985,7 +5305,11 @@ export interface TriggerState { } export interface UpdateJobRequest { - /** The canonical identifier of the job to update. This field is required. */ + /** + * The canonical identifier of the job to update. This field is required. + * + * Required. This field must be set in requests. + */ jobId?: bigint | undefined; /** * The new settings for the job. @@ -5019,11 +5343,14 @@ export interface VolumesStorageInfo { /** * UC Volumes destination, e.g. `/Volumes/catalog/schema/vol1/init-scripts/setup-datadog.sh` * or `dbfs:/Volumes/catalog/schema/vol1/init-scripts/setup-datadog.sh` + * + * Required. This field must be set in requests. */ destination?: string | undefined; } export interface Webhook { + /** Required. This field must be set in requests. */ id?: string | undefined; } @@ -5051,7 +5378,11 @@ export interface WidgetErrorDetail { /** Cluster Attributes showing for clusters workload types. */ export interface WorkloadType { - /** defined what type of clients can use the cluster. E.g. Notebooks, Jobs */ + /** + * defined what type of clients can use the cluster. E.g. Notebooks, Jobs + * + * Required. This field must be set in requests. + */ clients?: WorkloadType_ClientsTypes | undefined; } @@ -5065,7 +5396,11 @@ export interface WorkloadType_ClientsTypes { /** A storage location in Workspace Filesystem (WSFS) */ export interface WorkspaceStorageInfo { - /** wsfs destination, e.g. `workspace:/cluster-init-scripts/setup-datadog.sh` */ + /** + * wsfs destination, e.g. `workspace:/cluster-init-scripts/setup-datadog.sh` + * + * Required. This field must be set in requests. + */ destination?: string | undefined; } @@ -5100,10 +5435,12 @@ export const unmarshalAiRuntimeTaskOutputSchema: z.ZodType .object({ mlflow_experiment_id: z.string().optional(), mlflow_run_id: z.string().optional(), + status_message: z.string().optional(), }) .transform(d => ({ mlflowExperimentId: d.mlflow_experiment_id, mlflowRunId: d.mlflow_run_id, + statusMessage: d.status_message, })); export const unmarshalAlertTaskSchema: z.ZodType = z diff --git a/packages/keyconfigurations/src/v1/model.ts b/packages/keyconfigurations/src/v1/model.ts index 212ecc07..d654d97b 100644 --- a/packages/keyconfigurations/src/v1/model.ts +++ b/packages/keyconfigurations/src/v1/model.ts @@ -14,7 +14,11 @@ export type CmkUseCase = | (string & {}); export interface AwsKeyInfo { - /** The AWS KMS key's Amazon Resource Name (ARN). */ + /** + * The AWS KMS key's Amazon Resource Name (ARN). + * + * Required. This field must be set in requests. + */ keyArn?: string | undefined; /** The AWS KMS key alias. */ keyAlias?: string | undefined; @@ -49,7 +53,11 @@ export interface AzureKeyInfo { } export interface CreateAwsKeyInfo { - /** The AWS KMS key's Amazon Resource Name (ARN). */ + /** + * The AWS KMS key's Amazon Resource Name (ARN). + * + * Required. This field must be set in requests. + */ keyArn?: string | undefined; /** The AWS KMS key alias. */ keyAlias?: string | undefined; @@ -84,6 +92,7 @@ export interface CreateAzureKeyInfo { } export interface CreateCustomerManagedKeyRequest { + /** Required. This field must be set in requests. */ accountId?: string | undefined; /** * (-- The key information. Exactly one of aws_key_info, gcp_key_info, or @@ -94,7 +103,11 @@ export interface CreateCustomerManagedKeyRequest { | {$case: 'gcpKeyInfo'; gcpKeyInfo: CreateGcpKeyInfo} | {$case: 'azureKeyInfo'; azureKeyInfo: CreateAzureKeyInfo} | undefined; - /** The cases that the key can be used for. */ + /** + * The cases that the key can be used for. + * + * Required. This field must be set in requests. + */ useCases?: CmkUseCase[] | undefined; } @@ -102,6 +115,8 @@ export interface CreateGcpKeyInfo { /** * Globally unique kms key resource id of the form * projects/testProjectId/locations/us-east4/keyRings/gcpCmkKeyRing/cryptoKeys/cmk-eastus4 + * + * Required. This field must be set in requests. */ kmsKeyId?: string | undefined; /** @@ -138,8 +153,13 @@ export interface CustomerManagedKey { } export interface DeleteCustomerManagedKeyRequest { - /** encryption key configuration ID. */ + /** + * encryption key configuration ID. + * + * Required. This field must be set in requests. + */ customerManagedKeyId?: string | undefined; + /** Required. This field must be set in requests. */ accountId?: string | undefined; } @@ -147,6 +167,8 @@ export interface GcpKeyInfo { /** * Globally unique kms key resource id of the form * projects/testProjectId/locations/us-east4/keyRings/gcpCmkKeyRing/cryptoKeys/cmk-eastus4 + * + * Required. This field must be set in requests. */ kmsKeyId?: string | undefined; /** @@ -167,8 +189,13 @@ export interface GcpServiceAccount { } export interface GetCustomerManagedKeyRequest { - /** encryption key configuration ID. */ + /** + * encryption key configuration ID. + * + * Required. This field must be set in requests. + */ customerManagedKeyId?: string | undefined; + /** Required. This field must be set in requests. */ accountId?: string | undefined; } @@ -178,6 +205,7 @@ export interface KeyAccessConfiguration { } export interface ListCustomerManagedKeyRequest { + /** Required. This field must be set in requests. */ accountId?: string | undefined; } diff --git a/packages/knowledgeassistants/src/v1/model.ts b/packages/knowledgeassistants/src/v1/model.ts index 83757369..bc0d0bc1 100644 --- a/packages/knowledgeassistants/src/v1/model.ts +++ b/packages/knowledgeassistants/src/v1/model.ts @@ -34,14 +34,24 @@ export interface CreateExampleRequest { /** * Parent resource where this example will be created. * Format: knowledge-assistants/{knowledge_assistant_id} + * + * Required. This field must be set in requests. */ parent?: string | undefined; - /** The example to create under the parent Knowledge Assistant. */ + /** + * The example to create under the parent Knowledge Assistant. + * + * Required. This field must be set in requests. + */ example?: Example | undefined; } export interface CreateKnowledgeAssistantRequest { - /** The Knowledge Assistant to create. */ + /** + * The Knowledge Assistant to create. + * + * Required. This field must be set in requests. + */ knowledgeAssistant?: KnowledgeAssistant | undefined; } @@ -49,8 +59,11 @@ export interface CreateKnowledgeSourceRequest { /** * Parent resource where this source will be created. * Format: knowledge-assistants/{knowledge_assistant_id} + * + * Required. This field must be set in requests. */ parent?: string | undefined; + /** Required. This field must be set in requests. */ knowledgeSource?: KnowledgeSource | undefined; } @@ -59,6 +72,8 @@ export interface DeleteExampleRequest { /** * The resource name of the example to delete. * Format: knowledge-assistants/{knowledge_assistant_id}/examples/{example_id} + * + * Required. This field must be set in requests. */ name?: string | undefined; } @@ -68,6 +83,8 @@ export interface DeleteKnowledgeAssistantRequest { /** * The resource name of the knowledge assistant to be deleted. * Format: knowledge-assistants/{knowledge_assistant_id} + * + * Required. This field must be set in requests. */ name?: string | undefined; } @@ -76,6 +93,8 @@ export interface DeleteKnowledgeSourceRequest { /** * The resource name of the Knowledge Source to delete. * Format: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id} + * + * Required. This field must be set in requests. */ name?: string | undefined; } @@ -90,32 +109,60 @@ export interface Example { * knowledge-assistants/{knowledge_assistant_id}/examples/{example_id} */ name?: string | undefined; - /** The example question. */ + /** + * The example question. + * + * Required. This field must be set in requests. + */ question?: string | undefined; /** * Guidelines for answering the question. Optional — examples may be created * with just a question; the front-end form does not require guidelines. */ guidelines?: string[] | undefined; - /** The universally unique identifier (UUID) of the example. */ + /** + * The universally unique identifier (UUID) of the example. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ exampleId?: string | undefined; - /** Timestamp when this example was created. */ + /** + * Timestamp when this example was created. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createTime?: Temporal.Instant | undefined; - /** Timestamp when this example was last updated. */ + /** + * Timestamp when this example was last updated. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updateTime?: Temporal.Instant | undefined; } /** FileTableSpec specifies a file table source configuration. */ export interface FileTableSpec { - /** Full UC name of the table, in the format of {CATALOG}.{SCHEMA}.{TABLE_NAME}. */ + /** + * Full UC name of the table, in the format of {CATALOG}.{SCHEMA}.{TABLE_NAME}. + * + * Required. This field must be set in requests. + */ tableName?: string | undefined; - /** The name of the column containing BINARY file content to be indexed. */ + /** + * The name of the column containing BINARY file content to be indexed. + * + * Required. This field must be set in requests. + */ fileCol?: string | undefined; } /** FilesSpec specifies a files source configuration. */ export interface FilesSpec { - /** A UC volume path that includes a list of files. */ + /** + * A UC volume path that includes a list of files. + * + * Required. This field must be set in requests. + */ path?: string | undefined; } @@ -124,6 +171,8 @@ export interface GetExampleRequest { /** * The resource name of the example. * Format: knowledge-assistants/{knowledge_assistant_id}/examples/{example_id} + * + * Required. This field must be set in requests. */ name?: string | undefined; } @@ -133,6 +182,8 @@ export interface GetKnowledgeAssistantRequest { /** * The resource name of the knowledge assistant. * Format: knowledge-assistants/{knowledge_assistant_id} + * + * Required. This field must be set in requests. */ name?: string | undefined; } @@ -141,17 +192,31 @@ export interface GetKnowledgeSourceRequest { /** * The resource name of the Knowledge Source. * Format: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id} + * + * Required. This field must be set in requests. */ name?: string | undefined; } /** IndexSpec specifies a vector search index source configuration. */ export interface IndexSpec { - /** Full UC name of the vector search index, in the format of {CATALOG}.{SCHEMA}.{INDEX_NAME}. */ + /** + * Full UC name of the vector search index, in the format of {CATALOG}.{SCHEMA}.{INDEX_NAME}. + * + * Required. This field must be set in requests. + */ indexName?: string | undefined; - /** The column that includes the document text for retrieval. */ + /** + * The column that includes the document text for retrieval. + * + * Required. This field must be set in requests. + */ textCol?: string | undefined; - /** The column that specifies a link or reference to where the information came from. */ + /** + * The column that specifies a link or reference to where the information came from. + * + * Required. This field must be set in requests. + */ docUriCol?: string | undefined; } @@ -166,15 +231,25 @@ export interface KnowledgeAssistant { * Format: knowledge-assistants/{knowledge_assistant_id} */ name?: string | undefined; - /** State of the Knowledge Assistant. Not returned in List responses. */ + /** + * State of the Knowledge Assistant. Not returned in List responses. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ state?: KnowledgeAssistant_State | undefined; - /** Deprecated: use knowledge_assistant_id instead. */ + /** + * Deprecated: use knowledge_assistant_id instead. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ id?: string | undefined; /** * The display name of the Knowledge Assistant, unique at workspace level. * Required when creating a Knowledge Assistant. * When updating a Knowledge Assistant, optional unless included in * update_mask. + * + * Required. This field must be set in requests. */ displayName?: string | undefined; /** @@ -182,6 +257,8 @@ export interface KnowledgeAssistant { * Required when creating a Knowledge Assistant. * When updating a Knowledge Assistant, optional unless included in * update_mask. + * + * Required. This field must be set in requests. */ description?: string | undefined; /** @@ -191,15 +268,35 @@ export interface KnowledgeAssistant { * modify it. */ instructions?: string | undefined; - /** The creator of the Knowledge Assistant. */ + /** + * The creator of the Knowledge Assistant. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ creator?: string | undefined; - /** Creation timestamp. */ + /** + * Creation timestamp. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createTime?: Temporal.Instant | undefined; - /** The name of the knowledge assistant agent endpoint. */ + /** + * The name of the knowledge assistant agent endpoint. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ endpointName?: string | undefined; - /** The MLflow experiment ID. */ + /** + * The MLflow experiment ID. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ experimentId?: string | undefined; - /** Error details when the Knowledge Assistant is in FAILED state. */ + /** + * Error details when the Knowledge Assistant is in FAILED state. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ errorInfo?: string | undefined; } @@ -219,18 +316,24 @@ export interface KnowledgeSource { * Human-readable display name of the knowledge source. * Required when creating a Knowledge Source. * When updating a Knowledge Source, optional unless included in update_mask. + * + * Required. This field must be set in requests. */ displayName?: string | undefined; /** * Description of the knowledge source. * Required when creating a Knowledge Source. * When updating a Knowledge Source, optional unless included in update_mask. + * + * Required. This field must be set in requests. */ description?: string | undefined; /** * The type of the source: "index", "files", or "file_table". * Required when creating a Knowledge Source. * When updating a Knowledge Source, this field is ignored. + * + * Required. This field must be set in requests. */ sourceType?: string | undefined; /** Specification for the knowledge source type. */ @@ -239,11 +342,21 @@ export interface KnowledgeSource { | {$case: 'files'; files: FilesSpec} | {$case: 'fileTable'; fileTable: FileTableSpec} | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ state?: KnowledgeSource_State | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ id?: string | undefined; - /** Timestamp representing the cutoff before which content in this knowledge source is being ingested. */ + /** + * Timestamp representing the cutoff before which content in this knowledge source is being ingested. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ knowledgeCutoffTime?: Temporal.Instant | undefined; - /** Timestamp when this knowledge source was created. */ + /** + * Timestamp when this knowledge source was created. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createTime?: Temporal.Instant | undefined; } @@ -252,6 +365,8 @@ export interface ListExamplesRequest { /** * Parent resource to list from. * Format: knowledge-assistants/{knowledge_assistant_id} + * + * Required. This field must be set in requests. */ parent?: string | undefined; /** @@ -304,6 +419,8 @@ export interface ListKnowledgeSourcesRequest { /** * Parent resource to list from. * Format: knowledge-assistants/{knowledge_assistant_id} + * + * Required. This field must be set in requests. */ parent?: string | undefined; pageSize?: number | undefined; @@ -319,6 +436,8 @@ export interface SyncKnowledgeSourcesRequest { /** * The resource name of the Knowledge Assistant. * Format: knowledge-assistants/{knowledge_assistant_id} + * + * Required. This field must be set in requests. */ name?: string | undefined; } @@ -328,8 +447,11 @@ export interface UpdateExampleRequest { /** * The resource name of the example to update. * Format: knowledge-assistants/{knowledge_assistant_id}/examples/{example_id} + * + * Required. This field must be set in requests. */ name?: string | undefined; + /** Required. This field must be set in requests. */ example?: Example | undefined; /** * Comma-delimited list of fields to update on the example. @@ -337,6 +459,8 @@ export interface UpdateExampleRequest { * Examples: * - `question` * - `question,guidelines` + * + * Required. This field must be set in requests. */ updateMask?: FieldMask | undefined; } @@ -347,6 +471,8 @@ export interface UpdateKnowledgeAssistantRequest { * Only fields listed in update_mask are updated. * REQUIRED annotations on Knowledge Assistant fields describe create-time * requirements and do not mean all those fields are required for update. + * + * Required. This field must be set in requests. */ knowledgeAssistant?: KnowledgeAssistant | undefined; /** @@ -355,6 +481,8 @@ export interface UpdateKnowledgeAssistantRequest { * Examples: * - `display_name` * - `description,instructions` + * + * Required. This field must be set in requests. */ updateMask?: FieldMask | undefined; } @@ -363,6 +491,8 @@ export interface UpdateKnowledgeSourceRequest { /** * The resource name of the Knowledge Source to update. * Format: knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id} + * + * Required. This field must be set in requests. */ name?: string | undefined; /** @@ -370,6 +500,8 @@ export interface UpdateKnowledgeSourceRequest { * Only fields listed in update_mask are updated. * REQUIRED annotations on Knowledge Source fields describe create-time * requirements and do not mean all those fields are required for update. + * + * Required. This field must be set in requests. */ knowledgeSource?: KnowledgeSource | undefined; /** @@ -378,6 +510,8 @@ export interface UpdateKnowledgeSourceRequest { * Examples: * - `display_name` * - `display_name,description` + * + * Required. This field must be set in requests. */ updateMask?: FieldMask | undefined; } diff --git a/packages/lakeview/src/v1/model.ts b/packages/lakeview/src/v1/model.ts index b3fb1e2e..01f0d75a 100755 --- a/packages/lakeview/src/v1/model.ts +++ b/packages/lakeview/src/v1/model.ts @@ -64,6 +64,7 @@ export interface AuthorizationDetails_GrantRule { } export interface CreateDashboardRequest { + /** Required. This field must be set in requests. */ dashboard?: Dashboard | undefined; /** * Sets the default catalog for all datasets in this dashboard. @@ -80,12 +81,20 @@ export interface CreateDashboardRequest { } export interface CreateScheduleRequest { - /** The schedule to create. A dashboard is limited to 10 schedules. */ + /** + * The schedule to create. A dashboard is limited to 10 schedules. + * + * Required. This field must be set in requests. + */ schedule?: Schedule | undefined; } export interface CreateSubscriptionRequest { - /** The subscription to create. A schedule is limited to 100 subscriptions. */ + /** + * The subscription to create. A schedule is limited to 100 subscriptions. + * + * Required. This field must be set in requests. + */ subscription?: Subscription | undefined; } @@ -93,17 +102,25 @@ export interface CronSchedule { /** * A cron expression using quartz syntax. EX: `0 0 8 * * ?` represents everyday at 8am. * See [Cron Trigger](http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html) for details. + * + * Required. This field must be set in requests. */ quartzCronExpression?: string | undefined; /** * A Java timezone id. The schedule will be resolved with respect to this timezone. * See [Java TimeZone](https://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html) for details. + * + * Required. This field must be set in requests. */ timezoneId?: string | undefined; } export interface Dashboard { - /** UUID identifying the dashboard. */ + /** + * UUID identifying the dashboard. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ dashboardId?: string | undefined; /** The display name of the dashboard. */ displayName?: string | undefined; @@ -111,13 +128,21 @@ export interface Dashboard { * The workspace path of the dashboard asset, including the file name. * Exported dashboards always have the file extension `.lvdash.json`. * This field is excluded in List Dashboards responses. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ path?: string | undefined; - /** The timestamp of when the dashboard was created. */ + /** + * The timestamp of when the dashboard was created. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createTime?: Temporal.Instant | undefined; /** * The timestamp of when the dashboard was last updated by the user. * This field is excluded in List Dashboards responses. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ updateTime?: Temporal.Instant | undefined; /** The warehouse ID used to run the dashboard. */ @@ -137,20 +162,34 @@ export interface Dashboard { * layout and components. */ serializedDashboard?: string | undefined; - /** The state of the dashboard resource. Used for tracking trashed status. */ + /** + * The state of the dashboard resource. Used for tracking trashed status. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ lifecycleState?: LifecycleState | undefined; /** * The workspace path of the folder containing the dashboard. Includes leading slash and no * trailing slash. * This field is excluded in List Dashboards responses. + * + * Immutable. Set this field when the resource is created; it cannot be changed afterward. */ parentPath?: string | undefined; } export interface DeleteScheduleRequest { - /** UUID identifying the schedule. */ + /** + * UUID identifying the schedule. + * + * Required. This field must be set in requests. + */ scheduleId?: string | undefined; - /** UUID identifying the dashboard to which the schedule belongs. */ + /** + * UUID identifying the dashboard to which the schedule belongs. + * + * Required. This field must be set in requests. + */ dashboardId?: string | undefined; /** * The etag for the schedule. Optionally, it can be provided to verify that the schedule has not @@ -160,11 +199,23 @@ export interface DeleteScheduleRequest { } export interface DeleteSubscriptionRequest { - /** UUID identifying the subscription. */ + /** + * UUID identifying the subscription. + * + * Required. This field must be set in requests. + */ subscriptionId?: string | undefined; - /** UUID identifying the schedule which the subscription belongs. */ + /** + * UUID identifying the schedule which the subscription belongs. + * + * Required. This field must be set in requests. + */ scheduleId?: string | undefined; - /** UUID identifying the dashboard which the subscription belongs. */ + /** + * UUID identifying the dashboard which the subscription belongs. + * + * Required. This field must be set in requests. + */ dashboardId?: string | undefined; /** * The etag for the subscription. Can be optionally provided to ensure that the subscription has not been @@ -174,17 +225,29 @@ export interface DeleteSubscriptionRequest { } export interface GetDashboardRequest { - /** UUID identifying the dashboard. */ + /** + * UUID identifying the dashboard. + * + * Required. This field must be set in requests. + */ dashboardId?: string | undefined; } export interface GetPublishedDashboardRequest { - /** UUID identifying the published dashboard. */ + /** + * UUID identifying the published dashboard. + * + * Required. This field must be set in requests. + */ dashboardId?: string | undefined; } export interface GetPublishedDashboardTokenInfoRequest { - /** UUID identifying the published dashboard. */ + /** + * UUID identifying the published dashboard. + * + * Required. This field must be set in requests. + */ dashboardId?: string | undefined; /** Provided external value to be included in the custom claim. */ externalValue?: string | undefined; @@ -209,18 +272,38 @@ export interface GetPublishedDashboardTokenInfoResponse { } export interface GetScheduleRequest { - /** UUID identifying the schedule. */ + /** + * UUID identifying the schedule. + * + * Required. This field must be set in requests. + */ scheduleId?: string | undefined; - /** UUID identifying the dashboard to which the schedule belongs. */ + /** + * UUID identifying the dashboard to which the schedule belongs. + * + * Required. This field must be set in requests. + */ dashboardId?: string | undefined; } export interface GetSubscriptionRequest { - /** UUID identifying the subscription. */ + /** + * UUID identifying the subscription. + * + * Required. This field must be set in requests. + */ subscriptionId?: string | undefined; - /** UUID identifying the schedule which the subscription belongs. */ + /** + * UUID identifying the schedule which the subscription belongs. + * + * Required. This field must be set in requests. + */ scheduleId?: string | undefined; - /** UUID identifying the dashboard which the subscription belongs. */ + /** + * UUID identifying the dashboard which the subscription belongs. + * + * Required. This field must be set in requests. + */ dashboardId?: string | undefined; } @@ -251,7 +334,11 @@ export interface ListDashboardsResponse { } export interface ListSchedulesRequest { - /** UUID identifying the dashboard to which the schedules belongs. */ + /** + * UUID identifying the dashboard to which the schedules belongs. + * + * Required. This field must be set in requests. + */ dashboardId?: string | undefined; /** The number of schedules to return per page. */ pageSize?: number | undefined; @@ -272,9 +359,17 @@ export interface ListSchedulesResponse { } export interface ListSubscriptionsRequest { - /** UUID identifying the dashboard which the subscriptions belongs. */ + /** + * UUID identifying the dashboard which the subscriptions belongs. + * + * Required. This field must be set in requests. + */ dashboardId?: string | undefined; - /** UUID identifying the schedule which the subscriptions belongs. */ + /** + * UUID identifying the schedule which the subscriptions belongs. + * + * Required. This field must be set in requests. + */ scheduleId?: string | undefined; /** The number of subscriptions to return per page. */ pageSize?: number | undefined; @@ -295,7 +390,11 @@ export interface ListSubscriptionsResponse { } export interface MigrateDashboardRequest { - /** UUID of the dashboard to be migrated. */ + /** + * UUID of the dashboard to be migrated. + * + * Required. This field must be set in requests. + */ sourceDashboardId?: string | undefined; /** Display name for the new Lakeview dashboard. */ displayName?: string | undefined; @@ -309,7 +408,11 @@ export interface MigrateDashboardRequest { } export interface PublishDashboardRequest { - /** UUID identifying the dashboard to be published. */ + /** + * UUID identifying the dashboard to be published. + * + * Required. This field must be set in requests. + */ dashboardId?: string | undefined; /** * Flag to indicate if the publisher's credentials should be embedded in the @@ -325,19 +428,31 @@ export interface PublishDashboardRequest { } export interface PublishedDashboard { - /** The display name of the published dashboard. */ + /** + * The display name of the published dashboard. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ displayName?: string | undefined; /** The warehouse ID used to run the published dashboard. */ warehouseId?: string | undefined; /** Indicates whether credentials are embedded in the published dashboard. */ embedCredentials?: boolean | undefined; - /** The timestamp of when the published dashboard was last revised. */ + /** + * The timestamp of when the published dashboard was last revised. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ revisionCreateTime?: Temporal.Instant | undefined; } /** Request to revert a dashboard draft to its last published state. */ export interface RevertDashboardRequest { - /** UUID identifying the dashboard. */ + /** + * UUID identifying the dashboard. + * + * Required. This field must be set in requests. + */ dashboardId?: string | undefined; /** * The etag for the dashboard. Optionally, it can be provided to verify that the dashboard @@ -353,11 +468,23 @@ export interface RevertDashboardResponse { } export interface Schedule { - /** UUID identifying the schedule. */ + /** + * UUID identifying the schedule. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ scheduleId?: string | undefined; - /** UUID identifying the dashboard to which the schedule belongs. */ + /** + * UUID identifying the dashboard to which the schedule belongs. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ dashboardId?: string | undefined; - /** The cron expression describing the frequency of the periodic refresh for this schedule. */ + /** + * The cron expression describing the frequency of the periodic refresh for this schedule. + * + * Required. This field must be set in requests. + */ cronSchedule?: CronSchedule | undefined; /** The status indicates whether this schedule is paused or not. */ pauseStatus?: SchedulePauseStatus | undefined; @@ -368,33 +495,69 @@ export interface Schedule { * that the schedule has not been modified since the last read, and can be optionally provided on delete. */ etag?: string | undefined; - /** A timestamp indicating when the schedule was created. */ + /** + * A timestamp indicating when the schedule was created. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createTime?: Temporal.Instant | undefined; - /** A timestamp indicating when the schedule was last updated. */ + /** + * A timestamp indicating when the schedule was last updated. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updateTime?: Temporal.Instant | undefined; /** The warehouse id to run the dashboard with for the schedule. */ warehouseId?: string | undefined; } export interface Subscription { - /** UUID identifying the subscription. */ + /** + * UUID identifying the subscription. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ subscriptionId?: string | undefined; - /** UUID identifying the schedule to which the subscription belongs. */ + /** + * UUID identifying the schedule to which the subscription belongs. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ scheduleId?: string | undefined; - /** UUID identifying the dashboard to which the subscription belongs. */ + /** + * UUID identifying the dashboard to which the subscription belongs. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ dashboardId?: string | undefined; - /** Subscriber details for users and destinations to be added as subscribers to the schedule. */ + /** + * Subscriber details for users and destinations to be added as subscribers to the schedule. + * + * Required. This field must be set in requests. + */ subscriber?: Subscription_Subscriber | undefined; - /** UserId of the user who adds subscribers (users or notification destinations) to the dashboard's schedule. */ + /** + * UserId of the user who adds subscribers (users or notification destinations) to the dashboard's schedule. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdByUserId?: bigint | undefined; /** * The etag for the subscription. Must be left empty on create, can be optionally provided on delete * to ensure that the subscription has not been deleted since the last read. */ etag?: string | undefined; - /** A timestamp indicating when the subscription was created. */ + /** + * A timestamp indicating when the subscription was created. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createTime?: Temporal.Instant | undefined; - /** A timestamp indicating when the subscription was last updated. */ + /** + * A timestamp indicating when the subscription was last updated. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updateTime?: Temporal.Instant | undefined; /** * Controls whether notifications are sent to the subscriber for scheduled dashboard refreshes. @@ -419,18 +582,30 @@ export interface Subscription_Subscriber { // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name. export interface Subscription_Subscriber_Destination { - /** The canonical identifier of the destination to receive email notification. */ + /** + * The canonical identifier of the destination to receive email notification. + * + * Required. This field must be set in requests. + */ destinationId?: string | undefined; } // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name. export interface Subscription_Subscriber_User { - /** UserId of the subscriber. */ + /** + * UserId of the subscriber. + * + * Required. This field must be set in requests. + */ userId?: bigint | undefined; } export interface TrashDashboardRequest { - /** UUID identifying the dashboard. */ + /** + * UUID identifying the dashboard. + * + * Required. This field must be set in requests. + */ dashboardId?: string | undefined; } @@ -438,7 +613,11 @@ export interface TrashDashboardRequest { export interface TrashDashboardResponse {} export interface UnpublishDashboardRequest { - /** UUID identifying the published dashboard. */ + /** + * UUID identifying the published dashboard. + * + * Required. This field must be set in requests. + */ dashboardId?: string | undefined; } @@ -446,6 +625,7 @@ export interface UnpublishDashboardRequest { export interface UnpublishDashboardResponse {} export interface UpdateDashboardRequest { + /** Required. This field must be set in requests. */ dashboard?: Dashboard | undefined; /** * Sets the default catalog for all datasets in this dashboard. @@ -462,7 +642,11 @@ export interface UpdateDashboardRequest { } export interface UpdateScheduleRequest { - /** The schedule to update. */ + /** + * The schedule to update. + * + * Required. This field must be set in requests. + */ schedule?: Schedule | undefined; } diff --git a/packages/logdelivery/src/v1/model.ts b/packages/logdelivery/src/v1/model.ts index 8c580c66..46a20696 100755 --- a/packages/logdelivery/src/v1/model.ts +++ b/packages/logdelivery/src/v1/model.ts @@ -89,19 +89,35 @@ export interface CreateLogDeliveryConfigurationParams { * Log delivery type. Supported values are: * * `BILLABLE_USAGE` — Configure [billable usage log delivery](https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html). For the CSV schema, see the [View billable usage](https://docs.databricks.com/administration-guide/account-settings/usage.html). * * `AUDIT_LOGS` — Configure [audit log delivery](https://docs.databricks.com/administration-guide/account-settings/audit-logs.html). For the JSON schema, see [Configure audit logging](https://docs.databricks.com/administration-guide/account-settings/audit-logs.html) + * + * Required. This field must be set in requests. */ logType?: LogDeliveryType | undefined; /** * The file type of log delivery. * * If `log_type` is `BILLABLE_USAGE`, this value must be `CSV`. Only the CSV (comma-separated values) format is supported. For the schema, see the [View billable usage](https://docs.databricks.com/administration-guide/account-settings/usage.html) * * If `log_type` is `AUDIT_LOGS`, this value must be `JSON`. Only the JSON (JavaScript Object Notation) format is supported. For the schema, see the [Configuring audit logs](https://docs.databricks.com/administration-guide/account-settings/audit-logs.html). + * + * Required. This field must be set in requests. */ outputFormat?: LogDeliveryOutputFormat | undefined; - /** account ID. */ + /** + * account ID. + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; - /** The ID for a method:credentials/create that represents the AWS IAM role with policy and trust relationship as described in the main billable usage documentation page. See [Configure billable usage delivery](https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html). */ + /** + * The ID for a method:credentials/create that represents the AWS IAM role with policy and trust relationship as described in the main billable usage documentation page. See [Configure billable usage delivery](https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html). + * + * Required. This field must be set in requests. + */ credentialsId?: string | undefined; - /** The ID for a method:storage/create that represents the S3 bucket with bucket policy as described in the main billable usage documentation page. See [Configure billable usage delivery](https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html). */ + /** + * The ID for a method:storage/create that represents the S3 bucket with bucket policy as described in the main billable usage documentation page. See [Configure billable usage delivery](https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html). + * + * Required. This field must be set in requests. + */ storageConfigurationId?: string | undefined; /** Optional filter that specifies workspace IDs to deliver logs for. By default the workspace filter is empty and log delivery applies at the account level, delivering workspace-level logs for all workspaces in your account, plus account level logs. You can optionally set this field to an array of workspace IDs (each one is an `int64`) to which log delivery should apply, in which case only workspace-level logs relating to the specified workspaces are delivered. If you plan to use different log delivery configurations for different workspaces, set this field explicitly. Be aware that delivery configurations mentioning specific workspaces won't apply to new workspaces created in the future, and delivery won't include account level logs. For some types of deployments there is only one workspace per account ID, so this field is unnecessary. */ workspaceIdsFilter?: bigint[] | undefined; @@ -124,6 +140,7 @@ export interface CreateLogDeliveryConfigurationParams { * Properties of the new log delivery configuration. */ export interface CreateLogDeliveryConfigurationRequest { + /** Required. This field must be set in requests. */ logDeliveryConfiguration?: CreateLogDeliveryConfigurationParams | undefined; } @@ -137,9 +154,17 @@ export interface CreateLogDeliveryConfigurationResponse { * Get Log Delivery Configuration */ export interface GetLogDeliveryConfigurationRequest { - /** The log delivery configuration id of customer */ + /** + * The log delivery configuration id of customer + * + * Required. This field must be set in requests. + */ configId?: string | undefined; - /** account ID. */ + /** + * account ID. + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; } @@ -153,7 +178,11 @@ export interface GetLogDeliveryConfigurationResponse { * List Log Delivery Configuration */ export interface ListLogDeliveryConfigurationRequest { - /** account ID. */ + /** + * account ID. + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; /** The Credentials id to filter the search results with */ credentialsId?: string | undefined; @@ -188,19 +217,35 @@ export interface LogDeliveryConfiguration { * Log delivery type. Supported values are: * * `BILLABLE_USAGE` — Configure [billable usage log delivery](https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html). For the CSV schema, see the [View billable usage](https://docs.databricks.com/administration-guide/account-settings/usage.html). * * `AUDIT_LOGS` — Configure [audit log delivery](https://docs.databricks.com/administration-guide/account-settings/audit-logs.html). For the JSON schema, see [Configure audit logging](https://docs.databricks.com/administration-guide/account-settings/audit-logs.html) + * + * Required. This field must be set in requests. */ logType?: LogDeliveryType | undefined; /** * The file type of log delivery. * * If `log_type` is `BILLABLE_USAGE`, this value must be `CSV`. Only the CSV (comma-separated values) format is supported. For the schema, see the [View billable usage](https://docs.databricks.com/administration-guide/account-settings/usage.html) * * If `log_type` is `AUDIT_LOGS`, this value must be `JSON`. Only the JSON (JavaScript Object Notation) format is supported. For the schema, see the [Configuring audit logs](https://docs.databricks.com/administration-guide/account-settings/audit-logs.html). + * + * Required. This field must be set in requests. */ outputFormat?: LogDeliveryOutputFormat | undefined; - /** account ID. */ + /** + * account ID. + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; - /** The ID for a method:credentials/create that represents the AWS IAM role with policy and trust relationship as described in the main billable usage documentation page. See [Configure billable usage delivery](https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html). */ + /** + * The ID for a method:credentials/create that represents the AWS IAM role with policy and trust relationship as described in the main billable usage documentation page. See [Configure billable usage delivery](https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html). + * + * Required. This field must be set in requests. + */ credentialsId?: string | undefined; - /** The ID for a method:storage/create that represents the S3 bucket with bucket policy as described in the main billable usage documentation page. See [Configure billable usage delivery](https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html). */ + /** + * The ID for a method:storage/create that represents the S3 bucket with bucket policy as described in the main billable usage documentation page. See [Configure billable usage delivery](https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html). + * + * Required. This field must be set in requests. + */ storageConfigurationId?: string | undefined; /** Optional filter that specifies workspace IDs to deliver logs for. By default the workspace filter is empty and log delivery applies at the account level, delivering workspace-level logs for all workspaces in your account, plus account level logs. You can optionally set this field to an array of workspace IDs (each one is an `int64`) to which log delivery should apply, in which case only workspace-level logs relating to the specified workspaces are delivered. If you plan to use different log delivery configurations for different workspaces, set this field explicitly. Be aware that delivery configurations mentioning specific workspaces won't apply to new workspaces created in the future, and delivery won't include account level logs. For some types of deployments there is only one workspace per account ID, so this field is unnecessary. */ workspaceIdsFilter?: bigint[] | undefined; @@ -226,13 +271,19 @@ export interface LogDeliveryStatus { * * `USER_FAILURE`: The latest attempt of log delivery failed because of misconfiguration of customer provided permissions on role or storage. * * `SYSTEM_FAILURE`: The latest attempt of log delivery failed because of an internal error. Contact support if it doesn't go away soon. * * `NOT_FOUND`: The log delivery status as the configuration has been disabled since the release of this feature or there are no workspaces in the account. + * + * Required. This field must be set in requests. */ status?: LogDeliveryStatusEnum | undefined; /** The UTC time for the latest log delivery attempt. */ lastAttemptTime?: string | undefined; /** The UTC time for the latest successful log delivery. */ lastSuccessfulAttemptTime?: string | undefined; - /** Informative message about the latest log delivery attempt. If the log delivery fails with USER_FAILURE, error details will be provided for fixing misconfigurations in cloud permissions. */ + /** + * Informative message about the latest log delivery attempt. If the log delivery fails with USER_FAILURE, error details will be provided for fixing misconfigurations in cloud permissions. + * + * Required. This field must be set in requests. + */ message?: string | undefined; } @@ -241,11 +292,23 @@ export interface LogDeliveryStatus { * Update Log Delivery Configuration */ export interface UpdateLogDeliveryConfigurationRequest { - /** The log delivery configuration id of customer */ + /** + * The log delivery configuration id of customer + * + * Required. This field must be set in requests. + */ configId?: string | undefined; - /** account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html). */ + /** + * account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html). + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; - /** Status of log delivery configuration. Set to `ENABLED` (enabled) or `DISABLED` (disabled). Defaults to `ENABLED`. You can [enable or disable the configuration](#operation/patch-log-delivery-config-status) later. Deletion of a configuration is not supported, so disable a log delivery configuration that is no longer needed. */ + /** + * Status of log delivery configuration. Set to `ENABLED` (enabled) or `DISABLED` (disabled). Defaults to `ENABLED`. You can [enable or disable the configuration](#operation/patch-log-delivery-config-status) later. Deletion of a configuration is not supported, so disable a log delivery configuration that is no longer needed. + * + * Required. This field must be set in requests. + */ status?: LogDeliveryConfigStatus | undefined; } diff --git a/packages/marketplaces/src/v1/model.ts b/packages/marketplaces/src/v1/model.ts index bb33435e..fd2ed21c 100755 --- a/packages/marketplaces/src/v1/model.ts +++ b/packages/marketplaces/src/v1/model.ts @@ -205,7 +205,9 @@ export type Visibility = | (string & {}); export interface AddExchangeForListingRequest { + /** Required. This field must be set in requests. */ listingId?: string | undefined; + /** Required. This field must be set in requests. */ exchangeId?: string | undefined; } @@ -230,6 +232,7 @@ export interface BatchGetProvidersResponse { } export interface ConsumerTerms { + /** Required. This field must be set in requests. */ version?: string | undefined; } @@ -242,6 +245,7 @@ export interface ContactInfo { } export interface CreateExchangeFilterRequest { + /** Required. This field must be set in requests. */ filter?: ExchangeFilter | undefined; } @@ -250,6 +254,7 @@ export interface CreateExchangeFilterResponse { } export interface CreateExchangeRequest { + /** Required. This field must be set in requests. */ exchange?: Exchange | undefined; } @@ -258,8 +263,11 @@ export interface CreateExchangeResponse { } export interface CreateFileRequest { + /** Required. This field must be set in requests. */ fileParent?: FileParent | undefined; + /** Required. This field must be set in requests. */ marketplaceFileType?: MarketplaceFileType | undefined; + /** Required. This field must be set in requests. */ mimeType?: string | undefined; displayName?: string | undefined; } @@ -271,6 +279,7 @@ export interface CreateFileResponse { } export interface CreateInstallationRequest { + /** Required. This field must be set in requests. */ listingId?: string | undefined; shareName?: string | undefined; catalogName?: string | undefined; @@ -285,6 +294,7 @@ export interface CreateInstallationResponse { } export interface CreateListingRequest { + /** Required. This field must be set in requests. */ listing?: Listing | undefined; } @@ -297,14 +307,17 @@ export interface CreateListingResponse { * also creates a lead (maybe) */ export interface CreatePersonalizationRequest { + /** Required. This field must be set in requests. */ listingId?: string | undefined; comment?: string | undefined; + /** Required. This field must be set in requests. */ intendedUse?: string | undefined; firstName?: string | undefined; lastName?: string | undefined; company?: string | undefined; isFromLighthouse?: boolean | undefined; recipientType?: DeltaSharingRecipientType | undefined; + /** Required. This field must be set in requests. */ acceptedConsumerTerms?: ConsumerTerms | undefined; } @@ -316,10 +329,12 @@ export interface CreatePersonalizationResponse { export interface CreateProviderAnalyticsDashboardRequest {} export interface CreateProviderAnalyticsDashboardResponse { + /** Required. This field must be set in requests. */ id?: string | undefined; } export interface CreateProviderRequest { + /** Required. This field must be set in requests. */ provider?: ProviderInfo | undefined; } @@ -328,11 +343,14 @@ export interface CreateProviderResponse { } export interface DataRefreshInfo { + /** Required. This field must be set in requests. */ interval?: bigint | undefined; + /** Required. This field must be set in requests. */ unit?: DataRefresh | undefined; } export interface DeleteExchangeFilterRequest { + /** Required. This field must be set in requests. */ id?: string | undefined; } @@ -340,6 +358,7 @@ export interface DeleteExchangeFilterRequest { export interface DeleteExchangeFilterResponse {} export interface DeleteExchangeRequest { + /** Required. This field must be set in requests. */ id?: string | undefined; } @@ -347,6 +366,7 @@ export interface DeleteExchangeRequest { export interface DeleteExchangeResponse {} export interface DeleteFileRequest { + /** Required. This field must be set in requests. */ fileId?: string | undefined; } @@ -354,7 +374,9 @@ export interface DeleteFileRequest { export interface DeleteFileResponse {} export interface DeleteInstallationRequest { + /** Required. This field must be set in requests. */ listingId?: string | undefined; + /** Required. This field must be set in requests. */ installationId?: string | undefined; } @@ -362,6 +384,7 @@ export interface DeleteInstallationRequest { export interface DeleteInstallationResponse {} export interface DeleteListingRequest { + /** Required. This field must be set in requests. */ id?: string | undefined; } @@ -369,6 +392,7 @@ export interface DeleteListingRequest { export interface DeleteListingResponse {} export interface DeleteProviderRequest { + /** Required. This field must be set in requests. */ id?: string | undefined; } @@ -377,6 +401,7 @@ export interface DeleteProviderResponse {} export interface Exchange { id?: string | undefined; + /** Required. This field must be set in requests. */ name?: string | undefined; comment?: string | undefined; filters?: ExchangeFilter[] | undefined; @@ -389,13 +414,16 @@ export interface Exchange { export interface ExchangeFilter { id?: string | undefined; + /** Required. This field must be set in requests. */ exchangeId?: string | undefined; + /** Required. This field must be set in requests. */ filterValue?: string | undefined; name?: string | undefined; createdAt?: bigint | undefined; createdBy?: string | undefined; updatedAt?: bigint | undefined; updatedBy?: string | undefined; + /** Required. This field must be set in requests. */ filterType?: ExchangeFilterType | undefined; } @@ -435,6 +463,7 @@ export interface GetAllPersonalizationRequestsForConsumerResponse { } export interface GetExchangeRequest { + /** Required. This field must be set in requests. */ id?: string | undefined; } @@ -443,6 +472,7 @@ export interface GetExchangeResponse { } export interface GetFileRequest { + /** Required. This field must be set in requests. */ fileId?: string | undefined; } @@ -451,6 +481,7 @@ export interface GetFileResponse { } export interface GetInstallationDetailsRequest { + /** Required. This field must be set in requests. */ listingId?: string | undefined; pageToken?: string | undefined; pageSize?: number | undefined; @@ -469,6 +500,7 @@ export interface GetLatestVersionProviderAnalyticsDashboardResponse { } export interface GetListingContentMetadataRequest { + /** Required. This field must be set in requests. */ listingId?: string | undefined; pageToken?: string | undefined; pageSize?: number | undefined; @@ -480,6 +512,7 @@ export interface GetListingContentMetadataResponse { } export interface GetListingRequest { + /** Required. This field must be set in requests. */ id?: string | undefined; } @@ -493,6 +526,7 @@ export interface GetListingsResponse { } export interface GetPersonalizationRequestsForConsumerRequest { + /** Required. This field must be set in requests. */ listingId?: string | undefined; } @@ -511,6 +545,7 @@ export interface GetPersonalizationRequestsForProviderResponse { } export interface GetProviderRequest { + /** Required. This field must be set in requests. */ id?: string | undefined; } @@ -519,6 +554,7 @@ export interface GetProviderResponse { } export interface GetPublishedListingForConsumerRequest { + /** Required. This field must be set in requests. */ id?: string | undefined; } @@ -532,6 +568,7 @@ export interface GetPublishedListingsForConsumerResponse { } export interface GetPublishedProviderForConsumerRequest { + /** Required. This field must be set in requests. */ id?: string | undefined; } @@ -561,6 +598,7 @@ export interface ListAllInstallationsResponse { } export interface ListExchangeFiltersRequest { + /** Required. This field must be set in requests. */ exchangeId?: string | undefined; pageToken?: string | undefined; pageSize?: number | undefined; @@ -572,6 +610,7 @@ export interface ListExchangeFiltersResponse { } export interface ListExchangesForListingRequest { + /** Required. This field must be set in requests. */ listingId?: string | undefined; pageToken?: string | undefined; pageSize?: number | undefined; @@ -593,6 +632,7 @@ export interface ListExchangesResponse { } export interface ListFilesRequest { + /** Required. This field must be set in requests. */ fileParent?: FileParent | undefined; pageToken?: string | undefined; pageSize?: number | undefined; @@ -619,12 +659,14 @@ export interface ListInstallationsResponse { } export interface ListListingFulfillmentsRequest { + /** Required. This field must be set in requests. */ listingId?: string | undefined; pageToken?: string | undefined; pageSize?: number | undefined; } export interface ListListingsForExchangeRequest { + /** Required. This field must be set in requests. */ exchangeId?: string | undefined; pageToken?: string | undefined; pageSize?: number | undefined; @@ -649,9 +691,14 @@ export interface ListPersonalizationRequestsForConsumerRequest { export interface ListProviderAnalyticsDashboardRequest {} export interface ListProviderAnalyticsDashboardResponse { + /** Required. This field must be set in requests. */ id?: string | undefined; version?: bigint | undefined; - /** dashboard_id will be used to open Lakeview dashboard. */ + /** + * dashboard_id will be used to open Lakeview dashboard. + * + * Required. This field must be set in requests. + */ dashboardId?: string | undefined; } @@ -698,6 +745,7 @@ export interface ListPublishedProvidersForConsumerResponse { export interface Listing { id?: string | undefined; + /** Required. This field must be set in requests. */ summary?: ListingSummary | undefined; detail?: ListingDetail | undefined; } @@ -749,6 +797,7 @@ export interface ListingDetail { } export interface ListingFulfillment { + /** Required. This field must be set in requests. */ listingId?: string | undefined; fulfillmentType?: FulfillmentType | undefined; shareInfo?: ShareInfo | undefined; @@ -761,6 +810,7 @@ export interface ListingSetting { } export interface ListingSummary { + /** Required. This field must be set in requests. */ name?: string | undefined; subtitle?: string | undefined; status?: ListingStatus | undefined; @@ -774,6 +824,7 @@ export interface ListingSummary { publishedAt?: bigint | undefined; publishedBy?: string | undefined; categories?: Category[] | undefined; + /** Required. This field must be set in requests. */ listingType?: ListingType | undefined; createdById?: bigint | undefined; updatedById?: bigint | undefined; @@ -792,6 +843,7 @@ export interface ListingTag { export interface PersonalizationRequest { id?: string | undefined; + /** Required. This field must be set in requests. */ consumerRegion?: RegionInfo | undefined; contactInfo?: ContactInfo | undefined; comment?: string | undefined; @@ -815,9 +867,11 @@ export interface PersonalizationRequest { export interface ProviderInfo { id?: string | undefined; + /** Required. This field must be set in requests. */ name?: string | undefined; description?: string | undefined; iconFilePath?: string | undefined; + /** Required. This field must be set in requests. */ businessContactEmail?: string | undefined; supportContactEmail?: string | undefined; /** is_featured is accessible by consumers only */ @@ -826,7 +880,9 @@ export interface ProviderInfo { publishedBy?: string | undefined; companyWebsiteLink?: string | undefined; iconFileId?: string | undefined; + /** Required. This field must be set in requests. */ termOfServiceLink?: string | undefined; + /** Required. This field must be set in requests. */ privacyPolicyLink?: string | undefined; darkModeIconFileId?: string | undefined; darkModeIconFilePath?: string | undefined; @@ -838,6 +894,7 @@ export interface RegionInfo { } export interface RemoveExchangeForListingRequest { + /** Required. This field must be set in requests. */ id?: string | undefined; } @@ -845,22 +902,36 @@ export interface RemoveExchangeForListingRequest { export interface RemoveExchangeForListingResponse {} export interface RepoInfo { - /** the git repo url e.g. https://github.com/databrickslabs/dolly.git */ + /** + * the git repo url e.g. https://github.com/databrickslabs/dolly.git + * + * Required. This field must be set in requests. + */ gitRepoUrl?: string | undefined; } export interface RepoInstallation { - /** the user-specified repo name for their installed git repo listing */ + /** + * the user-specified repo name for their installed git repo listing + * + * Required. This field must be set in requests. + */ repoName?: string | undefined; /** * refers to the full url file path that navigates the user to the repo's entrypoint (e.g. a README.md file, or the repo file view in the unified UI) * should just be a relative path + * + * Required. This field must be set in requests. */ repoPath?: string | undefined; } export interface SearchPublishedListingsForConsumerRequest { - /** Fuzzy matches query */ + /** + * Fuzzy matches query + * + * Required. This field must be set in requests. + */ query?: string | undefined; isFree?: boolean | undefined; isPrivateExchange?: boolean | undefined; @@ -880,7 +951,9 @@ export interface SearchPublishedListingsForConsumerResponse { } export interface ShareInfo { + /** Required. This field must be set in requests. */ name?: string | undefined; + /** Required. This field must be set in requests. */ type?: ListingShareType | undefined; } @@ -923,7 +996,9 @@ export interface TokenInfo { } export interface UpdateExchangeFilterRequest { + /** Required. This field must be set in requests. */ id?: string | undefined; + /** Required. This field must be set in requests. */ filter?: ExchangeFilter | undefined; } @@ -932,7 +1007,9 @@ export interface UpdateExchangeFilterResponse { } export interface UpdateExchangeRequest { + /** Required. This field must be set in requests. */ id?: string | undefined; + /** Required. This field must be set in requests. */ exchange?: Exchange | undefined; } @@ -941,8 +1018,11 @@ export interface UpdateExchangeResponse { } export interface UpdateInstallationRequest { + /** Required. This field must be set in requests. */ listingId?: string | undefined; + /** Required. This field must be set in requests. */ installationId?: string | undefined; + /** Required. This field must be set in requests. */ installation?: InstallationDetail | undefined; rotateToken?: boolean | undefined; } @@ -952,7 +1032,9 @@ export interface UpdateInstallationResponse { } export interface UpdateListingRequest { + /** Required. This field must be set in requests. */ id?: string | undefined; + /** Required. This field must be set in requests. */ listing?: Listing | undefined; } @@ -961,8 +1043,11 @@ export interface UpdateListingResponse { } export interface UpdatePersonalizationRequestStatusRequest { + /** Required. This field must be set in requests. */ listingId?: string | undefined; + /** Required. This field must be set in requests. */ requestId?: string | undefined; + /** Required. This field must be set in requests. */ status?: PersonalizationRequestStatus | undefined; reason?: string | undefined; share?: ShareInfo | undefined; @@ -973,7 +1058,11 @@ export interface UpdatePersonalizationRequestStatusResponse { } export interface UpdateProviderAnalyticsDashboardRequest { - /** id is immutable property and can't be updated. */ + /** + * id is immutable property and can't be updated. + * + * Required. This field must be set in requests. + */ id?: string | undefined; /** * this is the version of the dashboard template we want to update our user to @@ -983,15 +1072,25 @@ export interface UpdateProviderAnalyticsDashboardRequest { } export interface UpdateProviderAnalyticsDashboardResponse { - /** id & version should be the same as the request */ + /** + * id & version should be the same as the request + * + * Required. This field must be set in requests. + */ id?: string | undefined; version?: bigint | undefined; - /** this is newly created Lakeview dashboard for the user */ + /** + * this is newly created Lakeview dashboard for the user + * + * Required. This field must be set in requests. + */ dashboardId?: string | undefined; } export interface UpdateProviderRequest { + /** Required. This field must be set in requests. */ id?: string | undefined; + /** Required. This field must be set in requests. */ provider?: ProviderInfo | undefined; } diff --git a/packages/modelregistry/src/v1/model.ts b/packages/modelregistry/src/v1/model.ts index 5c076859..8119ed48 100755 --- a/packages/modelregistry/src/v1/model.ts +++ b/packages/modelregistry/src/v1/model.ts @@ -225,9 +225,17 @@ export interface Activity { /** Details required to identify and approve a model version stage transition request. */ export interface ApproveTransitionRequest { - /** Name of the model. */ + /** + * Name of the model. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Version of the model. */ + /** + * Version of the model. + * + * Required. This field must be set in requests. + */ version?: string | undefined; /** * Target stage of the transition. Valid values are: @@ -239,9 +247,15 @@ export interface ApproveTransitionRequest { * * `Production`: Production stage. * * * `Archived`: Archived stage. + * + * Required. This field must be set in requests. */ stage?: string | undefined; - /** Specifies whether to archive all current model versions in the target stage. */ + /** + * Specifies whether to archive all current model versions in the target stage. + * + * Required. This field must be set in requests. + */ archiveExistingVersions?: boolean | undefined; /** User-provided comment on the action. */ comment?: string | undefined; @@ -301,11 +315,23 @@ export interface CommentObject { /** Details required to create a comment on a model version. */ export interface CreateCommentRequest { - /** Name of the model. */ + /** + * Name of the model. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Version of the model. */ + /** + * Version of the model. + * + * Required. This field must be set in requests. + */ version?: string | undefined; - /** User-provided comment on the action. */ + /** + * User-provided comment on the action. + * + * Required. This field must be set in requests. + */ comment?: string | undefined; } @@ -315,9 +341,17 @@ export interface CreateCommentResponse { } export interface CreateModelVersionRequest { - /** Register model under this name */ + /** + * Register model under this name + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** URI indicating the location of the model artifacts. */ + /** + * URI indicating the location of the model artifacts. + * + * Required. This field must be set in requests. + */ source?: string | undefined; /** * MLflow run ID for correlation, if `source` was generated by an experiment run in @@ -341,7 +375,11 @@ export interface CreateModelVersionResponse { } export interface CreateRegisteredModelRequest { - /** Register models under this name */ + /** + * Register models under this name + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** Additional metadata for registered model. */ tags?: RegisteredModelTag[] | undefined; @@ -382,6 +420,8 @@ export interface CreateRegistryWebhookRequest { * * `TRANSITION_REQUEST_TO_PRODUCTION_CREATED`: A user requested a model version be transitioned to production. * * * `TRANSITION_REQUEST_TO_ARCHIVED_CREATED`: A user requested a model version be archived. + * + * Required. This field must be set in requests. */ events?: RegistryWebhookEvent[] | undefined; /** User-specified description for the webhook. */ @@ -407,9 +447,17 @@ export interface CreateRegistryWebhookResponse { /** Details required to create a model version stage transition request. */ export interface CreateTransitionRequest { - /** Name of the model. */ + /** + * Name of the model. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Version of the model. */ + /** + * Version of the model. + * + * Required. This field must be set in requests. + */ version?: string | undefined; /** * Target stage of the transition. Valid values are: @@ -421,6 +469,8 @@ export interface CreateTransitionRequest { * * `Production`: Production stage. * * * `Archived`: Archived stage. + * + * Required. This field must be set in requests. */ stage?: string | undefined; /** User-provided comment on the action. */ @@ -433,7 +483,11 @@ export interface CreateTransitionResponse { } export interface DeleteCommentRequest { - /** Unique identifier of an activity */ + /** + * Unique identifier of an activity + * + * Required. This field must be set in requests. + */ id?: string | undefined; } @@ -441,9 +495,17 @@ export interface DeleteCommentRequest { export interface DeleteCommentResponse {} export interface DeleteModelVersionRequest { - /** Name of the registered model */ + /** + * Name of the registered model + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Model version number */ + /** + * Model version number + * + * Required. This field must be set in requests. + */ version?: string | undefined; } @@ -451,11 +513,23 @@ export interface DeleteModelVersionRequest { export interface DeleteModelVersionResponse {} export interface DeleteModelVersionTagRequest { - /** Name of the registered model that the tag was logged under. */ + /** + * Name of the registered model that the tag was logged under. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Model version number that the tag was logged under. */ + /** + * Model version number that the tag was logged under. + * + * Required. This field must be set in requests. + */ version?: string | undefined; - /** Name of the tag. The name must be an exact match; wild-card deletion is not supported. Maximum size is 250 bytes. */ + /** + * Name of the tag. The name must be an exact match; wild-card deletion is not supported. Maximum size is 250 bytes. + * + * Required. This field must be set in requests. + */ key?: string | undefined; } @@ -463,7 +537,11 @@ export interface DeleteModelVersionTagRequest { export interface DeleteModelVersionTagResponse {} export interface DeleteRegisteredModelRequest { - /** Registered model unique name identifier. */ + /** + * Registered model unique name identifier. + * + * Required. This field must be set in requests. + */ name?: string | undefined; } @@ -471,9 +549,17 @@ export interface DeleteRegisteredModelRequest { export interface DeleteRegisteredModelResponse {} export interface DeleteRegisteredModelTagRequest { - /** Name of the registered model that the tag was logged under. */ + /** + * Name of the registered model that the tag was logged under. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Name of the tag. The name must be an exact match; wild-card deletion is not supported. Maximum size is 250 bytes. */ + /** + * Name of the tag. The name must be an exact match; wild-card deletion is not supported. Maximum size is 250 bytes. + * + * Required. This field must be set in requests. + */ key?: string | undefined; } @@ -485,7 +571,11 @@ export interface DeleteRegisteredModelTagResponse {} * Experimental: This entity may change or be removed in a future release without warning. */ export interface DeleteRegistryWebhookRequest { - /** Webhook ID required to delete a registry webhook. */ + /** + * Webhook ID required to delete a registry webhook. + * + * Required. This field must be set in requests. + */ id?: string | undefined; } @@ -493,9 +583,17 @@ export interface DeleteRegistryWebhookRequest { export interface DeleteRegistryWebhookResponse {} export interface DeleteTransitionRequest { - /** Name of the model. */ + /** + * Name of the model. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Version of the model. */ + /** + * Version of the model. + * + * Required. This field must be set in requests. + */ version?: string | undefined; /** * Target stage of the transition request. Valid values are: @@ -507,9 +605,15 @@ export interface DeleteTransitionRequest { * * `Production`: Production stage. * * * `Archived`: Archived stage. + * + * Required. This field must be set in requests. */ stage?: string | undefined; - /** Username of the user who created this request. Of the transition requests matching the specified details, only the one transition created by this user will be deleted. */ + /** + * Username of the user who created this request. Of the transition requests matching the specified details, only the one transition created by this user will be deleted. + * + * Required. This field must be set in requests. + */ creator?: string | undefined; /** User-provided comment on the action. */ comment?: string | undefined; @@ -534,9 +638,17 @@ export interface GetLatestVersionsResponse { } export interface GetModelVersionDownloadUriRequest { - /** Name of the registered model */ + /** + * Name of the registered model + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Model version number */ + /** + * Model version number + * + * Required. This field must be set in requests. + */ version?: string | undefined; } @@ -546,9 +658,17 @@ export interface GetModelVersionDownloadUriResponse { } export interface GetModelVersionRequest { - /** Name of the registered model */ + /** + * Name of the registered model + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Model version number */ + /** + * Model version number + * + * Required. This field must be set in requests. + */ version?: string | undefined; } @@ -557,7 +677,11 @@ export interface GetModelVersionResponse { } export interface GetRegisteredModelDatabricksRequest { - /** Registered model unique name identifier. */ + /** + * Registered model unique name identifier. + * + * Required. This field must be set in requests. + */ name?: string | undefined; } @@ -596,7 +720,11 @@ export interface LinkedFeature { } export interface ListLatestVersionsRequest { - /** Registered model unique name identifier. */ + /** + * Registered model unique name identifier. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** List of stages. */ stages?: string[] | undefined; @@ -664,9 +792,17 @@ export interface ListRegistryWebhooksResponse { } export interface ListTransitionRequest { - /** Name of the registered model. */ + /** + * Name of the registered model. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Version of the model. */ + /** + * Version of the model. + * + * Required. This field must be set in requests. + */ version?: string | undefined; } @@ -849,9 +985,17 @@ export interface RegistryWebhook { /** Details required to identify and reject a model version stage transition request. */ export interface RejectTransitionRequest { - /** Name of the model. */ + /** + * Name of the model. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Version of the model. */ + /** + * Version of the model. + * + * Required. This field must be set in requests. + */ version?: string | undefined; /** * Target stage of the transition. Valid values are: @@ -863,6 +1007,8 @@ export interface RejectTransitionRequest { * * `Production`: Production stage. * * * `Archived`: Archived stage. + * + * Required. This field must be set in requests. */ stage?: string | undefined; /** User-provided comment on the action. */ @@ -875,7 +1021,11 @@ export interface RejectTransitionResponse { } export interface RenameRegisteredModelRequest { - /** Registered model unique name identifier. */ + /** + * Registered model unique name identifier. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** If provided, updates the name for this `registered_model`. */ newName?: string | undefined; @@ -938,19 +1088,31 @@ export interface SearchRegisteredModelsResponse { } export interface SetModelVersionTagRequest { - /** Unique name of the model. */ + /** + * Unique name of the model. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Model version number. */ + /** + * Model version number. + * + * Required. This field must be set in requests. + */ version?: string | undefined; /** * Name of the tag. Maximum size depends on storage backend. * If a tag with this name already exists, its preexisting value will be replaced by the specified `value`. * All storage backends are guaranteed to support key values up to 250 bytes in size. + * + * Required. This field must be set in requests. */ key?: string | undefined; /** * String value of the tag being logged. Maximum size depends on storage backend. * All storage backends are guaranteed to support key values up to 5000 bytes in size. + * + * Required. This field must be set in requests. */ value?: string | undefined; } @@ -959,17 +1121,25 @@ export interface SetModelVersionTagRequest { export interface SetModelVersionTagResponse {} export interface SetRegisteredModelTagRequest { - /** Unique name of the model. */ + /** + * Unique name of the model. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** * Name of the tag. Maximum size depends on storage backend. * If a tag with this name already exists, its preexisting value will be replaced by the specified `value`. * All storage backends are guaranteed to support key values up to 250 bytes in size. + * + * Required. This field must be set in requests. */ key?: string | undefined; /** * String value of the tag being logged. Maximum size depends on storage backend. * All storage backends are guaranteed to support key values up to 5000 bytes in size. + * + * Required. This field must be set in requests. */ value?: string | undefined; } @@ -979,7 +1149,11 @@ export interface SetRegisteredModelTagResponse {} /** Details required to test a registry webhook. */ export interface TestRegistryWebhookRequest { - /** Webhook ID */ + /** + * Webhook ID + * + * Required. This field must be set in requests. + */ id?: string | undefined; /** If `event` is specified, the test trigger uses the specified event. If `event` is not specified, the test trigger uses a randomly chosen event associated with the webhook. */ event?: RegistryWebhookEvent | undefined; @@ -994,9 +1168,17 @@ export interface TestRegistryWebhookResponse { /** Details required to transition a model version's stage. */ export interface TransitionModelVersionStageDatabricksRequest { - /** Name of the model. */ + /** + * Name of the model. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Version of the model. */ + /** + * Version of the model. + * + * Required. This field must be set in requests. + */ version?: string | undefined; /** * Target stage of the transition. Valid values are: @@ -1008,9 +1190,15 @@ export interface TransitionModelVersionStageDatabricksRequest { * * `Production`: Production stage. * * * `Archived`: Archived stage. + * + * Required. This field must be set in requests. */ stage?: string | undefined; - /** Specifies whether to archive all current model versions in the target stage. */ + /** + * Specifies whether to archive all current model versions in the target stage. + * + * Required. This field must be set in requests. + */ archiveExistingVersions?: boolean | undefined; /** User-provided comment on the action. */ comment?: string | undefined; @@ -1070,9 +1258,17 @@ export interface TransitionRequest { /** Details required to edit a comment on a model version. */ export interface UpdateCommentRequest { - /** Unique identifier of an activity */ + /** + * Unique identifier of an activity + * + * Required. This field must be set in requests. + */ id?: string | undefined; - /** User-provided comment on the action. */ + /** + * User-provided comment on the action. + * + * Required. This field must be set in requests. + */ comment?: string | undefined; } @@ -1082,9 +1278,17 @@ export interface UpdateCommentResponse { } export interface UpdateModelVersionRequest { - /** Name of the registered model */ + /** + * Name of the registered model + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Model version number */ + /** + * Model version number + * + * Required. This field must be set in requests. + */ version?: string | undefined; /** If provided, updates the description for this `registered_model`. */ description?: string | undefined; @@ -1096,7 +1300,11 @@ export interface UpdateModelVersionResponse { } export interface UpdateRegisteredModelRequest { - /** Registered model unique name identifier. */ + /** + * Registered model unique name identifier. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** If provided, updates the description for this `registered_model`. */ description?: string | undefined; @@ -1108,7 +1316,11 @@ export interface UpdateRegisteredModelResponse { /** Details required to update a registry webhook. Only the fields that need to be updated should be specified, and both `http_url_spec` and `job_spec` should not be specified in the same request. */ export interface UpdateRegistryWebhookRequest { - /** Webhook ID */ + /** + * Webhook ID + * + * Required. This field must be set in requests. + */ id?: string | undefined; /** * Events that can trigger a registry webhook: diff --git a/packages/modelserving/src/v1/model.ts b/packages/modelserving/src/v1/model.ts index 264deddb..e5cde7cc 100755 --- a/packages/modelserving/src/v1/model.ts +++ b/packages/modelserving/src/v1/model.ts @@ -120,7 +120,11 @@ export interface AiGatewayRateLimit { * with 'endpoint' being the default if not specified. */ key?: string | undefined; - /** Renewal period field for a rate limit. Currently, only 'minute' is supported. */ + /** + * Renewal period field for a rate limit. Currently, only 'minute' is supported. + * + * Required. This field must be set in requests. + */ renewalPeriod?: string | undefined; /** Principal field for a user, user group, or service principal to apply rate limiting to. Accepts a user email, group name, or service principal application ID. */ principal?: string | undefined; @@ -153,7 +157,11 @@ export interface AiGuardrails { } export interface AmazonBedrockConfig { - /** The AWS region to use. Bedrock has to be enabled there. */ + /** + * The AWS region to use. Bedrock has to be enabled there. + * + * Required. This field must be set in requests. + */ awsRegion?: string | undefined; /** * The secret key reference for an AWS access key ID with @@ -175,6 +183,8 @@ export interface AmazonBedrockConfig { /** * The underlying provider in Amazon Bedrock. Supported values (case * insensitive) include: Anthropic, Cohere, AI21Labs, Amazon. + * + * Required. This field must be set in requests. */ bedrockProvider?: string | undefined; /** @@ -221,7 +231,11 @@ export interface AnthropicConfig { } export interface ApiKeyAuth { - /** The name of the API key parameter used for authentication. */ + /** + * The name of the API key parameter used for authentication. + * + * Required. This field must be set in requests. + */ key?: string | undefined; /** * The secret key reference for an API Key. @@ -294,6 +308,8 @@ export interface CreateInferenceEndpointRequest { /** * The name of the serving endpoint. This field is required and must be unique across a . * An endpoint name can consist of alphanumeric characters, dashes, and underscores. + * + * Required. This field must be set in requests. */ name?: string | undefined; /** The core config of the serving endpoint. */ @@ -319,9 +335,15 @@ export interface CreatePtEndpointRequest { /** * The name of the serving endpoint. This field is required and must be unique across a . * An endpoint name can consist of alphanumeric characters, dashes, and underscores. + * + * Required. This field must be set in requests. */ name?: string | undefined; - /** The core config of the serving endpoint. */ + /** + * The core config of the serving endpoint. + * + * Required. This field must be set in requests. + */ config?: PtEndpointCoreConfig | undefined; /** Tags to be attached to the serving endpoint and automatically propagated to billing logs. */ tags?: EndpointTag[] | undefined; @@ -335,7 +357,11 @@ export interface CreatePtEndpointRequest { /** Configs needed to create a custom provider model route. */ export interface CustomProviderConfig { - /** This is a field to provide the URL of the custom provider API. */ + /** + * This is a field to provide the URL of the custom provider API. + * + * Required. This field must be set in requests. + */ customProviderUrl?: string | undefined; /** * This is a field to provide bearer token authentication for the custom provider API. @@ -370,6 +396,8 @@ export interface DatabricksModelServingConfig { /** * The URL of the workspace containing the model serving endpoint * pointed to by this external model. + * + * Required. This field must be set in requests. */ databricksWorkspaceUrl?: string | undefined; /** @@ -384,6 +412,7 @@ export interface DatabricksModelServingConfig { } export interface DeleteInferenceEndpointRequest { + /** Required. This field must be set in requests. */ name?: string | undefined; } @@ -439,7 +468,11 @@ export interface EndpointCoreConfigSummary { } export interface EndpointTag { - /** Key field for a serving endpoint tag. */ + /** + * Key field for a serving endpoint tag. + * + * Required. This field must be set in requests. + */ key?: string | undefined; /** Optional value field for a serving endpoint tag. */ value?: string | undefined; @@ -461,11 +494,23 @@ export interface ExportMetricsResponse { /** Simple Proto message for testing */ export interface ExternalFunctionRequest { - /** The connection name to use. This is required to identify the external connection. */ + /** + * The connection name to use. This is required to identify the external connection. + * + * Required. This field must be set in requests. + */ connectionName?: string | undefined; - /** The HTTP method to use (e.g., 'GET', 'POST'). */ + /** + * The HTTP method to use (e.g., 'GET', 'POST'). + * + * Required. This field must be set in requests. + */ method?: ExternalFunctionRequest_HttpMethod | undefined; - /** The relative path for the API endpoint. This is required. */ + /** + * The relative path for the API endpoint. This is required. + * + * Required. This field must be set in requests. + */ path?: string | undefined; /** The JSON payload to send in the request body. */ json?: string | undefined; @@ -487,11 +532,23 @@ export interface ExternalFunctionResponse { } export interface ExternalModel { - /** The name of the provider for the external model. Currently, the supported providers are 'ai21labs', 'anthropic', 'amazon-bedrock', 'cohere', 'databricks-model-serving', 'google-cloud-vertex-ai', 'openai', 'palm', and 'custom'. */ + /** + * The name of the provider for the external model. Currently, the supported providers are 'ai21labs', 'anthropic', 'amazon-bedrock', 'cohere', 'databricks-model-serving', 'google-cloud-vertex-ai', 'openai', 'palm', and 'custom'. + * + * Required. This field must be set in requests. + */ provider?: string | undefined; - /** The name of the external model. */ + /** + * The name of the external model. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** The task type of the external model. */ + /** + * The task type of the external model. + * + * Required. This field must be set in requests. + */ task?: string | undefined; /** external model config. The config corresponding to the provider will be used. */ config?: @@ -549,6 +606,8 @@ export interface FallbackConfig { * codes (e.g. 500), the request will automatically be round-robin attempted with other served entities in the same * endpoint, following the order of served entity list, until a successful response is returned. * If all attempts fail, return the last response with the error code. + * + * Required. This field must be set in requests. */ enabled?: boolean | undefined; } @@ -562,17 +621,29 @@ export interface FoundationModel { } export interface GetExportEndpointMetricsRequest { - /** The name of the serving endpoint to retrieve metrics for. This field is required. */ + /** + * The name of the serving endpoint to retrieve metrics for. This field is required. + * + * Required. This field must be set in requests. + */ name?: string | undefined; } export interface GetInferenceEndpointRequest { - /** The name of the serving endpoint. This field is required. */ + /** + * The name of the serving endpoint. This field is required. + * + * Required. This field must be set in requests. + */ name?: string | undefined; } export interface GetInferenceEndpointSchemaRequest { - /** The name of the serving endpoint that the served model belongs to. This field is required. */ + /** + * The name of the serving endpoint that the served model belongs to. This field is required. + * + * Required. This field must be set in requests. + */ name?: string | undefined; } @@ -582,26 +653,42 @@ export interface GetOpenApiResponse { } export interface GetServedModelBuildLogsRequest { - /** The name of the serving endpoint that the served model belongs to. This field is required. */ + /** + * The name of the serving endpoint that the served model belongs to. This field is required. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** The name of the served model that build logs will be retrieved for. This field is required. */ servedModelName?: string | undefined; } export interface GetServedModelBuildLogsResponse { - /** The logs associated with building the served entity's environment. */ + /** + * The logs associated with building the served entity's environment. + * + * Required. This field must be set in requests. + */ logs?: string | undefined; } export interface GetServedModelLogsRequest { - /** The name of the serving endpoint that the served model belongs to. This field is required. */ + /** + * The name of the serving endpoint that the served model belongs to. This field is required. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** The name of the served model that logs will be retrieved for. This field is required. */ servedModelName?: string | undefined; } export interface GetServedModelLogsResponse { - /** The most recent log lines of the model server processing invocation requests. */ + /** + * The most recent log lines of the model server processing invocation requests. + * + * Required. This field must be set in requests. + */ logs?: string | undefined; } @@ -620,6 +707,8 @@ export interface GoogleCloudVertexAiConfig { /** * This is the Google Cloud project id that the service account is * associated with. + * + * Required. This field must be set in requests. */ projectId?: string | undefined; /** @@ -628,6 +717,8 @@ export interface GoogleCloudVertexAiConfig { * regions. * * [supported regions]: https://cloud.google.com/vertex-ai/docs/general/locations + * + * Required. This field must be set in requests. */ region?: string | undefined; /** @@ -859,7 +950,11 @@ export interface PaLmConfig { } export interface PatchInferenceEndpointTagsRequest { - /** The name of the serving endpoint who's tags to patch. This field is required. */ + /** + * The name of the serving endpoint who's tags to patch. This field is required. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** List of endpoint tags to add */ addTags?: EndpointTag[] | undefined; @@ -911,10 +1006,18 @@ export interface PtEndpointCoreConfig { export interface PtServedModel { /** The name of a served entity. It must be unique across an endpoint. A served entity name can consist of alphanumeric characters, dashes, and underscores. If not specified for an external model, this field defaults to external_model.name, with '.' and ':' replaced with '-', and if not specified for other entities, it defaults to entity_name-entity_version. */ name?: string | undefined; - /** The name of the entity to be served. The entity may be a model in the Databricks Model Registry, a model in the Unity Catalog (UC), or a function of type FEATURE_SPEC in the UC. If it is a UC object, the full name of the object should be given in the form of **catalog_name.schema_name.model_name**. */ + /** + * The name of the entity to be served. The entity may be a model in the Databricks Model Registry, a model in the Unity Catalog (UC), or a function of type FEATURE_SPEC in the UC. If it is a UC object, the full name of the object should be given in the form of **catalog_name.schema_name.model_name**. + * + * Required. This field must be set in requests. + */ entityName?: string | undefined; entityVersion?: string | undefined; - /** The number of model units to be provisioned. */ + /** + * The number of model units to be provisioned. + * + * Required. This field must be set in requests. + */ provisionedModelUnits?: bigint | undefined; /** * Whether burst scaling is enabled. When enabled (default), the endpoint can automatically @@ -925,7 +1028,11 @@ export interface PtServedModel { } export interface PutInferenceEndpointAiGatewayRequest { - /** The name of the serving endpoint whose AI Gateway is being updated. This field is required. */ + /** + * The name of the serving endpoint whose AI Gateway is being updated. This field is required. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** * Configuration to enable usage tracking using system tables. @@ -971,7 +1078,11 @@ export interface PutInferenceEndpointAiGatewayResponse { } export interface PutInferenceEndpointConfigRequest { - /** The name of the serving endpoint to update. This field is required. */ + /** + * The name of the serving endpoint to update. This field is required. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** The list of served entities under the serving endpoint config. */ servedEntities?: ServedModel[] | undefined; @@ -989,7 +1100,11 @@ export interface PutInferenceEndpointConfigRequest { } export interface PutInferenceEndpointRateLimitsRequest { - /** The name of the serving endpoint whose rate limits are being updated. This field is required. */ + /** + * The name of the serving endpoint whose rate limits are being updated. This field is required. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** The list of endpoint rate limits. */ rateLimits?: RateLimit[] | undefined; @@ -1001,24 +1116,41 @@ export interface PutInferenceEndpointRateLimitsResponse { } export interface PutPtEndpointConfigRequest { - /** The name of the pt endpoint to update. This field is required. */ + /** + * The name of the pt endpoint to update. This field is required. + * + * Required. This field must be set in requests. + */ name?: string | undefined; + /** Required. This field must be set in requests. */ config?: PtEndpointCoreConfig | undefined; } export interface RateLimit { - /** Used to specify how many calls are allowed for a key within the renewal_period. */ + /** + * Used to specify how many calls are allowed for a key within the renewal_period. + * + * Required. This field must be set in requests. + */ calls?: bigint | undefined; /** Key field for a serving endpoint rate limit. Currently, only 'user' and 'endpoint' are supported, with 'endpoint' being the default if not specified. */ key?: string | undefined; - /** Renewal period field for a serving endpoint rate limit. Currently, only 'minute' is supported. */ + /** + * Renewal period field for a serving endpoint rate limit. Currently, only 'minute' is supported. + * + * Required. This field must be set in requests. + */ renewalPeriod?: string | undefined; } export interface Route { /** The name of the served model this route configures traffic for. */ servedModelName?: string | undefined; - /** The percentage of endpoint traffic to send to this route. It must be an integer between 0 and 100 inclusive. */ + /** + * The percentage of endpoint traffic to send to this route. It must be an integer between 0 and 100 inclusive. + * + * Required. This field must be set in requests. + */ trafficPercentage?: number | undefined; servedEntityName?: string | undefined; } @@ -1051,7 +1183,9 @@ export interface ServedModel { burstScalingEnabled?: boolean | undefined; /** Whether the compute resources for the served entity should scale down to zero. */ scaleToZeroEnabled?: boolean | undefined; + /** Required. This field must be set in requests. */ modelName?: string | undefined; + /** Required. This field must be set in requests. */ modelVersion?: string | undefined; /** An object containing a set of optional, user-specified environment variable key-value pairs used for serving this entity. Note: this is an experimental feature and subject to change. Example entity environment variables that refer to secrets: `{"OPENAI_API_KEY": "{{secrets/my_scope/my_key}}", "DATABRICKS_TOKEN": "{{secrets/my_scope2/my_key2}}"}` */ environmentVars?: Record | undefined; @@ -1089,7 +1223,11 @@ export interface TelemetryConfig { export interface TelemetryInferenceTableConfig { /** Fraction of requests sampled for payload logging, in the range [0.0, 1.0], where 1.0 logs all requests. */ samplingFraction?: number | undefined; - /** The full name of the inference table created for this endpoint. */ + /** + * The full name of the inference table created for this endpoint. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ name?: string | undefined; } @@ -1099,7 +1237,11 @@ export interface TrafficConfig { } export interface UpdateInferenceEndpointNotificationsRequest { - /** The name of the serving endpoint whose notifications are being updated. This field is required. */ + /** + * The name of the serving endpoint whose notifications are being updated. This field is required. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** The email notification settings to update. Specify email addresses to notify when endpoint state changes occur. */ emailNotifications?: EmailNotifications | undefined; diff --git a/packages/modelservingquery/src/v1/model.ts b/packages/modelservingquery/src/v1/model.ts index b9c6df16..34cef184 100755 --- a/packages/modelservingquery/src/v1/model.ts +++ b/packages/modelservingquery/src/v1/model.ts @@ -88,7 +88,11 @@ export interface ExternalModelUsageElement { } export interface QueryEndpointRequest { - /** The name of the serving endpoint. This field is required and is provided via the path parameter. */ + /** + * The name of the serving endpoint. This field is required and is provided via the path parameter. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** * The prompt string (or array of strings) field used ONLY for __completions external & foundation model__ diff --git a/packages/networking/src/v1/model.ts b/packages/networking/src/v1/model.ts index a4c34643..8c79c414 100755 --- a/packages/networking/src/v1/model.ts +++ b/packages/networking/src/v1/model.ts @@ -394,23 +394,39 @@ export interface AccountNetworkPolicy { } export interface AzurePrivateEndpointInfo { - /** The name of the Private Endpoint in the Azure subscription. */ + /** + * The name of the Private Endpoint in the Azure subscription. + * + * Required. This field must be set in requests. + */ privateEndpointName?: string | undefined; /** * The GUID of the Private Endpoint resource in the Azure subscription. * This is assigned by Azure when the user sets up the Private Endpoint. + * + * Required. This field must be set in requests. */ privateEndpointResourceGuid?: string | undefined; - /** The full resource ID of the Private Endpoint. */ + /** + * The full resource ID of the Private Endpoint. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ privateEndpointResourceId?: string | undefined; - /** The resource ID of the Databricks Private Link Service that this Private Endpoint connects to. */ + /** + * The resource ID of the Databricks Private Link Service that this Private Endpoint connects to. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ privateLinkServiceId?: string | undefined; } /** Details required to configure a block list or allow list. */ export interface CreateAccountIpAccessListRequest { accountId?: string | undefined; + /** Required. This field must be set in requests. */ label?: string | undefined; + /** Required. This field must be set in requests. */ listType?: AccountIpAccessListType_IpAccessListType | undefined; ipAddresses?: string[] | undefined; } @@ -424,15 +440,23 @@ export interface CreateEndpointRequest { /** * The parent resource name of the account under which the endpoint is created. * Format: `accounts/{account_id}`. + * + * Required. This field must be set in requests. */ parent?: string | undefined; + /** Required. This field must be set in requests. */ endpoint?: Endpoint | undefined; } /** Details required to configure a block list or allow list. */ export interface CreateIpAccessListRequest { - /** Label for the IP access list. This **cannot** be empty. */ + /** + * Label for the IP access list. This **cannot** be empty. + * + * Required. This field must be set in requests. + */ label?: string | undefined; + /** Required. This field must be set in requests. */ listType?: IpAccessListType | undefined; ipAddresses?: string[] | undefined; } @@ -488,13 +512,22 @@ export interface CreateNetworkConnectivityConfiguration { } export interface CreateNetworkPolicyRequest { - /** Your account ID. You can find your account ID in your accounts console. */ + /** + * Your account ID. You can find your account ID in your accounts console. + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; - /** Network policy configuration details. */ + /** + * Network policy configuration details. + * + * Required. This field must be set in requests. + */ networkPolicy?: AccountNetworkPolicy | undefined; } export interface CreateNetworkRequest { + /** Required. This field must be set in requests. */ accountId?: string | undefined; /** The human-readable name of the network configuration. */ networkName?: string | undefined; @@ -509,6 +542,7 @@ export interface CreateNetworkRequest { } export interface CreatePrivateAccessSettingsRequest { + /** Required. This field must be set in requests. */ accountId?: string | undefined; /** The human-readable name of the private access settings object. */ privateAccessSettingsName?: string | undefined; @@ -606,6 +640,7 @@ export interface CreatePrivateEndpointRule { } export interface CreateVpcEndpointRequest { + /** Required. This field must be set in requests. */ accountId?: string | undefined; /** The human-readable name of the storage configuration. */ vpcEndpointName?: string | undefined; @@ -657,6 +692,7 @@ export interface DeleteAccountIpAccessListRequest { export interface DeleteAccountIpAccessListResponse {} export interface DeleteEndpointRequest { + /** Required. This field must be set in requests. */ name?: string | undefined; } @@ -692,25 +728,42 @@ export interface DeleteNetworkConnectivityConfigRequest { } export interface DeleteNetworkPolicyRequest { - /** The unique identifier of the network policy to delete. */ + /** + * The unique identifier of the network policy to delete. + * + * Required. This field must be set in requests. + */ networkPolicyId?: string | undefined; - /** Your account ID. You can find your account ID in your accounts console. */ + /** + * Your account ID. You can find your account ID in your accounts console. + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; } export interface DeleteNetworkRequest { - /** Databricks Account API network configuration ID. */ + /** + * Databricks Account API network configuration ID. + * + * Required. This field must be set in requests. + */ networkId?: string | undefined; + /** Required. This field must be set in requests. */ accountId?: string | undefined; } export interface DeletePrivateAccessSettingsRequest { + /** Required. This field must be set in requests. */ privateAccessSettingsId?: string | undefined; + /** Required. This field must be set in requests. */ accountId?: string | undefined; } export interface DeleteVpcEndpointRequest { + /** Required. This field must be set in requests. */ vpcEndpointId?: string | undefined; + /** Required. This field must be set in requests. */ accountId?: string | undefined; } @@ -812,26 +865,50 @@ export interface EgressNetworkPolicy_NetworkAccessPolicy_StorageDestination { /** Endpoint represents a cloud networking resource in a user's cloud account and binds it to the account. */ export interface Endpoint { - /** The resource name of the endpoint, which uniquely identifies the endpoint. */ + /** + * The resource name of the endpoint, which uniquely identifies the endpoint. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ name?: string | undefined; - /** The unique identifier for this endpoint under the account. This field is a UUID generated by . */ + /** + * The unique identifier for this endpoint under the account. This field is a UUID generated by . + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ endpointId?: string | undefined; - /** The Databricks Account in which the endpoint object exists. */ + /** + * The Databricks Account in which the endpoint object exists. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ accountId?: string | undefined; /** * The human-readable display name of this endpoint. * The input should conform to RFC-1034, which restricts to letters, numbers, and hyphens, * with the first character a letter, the last a letter or a number, and a 63 character maximum. + * + * Required. This field must be set in requests. Immutable. Set this field when the resource is created; it cannot be changed afterward. */ displayName?: string | undefined; /** * The use case that determines the type of network connectivity this endpoint provides. * This field is automatically determined based on the endpoint configuration and cloud-specific settings. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. Immutable. Set this field when the resource is created; it cannot be changed afterward. */ useCase?: EndpointUseCase_EndpointUseCase | undefined; - /** The cloud provider region where this endpoint is located. */ + /** + * The cloud provider region where this endpoint is located. + * + * Required. This field must be set in requests. Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ region?: string | undefined; - /** The state of the endpoint. The endpoint can only be used if the state is `APPROVED`. */ + /** + * The state of the endpoint. The endpoint can only be used if the state is `APPROVED`. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ state?: EndpointState | undefined; /** * The cloud info of this endpoint. @@ -840,11 +917,19 @@ export interface Endpoint { endpointInfo?: | { $case: 'azurePrivateEndpointInfo'; - /** Info for an Azure private endpoint. */ + /** + * Info for an Azure private endpoint. + * + * Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ azurePrivateEndpointInfo: AzurePrivateEndpointInfo; } | undefined; - /** The timestamp when the endpoint was created. The timestamp is in RFC 3339 format in UTC timezone. */ + /** + * The timestamp when the endpoint was created. The timestamp is in RFC 3339 format in UTC timezone. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ createTime?: Temporal.Instant | undefined; } @@ -852,7 +937,11 @@ export interface Endpoint { export interface EndpointUseCase {} export interface GcpEndpoint { - /** Output only. The URI of the created PSC endpoint. */ + /** + * Output only. The URI of the created PSC endpoint. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ pscEndpointUri?: string | undefined; /** Selects which target services this private endpoint reaches. */ targetServices?: @@ -869,29 +958,49 @@ export interface GcpEndpoint { } export interface GcpNetworkInfo { - /** The GCP project ID for network resources. This project is where the VPC and subnet resides. */ + /** + * The GCP project ID for network resources. This project is where the VPC and subnet resides. + * + * Required. This field must be set in requests. + */ networkProjectId?: string | undefined; - /** The customer-provided VPC ID. */ + /** + * The customer-provided VPC ID. + * + * Required. This field must be set in requests. + */ vpcId?: string | undefined; /** * The customer-provided Subnet ID that will be available to Clusters in Workspaces using this * Network. + * + * Required. This field must be set in requests. */ subnetId?: string | undefined; + /** Required. This field must be set in requests. */ subnetRegion?: string | undefined; /** * Name of the secondary range within the subnet that will be used by GKE as Pod IP range. * This is BYO VPC specific. DB VPC uses network.getGcpManagedNetworkConfig.getGkeClusterPodIpRange + * + * Required. This field must be set in requests. */ podIpRangeName?: string | undefined; - /** Name of the secondary range within the subnet that will be used by GKE as Service IP range. */ + /** + * Name of the secondary range within the subnet that will be used by GKE as Service IP range. + * + * Required. This field must be set in requests. + */ serviceIpRangeName?: string | undefined; } export interface GcpVpcEndpointInfo { pscConnectionId?: string | undefined; + /** Required. This field must be set in requests. */ projectId?: string | undefined; + /** Required. This field must be set in requests. */ pscEndpointName?: string | undefined; + /** Required. This field must be set in requests. */ endpointRegion?: string | undefined; serviceAttachmentId?: string | undefined; } @@ -907,6 +1016,7 @@ export interface GetAccountIpAccessListResponse { } export interface GetEndpointRequest { + /** Required. This field must be set in requests. */ name?: string | undefined; } @@ -938,26 +1048,46 @@ export interface GetNetworkConnectivityConfigRequest { } export interface GetNetworkPolicyRequest { - /** The unique identifier of the network policy to retrieve. */ + /** + * The unique identifier of the network policy to retrieve. + * + * Required. This field must be set in requests. + */ networkPolicyId?: string | undefined; - /** Your account ID. You can find your account ID in your accounts console. */ + /** + * Your account ID. You can find your account ID in your accounts console. + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; } export interface GetNetworkRequest { - /** Databricks Account API network configuration ID. */ + /** + * Databricks Account API network configuration ID. + * + * Required. This field must be set in requests. + */ networkId?: string | undefined; + /** Required. This field must be set in requests. */ accountId?: string | undefined; } export interface GetPrivateAccessSettingsRequest { + /** Required. This field must be set in requests. */ privateAccessSettingsId?: string | undefined; + /** Required. This field must be set in requests. */ accountId?: string | undefined; } export interface GetVpcEndpointRequest { - /** Databricks VPC endpoint ID. */ + /** + * Databricks VPC endpoint ID. + * + * Required. This field must be set in requests. + */ vpcEndpointId?: string | undefined; + /** Required. This field must be set in requests. */ accountId?: string | undefined; } @@ -1226,6 +1356,8 @@ export interface ListEndpointsRequest { /** * The parent resource name of the account to list endpoints for. * Format: `accounts/{account_id}`. + * + * Required. This field must be set in requests. */ parent?: string | undefined; pageToken?: string | undefined; @@ -1277,7 +1409,11 @@ export interface ListNetworkConnectivityConfigsResponse { } export interface ListNetworkPoliciesRequest { - /** Your account ID. You can find your account ID in your accounts console. */ + /** + * Your account ID. You can find your account ID in your accounts console. + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; /** Pagination token to go to next page based on previous query. */ pageToken?: string | undefined; @@ -1291,6 +1427,7 @@ export interface ListNetworkPoliciesResponse { } export interface ListNetworkRequest { + /** Required. This field must be set in requests. */ accountId?: string | undefined; } @@ -1299,6 +1436,7 @@ export interface ListNetworkResponse { } export interface ListPrivateAccessSettingsRequest { + /** Required. This field must be set in requests. */ accountId?: string | undefined; } @@ -1307,6 +1445,7 @@ export interface ListPrivateAccessSettingsResponse { } export interface ListVpcEndpointRequest { + /** Required. This field must be set in requests. */ accountId?: string | undefined; } @@ -1620,9 +1759,17 @@ export interface NetworkWarning { /** * */ export interface PrivateAccessSettings { - /** private access settings ID. */ + /** + * private access settings ID. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ privateAccessSettingsId?: string | undefined; - /** The account ID that hosts the private access settings. */ + /** + * The account ID that hosts the private access settings. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ accountId?: string | undefined; /** The human-readable name of the private access settings object. */ privateAccessSettingsName?: string | undefined; @@ -1649,11 +1796,20 @@ export interface ReplaceAccountIpAccessListRequest { accountId?: string | undefined; /** The ID for the corresponding IP access list */ listId?: string | undefined; - /** Label for the IP access list. This **cannot** be empty. */ + /** + * Label for the IP access list. This **cannot** be empty. + * + * Required. This field must be set in requests. + */ label?: string | undefined; + /** Required. This field must be set in requests. */ listType?: AccountIpAccessListType_IpAccessListType | undefined; ipAddresses?: string[] | undefined; - /** Specifies whether this IP access list is enabled. */ + /** + * Specifies whether this IP access list is enabled. + * + * Required. This field must be set in requests. + */ enabled?: boolean | undefined; } @@ -1666,11 +1822,20 @@ export interface ReplaceAccountIpAccessListResponse { export interface ReplaceIpAccessListRequest { /** The ID for the corresponding IP access list */ listId?: string | undefined; - /** Label for the IP access list. This **cannot** be empty. */ + /** + * Label for the IP access list. This **cannot** be empty. + * + * Required. This field must be set in requests. + */ label?: string | undefined; + /** Required. This field must be set in requests. */ listType?: IpAccessListType | undefined; ipAddresses?: string[] | undefined; - /** Specifies whether this IP access list is enabled. */ + /** + * Specifies whether this IP access list is enabled. + * + * Required. This field must be set in requests. + */ enabled?: boolean | undefined; } @@ -1682,7 +1847,11 @@ export interface ReplaceIpAccessListResponse { /** Details required to update an IP access list. */ export interface UpdateAccountIpAccessListRequest { accountId?: string | undefined; - /** The ID for the corresponding IP access list */ + /** + * The ID for the corresponding IP access list + * + * Required. This field must be set in requests. + */ listId?: string | undefined; /** Label for the IP access list. This **cannot** be empty. */ label?: string | undefined; @@ -1699,7 +1868,11 @@ export interface UpdateAccountIpAccessListResponse { /** Details required to update an IP access list. */ export interface UpdateIpAccessListRequest { - /** The ID for the corresponding IP access list */ + /** + * The ID for the corresponding IP access list + * + * Required. This field must be set in requests. + */ listId?: string | undefined; /** Label for the IP access list. This **cannot** be empty. */ label?: string | undefined; @@ -1723,20 +1896,33 @@ export interface UpdateNccPrivateEndpointRuleRequest { /** Your private endpoint rule ID. */ privateEndpointRuleId?: string | undefined; privateEndpointRule?: UpdatePrivateEndpointRule | undefined; + /** Required. This field must be set in requests. */ updateMask?: FieldMask | undefined; } export interface UpdateNetworkPolicyRequest { - /** The unique identifier for the network policy. */ + /** + * The unique identifier for the network policy. + * + * Required. This field must be set in requests. + */ networkPolicyId?: string | undefined; - /** Your account ID. You can find your account ID in your accounts console. */ + /** + * Your account ID. You can find your account ID in your accounts console. + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; /** Updated network policy configuration details. */ networkPolicy?: AccountNetworkPolicy | undefined; } export interface UpdatePrivateAccessSettingsRequest { - /** Properties of the new private access settings object. */ + /** + * Properties of the new private access settings object. + * + * Required. This field must be set in requests. + */ customerFacingPrivateAccessSettings?: PrivateAccessSettings | undefined; } diff --git a/packages/pipelines/src/v2/model.ts b/packages/pipelines/src/v2/model.ts index fe343310..87873171 100755 --- a/packages/pipelines/src/v2/model.ts +++ b/packages/pipelines/src/v2/model.ts @@ -427,7 +427,11 @@ export interface ApplyEnvironmentResponse {} /** Policy for auto full refresh. */ export interface AutoFullRefreshPolicy { - /** (Required, Mutable) Whether to enable auto full refresh or not. */ + /** + * (Required, Mutable) Whether to enable auto full refresh or not. + * + * Required. This field must be set in requests. + */ enabled?: boolean | undefined; /** * (Optional, Mutable) Specify the minimum interval in hours between the timestamp @@ -661,9 +665,17 @@ export interface DataPlaneId { /** Location of staged data storage */ export interface DataStagingOptions { - /** (Required, Immutable) The name of the catalog for the connector's staging storage location. */ + /** + * (Required, Immutable) The name of the catalog for the connector's staging storage location. + * + * Required. This field must be set in requests. + */ catalogName?: string | undefined; - /** (Required, Immutable) The name of the schema for the connector's staging storage location. */ + /** + * (Required, Immutable) The name of the schema for the connector's staging storage location. + * + * Required. This field must be set in requests. + */ schemaName?: string | undefined; /** * (Optional) The Unity Catalog-compatible name for the storage location. @@ -676,6 +688,7 @@ export interface DataStagingOptions { } export interface DeletePipelineRequest { + /** Required. This field must be set in requests. */ pipelineId?: string | undefined; /** * If true, deletion will proceed even if resource cleanup fails. @@ -693,7 +706,11 @@ export interface DeletePipelineRequest { export interface DeletePipelineResponse {} export interface EditPipelineRequest { - /** Unique identifier for this pipeline. */ + /** + * Unique identifier for this pipeline. + * + * Required. This field must be set in requests. + */ pipelineId?: string | undefined; /** If false, deployment will fail if name has changed and conflicts the name of another pipeline. */ allowDuplicateNames?: boolean | undefined; @@ -864,6 +881,7 @@ export interface Filters { } export interface GetPipelineRequest { + /** Required. This field must be set in requests. */ pipelineId?: string | undefined; } @@ -908,9 +926,17 @@ export interface GetPipelineResponse { } export interface GetUpdateRequest { - /** The ID of the pipeline. */ + /** + * The ID of the pipeline. + * + * Required. This field must be set in requests. + */ pipelineId?: string | undefined; - /** The ID of the update. */ + /** + * The ID of the update. + * + * Required. This field must be set in requests. + */ updateId?: string | undefined; } @@ -940,6 +966,8 @@ export interface GoogleAdsOptions { * (Optional at this level) Manager Account ID (also called MCC Account ID) used to list * and access customer accounts under this manager account. * Overrides GoogleAdsConfig.manager_account_id from source_configurations when set. + * + * Required. This field must be set in requests. */ managerAccountId?: string | undefined; /** @@ -963,13 +991,25 @@ export interface GoogleDriveOptions { } export interface IngestionGatewayPipelineDefinition { - /** Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source. */ + /** + * Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source. + * + * Required. This field must be set in requests. + */ connectionName?: string | undefined; /** [Deprecated, use connection_name instead] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source. */ connectionId?: string | undefined; - /** Required, Immutable. The name of the catalog for the gateway pipeline's storage location. */ + /** + * Required, Immutable. The name of the catalog for the gateway pipeline's storage location. + * + * Required. This field must be set in requests. + */ gatewayStorageCatalog?: string | undefined; - /** Required, Immutable. The name of the schema for the gateway pipelines's storage location. */ + /** + * Required, Immutable. The name of the schema for the gateway pipelines's storage location. + * + * Required. This field must be set in requests. + */ gatewayStorageSchema?: string | undefined; /** * Optional. The Unity Catalog-compatible name for the gateway storage location. @@ -1028,6 +1068,8 @@ export interface IngestionPipelineDefinition { * The type of the foreign source. * The source type will be inferred from the source connection or ingestion gateway. * This field is output only and will be ignored if provided. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ sourceType?: IngestionSourceType | undefined; /** Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline. */ @@ -1078,11 +1120,23 @@ export interface IngestionPipelineDefinition_IngestionConfig { // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name. export interface IngestionPipelineDefinition_ReportSpec { - /** Required. Report URL in the source system. */ + /** + * Required. Report URL in the source system. + * + * Required. This field must be set in requests. + */ sourceUrl?: string | undefined; - /** Required. Destination catalog to store table. */ + /** + * Required. Destination catalog to store table. + * + * Required. This field must be set in requests. + */ destinationCatalog?: string | undefined; - /** Required. Destination schema to store table. */ + /** + * Required. Destination schema to store table. + * + * Required. This field must be set in requests. + */ destinationSchema?: string | undefined; /** Required. Destination table name. The pipeline fails if a table with that name already exists. */ destinationTable?: string | undefined; @@ -1096,11 +1150,23 @@ export interface IngestionPipelineDefinition_ReportSpec { export interface IngestionPipelineDefinition_SchemaSpec { /** The source catalog name. Might be optional depending on the type of source. */ sourceCatalog?: string | undefined; - /** Required. Schema name in the source database. */ + /** + * Required. Schema name in the source database. + * + * Required. This field must be set in requests. + */ sourceSchema?: string | undefined; - /** Required. Destination catalog to store tables. */ + /** + * Required. Destination catalog to store tables. + * + * Required. This field must be set in requests. + */ destinationCatalog?: string | undefined; - /** Required. Destination schema to store tables in. Tables with the same name as the source tables are created in this destination schema. The pipeline fails If a table with the same name already exists. */ + /** + * Required. Destination schema to store tables in. Tables with the same name as the source tables are created in this destination schema. The pipeline fails If a table with the same name already exists. + * + * Required. This field must be set in requests. + */ destinationSchema?: string | undefined; /** Configuration settings to control the ingestion of tables. These settings are applied to all tables in this schema and override the table_configuration defined in the IngestionPipelineDefinition object. */ tableConfiguration?: @@ -1116,11 +1182,23 @@ export interface IngestionPipelineDefinition_TableSpec { sourceCatalog?: string | undefined; /** Schema name in the source database. Might be optional depending on the type of source. */ sourceSchema?: string | undefined; - /** Required. Table name in the source database. */ + /** + * Required. Table name in the source database. + * + * Required. This field must be set in requests. + */ sourceTable?: string | undefined; - /** Required. Destination catalog to store table. */ + /** + * Required. Destination catalog to store table. + * + * Required. This field must be set in requests. + */ destinationCatalog?: string | undefined; - /** Required. Destination schema to store table. */ + /** + * Required. Destination schema to store table. + * + * Required. This field must be set in requests. + */ destinationSchema?: string | undefined; /** Optional. Destination table name. The pipeline fails if a table with that name already exists. If not set, the source table name is used. */ destinationTable?: string | undefined; @@ -1436,7 +1514,11 @@ export interface ListPipelinesResponse { * sorting or filtering is supported. */ export interface ListUpdatesRequest { - /** The pipeline to return updates for. */ + /** + * The pipeline to return updates for. + * + * Required. This field must be set in requests. + */ pipelineId?: string | undefined; /** Page token returned by previous call */ pageToken?: string | undefined; @@ -1520,7 +1602,11 @@ export interface Notifications { /** Proto representing a window */ export interface OperationTimeWindow { - /** An integer between 0 and 23 denoting the start hour for the window in the 24-hour day. */ + /** + * An integer between 0 and 23 denoting the start hour for the window in the 24-hour day. + * + * Required. This field must be set in requests. + */ startHour?: number | undefined; /** * Days of week in which the window is allowed to happen @@ -1761,7 +1847,11 @@ export interface PipelineCluster { } export interface PipelineDeployment { - /** The deployment method that manages the pipeline. */ + /** + * The deployment method that manages the pipeline. + * + * Required. This field must be set in requests. + */ kind?: DeploymentKind | undefined; /** The path to the file containing metadata about the deployment. */ metadataFilePath?: string | undefined; @@ -1947,9 +2037,15 @@ export interface PipelinesAutoScale { /** * The minimum number of workers the cluster can scale down to when underutilized. * It is also the initial number of workers the cluster will have after creation. + * + * Required. This field must be set in requests. */ minWorkers?: number | undefined; - /** The maximum number of workers to which the cluster can scale up when overloaded. `max_workers` must be strictly greater than `min_workers`. */ + /** + * The maximum number of workers to which the cluster can scale up when overloaded. `max_workers` must be strictly greater than `min_workers`. + * + * Required. This field must be set in requests. + */ maxWorkers?: number | undefined; /** * Databricks Enhanced Autoscaling optimizes cluster utilization by automatically @@ -2209,7 +2305,11 @@ export interface PipelinesJobRunAs { } export interface PipelinesMavenLibrary { - /** Gradle-style maven coordinates. For example: "org.jsoup:jsoup:1.7.2". */ + /** + * Gradle-style maven coordinates. For example: "org.jsoup:jsoup:1.7.2". + * + * Required. This field must be set in requests. + */ coordinates?: string | undefined; /** * Maven repo to install the Maven package from. If omitted, both Maven Central Repository @@ -2293,6 +2393,8 @@ export interface RestartWindow { /** * An integer between 0 and 23 denoting the start hour for the restart window in the 24-hour day. * Continuous pipeline restart is triggered only within a five-hour window starting at this hour. + * + * Required. This field must be set in requests. */ startHour?: number | undefined; /** @@ -2414,6 +2516,7 @@ export interface StackFrame { } export interface StartUpdateRequest { + /** Required. This field must be set in requests. */ pipelineId?: string | undefined; /** If true, this update will reset all tables before running. */ fullRefresh?: boolean | undefined; @@ -2456,6 +2559,7 @@ export interface StartUpdateResponse { } export interface StopPipelineRequest { + /** Required. This field must be set in requests. */ pipelineId?: string | undefined; } diff --git a/packages/policyfamilies/src/v2/model.ts b/packages/policyfamilies/src/v2/model.ts index 7e2d5b7f..b1bf440d 100755 --- a/packages/policyfamilies/src/v2/model.ts +++ b/packages/policyfamilies/src/v2/model.ts @@ -4,7 +4,11 @@ import {z} from 'zod'; /** Returns the details of a policy family at a specific version */ export interface GetPolicyFamilyRequest { - /** The family ID about which to retrieve information. */ + /** + * The family ID about which to retrieve information. + * + * Required. This field must be set in requests. + */ policyFamilyId?: string | undefined; /** The version number for the family to fetch. Defaults to the latest version. */ version?: bigint | undefined; diff --git a/packages/postgres/src/v1/model.ts b/packages/postgres/src/v1/model.ts index ed458bfe..55951f94 100755 --- a/packages/postgres/src/v1/model.ts +++ b/packages/postgres/src/v1/model.ts @@ -786,7 +786,11 @@ export interface Branch { * Format: projects/{project_id}/branches/{branch_id} */ name?: string | undefined; - /** System-generated unique ID for the branch. */ + /** + * System-generated unique ID for the branch. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ uid?: string | undefined; /** * The project containing this branch (API resource hierarchy). @@ -794,17 +798,39 @@ export interface Branch { * * Note: This field indicates where the branch exists in the resource hierarchy. * For point-in-time branching from another branch, see `status.source_branch`. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ parent?: string | undefined; - /** A timestamp indicating when the branch was created. */ + /** + * A timestamp indicating when the branch was created. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createTime?: Temporal.Instant | undefined; - /** A timestamp indicating when the branch was last updated. */ + /** + * A timestamp indicating when the branch was last updated. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updateTime?: Temporal.Instant | undefined; - /** The spec contains the branch configuration. */ + /** + * The spec contains the branch configuration. + * + * Input only. Provide this field in requests; it is never returned in responses. + */ spec?: BranchSpec | undefined; - /** The current status of a Branch. */ + /** + * The current status of a Branch. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ status?: BranchStatus | undefined; - /** The part of the name, chosen by the user when the resource was created. */ + /** + * The part of the name, chosen by the user when the resource was created. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ branchId?: string | undefined; } @@ -816,11 +842,21 @@ export interface BranchSpec { * The name of the source branch from which this branch was created (data lineage for point-in-time recovery). * If not specified, defaults to the project's default branch. * Format: projects/{project_id}/branches/{branch_id} + * + * Immutable. Set this field when the resource is created; it cannot be changed afterward. */ sourceBranch?: string | undefined; - /** The Log Sequence Number (LSN) on the source branch from which this branch was created. */ + /** + * The Log Sequence Number (LSN) on the source branch from which this branch was created. + * + * Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ sourceBranchLsn?: string | undefined; - /** The point in time on the source branch from which this branch was created. */ + /** + * The point in time on the source branch from which this branch was created. + * + * Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ sourceBranchTime?: Temporal.Instant | undefined; /** When set to true, protects the branch from deletion and reset. Associated compute endpoints and the project cannot be deleted while the branch is protected. */ isProtected?: boolean | undefined; @@ -863,36 +899,82 @@ export interface BranchStatus { /** * The name of the source branch from which this branch was created. * Format: projects/{project_id}/branches/{branch_id} + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ sourceBranch?: string | undefined; - /** The Log Sequence Number (LSN) on the source branch from which this branch was created. */ + /** + * The Log Sequence Number (LSN) on the source branch from which this branch was created. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ sourceBranchLsn?: string | undefined; - /** The point in time on the source branch from which this branch was created. */ + /** + * The point in time on the source branch from which this branch was created. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ sourceBranchTime?: Temporal.Instant | undefined; - /** Whether the branch is the project's default branch. */ + /** + * Whether the branch is the project's default branch. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ default?: boolean | undefined; - /** Whether the branch is protected. */ + /** + * Whether the branch is protected. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ isProtected?: boolean | undefined; - /** The branch's state, indicating if it is initializing, ready for use, or archived. */ + /** + * The branch's state, indicating if it is initializing, ready for use, or archived. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ currentState?: BranchStatus_State | undefined; - /** The pending state of the branch, if a state transition is in progress. */ + /** + * The pending state of the branch, if a state transition is in progress. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ pendingState?: BranchStatus_State | undefined; - /** A timestamp indicating when the `current_state` began. */ + /** + * A timestamp indicating when the `current_state` began. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ stateChangeTime?: Temporal.Instant | undefined; - /** The logical size of the branch. */ + /** + * The logical size of the branch. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ logicalSizeBytes?: bigint | undefined; - /** Absolute expiration time for the branch. Empty if expiration is disabled. */ + /** + * Absolute expiration time for the branch. Empty if expiration is disabled. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ expireTime?: Temporal.Instant | undefined; - /** Part of the resource name. */ + /** + * Part of the resource name. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ branchId?: string | undefined; /** * A timestamp indicating when the branch was deleted. * Empty if the branch is not deleted. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ deleteTime?: Temporal.Instant | undefined; /** * A timestamp indicating when the branch is scheduled to be purged. * Empty if the branch is not deleted, otherwise set to a timestamp in the future. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ purgeTime?: Temporal.Instant | undefined; } @@ -904,17 +986,41 @@ export interface Catalog { * Format: "catalogs/{catalog_id}". */ name?: string | undefined; - /** System-generated unique identifier for the catalog. */ + /** + * System-generated unique identifier for the catalog. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ uid?: string | undefined; - /** The desired state of the Catalog. */ + /** + * The desired state of the Catalog. + * + * Input only. Provide this field in requests; it is never returned in responses. + */ spec?: Catalog_CatalogSpec | undefined; - /** The observed state of the Catalog. */ + /** + * The observed state of the Catalog. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ status?: Catalog_CatalogStatus | undefined; - /** A timestamp indicating when the catalog was created. */ + /** + * A timestamp indicating when the catalog was created. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createTime?: Temporal.Instant | undefined; - /** A timestamp indicating when the catalog was last updated. */ + /** + * A timestamp indicating when the catalog was last updated. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updateTime?: Temporal.Instant | undefined; - /** The part of the name, chosen by the user when the resource was created. */ + /** + * The part of the name, chosen by the user when the resource was created. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ catalogId?: string | undefined; } @@ -936,6 +1042,8 @@ export interface Catalog_CatalogSpec { * * Doing Point In Time Restore (PITR) prior to the moment before the Postgres DB was registered * in the Catalog drops the fact of registration of the database. So the user should avoid doing so. + * + * Required. This field must be set in requests. Immutable. Set this field when the resource is created; it cannot be changed afterward. */ postgresDatabase?: string | undefined; /** @@ -957,18 +1065,26 @@ export interface Catalog_CatalogSpec { /** The observed state of the Catalog. */ // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name. export interface Catalog_CatalogStatus { - /** The name of the Postgres database associated with the catalog. */ + /** + * The name of the Postgres database associated with the catalog. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ postgresDatabase?: string | undefined; /** * The resource path of the project associated with the catalog. * * Format: projects/{project_id}. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ project?: string | undefined; /** * The resource path of the branch associated with the catalog. * * Format: projects/{project_id}/branches/{branch_id}. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ branch?: string | undefined; } @@ -980,17 +1096,25 @@ export interface CreateBranchRequest { /** * The Project where this Branch will be created. * Format: projects/{project_id} + * + * Required. This field must be set in requests. */ parent?: string | undefined; /** * The ID to use for the Branch. This becomes the final component of the branch's resource name. * The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens. * For example, `development` becomes `projects/my-app/branches/development`. + * + * Required. This field must be set in requests. */ branchId?: string | undefined; /** The Branch to create. */ branch?: Branch | undefined; - /** If true, update the branch if it already exists instead of returning an error. */ + /** + * If true, update the branch if it already exists instead of returning an error. + * + * Input only. Provide this field in requests; it is never returned in responses. + */ replaceExisting?: boolean | undefined; } @@ -998,16 +1122,27 @@ export interface CreateCatalogRequest { /** * The ID in the Unity Catalog. * It becomes the full resource name, for example "my_catalog" becomes "catalogs/my_catalog". + * + * Required. This field must be set in requests. */ catalogId?: string | undefined; + /** Required. This field must be set in requests. */ catalog?: Catalog | undefined; } /** Enable Data API for a database. */ export interface CreateDataApiRequest { - /** Parent database: projects/{project_id}/branches/{branch_id}/databases/{database_id} */ + /** + * Parent database: projects/{project_id}/branches/{branch_id}/databases/{database_id} + * + * Required. This field must be set in requests. + */ parent?: string | undefined; - /** The Data API configuration to create. */ + /** + * The Data API configuration to create. + * + * Required. This field must be set in requests. + */ dataApi?: DataApi | undefined; } @@ -1015,6 +1150,8 @@ export interface CreateDatabaseRequest { /** * The Branch where this Database will be created. * Format: projects/{project_id}/branches/{branch_id} + * + * Required. This field must be set in requests. */ parent?: string | undefined; /** @@ -1028,11 +1165,17 @@ export interface CreateDatabaseRequest { * If database_id is not specified in the request, it is generated automatically. */ databaseId?: string | undefined; - /** The desired specification of a Database. */ + /** + * The desired specification of a Database. + * + * Required. This field must be set in requests. + */ database?: Database | undefined; /** * If true, update the database if it already exists instead of returning an * error. + * + * Input only. Provide this field in requests; it is never returned in responses. */ replaceExisting?: boolean | undefined; } @@ -1041,17 +1184,29 @@ export interface CreateEndpointRequest { /** * The Branch where this Endpoint will be created. * Format: projects/{project_id}/branches/{branch_id} + * + * Required. This field must be set in requests. */ parent?: string | undefined; /** * The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name. * The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens. * For example, `primary` becomes `projects/my-app/branches/development/endpoints/primary`. + * + * Required. This field must be set in requests. */ endpointId?: string | undefined; - /** The Endpoint to create. */ + /** + * The Endpoint to create. + * + * Required. This field must be set in requests. + */ endpoint?: Endpoint | undefined; - /** If true, update the endpoint if it already exists instead of returning an error. */ + /** + * If true, update the endpoint if it already exists instead of returning an error. + * + * Input only. Provide this field in requests; it is never returned in responses. + */ replaceExisting?: boolean | undefined; } @@ -1060,6 +1215,8 @@ export interface CreateProjectRequest { * The ID to use for the Project. This becomes the final component of the project's resource name. * The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens. * For example, `my-app` becomes `projects/my-app`. + * + * Required. This field must be set in requests. */ projectId?: string | undefined; /** The Project to create. */ @@ -1070,6 +1227,8 @@ export interface CreateRoleRequest { /** * The Branch where this Role is created. * Format: projects/{project_id}/branches/{branch_id} + * + * Required. This field must be set in requests. */ parent?: string | undefined; /** @@ -1083,7 +1242,11 @@ export interface CreateRoleRequest { * If role_id is not specified in the request, it is generated automatically. */ roleId?: string | undefined; - /** The desired specification of a Role. */ + /** + * The desired specification of a Role. + * + * Required. This field must be set in requests. + */ role?: Role | undefined; /** * If true, update the role if it already exists instead of returning an @@ -1094,6 +1257,8 @@ export interface CreateRoleRequest { * `membership_roles` empty clears all of the role's existing memberships, * including `DATABRICKS_SUPERUSER`. Always send the complete desired list of * memberships when using this field. + * + * Input only. Provide this field in requests; it is never returned in responses. */ replaceExisting?: boolean | undefined; } @@ -1111,8 +1276,11 @@ export interface CreateSyncedTableRequest { * * 1. An online VIEW virtual table in the Unity Catalog accessible via the Lakehouse Federation. * 2. Postgres table named "{table}" in schema "{schema}" in the connected Postgres database + * + * Required. This field must be set in requests. */ syncedTableId?: string | undefined; + /** Required. This field must be set in requests. */ syncedTable?: SyncedTable | undefined; } @@ -1126,15 +1294,33 @@ export interface DataApi { /** * The database containing this Data API configuration. * Format: projects/{project_id}/branches/{branch_id}/databases/{database_id} + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ parent?: string | undefined; - /** A timestamp indicating when the Data API was first enabled. */ + /** + * A timestamp indicating when the Data API was first enabled. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createTime?: Temporal.Instant | undefined; - /** A timestamp indicating when the Data API configuration was last updated. */ + /** + * A timestamp indicating when the Data API configuration was last updated. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updateTime?: Temporal.Instant | undefined; - /** The desired Data API configuration. */ + /** + * The desired Data API configuration. + * + * Input only. Provide this field in requests; it is never returned in responses. + */ spec?: DataApi_DataApiSpec | undefined; - /** The observed Data API state (read-only). */ + /** + * The observed Data API state (read-only). + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ status?: DataApi_DataApiStatus | undefined; } @@ -1183,27 +1369,71 @@ export interface DataApi_DataApiSpec { /** Observed state (output-only). */ // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name. export interface DataApi_DataApiStatus { - /** Actual aggregate function setting read from the database. */ + /** + * Actual aggregate function setting read from the database. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ dbAggregatesEnabled?: boolean | undefined; - /** Actual extra search path schemas read from the database. */ + /** + * Actual extra search path schemas read from the database. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ dbExtraSearchPath?: string[] | undefined; - /** Actual max rows setting read from the database. */ + /** + * Actual max rows setting read from the database. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ dbMaxRows?: number | undefined; - /** Actual exposed schemas read from the database. */ + /** + * Actual exposed schemas read from the database. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ dbSchemas?: string[] | undefined; - /** Actual JWT role claim key read from the database. */ + /** + * Actual JWT role claim key read from the database. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ jwtRoleClaimKey?: string | undefined; - /** Actual JWT cache max lifetime read from the database. */ + /** + * Actual JWT cache max lifetime read from the database. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ jwtCacheMaxLifetime?: Temporal.Duration | undefined; - /** Actual OpenAPI mode read from the database. */ + /** + * Actual OpenAPI mode read from the database. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ openapiMode?: OpenApiMode | undefined; - /** Actual CORS allowed origins read from the database. */ + /** + * Actual CORS allowed origins read from the database. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ serverCorsAllowedOrigins?: string[] | undefined; - /** Actual Server-Timing header setting read from the database. */ + /** + * Actual Server-Timing header setting read from the database. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ serverTimingEnabled?: boolean | undefined; - /** Data API endpoint URL. */ + /** + * Data API endpoint URL. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ url?: string | undefined; - /** Schemas available in the database (for reference when configuring db_schemas). */ + /** + * Schemas available in the database (for reference when configuring db_schemas). + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ availableSchemas?: string[] | undefined; } @@ -1220,17 +1450,39 @@ export interface Database { /** * The branch containing this database. * Format: projects/{project_id}/branches/{branch_id} + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ parent?: string | undefined; - /** A timestamp indicating when the database was created. */ + /** + * A timestamp indicating when the database was created. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createTime?: Temporal.Instant | undefined; - /** A timestamp indicating when the database was last updated. */ + /** + * A timestamp indicating when the database was last updated. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updateTime?: Temporal.Instant | undefined; - /** The desired state of the Database. */ + /** + * The desired state of the Database. + * + * Input only. Provide this field in requests; it is never returned in responses. + */ spec?: Database_DatabaseSpec | undefined; - /** The observed state of the Database. */ + /** + * The observed state of the Database. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ status?: Database_DatabaseStatus | undefined; - /** The part of the name, chosen by the user when the resource was created. */ + /** + * The part of the name, chosen by the user when the resource was created. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ databaseId?: string | undefined; } @@ -1266,7 +1518,11 @@ export interface Database_DatabaseStatus { role?: string | undefined; /** The name of the Postgres database. */ postgresDatabase?: string | undefined; - /** Part of the resource name. */ + /** + * Part of the resource name. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ databaseId?: string | undefined; } @@ -1284,6 +1540,8 @@ export interface DeleteBranchRequest { /** * The full resource path of the branch to delete. * Format: projects/{project_id}/branches/{branch_id} + * + * Required. This field must be set in requests. */ name?: string | undefined; /** If true, permanently delete the branch; if false, soft delete. */ @@ -1295,13 +1553,19 @@ export interface DeleteCatalogRequest { * The full resource path of the catalog to delete. * * Format: "catalogs/{catalog_id}". + * + * Required. This field must be set in requests. */ name?: string | undefined; } /** Disable Data API for a database. */ export interface DeleteDataApiRequest { - /** Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api */ + /** + * Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api + * + * Required. This field must be set in requests. + */ name?: string | undefined; } @@ -1309,6 +1573,8 @@ export interface DeleteDatabaseRequest { /** * The resource name of the postgres database. * Format: projects/{project_id}/branches/{branch_id}/databases/{database_id} + * + * Required. This field must be set in requests. */ name?: string | undefined; } @@ -1317,6 +1583,8 @@ export interface DeleteEndpointRequest { /** * The full resource path of the endpoint to delete. * Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id} + * + * Required. This field must be set in requests. */ name?: string | undefined; } @@ -1338,6 +1606,8 @@ export interface DeleteRoleRequest { /** * The full resource path of the role to delete. * Format: projects/{project_id}/branches/{branch_id}/roles/{role_id} + * + * Required. This field must be set in requests. */ name?: string | undefined; /** @@ -1354,16 +1624,24 @@ export interface DeleteSyncedTableRequest { /** * The Full resource name of the synced table, of the format "synced_tables/{catalog}.{schema}.{table}", * where (catalog, schema, table) are the UC entity names. + * + * Required. This field must be set in requests. */ name?: string | undefined; } export interface DeltaTableSyncInfo { - /** The Delta Lake commit version that was last successfully synced. */ + /** + * The Delta Lake commit version that was last successfully synced. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ deltaCommitVersion?: bigint | undefined; /** * The timestamp when the above Delta version was committed in the source Delta table. * Note: This is the Delta commit time, not the time the data was written to the synced table. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ deltaCommitTime?: Temporal.Instant | undefined; } @@ -1374,22 +1652,48 @@ export interface Endpoint { * Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id} */ name?: string | undefined; - /** System-generated unique ID for the endpoint. */ + /** + * System-generated unique ID for the endpoint. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ uid?: string | undefined; /** * The branch containing this endpoint (API resource hierarchy). * Format: projects/{project_id}/branches/{branch_id} + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ parent?: string | undefined; - /** A timestamp indicating when the compute endpoint was created. */ + /** + * A timestamp indicating when the compute endpoint was created. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createTime?: Temporal.Instant | undefined; - /** A timestamp indicating when the compute endpoint was last updated. */ + /** + * A timestamp indicating when the compute endpoint was last updated. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updateTime?: Temporal.Instant | undefined; - /** The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state. */ + /** + * The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state. + * + * Input only. Provide this field in requests; it is never returned in responses. + */ spec?: EndpointSpec | undefined; - /** Current operational status of the compute endpoint. */ + /** + * Current operational status of the compute endpoint. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ status?: EndpointStatus | undefined; - /** The part of the name, chosen by the user when the resource was created. */ + /** + * The part of the name, chosen by the user when the resource was created. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ endpointId?: string | undefined; } @@ -1397,12 +1701,16 @@ export interface EndpointGroupSpec { /** * The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater * than or equal to 1. + * + * Required. This field must be set in requests. */ min?: number | undefined; /** * The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single * compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to * true on the EndpointSpec. + * + * Required. This field must be set in requests. */ max?: number | undefined; /** @@ -1416,17 +1724,23 @@ export interface EndpointGroupStatus { /** * The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater * than or equal to 1. + * + * Required. This field must be set in requests. */ min?: number | undefined; /** * The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single * compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to * true on the EndpointSpec. + * + * Required. This field must be set in requests. */ max?: number | undefined; /** * Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured * by specifying size.max > 1. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ enableReadableSecondaries?: boolean | undefined; } @@ -1436,12 +1750,16 @@ export interface EndpointHosts { /** * The hostname to connect to this endpoint. For read-write endpoints, this is a read-write hostname which connects * to the primary compute. For read-only endpoints, this is a read-only hostname which allows read-only operations. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ host?: string | undefined; /** * An optionally defined read-only host for the endpoint, without pooling. For read-only endpoints, * this attribute is always defined and is equivalent to host. For read-write endpoints, this attribute is defined * if the enclosing endpoint is a group with greater than 1 computes configured, and has readable secondaries enabled. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ readOnlyHost?: string | undefined; } @@ -1456,7 +1774,11 @@ export interface EndpointSettings { } export interface EndpointSpec { - /** The endpoint type. A branch can only have one READ_WRITE endpoint. */ + /** + * The endpoint type. A branch can only have one READ_WRITE endpoint. + * + * Required. This field must be set in requests. Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ endpointType?: EndpointType | undefined; /** The minimum number of Compute Units. Minimum value is 0.5. */ autoscalingLimitMinCu?: number | undefined; @@ -1508,32 +1830,63 @@ export interface EndpointSpec { } export interface EndpointStatus { - /** The endpoint type. A branch can only have one READ_WRITE endpoint. */ + /** + * The endpoint type. A branch can only have one READ_WRITE endpoint. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ endpointType?: EndpointType | undefined; - /** Contains host information for connecting to the endpoint. */ + /** + * Contains host information for connecting to the endpoint. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ hosts?: EndpointHosts | undefined; - /** The minimum number of Compute Units. */ + /** + * The minimum number of Compute Units. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ autoscalingLimitMinCu?: number | undefined; /** * The maximum number of Compute Units. The maximum value is 64. * The difference between the minimum and maximum Compute Units (max - min) must not exceed 16. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ autoscalingLimitMaxCu?: number | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ currentState?: EndpointStatus_State | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ pendingState?: EndpointStatus_State | undefined; /** * Whether to restrict connections to the compute endpoint. * Enabling this option schedules a suspend compute operation. * A disabled compute endpoint cannot be enabled by a connection or * console action. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ disabled?: boolean | undefined; - /** Duration of inactivity after which the compute endpoint is automatically suspended. */ + /** + * Duration of inactivity after which the compute endpoint is automatically suspended. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ suspendTimeoutDuration?: Temporal.Duration | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ settings?: EndpointSettings | undefined; - /** Details on the HA configuration of the endpoint. */ + /** + * Details on the HA configuration of the endpoint. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ group?: EndpointGroupStatus | undefined; - /** Part of the resource name. */ + /** + * Part of the resource name. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ endpointId?: string | undefined; } @@ -1543,14 +1896,46 @@ export interface GenerateDatabaseCredentialRequest { /** * The endpoint resource name for which this credential will be generated. * Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id} + * + * Required. This field must be set in requests. */ endpoint?: string | undefined; + /** + * workspace group name. When provided, credentials are generated + * with permissions scoped to this group. + */ + groupName?: string | undefined; + /** + * Expiration information for the credential. + * Users can specify either expire_time or ttl. + * If unspecified, maximum allowed duration (1 hour) is used. + */ + expiration?: + | { + $case: 'ttl'; + /** + * The requested time-to-live for the generated credential token. + * Must be at least 300 seconds (5 minutes) and at most 3600 seconds (1 hour). + */ + ttl: Temporal.Duration; + } + | { + $case: 'expireTime'; + /** + * Timestamp in UTC of when this credential should expire. + * Must be at least 300 seconds (5 minutes) and at most 1 hour from the current time. + */ + expireTime: Temporal.Instant; + } + | undefined; } export interface GetBranchRequest { /** * The full resource path of the branch to retrieve. * Format: projects/{project_id}/branches/{branch_id} + * + * Required. This field must be set in requests. */ name?: string | undefined; } @@ -1560,13 +1945,19 @@ export interface GetCatalogRequest { * The full resource path of the catalog to retrieve. * * Format: "catalogs/{catalog_id}". + * + * Required. This field must be set in requests. */ name?: string | undefined; } /** Get Data API configuration for a database. */ export interface GetDataApiRequest { - /** Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api */ + /** + * Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api + * + * Required. This field must be set in requests. + */ name?: string | undefined; } @@ -1574,6 +1965,8 @@ export interface GetDatabaseRequest { /** * The name of the Database to retrieve. * Format: projects/{project_id}/branches/{branch_id}/databases/{database_id} + * + * Required. This field must be set in requests. */ name?: string | undefined; } @@ -1582,6 +1975,8 @@ export interface GetEndpointRequest { /** * The full resource path of the endpoint to retrieve. * Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id} + * + * Required. This field must be set in requests. */ name?: string | undefined; } @@ -1604,6 +1999,8 @@ export interface GetRoleRequest { /** * The full resource path of the role to retrieve. * Format: projects/{project_id}/branches/{branch_id}/roles/{role_id} + * + * Required. This field must be set in requests. */ name?: string | undefined; } @@ -1613,6 +2010,8 @@ export interface GetSyncedTableRequest { * The Full resource name of the synced table. * Format: "synced_tables/{catalog}.{schema}.{table}", * where (catalog, schema, table) are the entity names in the Unity Catalog. + * + * Required. This field must be set in requests. */ name?: string | undefined; } @@ -1657,6 +2056,8 @@ export interface ListBranchesRequest { /** * The Project that owns this collection of branches. * Format: projects/{project_id} + * + * Required. This field must be set in requests. */ parent?: string | undefined; /** Page token from a previous response. If not provided, returns the first page. */ @@ -1683,6 +2084,8 @@ export interface ListDatabasesRequest { /** * The Branch that owns this collection of databases. * Format: projects/{project_id}/branches/{branch_id} + * + * Required. This field must be set in requests. */ parent?: string | undefined; /** Pagination token to go to the next page of Databases. Requests first page if absent. */ @@ -1702,6 +2105,8 @@ export interface ListEndpointsRequest { /** * The Branch that owns this collection of endpoints. * Format: projects/{project_id}/branches/{branch_id} + * + * Required. This field must be set in requests. */ parent?: string | undefined; /** Page token from a previous response. If not provided, returns the first page. */ @@ -1711,9 +2116,17 @@ export interface ListEndpointsRequest { } export interface ListEndpointsResponse { - /** List of compute endpoints in the branch. */ + /** + * List of compute endpoints in the branch. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ endpoints?: Endpoint[] | undefined; - /** Token to request the next page of compute endpoints. */ + /** + * Token to request the next page of compute endpoints. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ nextPageToken?: string | undefined; } @@ -1741,6 +2154,8 @@ export interface ListRolesRequest { /** * The Branch that owns this collection of roles. * Format: projects/{project_id}/branches/{branch_id} + * + * Required. This field must be set in requests. */ parent?: string | undefined; /** Page token from a previous response. If not provided, returns the first page. */ @@ -1820,40 +2235,72 @@ export interface Project { * Format: projects/{project_id} */ name?: string | undefined; - /** System-generated unique ID for the project. */ + /** + * System-generated unique ID for the project. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ uid?: string | undefined; - /** A timestamp indicating when the project was created. */ + /** + * A timestamp indicating when the project was created. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createTime?: Temporal.Instant | undefined; - /** A timestamp indicating when the project was last updated. */ + /** + * A timestamp indicating when the project was last updated. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updateTime?: Temporal.Instant | undefined; - /** The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings. */ + /** + * The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings. + * + * Input only. Provide this field in requests; it is never returned in responses. + */ spec?: ProjectSpec | undefined; - /** The current status of a Project. */ + /** + * The current status of a Project. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ status?: ProjectStatus | undefined; /** * Configuration settings for the initial Read/Write endpoint created inside the initial branch for a newly * created project. If omitted, the initial endpoint created will have default settings, without high availability * configured. This field does not apply to any endpoints created after project creation. Use * spec.default_endpoint_settings to configure default settings for endpoints created after project creation. + * + * Input only. Provide this field in requests; it is never returned in responses. */ initialEndpointSpec?: InitialEndpointSpec | undefined; /** * A timestamp indicating when the project was soft-deleted. * Empty if the project is not deleted, otherwise set to a timestamp in the past. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ deleteTime?: Temporal.Instant | undefined; /** * A timestamp indicating when the project is scheduled for permanent deletion. * Empty if the project is not deleted, otherwise set to a timestamp in the future. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ purgeTime?: Temporal.Instant | undefined; /** * Configuration for the initial default branch created as part of project creation. * Allows overriding branch protection. These settings only apply at creation time * and do not affect resources created after project creation. + * + * Input only. Provide this field in requests; it is never returned in responses. */ initialBranchSpec?: InitialBranchSpec | undefined; - /** The part of the name, chosen by the user when the resource was created. */ + /** + * The part of the name, chosen by the user when the resource was created. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ projectId?: string | undefined; } @@ -1900,7 +2347,11 @@ export interface ProjectOperationMetadata {} export interface ProjectSpec { /** Human-readable project name. Length should be between 1 and 256 characters. */ displayName?: string | undefined; - /** The major Postgres version number. The set of supported versions may vary; consult the API documentation for currently accepted values. */ + /** + * The major Postgres version number. The set of supported versions may vary; consult the API documentation for currently accepted values. + * + * Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ pgVersion?: number | undefined; /** The number of seconds to retain the shared history for point in time recovery for all branches in this project. Value should be between 172800s (2 days) and 3024000s (35 days). */ historyRetentionDuration?: Temporal.Duration | undefined; @@ -1927,31 +2378,83 @@ export interface ProjectSpec { } export interface ProjectStatus { - /** The effective human-readable project name. */ + /** + * The effective human-readable project name. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ displayName?: string | undefined; - /** The effective major Postgres version number. */ + /** + * The effective major Postgres version number. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ pgVersion?: number | undefined; - /** The effective number of seconds to retain the shared history for point in time recovery. */ + /** + * The effective number of seconds to retain the shared history for point in time recovery. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ historyRetentionDuration?: Temporal.Duration | undefined; - /** The effective default endpoint settings. */ + /** + * The effective default endpoint settings. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ defaultEndpointSettings?: ProjectDefaultEndpointSettings | undefined; - /** The logical size limit for a branch. */ + /** + * The logical size limit for a branch. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ branchLogicalSizeLimitBytes?: bigint | undefined; - /** The current space occupied by the project in storage. */ + /** + * The current space occupied by the project in storage. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ syntheticStorageSizeBytes?: bigint | undefined; - /** The most recent time when any endpoint of this project was active. */ + /** + * The most recent time when any endpoint of this project was active. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ computeLastActiveTime?: Temporal.Instant | undefined; - /** The budget policy that is applied to the project. */ + /** + * The budget policy that is applied to the project. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ budgetPolicyId?: string | undefined; - /** The effective custom tags associated with the project. */ + /** + * The effective custom tags associated with the project. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ customTags?: ProjectCustomTag[] | undefined; - /** The email of the project owner. */ + /** + * The email of the project owner. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ owner?: string | undefined; - /** Whether to enable PG native password login on all endpoints in this project. */ + /** + * Whether to enable PG native password login on all endpoints in this project. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ enablePgNativeLogin?: boolean | undefined; - /** The full resource path of the default branch of the project */ + /** + * The full resource path of the default branch of the project + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ defaultBranch?: string | undefined; - /** Part of the resource name. */ + /** + * Part of the resource name. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ projectId?: string | undefined; } @@ -1984,15 +2487,31 @@ export interface Role { /** * The Branch where this Role exists. * Format: projects/{project_id}/branches/{branch_id} + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ parent?: string | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ createTime?: Temporal.Instant | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ updateTime?: Temporal.Instant | undefined; - /** The spec contains the role configuration, including identity type, authentication method, and role attributes. */ + /** + * The spec contains the role configuration, including identity type, authentication method, and role attributes. + * + * Input only. Provide this field in requests; it is never returned in responses. + */ spec?: Role_RoleSpec | undefined; - /** Current status of the role, including its identity type, authentication method, and role attributes. */ + /** + * Current status of the role, including its identity type, authentication method, and role attributes. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ status?: Role_RoleStatus | undefined; - /** The part of the name, chosen by the user when the resource was created. */ + /** + * The part of the name, chosen by the user when the resource was created. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ roleId?: string | undefined; } @@ -2076,7 +2595,11 @@ export interface Role_RoleStatus { authMethod?: Role_AuthMethod | undefined; /** The name of the Postgres role. */ postgresRole?: string | undefined; - /** Part of the resource name. */ + /** + * Part of the resource name. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ roleId?: string | undefined; } @@ -2093,17 +2616,32 @@ export interface SyncedTable { * For the corresponding source table in the Unity catalog look for the "source_table_full_name" attribute. */ name?: string | undefined; - /** The Unity Catalog table ID for this synced table. */ + /** + * The Unity Catalog table ID for this synced table. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ uid?: string | undefined; /** * Configuration details of the synced table, such as the source table, scheduling policy, etc. * This attribute is specified at creation time and most fields are returned as is on subsequent queries. + * + * Input only. Provide this field in requests; it is never returned in responses. */ spec?: SyncedTable_SyncedTableSpec | undefined; - /** Synced Table data synchronization status. */ + /** + * Synced Table data synchronization status. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ status?: SyncedTable_SyncedTableStatus | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ createTime?: Temporal.Instant | undefined; - /** The part of the name, chosen by the user when the resource was created. */ + /** + * The part of the name, chosen by the user when the resource was created. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ syncedTableId?: string | undefined; } @@ -2179,9 +2717,17 @@ export interface SyncedTable_SyncedTableSpec { /** Overrides the default Delta-to-PostgreSQL type mapping for a single column. */ // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name. export interface SyncedTable_SyncedTableSpec_TypeOverride { - /** Name of the source column whose target PostgreSQL type should be overridden. */ + /** + * Name of the source column whose target PostgreSQL type should be overridden. + * + * Required. This field must be set in requests. + */ columnName?: string | undefined; - /** PostgreSQL-specific target type to use for the column. */ + /** + * PostgreSQL-specific target type to use for the column. + * + * Required. This field must be set in requests. + */ pgType?: SyncedTable_SyncedTableSpec_PgSpecificType | undefined; /** * Size parameter for the target type. Required when pg_type is PG_SPECIFIC_TYPE_VECTOR @@ -2192,30 +2738,63 @@ export interface SyncedTable_SyncedTableSpec_TypeOverride { // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name. export interface SyncedTable_SyncedTableStatus { - /** A text description of the current state of the synced table. */ + /** + * A text description of the current state of the synced table. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ message?: string | undefined; - /** The state of the synced table. */ + /** + * The state of the synced table. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ detailedState?: SyncedTableState | undefined; - /** Summary of the last successful synchronization from source to destination. */ + /** + * Summary of the last successful synchronization from source to destination. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ lastSync?: SyncedTablePosition | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ ongoingSyncProgress?: SyncedTablePipelineProgress | undefined; - /** The current phase of the data synchronization pipeline. */ + /** + * The current phase of the data synchronization pipeline. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ provisioningPhase?: ProvisioningPhase | undefined; - /** The last source table Delta version that was successfully synced to the synced table. */ + /** + * The last source table Delta version that was successfully synced to the synced table. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ lastProcessedCommitVersion?: bigint | undefined; /** * The end timestamp of the last time any data was synchronized from the source table to the synced * table. This is when the data is available in the synced table. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ lastSyncTime?: Temporal.Instant | undefined; - /** ID of the associated pipeline. */ + /** + * ID of the associated pipeline. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ pipelineId?: string | undefined; - /** The provisioning state of the synced table entity in Unity Catalog. */ + /** + * The provisioning state of the synced table entity in Unity Catalog. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ unityCatalogProvisioningState?: ProvisioningInfo_State | undefined; /** * The full resource name of the project associated with the table. * * Format: "projects/{project_id}". + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ project?: string | undefined; } @@ -2229,15 +2808,33 @@ export interface SyncedTablePipelineProgress { /** * The source table Delta version that was last processed by the pipeline. The pipeline may not * have completely processed this version yet. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ latestVersionCurrentlyProcessing?: bigint | undefined; - /** The number of rows that have been synced in this update. */ + /** + * The number of rows that have been synced in this update. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ syncedRowCount?: bigint | undefined; - /** The total number of rows that need to be synced in this update. This number may be an estimate. */ + /** + * The total number of rows that need to be synced in this update. This number may be an estimate. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ totalRowCount?: bigint | undefined; - /** The completion ratio of this update. This is a number between 0 and 1. */ + /** + * The completion ratio of this update. This is a number between 0 and 1. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ syncProgressCompletion?: number | undefined; - /** The estimated time remaining to complete this update in seconds. */ + /** + * The estimated time remaining to complete this update in seconds. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ estimatedCompletionTimeSeconds?: number | undefined; } @@ -2247,16 +2844,24 @@ export interface SyncedTablePosition { * to the destination (synced) table. * Note this is the starting timestamp of the sync operation, not the end time. * E.g., for a batch, this is the time when the sync operation started. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ syncStartTime?: Temporal.Instant | undefined; /** * The end timestamp of the most recent successful synchronization. * This is the time when the data is available in the synced table. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ syncEndTime?: Temporal.Instant | undefined; /** Information about the source system at the time of the last sync. */ sourceSyncInfo?: - | {$case: 'deltaTableSyncInfo'; deltaTableSyncInfo: DeltaTableSyncInfo} + | { + $case: 'deltaTableSyncInfo'; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ + deltaTableSyncInfo: DeltaTableSyncInfo; + } | undefined; } @@ -2264,6 +2869,8 @@ export interface UndeleteBranchRequest { /** * The full resource path of the branch to undelete. * Format: projects/{project_id}/branches/{branch_id} + * + * Required. This field must be set in requests. */ name?: string | undefined; } @@ -2273,6 +2880,8 @@ export interface UndeleteProjectRequest { /** * The full resource path of the project to undelete. * Format: projects/{project_id} + * + * Required. This field must be set in requests. */ name?: string | undefined; } @@ -2283,9 +2892,15 @@ export interface UpdateBranchRequest { * * The branch's `name` field is used to identify the branch to update. * Format: projects/{project_id}/branches/{branch_id} + * + * Required. This field must be set in requests. */ branch?: Branch | undefined; - /** The list of fields to update. If unspecified, all fields will be updated when possible. */ + /** + * The list of fields to update. If unspecified, all fields will be updated when possible. + * + * Required. This field must be set in requests. + */ updateMask?: FieldMask | undefined; } @@ -2294,9 +2909,15 @@ export interface UpdateDataApiRequest { /** * The Data API configuration to update. * The data_api's `name` field identifies the resource. + * + * Required. This field must be set in requests. */ dataApi?: DataApi | undefined; - /** The list of fields to update. If unspecified, all fields will be updated when possible. */ + /** + * The list of fields to update. If unspecified, all fields will be updated when possible. + * + * Required. This field must be set in requests. + */ updateMask?: FieldMask | undefined; } @@ -2306,9 +2927,15 @@ export interface UpdateDatabaseRequest { * * The database's `name` field is used to identify the database to update. * Format: projects/{project_id}/branches/{branch_id}/databases/{database_id} + * + * Required. This field must be set in requests. */ database?: Database | undefined; - /** The list of fields to update. If unspecified, all fields will be updated when possible. */ + /** + * The list of fields to update. If unspecified, all fields will be updated when possible. + * + * Required. This field must be set in requests. + */ updateMask?: FieldMask | undefined; } @@ -2318,9 +2945,15 @@ export interface UpdateEndpointRequest { * * The endpoint's `name` field is used to identify the endpoint to update. * Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id} + * + * Required. This field must be set in requests. */ endpoint?: Endpoint | undefined; - /** The list of fields to update. If unspecified, all fields will be updated when possible. */ + /** + * The list of fields to update. If unspecified, all fields will be updated when possible. + * + * Required. This field must be set in requests. + */ updateMask?: FieldMask | undefined; } @@ -2330,9 +2963,15 @@ export interface UpdateProjectRequest { * * The project's `name` field is used to identify the project to update. * Format: projects/{project_id} + * + * Required. This field must be set in requests. */ project?: Project | undefined; - /** The list of fields to update. If unspecified, all fields will be updated when possible. */ + /** + * The list of fields to update. If unspecified, all fields will be updated when possible. + * + * Required. This field must be set in requests. + */ updateMask?: FieldMask | undefined; } @@ -2342,11 +2981,15 @@ export interface UpdateRoleRequest { * * The role's `name` field is used to identify the role to update. * Format: projects/{project_id}/branches/{branch_id}/roles/{role_id} + * + * Required. This field must be set in requests. */ role?: Role | undefined; /** * The list of fields to update in Postgres Role. * If unspecified, all fields will be updated when possible. + * + * Required. This field must be set in requests. */ updateMask?: FieldMask | undefined; } @@ -3831,10 +4474,32 @@ export const marshalGenerateDatabaseCredentialRequestSchema: z.ZodType = z .object({ claims: z.array(z.lazy(() => marshalRequestedClaimsSchema)).optional(), endpoint: z.string().optional(), + groupName: z.string().optional(), + expiration: z + .discriminatedUnion('$case', [ + z.object({ + $case: z.literal('ttl'), + ttl: z + .any() + .transform((d: Temporal.Duration) => + d.toString().slice(2).toLowerCase() + ), + }), + z.object({ + $case: z.literal('expireTime'), + expireTime: z.any().transform((d: Temporal.Instant) => d.toString()), + }), + ]) + .optional(), }) .transform(d => ({ claims: d.claims, endpoint: d.endpoint, + group_name: d.groupName, + ...(d.expiration?.$case === 'ttl' && {ttl: d.expiration.ttl}), + ...(d.expiration?.$case === 'expireTime' && { + expire_time: d.expiration.expireTime, + }), })); export const marshalInitialBranchSpecSchema: z.ZodType = z diff --git a/packages/queries/src/v1/model.ts b/packages/queries/src/v1/model.ts index 30b57520..8b540e9f 100644 --- a/packages/queries/src/v1/model.ts +++ b/packages/queries/src/v1/model.ts @@ -111,7 +111,9 @@ export interface CreateQueryRequestQuery { } export interface DateRange { + /** Required. This field must be set in requests. */ start?: string | undefined; + /** Required. This field must be set in requests. */ end?: string | undefined; } @@ -335,6 +337,7 @@ export interface TrashQueryRequest { export interface UpdateQueryRequest { query?: UpdateQueryRequestQuery | undefined; + /** Required. This field must be set in requests. */ updateMask?: FieldMask | undefined; id?: string | undefined; /** If true, automatically resolve alert display name conflicts. Otherwise, fail the request if the alert's display name conflicts with an existing alert's display name. */ diff --git a/packages/queryhistory/src/v1/model.ts b/packages/queryhistory/src/v1/model.ts index 246bb444..d5a3fa07 100755 --- a/packages/queryhistory/src/v1/model.ts +++ b/packages/queryhistory/src/v1/model.ts @@ -356,6 +356,7 @@ export interface QueryMetrics { * QueryTag is the user-facing representation. */ export interface QueryTag { + /** Required. This field must be set in requests. */ key?: string | undefined; value?: string | undefined; } diff --git a/packages/repos/src/v1/model.ts b/packages/repos/src/v1/model.ts index cd7a55c1..f5f46705 100755 --- a/packages/repos/src/v1/model.ts +++ b/packages/repos/src/v1/model.ts @@ -3,7 +3,11 @@ import {z} from 'zod'; export interface CreateRepoRequest { - /** URL of the Git repository to be linked. */ + /** + * URL of the Git repository to be linked. + * + * Required. This field must be set in requests. + */ url?: string | undefined; /** * Git provider. This field is case-insensitive. The available Git providers are `gitHub`, @@ -11,6 +15,8 @@ export interface CreateRepoRequest { * Microsoft Entra ID authentication), `gitHubEnterprise`, `bitbucketServer` (Bitbucket * Data Center), `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit` * (deprecated by AWS, not accepting new customers). + * + * Required. This field must be set in requests. */ provider?: string | undefined; /** @@ -47,7 +53,11 @@ export interface CreateRepoResponse { } export interface DeleteRepoRequest { - /** The ID for the corresponding repo to delete. */ + /** + * The ID for the corresponding repo to delete. + * + * Required. This field must be set in requests. + */ id?: bigint | undefined; } @@ -55,7 +65,11 @@ export interface DeleteRepoRequest { export interface DeleteRepoResponse {} export interface GetRepoRequest { - /** ID of the Git folder (repo) object in the workspace. */ + /** + * ID of the Git folder (repo) object in the workspace. + * + * Required. This field must be set in requests. + */ id?: bigint | undefined; } @@ -147,7 +161,11 @@ export interface SparseCheckoutUpdate { } export interface UpdateRepoRequest { - /** ID of the Git folder (repo) object in the workspace. */ + /** + * ID of the Git folder (repo) object in the workspace. + * + * Required. This field must be set in requests. + */ id?: bigint | undefined; /** Branch that the local version of the repo is checked out to. */ branch?: string | undefined; diff --git a/packages/scim/src/v1/model.ts b/packages/scim/src/v1/model.ts index 3d5b235d..571b172c 100644 --- a/packages/scim/src/v1/model.ts +++ b/packages/scim/src/v1/model.ts @@ -372,7 +372,11 @@ export interface CreateUserRequest { /** Delete a group */ export interface DeleteAccountGroupRequest { - /** Unique ID for a group in the account. */ + /** + * Unique ID for a group in the account. + * + * Required. This field must be set in requests. + */ id?: string | undefined; /** account ID */ accountId?: string | undefined; @@ -380,7 +384,11 @@ export interface DeleteAccountGroupRequest { /** Delete a service principal */ export interface DeleteAccountServicePrincipalRequest { - /** Unique ID for a service principal in the account. */ + /** + * Unique ID for a service principal in the account. + * + * Required. This field must be set in requests. + */ id?: string | undefined; /** account ID */ accountId?: string | undefined; @@ -388,7 +396,11 @@ export interface DeleteAccountServicePrincipalRequest { /** Delete a user */ export interface DeleteAccountUserRequest { - /** Unique ID for a user in the account. */ + /** + * Unique ID for a user in the account. + * + * Required. This field must be set in requests. + */ id?: string | undefined; /** account ID */ accountId?: string | undefined; @@ -396,25 +408,41 @@ export interface DeleteAccountUserRequest { /** Delete a group */ export interface DeleteGroupRequest { - /** Unique ID for a group in the workspace. */ + /** + * Unique ID for a group in the workspace. + * + * Required. This field must be set in requests. + */ id?: string | undefined; } /** Delete a service principal */ export interface DeleteServicePrincipalRequest { - /** Unique ID for a service principal in the workspace. */ + /** + * Unique ID for a service principal in the workspace. + * + * Required. This field must be set in requests. + */ id?: string | undefined; } /** Delete a user */ export interface DeleteUserRequest { - /** Unique ID for a user in the workspace. */ + /** + * Unique ID for a user in the workspace. + * + * Required. This field must be set in requests. + */ id?: string | undefined; } /** Get group details */ export interface GetAccountGroupRequest { - /** Unique ID for a group in the account. */ + /** + * Unique ID for a group in the account. + * + * Required. This field must be set in requests. + */ id?: string | undefined; /** account ID */ accountId?: string | undefined; @@ -422,7 +450,11 @@ export interface GetAccountGroupRequest { /** Get service principal details */ export interface GetAccountServicePrincipalRequest { - /** Unique ID for a service principal in the account. */ + /** + * Unique ID for a service principal in the account. + * + * Required. This field must be set in requests. + */ id?: string | undefined; /** account ID */ accountId?: string | undefined; @@ -438,7 +470,11 @@ export interface GetAccountUserRequest { excludedAttributes?: string | undefined; /** Query by which the results have to be filtered. Supported operators are equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`). Additionally, simple expressions can be formed using logical operators - `and` and `or`. The [SCIM RFC](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) has more details but we currently only support simple expressions. */ filter?: string | undefined; - /** Unique ID for a user in the account. */ + /** + * Unique ID for a user in the account. + * + * Required. This field must be set in requests. + */ id?: string | undefined; /** Attribute to sort the results. Multi-part paths are supported. For example, `userName`, `name.givenName`, and `emails`. */ sortBy?: string | undefined; @@ -452,7 +488,11 @@ export interface GetAccountUserRequest { /** Get group details */ export interface GetGroupRequest { - /** Unique ID for a group in the workspace. */ + /** + * Unique ID for a group in the workspace. + * + * Required. This field must be set in requests. + */ id?: string | undefined; } @@ -470,7 +510,11 @@ export interface GetPasswordPermissionsRequest {} /** Get service principal details */ export interface GetServicePrincipalRequest { - /** Unique ID for a service principal in the workspace. */ + /** + * Unique ID for a service principal in the workspace. + * + * Required. This field must be set in requests. + */ id?: string | undefined; } @@ -484,7 +528,11 @@ export interface GetUserRequest { excludedAttributes?: string | undefined; /** Query by which the results have to be filtered. Supported operators are equals(`eq`), contains(`co`), starts with(`sw`) and not equals(`ne`). Additionally, simple expressions can be formed using logical operators - `and` and `or`. The [SCIM RFC](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) has more details but we currently only support simple expressions. */ filter?: string | undefined; - /** Unique ID for a user in the workspace. */ + /** + * Unique ID for a user in the workspace. + * + * Required. This field must be set in requests. + */ id?: string | undefined; /** Attribute to sort the results. Multi-part paths are supported. For example, `userName`, `name.givenName`, and `emails`. */ sortBy?: string | undefined; @@ -777,7 +825,11 @@ export interface Patch { } export interface PatchAccountGroupRequest { - /** Unique ID in the workspace. */ + /** + * Unique ID in the workspace. + * + * Required. This field must be set in requests. + */ id?: string | undefined; operations?: AccountPatch[] | undefined; /** The schema of the patch request. Must be ["urn:ietf:params:scim:api:messages:2.0:PatchOp"]. */ @@ -787,7 +839,11 @@ export interface PatchAccountGroupRequest { } export interface PatchAccountServicePrincipalRequest { - /** Unique ID in the workspace. */ + /** + * Unique ID in the workspace. + * + * Required. This field must be set in requests. + */ id?: string | undefined; operations?: AccountPatch[] | undefined; /** The schema of the patch request. Must be ["urn:ietf:params:scim:api:messages:2.0:PatchOp"]. */ @@ -797,7 +853,11 @@ export interface PatchAccountServicePrincipalRequest { } export interface PatchAccountUserRequest { - /** Unique ID in the workspace. */ + /** + * Unique ID in the workspace. + * + * Required. This field must be set in requests. + */ id?: string | undefined; operations?: AccountPatch[] | undefined; /** The schema of the patch request. Must be ["urn:ietf:params:scim:api:messages:2.0:PatchOp"]. */ @@ -807,7 +867,11 @@ export interface PatchAccountUserRequest { } export interface PatchGroupRequest { - /** Unique ID in the workspace. */ + /** + * Unique ID in the workspace. + * + * Required. This field must be set in requests. + */ id?: string | undefined; operations?: Patch[] | undefined; /** The schema of the patch request. Must be ["urn:ietf:params:scim:api:messages:2.0:PatchOp"]. */ @@ -815,7 +879,11 @@ export interface PatchGroupRequest { } export interface PatchServicePrincipalRequest { - /** Unique ID in the workspace. */ + /** + * Unique ID in the workspace. + * + * Required. This field must be set in requests. + */ id?: string | undefined; operations?: Patch[] | undefined; /** The schema of the patch request. Must be ["urn:ietf:params:scim:api:messages:2.0:PatchOp"]. */ @@ -823,7 +891,11 @@ export interface PatchServicePrincipalRequest { } export interface PatchUserRequest { - /** Unique ID in the workspace. */ + /** + * Unique ID in the workspace. + * + * Required. This field must be set in requests. + */ id?: string | undefined; operations?: Patch[] | undefined; /** The schema of the patch request. Must be ["urn:ietf:params:scim:api:messages:2.0:PatchOp"]. */ diff --git a/packages/secrets/src/v1/model.ts b/packages/secrets/src/v1/model.ts index e17a479a..8f802c42 100755 --- a/packages/secrets/src/v1/model.ts +++ b/packages/secrets/src/v1/model.ts @@ -42,22 +42,42 @@ export type ScopeBackendType = * on the associated scope point. */ export interface AclItem { - /** The principal in which the permission is applied. */ + /** + * The principal in which the permission is applied. + * + * Required. This field must be set in requests. + */ principal?: string | undefined; - /** The permission level applied to the principal. */ + /** + * The permission level applied to the principal. + * + * Required. This field must be set in requests. + */ permission?: AclPermission | undefined; } /** The metadata of the Azure KeyVault for a secret scope of type `AZURE_KEYVAULT` */ export interface AzureKeyVaultSecretScopeMetadata { - /** The resource id of the azure KeyVault that user wants to associate the scope with. */ + /** + * The resource id of the azure KeyVault that user wants to associate the scope with. + * + * Required. This field must be set in requests. + */ resourceId?: string | undefined; - /** The DNS of the KeyVault */ + /** + * The DNS of the KeyVault + * + * Required. This field must be set in requests. + */ dnsName?: string | undefined; } export interface CreateScopeRequest { - /** Scope name requested by the user. Scope names are unique. */ + /** + * Scope name requested by the user. Scope names are unique. + * + * Required. This field must be set in requests. + */ scope?: string | undefined; /** The principal that is initially granted ``MANAGE`` permission to the created scope. */ initialManagePrincipal?: string | undefined; @@ -71,9 +91,17 @@ export interface CreateScopeRequest { export interface CreateScopeResponse {} export interface DeleteAclRequest { - /** The name of the scope to remove permissions from. */ + /** + * The name of the scope to remove permissions from. + * + * Required. This field must be set in requests. + */ scope?: string | undefined; - /** The principal to remove an existing ACL from. */ + /** + * The principal to remove an existing ACL from. + * + * Required. This field must be set in requests. + */ principal?: string | undefined; } @@ -81,7 +109,11 @@ export interface DeleteAclRequest { export interface DeleteAclResponse {} export interface DeleteScopeRequest { - /** Name of the scope to delete. */ + /** + * Name of the scope to delete. + * + * Required. This field must be set in requests. + */ scope?: string | undefined; } @@ -89,9 +121,17 @@ export interface DeleteScopeRequest { export interface DeleteScopeResponse {} export interface DeleteSecretRequest { - /** The name of the scope that contains the secret to delete. */ + /** + * The name of the scope that contains the secret to delete. + * + * Required. This field must be set in requests. + */ scope?: string | undefined; - /** Name of the secret to delete. */ + /** + * Name of the secret to delete. + * + * Required. This field must be set in requests. + */ key?: string | undefined; } @@ -99,16 +139,32 @@ export interface DeleteSecretRequest { export interface DeleteSecretResponse {} export interface GetAclRequest { - /** The name of the scope to fetch ACL information from. */ + /** + * The name of the scope to fetch ACL information from. + * + * Required. This field must be set in requests. + */ scope?: string | undefined; - /** The principal to fetch ACL information for. */ + /** + * The principal to fetch ACL information for. + * + * Required. This field must be set in requests. + */ principal?: string | undefined; } export interface GetSecretRequest { - /** The name of the scope that contains the secret. */ + /** + * The name of the scope that contains the secret. + * + * Required. This field must be set in requests. + */ scope?: string | undefined; - /** Name of the secret to fetch value information. */ + /** + * Name of the secret to fetch value information. + * + * Required. This field must be set in requests. + */ key?: string | undefined; } @@ -120,7 +176,11 @@ export interface GetSecretResponse { } export interface ListAclsRequest { - /** The name of the scope to fetch ACL information from. */ + /** + * The name of the scope to fetch ACL information from. + * + * Required. This field must be set in requests. + */ scope?: string | undefined; } @@ -138,7 +198,11 @@ export interface ListScopesResponse { } export interface ListSecretsRequest { - /** The name of the scope to list secrets within. */ + /** + * The name of the scope to list secrets within. + * + * Required. This field must be set in requests. + */ scope?: string | undefined; } @@ -148,11 +212,23 @@ export interface ListSecretsResponse { } export interface PutAclRequest { - /** The name of the scope to apply permissions to. */ + /** + * The name of the scope to apply permissions to. + * + * Required. This field must be set in requests. + */ scope?: string | undefined; - /** The principal in which the permission is applied. */ + /** + * The principal in which the permission is applied. + * + * Required. This field must be set in requests. + */ principal?: string | undefined; - /** The permission level applied to the principal. */ + /** + * The permission level applied to the principal. + * + * Required. This field must be set in requests. + */ permission?: AclPermission | undefined; } @@ -160,9 +236,17 @@ export interface PutAclRequest { export interface PutAclResponse {} export interface PutSecretRequest { - /** The name of the scope to which the secret will be associated with. */ + /** + * The name of the scope to which the secret will be associated with. + * + * Required. This field must be set in requests. + */ scope?: string | undefined; - /** A unique name to identify the secret. */ + /** + * A unique name to identify the secret. + * + * Required. This field must be set in requests. + */ key?: string | undefined; value?: | { diff --git a/packages/settings/src/v2/model.ts b/packages/settings/src/v2/model.ts index 26ca8b2e..7d7b6ea7 100755 --- a/packages/settings/src/v2/model.ts +++ b/packages/settings/src/v2/model.ts @@ -124,6 +124,7 @@ export type RestrictWorkspaceAdminsMessage_Status = | (string & {}); export interface AibiDashboardEmbeddingAccessPolicy { + /** Required. This field must be set in requests. */ accessPolicyType?: | AibiDashboardEmbeddingAccessPolicy_AccessPolicyType | undefined; @@ -196,27 +197,46 @@ export interface ClusterAutoRestartMessage_MaintenanceWindow_WindowStartTime { * to a workspace. Defaults to ALLOW_ALL. */ export interface CollaborationPlatformConnectivityMessage { + /** Required. This field must be set in requests. */ connectivity?: | CollaborationPlatformConnectivityMessage_Connectivity | undefined; } export interface GetPublicAccountSettingRequest { + /** Required. This field must be set in requests. */ accountId?: string | undefined; + /** Required. This field must be set in requests. */ name?: string | undefined; } export interface GetPublicAccountUserPreferenceRequest { - /** account ID of the account being managed. */ + /** + * account ID of the account being managed. + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; - /** User ID of the user whose setting is being retrieved. */ + /** + * User ID of the user whose setting is being retrieved. + * + * Required. This field must be set in requests. + */ userId?: string | undefined; - /** User Setting name. */ + /** + * User Setting name. + * + * Required. This field must be set in requests. + */ name?: string | undefined; } export interface GetPublicWorkspaceSettingRequest { - /** Name of the setting */ + /** + * Name of the setting + * + * Required. This field must be set in requests. + */ name?: string | undefined; } @@ -225,7 +245,11 @@ export interface IntegerMessage { } export interface ListAccountSettingsMetadataRequest { - /** account ID of the account being managed. */ + /** + * account ID of the account being managed. + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; /** * The maximum number of settings to return. The service may return fewer than this value. @@ -254,9 +278,17 @@ export interface ListAccountSettingsMetadataResponse { } export interface ListAccountUserPreferencesMetadataRequest { - /** account ID of the account being managed. */ + /** + * account ID of the account being managed. + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; - /** User ID of the user whose settings metadata is being retrieved. */ + /** + * User ID of the user whose settings metadata is being retrieved. + * + * Required. This field must be set in requests. + */ userId?: string | undefined; /** * The maximum number of settings to return. The service may return fewer than this value. @@ -316,24 +348,45 @@ export interface OperationalEmailCustomRecipientMessage { } export interface PatchPublicAccountSettingRequest { - /** account ID of the account being managed. */ + /** + * account ID of the account being managed. + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; + /** Required. This field must be set in requests. */ name?: string | undefined; + /** Required. This field must be set in requests. */ setting?: Setting | undefined; } export interface PatchPublicAccountUserPreferenceRequest { - /** account ID of the account being managed. */ + /** + * account ID of the account being managed. + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; - /** User ID of the user whose setting is being updated. */ + /** + * User ID of the user whose setting is being updated. + * + * Required. This field must be set in requests. + */ userId?: string | undefined; + /** Required. This field must be set in requests. */ name?: string | undefined; + /** Required. This field must be set in requests. */ setting?: UserPreference | undefined; } export interface PatchPublicWorkspaceSettingRequest { - /** Name of the setting */ + /** + * Name of the setting + * + * Required. This field must be set in requests. + */ name?: string | undefined; + /** Required. This field must be set in requests. */ setting?: Setting | undefined; } @@ -342,6 +395,7 @@ export interface PersonalComputeMessage { } export interface RestrictWorkspaceAdminsMessage { + /** Required. This field must be set in requests. */ status?: RestrictWorkspaceAdminsMessage_Status | undefined; /** * When true, workspace admins cannot create governance tags. @@ -423,17 +477,29 @@ export interface Setting { effectiveValue?: | { $case: 'effectiveBooleanVal'; - /** Effective setting value for boolean type setting. This is the final effective value of setting. To set a value use boolean_val. */ + /** + * Effective setting value for boolean type setting. This is the final effective value of setting. To set a value use boolean_val. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ effectiveBooleanVal: BooleanMessage; } | { $case: 'effectiveStringVal'; - /** Effective setting value for string type setting. This is the final effective value of setting. To set a value use string_val. */ + /** + * Effective setting value for string type setting. This is the final effective value of setting. To set a value use string_val. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ effectiveStringVal: StringMessage; } | { $case: 'effectiveIntegerVal'; - /** Effective setting value for integer type setting. This is the final effective value of setting. To set a value use integer_val. */ + /** + * Effective setting value for integer type setting. This is the final effective value of setting. To set a value use integer_val. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ effectiveIntegerVal: IntegerMessage; } | { @@ -463,17 +529,29 @@ export interface Setting { } | { $case: 'effectiveAllowedAppsUserApiScopes'; - /** Effective setting value for allowed_apps_user_api_scopes setting. This is the final effective value of setting. To set a value use allowed_apps_user_api_scopes. */ + /** + * Effective setting value for allowed_apps_user_api_scopes setting. This is the final effective value of setting. To set a value use allowed_apps_user_api_scopes. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ effectiveAllowedAppsUserApiScopes: AllowedAppsUserApiScopesMessage; } | { $case: 'effectiveOperationalEmailCustomRecipient'; - /** Effective setting value for operational_email_custom_recipient setting. This is the final effective value of setting. To set a value use operational_email_custom_recipient. */ + /** + * Effective setting value for operational_email_custom_recipient setting. This is the final effective value of setting. To set a value use operational_email_custom_recipient. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ effectiveOperationalEmailCustomRecipient: OperationalEmailCustomRecipientMessage; } | { $case: 'effectiveCollaborationPlatformConnectivity'; - /** Effective setting value for collaboration_platform_connectivity setting. This is the final effective value of setting. To set a value use collaboration_platform_connectivity. */ + /** + * Effective setting value for collaboration_platform_connectivity setting. This is the final effective value of setting. To set a value use collaboration_platform_connectivity. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ effectiveCollaborationPlatformConnectivity: CollaborationPlatformConnectivityMessage; } | undefined; @@ -527,8 +605,16 @@ export interface UserPreference { * The final effective value from server as per the policy evaluation. */ effectiveValue?: - | {$case: 'effectiveBooleanVal'; effectiveBooleanVal: BooleanMessage} - | {$case: 'effectiveStringVal'; effectiveStringVal: StringMessage} + | { + $case: 'effectiveBooleanVal'; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ + effectiveBooleanVal: BooleanMessage; + } + | { + $case: 'effectiveStringVal'; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ + effectiveStringVal: StringMessage; + } | undefined; } diff --git a/packages/sharing/src/v1/model.ts b/packages/sharing/src/v1/model.ts index d63f239a..744767c5 100755 --- a/packages/sharing/src/v1/model.ts +++ b/packages/sharing/src/v1/model.ts @@ -152,19 +152,47 @@ export interface CreateProviderRequest { owner?: string | undefined; /** The recipient profile. This field is only present when the authentication_type is `TOKEN` or `OAUTH_CLIENT_CREDENTIALS`. */ recipientProfile?: RecipientProfile | undefined; - /** Time at which this Provider was created, in epoch milliseconds. */ + /** + * Time at which this Provider was created, in epoch milliseconds. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdAt?: bigint | undefined; - /** Username of Provider creator. */ + /** + * Username of Provider creator. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdBy?: string | undefined; - /** Time at which this Provider was created, in epoch milliseconds. */ + /** + * Time at which this Provider was created, in epoch milliseconds. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updatedAt?: bigint | undefined; - /** Username of user who last modified Provider. */ + /** + * Username of user who last modified Provider. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updatedBy?: string | undefined; - /** Cloud vendor of the provider's UC metastore. This field is only present when the __authentication_type__ is **DATABRICKS**. */ + /** + * Cloud vendor of the provider's UC metastore. This field is only present when the __authentication_type__ is **DATABRICKS**. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ cloud?: string | undefined; - /** Cloud region of the provider's UC metastore. This field is only present when the __authentication_type__ is **DATABRICKS**. */ + /** + * Cloud region of the provider's UC metastore. This field is only present when the __authentication_type__ is **DATABRICKS**. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ region?: string | undefined; - /** UUID of the provider's UC metastore. This field is only present when the __authentication_type__ is **DATABRICKS**. */ + /** + * UUID of the provider's UC metastore. This field is only present when the __authentication_type__ is **DATABRICKS**. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ metastoreId?: string | undefined; /** The global UC metastore id of the data provider. This field is only present when the __authentication_type__ is **DATABRICKS**. The identifier is of format __cloud__:__region__:__metastore-uuid__. */ dataProviderGlobalMetastoreId?: string | undefined; @@ -199,36 +227,72 @@ export interface CreateRecipientRequest { /** * Full activation url to retrieve the access token. * It will be empty if the token is already retrieved. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ activationUrl?: string | undefined; - /** A boolean status field showing whether the Recipient's activation URL has been exercised or not. */ + /** + * A boolean status field showing whether the Recipient's activation URL has been exercised or not. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ activated?: boolean | undefined; - /** Time at which this recipient was created, in epoch milliseconds. */ + /** + * Time at which this recipient was created, in epoch milliseconds. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdAt?: bigint | undefined; - /** Username of recipient creator. */ + /** + * Username of recipient creator. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdBy?: string | undefined; - /** This field is only present when the __authentication_type__ is **TOKEN**. */ + /** + * This field is only present when the __authentication_type__ is **TOKEN**. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ tokens?: RecipientTokenInfo[] | undefined; - /** Time at which the recipient was updated, in epoch milliseconds. */ + /** + * Time at which the recipient was updated, in epoch milliseconds. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updatedAt?: bigint | undefined; - /** Username of recipient updater. */ + /** + * Username of recipient updater. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updatedBy?: string | undefined; /** * Cloud vendor of the recipient's Unity Catalog Metastore. * This field is only present when the __authentication_type__ is **DATABRICKS**. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ cloud?: string | undefined; /** * Cloud region of the recipient's Unity Catalog Metastore. * This field is only present when the __authentication_type__ is **DATABRICKS**. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ region?: string | undefined; /** * Unique identifier of recipient's Unity Catalog Metastore. * This field is only present when the __authentication_type__ is **DATABRICKS**. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ metastoreId?: string | undefined; - /** [Create,Update:IGN] common - id of the recipient */ + /** + * [Create,Update:IGN] common - id of the recipient + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ id?: string | undefined; } @@ -243,27 +307,59 @@ export interface CreateShareRequest { storageRoot?: string | undefined; /** A list of shared data objects within the share. */ objects?: SharedDataObject[] | undefined; - /** Time at which this share was created, in epoch milliseconds. */ + /** + * Time at which this share was created, in epoch milliseconds. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdAt?: bigint | undefined; - /** Username of share creator. */ + /** + * Username of share creator. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdBy?: string | undefined; - /** Time at which this share was updated, in epoch milliseconds. */ + /** + * Time at which this share was updated, in epoch milliseconds. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updatedAt?: bigint | undefined; - /** Username of share updater. */ + /** + * Username of share updater. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updatedBy?: string | undefined; - /** Storage Location URL (full path) for the share. */ + /** + * Storage Location URL (full path) for the share. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ storageLocation?: string | undefined; } export interface DeleteFederationPolicyRequest { - /** Name of the recipient. This is the name of the recipient for which the policy is being deleted. */ + /** + * Name of the recipient. This is the name of the recipient for which the policy is being deleted. + * + * Required. This field must be set in requests. + */ recipientName?: string | undefined; - /** Name of the policy. This is the name of the policy to be deleted. */ + /** + * Name of the policy. This is the name of the policy to be deleted. + * + * Required. This field must be set in requests. + */ name?: string | undefined; } export interface DeleteProviderRequest { - /** Name of the provider. */ + /** + * Name of the provider. + * + * Required. This field must be set in requests. + */ nameArg?: string | undefined; } @@ -271,7 +367,11 @@ export interface DeleteProviderRequest { export interface DeleteProviderResponse {} export interface DeleteRecipientRequest { - /** Name of the recipient. */ + /** + * Name of the recipient. + * + * Required. This field must be set in requests. + */ name?: string | undefined; } @@ -279,7 +379,11 @@ export interface DeleteRecipientRequest { export interface DeleteRecipientResponse {} export interface DeleteShareRequest { - /** The name of the share. */ + /** + * The name of the share. + * + * Required. This field must be set in requests. + */ name?: string | undefined; } @@ -313,13 +417,25 @@ export interface FederationPolicy { oidcPolicy: OidcFederationPolicy; } | undefined; - /** System-generated timestamp indicating when the policy was created. */ + /** + * System-generated timestamp indicating when the policy was created. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ createTime?: Temporal.Instant | undefined; /** Description of the policy. This is a user-provided description. */ comment?: string | undefined; - /** System-generated timestamp indicating when the policy was last updated. */ + /** + * System-generated timestamp indicating when the policy was last updated. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updateTime?: Temporal.Instant | undefined; - /** Unique, immutable system-generated identifier for the federation policy. */ + /** + * Unique, immutable system-generated identifier for the federation policy. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ id?: string | undefined; } @@ -398,7 +514,11 @@ export interface FunctionParameterInfos { } export interface GetActivationUrlInfoRequest { - /** The one time activation url. It also accepts activation token. */ + /** + * The one time activation url. It also accepts activation token. + * + * Required. This field must be set in requests. + */ activationUrl?: string | undefined; } @@ -406,19 +526,35 @@ export interface GetActivationUrlInfoRequest { export interface GetActivationUrlInfoResponse {} export interface GetFederationPolicyRequest { - /** Name of the recipient. This is the name of the recipient for which the policy is being retrieved. */ + /** + * Name of the recipient. This is the name of the recipient for which the policy is being retrieved. + * + * Required. This field must be set in requests. + */ recipientName?: string | undefined; - /** Name of the policy. This is the name of the policy to be retrieved. */ + /** + * Name of the policy. This is the name of the policy to be retrieved. + * + * Required. This field must be set in requests. + */ name?: string | undefined; } export interface GetProviderRequest { - /** Name of the provider. */ + /** + * Name of the provider. + * + * Required. This field must be set in requests. + */ nameArg?: string | undefined; } export interface GetRecipientRequest { - /** Name of the recipient. */ + /** + * Name of the recipient. + * + * Required. This field must be set in requests. + */ name?: string | undefined; } @@ -443,7 +579,11 @@ export interface GetSharePermissionsResponse { } export interface GetShareRequest { - /** The name of the share. */ + /** + * The name of the share. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** Query for data to include in the share. */ includeSharedData?: boolean | undefined; @@ -455,7 +595,11 @@ export interface IpAccessList { } export interface ListFederationPoliciesRequest { - /** Name of the recipient. This is the name of the recipient for which the policies are being listed. */ + /** + * Name of the recipient. This is the name of the recipient for which the policies are being listed. + * + * Required. This field must be set in requests. + */ recipientName?: string | undefined; maxResults?: number | undefined; pageToken?: string | undefined; @@ -468,9 +612,17 @@ export interface ListFederationPoliciesResponse { /** Request to fetch the list of assets of a share that is shared with the recipient. */ export interface ListProviderShareAssetsRequest { - /** The name of the provider who owns the share. */ + /** + * The name of the provider who owns the share. + * + * Required. This field must be set in requests. + */ providerNameArg?: string | undefined; - /** The name of the share. */ + /** + * The name of the share. + * + * Required. This field must be set in requests. + */ shareNameArg?: string | undefined; /** Maximum number of tables to return. */ tableMaxResults?: number | undefined; @@ -497,7 +649,11 @@ export interface ListProviderShareAssetsResponse { } export interface ListProviderSharesRequest { - /** Name of the provider in which to list shares. */ + /** + * Name of the provider in which to list shares. + * + * Required. This field must be set in requests. + */ providerNameArg?: string | undefined; /** * Maximum number of shares to return. @@ -554,7 +710,11 @@ export interface ListProvidersResponse { } export interface ListRecipientSharePermissionsRequest { - /** The name of the Recipient. */ + /** + * The name of the Recipient. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** * Maximum number of permissions to return. @@ -601,7 +761,11 @@ export interface ListRecipientsResponse { } export interface ListSharePermissionsRequest { - /** The name of the share. */ + /** + * The name of the share. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** * Maximum number of permissions to return. @@ -662,7 +826,11 @@ export interface NotebookFile { * Refer to https://docs.databricks.com/en/delta-sharing/create-recipient-oidc-fed for more details. */ export interface OidcFederationPolicy { - /** The required token issuer, as specified in the 'iss' claim of federated tokens. */ + /** + * The required token issuer, as specified in the 'iss' claim of federated tokens. + * + * Required. This field must be set in requests. + */ issuer?: string | undefined; /** * The claim that contains the subject of the token. @@ -678,6 +846,8 @@ export interface OidcFederationPolicy { * - `azp`: Client ID of the OAuth app. * - `groups`: Object ID of the group. * - `sub`: Subject identifier for other use cases. + * + * Required. This field must be set in requests. */ subjectClaim?: string | undefined; /** @@ -687,6 +857,8 @@ export interface OidcFederationPolicy { * - U2M flow (group access): If the subject claim is `groups`, this must be the Object ID of the group in Entra ID. * - U2M flow (user access): If the subject claim is `oid`, this must be the Object ID of the user in Entra ID. * - M2M flow (OAuth App access): If the subject claim is `azp`, this must be the client ID of the OAuth app registered in Entra ID. + * + * Required. This field must be set in requests. */ subject?: string | undefined; /** @@ -757,7 +929,11 @@ export interface PrivilegeAssignment { /** An object with __properties__ containing map of key-value properties attached to the securable. */ export interface PropertiesKvPairs { - /** A map of key-value properties attached to the securable. */ + /** + * A map of key-value properties attached to the securable. + * + * Required. This field must be set in requests. + */ properties?: Record | undefined; } @@ -773,19 +949,47 @@ export interface ProviderInfo { owner?: string | undefined; /** The recipient profile. This field is only present when the authentication_type is `TOKEN` or `OAUTH_CLIENT_CREDENTIALS`. */ recipientProfile?: RecipientProfile | undefined; - /** Time at which this Provider was created, in epoch milliseconds. */ + /** + * Time at which this Provider was created, in epoch milliseconds. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdAt?: bigint | undefined; - /** Username of Provider creator. */ + /** + * Username of Provider creator. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdBy?: string | undefined; - /** Time at which this Provider was created, in epoch milliseconds. */ + /** + * Time at which this Provider was created, in epoch milliseconds. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updatedAt?: bigint | undefined; - /** Username of user who last modified Provider. */ + /** + * Username of user who last modified Provider. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updatedBy?: string | undefined; - /** Cloud vendor of the provider's UC metastore. This field is only present when the __authentication_type__ is **DATABRICKS**. */ + /** + * Cloud vendor of the provider's UC metastore. This field is only present when the __authentication_type__ is **DATABRICKS**. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ cloud?: string | undefined; - /** Cloud region of the provider's UC metastore. This field is only present when the __authentication_type__ is **DATABRICKS**. */ + /** + * Cloud region of the provider's UC metastore. This field is only present when the __authentication_type__ is **DATABRICKS**. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ region?: string | undefined; - /** UUID of the provider's UC metastore. This field is only present when the __authentication_type__ is **DATABRICKS**. */ + /** + * UUID of the provider's UC metastore. This field is only present when the __authentication_type__ is **DATABRICKS**. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ metastoreId?: string | undefined; /** The global UC metastore id of the data provider. This field is only present when the __authentication_type__ is **DATABRICKS**. The identifier is of format __cloud__:__region__:__metastore-uuid__. */ dataProviderGlobalMetastoreId?: string | undefined; @@ -825,36 +1029,72 @@ export interface RecipientInfo { /** * Full activation url to retrieve the access token. * It will be empty if the token is already retrieved. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ activationUrl?: string | undefined; - /** A boolean status field showing whether the Recipient's activation URL has been exercised or not. */ + /** + * A boolean status field showing whether the Recipient's activation URL has been exercised or not. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ activated?: boolean | undefined; - /** Time at which this recipient was created, in epoch milliseconds. */ + /** + * Time at which this recipient was created, in epoch milliseconds. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdAt?: bigint | undefined; - /** Username of recipient creator. */ + /** + * Username of recipient creator. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdBy?: string | undefined; - /** This field is only present when the __authentication_type__ is **TOKEN**. */ + /** + * This field is only present when the __authentication_type__ is **TOKEN**. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ tokens?: RecipientTokenInfo[] | undefined; - /** Time at which the recipient was updated, in epoch milliseconds. */ + /** + * Time at which the recipient was updated, in epoch milliseconds. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updatedAt?: bigint | undefined; - /** Username of recipient updater. */ + /** + * Username of recipient updater. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updatedBy?: string | undefined; /** * Cloud vendor of the recipient's Unity Catalog Metastore. * This field is only present when the __authentication_type__ is **DATABRICKS**. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ cloud?: string | undefined; /** * Cloud region of the recipient's Unity Catalog Metastore. * This field is only present when the __authentication_type__ is **DATABRICKS**. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ region?: string | undefined; /** * Unique identifier of recipient's Unity Catalog Metastore. * This field is only present when the __authentication_type__ is **DATABRICKS**. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ metastoreId?: string | undefined; - /** [Create,Update:IGN] common - id of the recipient */ + /** + * [Create,Update:IGN] common - id of the recipient + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ id?: string | undefined; } @@ -868,19 +1108,47 @@ export interface RecipientProfile { } export interface RecipientTokenInfo { - /** Unique ID of the recipient token. */ + /** + * Unique ID of the recipient token. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ id?: string | undefined; - /** Time at which this recipient token was created, in epoch milliseconds. */ + /** + * Time at which this recipient token was created, in epoch milliseconds. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdAt?: bigint | undefined; - /** Username of recipient token creator. */ + /** + * Username of recipient token creator. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdBy?: string | undefined; - /** Full activation URL to retrieve the access token. It will be empty if the token is already retrieved. */ + /** + * Full activation URL to retrieve the access token. It will be empty if the token is already retrieved. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ activationUrl?: string | undefined; - /** Expiration timestamp of the token in epoch milliseconds. */ + /** + * Expiration timestamp of the token in epoch milliseconds. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ expirationTime?: bigint | undefined; - /** Time at which this recipient token was updated, in epoch milliseconds. */ + /** + * Time at which this recipient token was updated, in epoch milliseconds. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updatedAt?: bigint | undefined; - /** Username of recipient token updater. */ + /** + * Username of recipient token updater. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updatedBy?: string | undefined; } @@ -892,28 +1160,54 @@ export interface RegisteredModelAlias { } export interface RetrieveTokenRequest { - /** The one time activation url. It also accepts activation token. */ + /** + * The one time activation url. It also accepts activation token. + * + * Required. This field must be set in requests. + */ activationUrl?: string | undefined; } export interface RetrieveTokenResponse { - /** These field names must follow the delta sharing protocol. */ + /** + * These field names must follow the delta sharing protocol. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ shareCredentialsVersion?: number | undefined; - /** The token used to authorize the recipient. */ + /** + * The token used to authorize the recipient. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ bearerToken?: string | undefined; - /** The endpoint for the share to be used by the recipient. */ + /** + * The endpoint for the share to be used by the recipient. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ endpoint?: string | undefined; - /** Expiration timestamp of the token in epoch milliseconds. */ + /** + * Expiration timestamp of the token in epoch milliseconds. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ expirationTime?: string | undefined; } export interface RotateRecipientTokenRequest { - /** The name of the Recipient. */ + /** + * The name of the Recipient. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** * The expiration time of the bearer token in ISO 8601 format. This will set the expiration_time * of existing token only to a smaller timestamp, it cannot extend the expiration_time. Use 0 to * expire the existing token immediately, negative number will return an error. + * + * Required. This field must be set in requests. */ existingTokenExpireInSeconds?: bigint | undefined; } @@ -934,15 +1228,35 @@ export interface ShareInfo { storageRoot?: string | undefined; /** A list of shared data objects within the share. */ objects?: SharedDataObject[] | undefined; - /** Time at which this share was created, in epoch milliseconds. */ + /** + * Time at which this share was created, in epoch milliseconds. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdAt?: bigint | undefined; - /** Username of share creator. */ + /** + * Username of share creator. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdBy?: string | undefined; - /** Time at which this share was updated, in epoch milliseconds. */ + /** + * Time at which this share was updated, in epoch milliseconds. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updatedAt?: bigint | undefined; - /** Username of share updater. */ + /** + * Username of share updater. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updatedBy?: string | undefined; - /** Storage Location URL (full path) for the share. */ + /** + * Storage Location URL (full path) for the share. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ storageLocation?: string | undefined; } @@ -957,13 +1271,23 @@ export interface SharedDataObject { /** * A fully qualified name that uniquely identifies a data object. * For example, a table's fully qualified name is in the format of `..`, + * + * Required. This field must be set in requests. */ name?: string | undefined; /** The type of the data object. */ dataObjectType?: string | undefined; - /** The time when this data object is added to the share, in epoch milliseconds. */ + /** + * The time when this data object is added to the share, in epoch milliseconds. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ addedAt?: bigint | undefined; - /** Username of the sharer. */ + /** + * Username of the sharer. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ addedBy?: string | undefined; /** A user-provided comment when adding the data object to the share. */ comment?: string | undefined; @@ -1089,7 +1413,11 @@ export interface TagKeyValue { } export interface UpdateProviderRequest { - /** Name of the provider. */ + /** + * Name of the provider. + * + * Required. This field must be set in requests. + */ nameArg?: string | undefined; /** New name for the provider. */ newName?: string | undefined; @@ -1104,26 +1432,58 @@ export interface UpdateProviderRequest { owner?: string | undefined; /** The recipient profile. This field is only present when the authentication_type is `TOKEN` or `OAUTH_CLIENT_CREDENTIALS`. */ recipientProfile?: RecipientProfile | undefined; - /** Time at which this Provider was created, in epoch milliseconds. */ + /** + * Time at which this Provider was created, in epoch milliseconds. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdAt?: bigint | undefined; - /** Username of Provider creator. */ + /** + * Username of Provider creator. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdBy?: string | undefined; - /** Time at which this Provider was created, in epoch milliseconds. */ + /** + * Time at which this Provider was created, in epoch milliseconds. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updatedAt?: bigint | undefined; - /** Username of user who last modified Provider. */ + /** + * Username of user who last modified Provider. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updatedBy?: string | undefined; - /** Cloud vendor of the provider's UC metastore. This field is only present when the __authentication_type__ is **DATABRICKS**. */ + /** + * Cloud vendor of the provider's UC metastore. This field is only present when the __authentication_type__ is **DATABRICKS**. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ cloud?: string | undefined; - /** Cloud region of the provider's UC metastore. This field is only present when the __authentication_type__ is **DATABRICKS**. */ + /** + * Cloud region of the provider's UC metastore. This field is only present when the __authentication_type__ is **DATABRICKS**. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ region?: string | undefined; - /** UUID of the provider's UC metastore. This field is only present when the __authentication_type__ is **DATABRICKS**. */ + /** + * UUID of the provider's UC metastore. This field is only present when the __authentication_type__ is **DATABRICKS**. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ metastoreId?: string | undefined; /** The global UC metastore id of the data provider. This field is only present when the __authentication_type__ is **DATABRICKS**. The identifier is of format __cloud__:__region__:__metastore-uuid__. */ dataProviderGlobalMetastoreId?: string | undefined; } export interface UpdateRecipientRequest { - /** Name of the recipient. */ + /** + * Name of the recipient. + * + * Required. This field must be set in requests. + */ nameArg?: string | undefined; /** * New name for the recipient. @@ -1158,41 +1518,81 @@ export interface UpdateRecipientRequest { /** * Full activation url to retrieve the access token. * It will be empty if the token is already retrieved. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ activationUrl?: string | undefined; - /** A boolean status field showing whether the Recipient's activation URL has been exercised or not. */ + /** + * A boolean status field showing whether the Recipient's activation URL has been exercised or not. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ activated?: boolean | undefined; - /** Time at which this recipient was created, in epoch milliseconds. */ + /** + * Time at which this recipient was created, in epoch milliseconds. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdAt?: bigint | undefined; - /** Username of recipient creator. */ + /** + * Username of recipient creator. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdBy?: string | undefined; - /** This field is only present when the __authentication_type__ is **TOKEN**. */ + /** + * This field is only present when the __authentication_type__ is **TOKEN**. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ tokens?: RecipientTokenInfo[] | undefined; - /** Time at which the recipient was updated, in epoch milliseconds. */ + /** + * Time at which the recipient was updated, in epoch milliseconds. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updatedAt?: bigint | undefined; - /** Username of recipient updater. */ + /** + * Username of recipient updater. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updatedBy?: string | undefined; /** * Cloud vendor of the recipient's Unity Catalog Metastore. * This field is only present when the __authentication_type__ is **DATABRICKS**. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ cloud?: string | undefined; /** * Cloud region of the recipient's Unity Catalog Metastore. * This field is only present when the __authentication_type__ is **DATABRICKS**. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ region?: string | undefined; /** * Unique identifier of recipient's Unity Catalog Metastore. * This field is only present when the __authentication_type__ is **DATABRICKS**. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ metastoreId?: string | undefined; - /** [Create,Update:IGN] common - id of the recipient */ + /** + * [Create,Update:IGN] common - id of the recipient + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ id?: string | undefined; } export interface UpdateSharePermissionsRequest { - /** The name of the share. */ + /** + * The name of the share. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** Optional. Whether to return the latest permissions list of the share in the response. */ omitPermissionsList?: boolean | undefined; @@ -1206,7 +1606,11 @@ export interface UpdateSharePermissionsResponse { } export interface UpdateShareRequest { - /** The name of the share. */ + /** + * The name of the share. + * + * Required. This field must be set in requests. + */ nameArg?: string | undefined; /** New name for the share. */ newName?: string | undefined; @@ -1222,15 +1626,35 @@ export interface UpdateShareRequest { storageRoot?: string | undefined; /** A list of shared data objects within the share. */ objects?: SharedDataObject[] | undefined; - /** Time at which this share was created, in epoch milliseconds. */ + /** + * Time at which this share was created, in epoch milliseconds. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdAt?: bigint | undefined; - /** Username of share creator. */ + /** + * Username of share creator. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdBy?: string | undefined; - /** Time at which this share was updated, in epoch milliseconds. */ + /** + * Time at which this share was updated, in epoch milliseconds. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updatedAt?: bigint | undefined; - /** Username of share updater. */ + /** + * Username of share updater. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updatedBy?: string | undefined; - /** Storage Location URL (full path) for the share. */ + /** + * Storage Location URL (full path) for the share. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ storageLocation?: string | undefined; } diff --git a/packages/statementexecution/src/v1/model.ts b/packages/statementexecution/src/v1/model.ts index 53fd3bcc..ca543863 100755 --- a/packages/statementexecution/src/v1/model.ts +++ b/packages/statementexecution/src/v1/model.ts @@ -117,6 +117,8 @@ export interface CancelStatementRequest { /** * The statement ID is returned upon successfully submitting a SQL statement, and is a required * reference for all subsequent calls. + * + * Required. This field must be set in requests. */ statementId?: string | undefined; } @@ -171,11 +173,15 @@ export interface ExecuteStatementRequest { /** * The SQL statement to execute. The statement can optionally be parameterized, see `parameters`. * The maximum query text size is 16 MiB. + * + * Required. This field must be set in requests. */ statement?: string | undefined; /** * Warehouse upon which to execute a statement. See also * [What are SQL warehouses?](https://docs.databricks.com/sql/admin/warehouse-type.html) + * + * Required. This field must be set in requests. */ warehouseId?: string | undefined; /** @@ -398,8 +404,11 @@ export interface GetResultDataRequest { /** * The statement ID is returned upon successfully submitting a SQL statement, and is a required * reference for all subsequent calls. + * + * Required. This field must be set in requests. */ statementId?: string | undefined; + /** Required. This field must be set in requests. */ chunkIndex?: number | undefined; } @@ -407,6 +416,8 @@ export interface GetStatementResultRequest { /** * The statement ID is returned upon successfully submitting a SQL statement, and is a required * reference for all subsequent calls. + * + * Required. This field must be set in requests. */ statementId?: string | undefined; } @@ -417,6 +428,7 @@ export interface GetStatementResultRequest { * QueryTag is the user-facing representation. */ export interface QueryTag { + /** Required. This field must be set in requests. */ key?: string | undefined; value?: string | undefined; } @@ -493,7 +505,11 @@ export interface ServiceError { } export interface StatementParameter { - /** The name of a parameter marker to be substituted in the statement. */ + /** + * The name of a parameter marker to be substituted in the statement. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** The value to substitute, represented as a string. If omitted, the value is interpreted as NULL. */ value?: string | undefined; diff --git a/packages/storageconfigurations/src/v1/model.ts b/packages/storageconfigurations/src/v1/model.ts index 7efee114..bb1c17a9 100644 --- a/packages/storageconfigurations/src/v1/model.ts +++ b/packages/storageconfigurations/src/v1/model.ts @@ -3,10 +3,19 @@ import {z} from 'zod'; export interface CreateStorageConfigurationRequest { + /** Required. This field must be set in requests. */ accountId?: string | undefined; - /** The human-readable name of the storage configuration. */ + /** + * The human-readable name of the storage configuration. + * + * Required. This field must be set in requests. + */ storageConfigurationName?: string | undefined; - /** Root S3 bucket information. */ + /** + * Root S3 bucket information. + * + * Required. This field must be set in requests. + */ rootBucketInfo?: RootBucketInfo | undefined; /** * Optional IAM role that is used to access the workspace catalog which is created during workspace creation @@ -18,16 +27,21 @@ export interface CreateStorageConfigurationRequest { } export interface DeleteStorageConfigurationRequest { + /** Required. This field must be set in requests. */ storageConfigurationId?: string | undefined; + /** Required. This field must be set in requests. */ accountId?: string | undefined; } export interface GetStorageConfigurationRequest { + /** Required. This field must be set in requests. */ storageConfigurationId?: string | undefined; + /** Required. This field must be set in requests. */ accountId?: string | undefined; } export interface ListStorageConfigurationRequest { + /** Required. This field must be set in requests. */ accountId?: string | undefined; } diff --git a/packages/supervisoragents/src/v1/model.ts b/packages/supervisoragents/src/v1/model.ts index a85ea05c..2dc027b5 100644 --- a/packages/supervisoragents/src/v1/model.ts +++ b/packages/supervisoragents/src/v1/model.ts @@ -7,7 +7,11 @@ import {z} from 'zod'; /** app. Supported app: custom mcp, custom agent. */ export interface App { - /** App name */ + /** + * App name + * + * Required. This field must be set in requests. + */ name?: string | undefined; } @@ -16,14 +20,24 @@ export interface CreateExampleRequest { /** * Parent resource where this example will be created. * Format: supervisor-agents/{supervisor_agent_id} + * + * Required. This field must be set in requests. */ parent?: string | undefined; - /** The example to create under the parent Supervisor Agent. */ + /** + * The example to create under the parent Supervisor Agent. + * + * Required. This field must be set in requests. + */ example?: Example | undefined; } export interface CreateSupervisorAgentRequest { - /** The Supervisor Agent to create. */ + /** + * The Supervisor Agent to create. + * + * Required. This field must be set in requests. + */ supervisorAgent?: SupervisorAgent | undefined; } @@ -31,12 +45,17 @@ export interface CreateToolRequest { /** * Parent resource where this tool will be created. * Format: supervisor-agents/{supervisor_agent_id} + * + * Required. This field must be set in requests. */ parent?: string | undefined; + /** Required. This field must be set in requests. */ tool?: Tool | undefined; /** * The ID to use for the tool, which will become the final component of * the tool's resource name. + * + * Required. This field must be set in requests. */ toolId?: string | undefined; } @@ -46,6 +65,8 @@ export interface DeleteExampleRequest { /** * The resource name of the example to delete. * Format: supervisor-agents/{supervisor_agent_id}/examples/{example_id} + * + * Required. This field must be set in requests. */ name?: string | undefined; } @@ -54,6 +75,8 @@ export interface DeleteSupervisorAgentRequest { /** * The resource name of the Supervisor Agent. * Format: supervisor-agents/{supervisor_agent_id} + * + * Required. This field must be set in requests. */ name?: string | undefined; } @@ -62,6 +85,8 @@ export interface DeleteToolRequest { /** * The resource name of the Tool. * Format: supervisor-agents/{supervisor_agent_id}/tools/{tool_id} + * + * Required. This field must be set in requests. */ name?: string | undefined; } @@ -76,11 +101,23 @@ export interface Example { * supervisor-agents/{supervisor_agent_id}/examples/{example_id} */ name?: string | undefined; - /** The example question. */ + /** + * The example question. + * + * Required. This field must be set in requests. + */ question?: string | undefined; - /** Guidelines for answering the question. */ + /** + * Guidelines for answering the question. + * + * Required. This field must be set in requests. + */ guidelines?: string[] | undefined; - /** The universally unique identifier (UUID) of the example. */ + /** + * The universally unique identifier (UUID) of the example. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ exampleId?: string | undefined; } @@ -88,6 +125,8 @@ export interface GenieSpace { /** * Deprecated: use space_id instead. Still REQUIRED for backward compatibility * until a future API version removes it. + * + * Required. This field must be set in requests. */ id?: string | undefined; } @@ -97,6 +136,8 @@ export interface GetExampleRequest { /** * The resource name of the example. * Format: supervisor-agents/{supervisor_agent_id}/examples/{example_id} + * + * Required. This field must be set in requests. */ name?: string | undefined; } @@ -105,6 +146,8 @@ export interface GetSupervisorAgentRequest { /** * The resource name of the Supervisor Agent. * Format: supervisor-agents/{supervisor_agent_id} + * + * Required. This field must be set in requests. */ name?: string | undefined; } @@ -113,6 +156,8 @@ export interface GetToolRequest { /** * The resource name of the Tool. * Format: supervisor-agents/{supervisor_agent_id}/tools/{tool_id} + * + * Required. This field must be set in requests. */ name?: string | undefined; } @@ -120,7 +165,11 @@ export interface GetToolRequest { export interface KnowledgeAssistant { /** Deprecated: use knowledge_assistant_id instead. */ servingEndpointName?: string | undefined; - /** The ID of the knowledge assistant. */ + /** + * The ID of the knowledge assistant. + * + * Required. This field must be set in requests. + */ knowledgeAssistantId?: string | undefined; } @@ -129,6 +178,8 @@ export interface ListExamplesRequest { /** * Parent resource to list from. * Format: supervisor-agents/{supervisor_agent_id} + * + * Required. This field must be set in requests. */ parent?: string | undefined; /** @@ -179,6 +230,8 @@ export interface ListToolsRequest { /** * Parent resource to list from. * Format: supervisor-agents/{supervisor_agent_id} + * + * Required. This field must be set in requests. */ parent?: string | undefined; pageSize?: number | undefined; @@ -196,23 +249,51 @@ export interface SupervisorAgent { * Format: supervisor-agents/{supervisor_agent_id} */ name?: string | undefined; - /** The display name of the Supervisor Agent, unique at workspace level. */ + /** + * The display name of the Supervisor Agent, unique at workspace level. + * + * Required. This field must be set in requests. + */ displayName?: string | undefined; /** Description of what this agent can do (user-facing). */ description?: string | undefined; /** Optional natural-language instructions for the supervisor agent. */ instructions?: string | undefined; - /** Deprecated: Use supervisor_agent_id instead. */ + /** + * Deprecated: Use supervisor_agent_id instead. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ id?: string | undefined; - /** The universally unique identifier (UUID) of the Supervisor Agent. */ + /** + * The universally unique identifier (UUID) of the Supervisor Agent. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ supervisorAgentId?: string | undefined; - /** The creator of the Supervisor Agent. */ + /** + * The creator of the Supervisor Agent. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ creator?: string | undefined; - /** Creation timestamp. */ + /** + * Creation timestamp. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createTime?: Temporal.Instant | undefined; - /** The name of the supervisor agent's serving endpoint. */ + /** + * The name of the supervisor agent's serving endpoint. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ endpointName?: string | undefined; - /** The MLflow experiment ID. */ + /** + * The MLflow experiment ID. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ experimentId?: string | undefined; } @@ -222,9 +303,17 @@ export interface Tool { * supervisor-agents/{supervisor_agent_id}/tools/{tool_id} */ name?: string | undefined; - /** Deprecated: Use tool_id instead. */ + /** + * Deprecated: Use tool_id instead. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ id?: string | undefined; - /** Tool type. Must be one of: "genie_space", "knowledge_assistant", "uc_function", "uc_connection", "uc_mcp", "app", "volume", "dashboard", "serving_endpoint", "table", "vector_search_index", "catalog", "schema", "supervisor_agent", "web_search", "skill". The legacy values "lakeview_dashboard" and "uc_table" are also accepted and remain equivalent to "dashboard" and "table" respectively. */ + /** + * Tool type. Must be one of: "genie_space", "knowledge_assistant", "uc_function", "uc_connection", "uc_mcp", "app", "volume", "dashboard", "serving_endpoint", "table", "vector_search_index", "catalog", "schema", "supervisor_agent", "web_search", "skill". The legacy values "lakeview_dashboard" and "uc_table" are also accepted and remain equivalent to "dashboard" and "table" respectively. + * + * Required. This field must be set in requests. + */ toolType?: string | undefined; /** Specification for the tool type. */ spec?: @@ -237,17 +326,26 @@ export interface Tool { | undefined; /** Description of what this tool does (user-facing). */ description?: string | undefined; - /** User specified id of the Tool. */ + /** + * User specified id of the Tool. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ toolId?: string | undefined; } /** Databricks UC connection. Supported connection: external mcp server. */ export interface UcConnection { + /** Required. This field must be set in requests. */ name?: string | undefined; } export interface UcFunction { - /** Full uc function name */ + /** + * Full uc function name + * + * Required. This field must be set in requests. + */ name?: string | undefined; } @@ -256,8 +354,11 @@ export interface UpdateExampleRequest { /** * The resource name of the example to update. * Format: supervisor-agents/{supervisor_agent_id}/examples/{example_id} + * + * Required. This field must be set in requests. */ name?: string | undefined; + /** Required. This field must be set in requests. */ example?: Example | undefined; /** * Comma-delimited list of fields to update on the example. @@ -265,26 +366,48 @@ export interface UpdateExampleRequest { * Examples: * - `question` * - `question,guidelines` + * + * Required. This field must be set in requests. */ updateMask?: FieldMask | undefined; } export interface UpdateSupervisorAgentRequest { - /** The SupervisorAgent to update. */ + /** + * The SupervisorAgent to update. + * + * Required. This field must be set in requests. + */ supervisorAgent?: SupervisorAgent | undefined; - /** Field mask for fields to be updated. */ + /** + * Field mask for fields to be updated. + * + * Required. This field must be set in requests. + */ updateMask?: FieldMask | undefined; } export interface UpdateToolRequest { - /** The Tool to update. */ + /** + * The Tool to update. + * + * Required. This field must be set in requests. + */ tool?: Tool | undefined; - /** Field mask for fields to be updated. */ + /** + * Field mask for fields to be updated. + * + * Required. This field must be set in requests. + */ updateMask?: FieldMask | undefined; } export interface Volume { - /** Full uc volume name */ + /** + * Full uc volume name + * + * Required. This field must be set in requests. + */ name?: string | undefined; } diff --git a/packages/tagassignments/src/v1/model.ts b/packages/tagassignments/src/v1/model.ts index 52eb60a2..adf4574c 100644 --- a/packages/tagassignments/src/v1/model.ts +++ b/packages/tagassignments/src/v1/model.ts @@ -5,31 +5,64 @@ import type {FieldMaskSchema} from '@databricks/sdk-core/wkt'; import {z} from 'zod'; export interface CreateTagAssignmentRequest { + /** Required. This field must be set in requests. */ tagAssignment?: TagAssignment | undefined; } export interface DeleteTagAssignmentRequest { - /** The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks */ + /** + * The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks + * + * Required. This field must be set in requests. + */ entityType?: string | undefined; - /** The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name */ + /** + * The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name + * + * Required. This field must be set in requests. + */ entityId?: string | undefined; - /** The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed */ + /** + * The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed + * + * Required. This field must be set in requests. + */ tagKey?: string | undefined; } export interface GetTagAssignmentRequest { - /** The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks */ + /** + * The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks + * + * Required. This field must be set in requests. + */ entityType?: string | undefined; - /** The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name */ + /** + * The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name + * + * Required. This field must be set in requests. + */ entityId?: string | undefined; - /** The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed */ + /** + * The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed + * + * Required. This field must be set in requests. + */ tagKey?: string | undefined; } export interface ListTagAssignmentsRequest { - /** The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks */ + /** + * The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks + * + * Required. This field must be set in requests. + */ entityType?: string | undefined; - /** The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name */ + /** + * The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name + * + * Required. This field must be set in requests. + */ entityId?: string | undefined; /** Optional. Maximum number of tag assignments to return in a single page */ pageSize?: number | undefined; @@ -44,18 +77,32 @@ export interface ListTagAssignmentsResponse { } export interface TagAssignment { - /** The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks */ + /** + * The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks + * + * Required. This field must be set in requests. Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ entityType?: string | undefined; - /** The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name */ + /** + * The identifier of the entity to which the tag is assigned. For apps, the entity_id is the app name + * + * Required. This field must be set in requests. Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ entityId?: string | undefined; - /** The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed */ + /** + * The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed + * + * Required. This field must be set in requests. Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ tagKey?: string | undefined; /** The value of the tag */ tagValue?: string | undefined; } export interface UpdateTagAssignmentRequest { + /** Required. This field must be set in requests. */ tagAssignment?: TagAssignment | undefined; + /** Required. This field must be set in requests. */ updateMask?: FieldMask | undefined; } diff --git a/packages/tagpolicies/src/v1/model.ts b/packages/tagpolicies/src/v1/model.ts index 89de50eb..4b0e627a 100644 --- a/packages/tagpolicies/src/v1/model.ts +++ b/packages/tagpolicies/src/v1/model.ts @@ -6,14 +6,17 @@ import type {FieldMaskSchema} from '@databricks/sdk-core/wkt'; import {z} from 'zod'; export interface CreateTagPolicyRequest { + /** Required. This field must be set in requests. */ tagPolicy?: TagPolicy | undefined; } export interface DeleteTagPolicyRequest { + /** Required. This field must be set in requests. */ tagKey?: string | undefined; } export interface GetTagPolicyRequest { + /** Required. This field must be set in requests. */ tagKey?: string | undefined; } @@ -34,22 +37,35 @@ export interface ListTagPoliciesResponse { } export interface TagPolicy { + /** Required. This field must be set in requests. Immutable. Set this field when the resource is created; it cannot be changed afterward. */ tagKey?: string | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ id?: string | undefined; description?: string | undefined; values?: Value[] | undefined; - /** Timestamp when the tag policy was created */ + /** + * Timestamp when the tag policy was created + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createTime?: Temporal.Instant | undefined; - /** Timestamp when the tag policy was last updated */ + /** + * Timestamp when the tag policy was last updated + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updateTime?: Temporal.Instant | undefined; } export interface UpdateTagPolicyRequest { + /** Required. This field must be set in requests. */ tagPolicy?: TagPolicy | undefined; + /** Required. This field must be set in requests. */ updateMask?: FieldMask | undefined; } export interface Value { + /** Required. This field must be set in requests. */ name?: string | undefined; } diff --git a/packages/tokenmanagement/src/v1/model.ts b/packages/tokenmanagement/src/v1/model.ts index 3813d486..9d37bd3b 100755 --- a/packages/tokenmanagement/src/v1/model.ts +++ b/packages/tokenmanagement/src/v1/model.ts @@ -55,7 +55,11 @@ export interface AdminTokenInfo { /** Configuration details for creating on-behalf tokens. */ export interface CreateOnBehalfOfTokenRequest { - /** Application ID of the service principal. */ + /** + * Application ID of the service principal. + * + * Required. This field must be set in requests. + */ applicationId?: string | undefined; /** The number of seconds before the token expires. */ lifetimeSeconds?: bigint | undefined; @@ -125,8 +129,13 @@ export interface RevokeTokenResponse {} * https://docs.databricks.com/api/workspace/api/scopes. */ export interface UpdateTokenRequest { + /** Required. This field must be set in requests. */ token?: AdminTokenInfo | undefined; - /** A list of field name under token, For example, {"update_mask": "comment,scopes"} */ + /** + * A list of field name under token, For example, {"update_mask": "comment,scopes"} + * + * Required. This field must be set in requests. + */ updateMask?: FieldMask | undefined; } diff --git a/packages/tokens/src/v1/model.ts b/packages/tokens/src/v1/model.ts index 6a696506..4027afa7 100755 --- a/packages/tokens/src/v1/model.ts +++ b/packages/tokens/src/v1/model.ts @@ -77,7 +77,11 @@ export interface PublicTokenInfo { } export interface RevokeTokenRequest { - /** The ID of the token to be revoked. */ + /** + * The ID of the token to be revoked. + * + * Required. This field must be set in requests. + */ tokenId?: string | undefined; } @@ -89,10 +93,19 @@ export interface RevokeTokenResponse {} * https://docs.databricks.com/api/workspace/api/scopes. */ export interface UpdateTokenRequest { - /** The SHA-256 hash of the token to be updated. */ + /** + * The SHA-256 hash of the token to be updated. + * + * Required. This field must be set in requests. + */ tokenId?: string | undefined; + /** Required. This field must be set in requests. */ token?: PublicTokenInfo | undefined; - /** A list of field name under token, For example, {"update_mask": "comment,scopes"} */ + /** + * A list of field name under token, For example, {"update_mask": "comment,scopes"} + * + * Required. This field must be set in requests. + */ updateMask?: FieldMask | undefined; } diff --git a/packages/uc/abacpolicies/src/v1/model.ts b/packages/uc/abacpolicies/src/v1/model.ts index eb366abe..c7cb8a29 100755 --- a/packages/uc/abacpolicies/src/v1/model.ts +++ b/packages/uc/abacpolicies/src/v1/model.ts @@ -47,12 +47,16 @@ export interface ColumnMaskOptions { * The function is called on each row of the target table. * The function's first argument and its return type should match the type of the masked column. * Required on create and update. + * + * Required. This field must be set in requests. */ functionName?: string | undefined; /** * The alias of the column to be masked. The alias must refer to one of matched columns. * The values of the column is passed to the column mask function as the first argument. * Required on create and update. + * + * Required. This field must be set in requests. */ onColumn?: string | undefined; /** @@ -63,16 +67,32 @@ export interface ColumnMaskOptions { } export interface CreatePolicyRequest { - /** Required. The policy to create. */ + /** + * Required. The policy to create. + * + * Required. This field must be set in requests. + */ policyInfo?: PolicyInfo | undefined; } export interface DeletePolicyRequest { - /** Required. The type of the securable to delete the policy from. */ + /** + * Required. The type of the securable to delete the policy from. + * + * Required. This field must be set in requests. + */ onSecurableType?: string | undefined; - /** Required. The fully qualified name of the securable to delete the policy from. */ + /** + * Required. The fully qualified name of the securable to delete the policy from. + * + * Required. This field must be set in requests. + */ onSecurableFullname?: string | undefined; - /** Required. The name of the policy to delete */ + /** + * Required. The name of the policy to delete + * + * Required. This field must be set in requests. + */ name?: string | undefined; } @@ -96,18 +116,38 @@ export interface FunctionArgument { } export interface GetPolicyRequest { - /** Required. The type of the securable to retrieve the policy for. */ + /** + * Required. The type of the securable to retrieve the policy for. + * + * Required. This field must be set in requests. + */ onSecurableType?: string | undefined; - /** Required. The fully qualified name of securable to retrieve policy for. */ + /** + * Required. The fully qualified name of securable to retrieve policy for. + * + * Required. This field must be set in requests. + */ onSecurableFullname?: string | undefined; - /** Required. The name of the policy to retrieve. */ + /** + * Required. The name of the policy to retrieve. + * + * Required. This field must be set in requests. + */ name?: string | undefined; } export interface ListPoliciesRequest { - /** Required. The type of the securable to list policies for. */ + /** + * Required. The type of the securable to list policies for. + * + * Required. This field must be set in requests. + */ onSecurableType?: string | undefined; - /** Required. The fully qualified name of securable to list policies for. */ + /** + * Required. The fully qualified name of securable to list policies for. + * + * Required. This field must be set in requests. + */ onSecurableFullname?: string | undefined; /** * Optional. Whether to include policies defined on parent securables. @@ -125,11 +165,17 @@ export interface ListPoliciesRequest { } export interface ListPoliciesResponse { - /** The list of retrieved policies. */ + /** + * The list of retrieved policies. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ policies?: PolicyInfo[] | undefined; /** * Optional opaque token for continuing pagination. `page_token` should be set to this value for * the next request to retrieve the next page of results. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ nextPageToken?: string | undefined; } @@ -142,7 +188,11 @@ export interface MatchColumn { } export interface PolicyInfo { - /** Unique identifier of the policy. This field is output only and is generated by the system. */ + /** + * Unique identifier of the policy. This field is output only and is generated by the system. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ id?: string | undefined; /** * Type of the securable on which the policy is defined. @@ -165,6 +215,8 @@ export interface PolicyInfo { /** * List of user or group names that the policy applies to. * Required on create and optional on update. + * + * Required. This field must be set in requests. */ toPrincipals?: string[] | undefined; /** Optional list of user or group names that should be excluded from the policy. */ @@ -173,11 +225,17 @@ export interface PolicyInfo { * Type of securables that the policy should take effect on. * Only `TABLE` is supported at this moment. * Required on create and optional on update. + * + * Required. This field must be set in requests. */ forSecurableType?: SecurableType | undefined; /** Optional condition when the policy should take effect. */ whenCondition?: string | undefined; - /** Type of the policy. Required on create. */ + /** + * Type of the policy. Required on create. + * + * Required. This field must be set in requests. + */ policyType?: PolicyType | undefined; /** * (--[Create:REQ Update:OPT] Type-specific options for the Policy--) @@ -209,13 +267,29 @@ export interface PolicyInfo { * When specified, the policy only applies to tables whose columns satisfy all match conditions. */ matchColumns?: MatchColumn[] | undefined; - /** Time at which the policy was created, in epoch milliseconds. Output only. */ + /** + * Time at which the policy was created, in epoch milliseconds. Output only. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdAt?: bigint | undefined; - /** Username of the user who created the policy. Output only. */ + /** + * Username of the user who created the policy. Output only. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdBy?: string | undefined; - /** Time at which the policy was last modified, in epoch milliseconds. Output only. */ + /** + * Time at which the policy was last modified, in epoch milliseconds. Output only. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updatedAt?: bigint | undefined; - /** Username of the user who last modified the policy. Output only. */ + /** + * Username of the user who last modified the policy. Output only. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updatedBy?: string | undefined; } @@ -225,6 +299,8 @@ export interface RowFilterOptions { * The function is called on each row of the target table. It should return a boolean value * indicating whether the row should be visible to the user. * Required on create and update. + * + * Required. This field must be set in requests. */ functionName?: string | undefined; /** @@ -235,11 +311,23 @@ export interface RowFilterOptions { } export interface UpdatePolicyRequest { - /** Required. The type of the securable to update the policy for. */ + /** + * Required. The type of the securable to update the policy for. + * + * Required. This field must be set in requests. + */ onSecurableType?: string | undefined; - /** Required. The fully qualified name of the securable to update the policy for. */ + /** + * Required. The fully qualified name of the securable to update the policy for. + * + * Required. This field must be set in requests. + */ onSecurableFullname?: string | undefined; - /** Required. The name of the policy to update. */ + /** + * Required. The name of the policy to update. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** * Optional fields to update. This is the request body for updating a policy. diff --git a/packages/uc/artifactallowlists/src/v1/model.ts b/packages/uc/artifactallowlists/src/v1/model.ts index 13ca59cf..caa9aaa4 100644 --- a/packages/uc/artifactallowlists/src/v1/model.ts +++ b/packages/uc/artifactallowlists/src/v1/model.ts @@ -27,38 +27,86 @@ export type ArtifactMatcher_MatchType = | (string & {}); export interface ArtifactAllowlistInfo { - /** A list of allowed artifact match patterns. */ + /** + * A list of allowed artifact match patterns. + * + * Required. This field must be set in requests. + */ artifactMatchers?: ArtifactMatcher[] | undefined; - /** Unique identifier of parent metastore. */ + /** + * Unique identifier of parent metastore. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ metastoreId?: string | undefined; - /** Username of the user who set the artifact allowlist. */ + /** + * Username of the user who set the artifact allowlist. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdBy?: string | undefined; - /** Time at which this artifact allowlist was set, in epoch milliseconds. */ + /** + * Time at which this artifact allowlist was set, in epoch milliseconds. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdAt?: bigint | undefined; } export interface ArtifactMatcher { - /** The artifact path or maven coordinate */ + /** + * The artifact path or maven coordinate + * + * Required. This field must be set in requests. + */ artifact?: string | undefined; - /** The pattern matching type of the artifact */ + /** + * The pattern matching type of the artifact + * + * Required. This field must be set in requests. + */ matchType?: ArtifactMatcher_MatchType | undefined; } export interface GetArtifactAllowlistRequest { - /** The artifact type of the allowlist. */ + /** + * The artifact type of the allowlist. + * + * Required. This field must be set in requests. + */ artifactType?: ArtifactType | undefined; } export interface SetArtifactAllowlistRequest { - /** The artifact type of the allowlist. */ + /** + * The artifact type of the allowlist. + * + * Required. This field must be set in requests. + */ artifactType?: ArtifactType | undefined; - /** A list of allowed artifact match patterns. */ + /** + * A list of allowed artifact match patterns. + * + * Required. This field must be set in requests. + */ artifactMatchers?: ArtifactMatcher[] | undefined; - /** Unique identifier of parent metastore. */ + /** + * Unique identifier of parent metastore. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ metastoreId?: string | undefined; - /** Username of the user who set the artifact allowlist. */ + /** + * Username of the user who set the artifact allowlist. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdBy?: string | undefined; - /** Time at which this artifact allowlist was set, in epoch milliseconds. */ + /** + * Time at which this artifact allowlist was set, in epoch milliseconds. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdAt?: bigint | undefined; } diff --git a/packages/uc/catalogs/src/v1/model.ts b/packages/uc/catalogs/src/v1/model.ts index 62ac1cd9..17bb7895 100755 --- a/packages/uc/catalogs/src/v1/model.ts +++ b/packages/uc/catalogs/src/v1/model.ts @@ -67,6 +67,7 @@ export type ProvisioningInfo_State = | (string & {}); export interface AzureEncryptionSettings { + /** Required. This field must be set in requests. */ azureTenantId?: string | undefined; azureCmkAccessConnectorId?: string | undefined; azureCmkManagedIdentityId?: string | undefined; @@ -121,7 +122,11 @@ export interface CatalogInfo { customMaxRetentionHours?: bigint | undefined; /** Control CMK encryption for managed catalog data */ managedEncryptionSettings?: EncryptionSettings | undefined; - /** A map of key-value properties attached to the securable. */ + /** + * A map of key-value properties attached to the securable. + * + * Required. This field must be set in requests. + */ properties?: Record | undefined; /** A map of key-value properties attached to the securable. */ options?: Record | undefined; @@ -176,14 +181,22 @@ export interface CreateCatalogRequest { customMaxRetentionHours?: bigint | undefined; /** Control CMK encryption for managed catalog data */ managedEncryptionSettings?: EncryptionSettings | undefined; - /** A map of key-value properties attached to the securable. */ + /** + * A map of key-value properties attached to the securable. + * + * Required. This field must be set in requests. + */ properties?: Record | undefined; /** A map of key-value properties attached to the securable. */ options?: Record | undefined; } export interface DeleteCatalogRequest { - /** The name of the catalog. */ + /** + * The name of the catalog. + * + * Required. This field must be set in requests. + */ nameArg?: string | undefined; /** Force deletion even if the catalog is not empty. */ force?: boolean | undefined; @@ -193,7 +206,11 @@ export interface DeleteCatalogRequest { export interface DeleteCatalogResponse {} export interface EffectivePredictiveOptimizationFlag { - /** Whether predictive optimization should be enabled for this object and objects under it. */ + /** + * Whether predictive optimization should be enabled for this object and objects under it. + * + * Required. This field must be set in requests. + */ value?: string | undefined; /** The type of the object from which the flag was inherited. If there was no inheritance, this field is left blank. */ inheritedFromType?: string | undefined; @@ -215,7 +232,11 @@ export interface EncryptionSettings { } export interface GetCatalogRequest { - /** The name of the catalog. */ + /** + * The name of the catalog. + * + * Required. This field must be set in requests. + */ nameArg?: string | undefined; /** Whether to include catalogs in the response for which the principal can only access selective metadata for */ includeBrowse?: boolean | undefined; @@ -260,7 +281,11 @@ export interface ProvisioningInfo { } export interface UpdateCatalogRequest { - /** The name of the catalog. */ + /** + * The name of the catalog. + * + * Required. This field must be set in requests. + */ nameArg?: string | undefined; /** New name for the catalog. */ newName?: string | undefined; @@ -312,7 +337,11 @@ export interface UpdateCatalogRequest { customMaxRetentionHours?: bigint | undefined; /** Control CMK encryption for managed catalog data */ managedEncryptionSettings?: EncryptionSettings | undefined; - /** A map of key-value properties attached to the securable. */ + /** + * A map of key-value properties attached to the securable. + * + * Required. This field must be set in requests. + */ properties?: Record | undefined; /** A map of key-value properties attached to the securable. */ options?: Record | undefined; diff --git a/packages/uc/connections/src/v1/model.ts b/packages/uc/connections/src/v1/model.ts index 9acd97dc..8cafd2a3 100755 --- a/packages/uc/connections/src/v1/model.ts +++ b/packages/uc/connections/src/v1/model.ts @@ -136,7 +136,11 @@ export interface ConnectionInfo { provisioningInfo?: ProvisioningInfo | undefined; /** A map of key-value properties attached to the securable. */ options?: Record | undefined; - /** A map of key-value properties attached to the securable. */ + /** + * A map of key-value properties attached to the securable. + * + * Required. This field must be set in requests. + */ properties?: Record | undefined; } @@ -175,12 +179,20 @@ export interface CreateConnectionRequest { provisioningInfo?: ProvisioningInfo | undefined; /** A map of key-value properties attached to the securable. */ options?: Record | undefined; - /** A map of key-value properties attached to the securable. */ + /** + * A map of key-value properties attached to the securable. + * + * Required. This field must be set in requests. + */ properties?: Record | undefined; } export interface DeleteConnectionRequest { - /** The name of the connection to be deleted. */ + /** + * The name of the connection to be deleted. + * + * Required. This field must be set in requests. + */ nameArg?: string | undefined; } @@ -193,7 +205,11 @@ export interface EnvironmentSettings { } export interface GetConnectionRequest { - /** Name of the connection. */ + /** + * Name of the connection. + * + * Required. This field must be set in requests. + */ nameArg?: string | undefined; } @@ -227,7 +243,11 @@ export interface ProvisioningInfo { } export interface UpdateConnectionRequest { - /** Name of the connection. */ + /** + * Name of the connection. + * + * Required. This field must be set in requests. + */ nameArg?: string | undefined; /** New name for the connection. */ newName?: string | undefined; @@ -265,7 +285,11 @@ export interface UpdateConnectionRequest { provisioningInfo?: ProvisioningInfo | undefined; /** A map of key-value properties attached to the securable. */ options?: Record | undefined; - /** A map of key-value properties attached to the securable. */ + /** + * A map of key-value properties attached to the securable. + * + * Required. This field must be set in requests. + */ properties?: Record | undefined; } diff --git a/packages/uc/credentials/src/v1/model.ts b/packages/uc/credentials/src/v1/model.ts index 30341e48..2de5bbf3 100755 --- a/packages/uc/credentials/src/v1/model.ts +++ b/packages/uc/credentials/src/v1/model.ts @@ -82,9 +82,17 @@ export type ValidateStorageCredentialRequest_Result = | (string & {}); export interface AccountsCreateStorageCredentialRequest { - /** account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html) */ + /** + * account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html) + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; - /** Unity Catalog metastore ID */ + /** + * Unity Catalog metastore ID + * + * Required. This field must be set in requests. + */ metastoreId?: string | undefined; credentialInfo?: CreateAccountsStorageCredential | undefined; /** @@ -100,11 +108,23 @@ export interface AccountsCreateStorageCredentialResponse { /** Deletes a storage credential for an account */ export interface AccountsDeleteStorageCredentialRequest { - /** account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html) */ + /** + * account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html) + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; - /** Unity Catalog metastore ID */ + /** + * Unity Catalog metastore ID + * + * Required. This field must be set in requests. + */ metastoreId?: string | undefined; - /** Name of the storage credential. */ + /** + * Name of the storage credential. + * + * Required. This field must be set in requests. + */ nameArg?: string | undefined; /** Force deletion even if the Storage Credential is not empty. Default is false. */ force?: boolean | undefined; @@ -116,11 +136,23 @@ export interface AccountsDeleteStorageCredentialResponse {} /** Retrieves a single storage credential */ export interface AccountsGetStorageCredentialRequest { - /** account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html) */ + /** + * account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html) + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; - /** Unity Catalog metastore ID */ + /** + * Unity Catalog metastore ID + * + * Required. This field must be set in requests. + */ metastoreId?: string | undefined; - /** Required. Name of the storage credential. */ + /** + * Required. Name of the storage credential. + * + * Required. This field must be set in requests. + */ nameArg?: string | undefined; } @@ -131,9 +163,17 @@ export interface AccountsGetStorageCredentialResponse { /** Lists all storage credentials for the given account and metastore */ export interface AccountsListStorageCredentialsRequest { - /** account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html) */ + /** + * account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html) + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; - /** Unity Catalog metastore ID */ + /** + * Unity Catalog metastore ID + * + * Required. This field must be set in requests. + */ metastoreId?: string | undefined; } @@ -145,11 +185,23 @@ export interface AccountsListStorageCredentialsResponse { /** The storage credential to update. */ export interface AccountsUpdateStorageCredentialRequest { - /** account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html) */ + /** + * account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html) + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; - /** Unity Catalog metastore ID */ + /** + * Unity Catalog metastore ID + * + * Required. This field must be set in requests. + */ metastoreId?: string | undefined; - /** Name of the storage credential. */ + /** + * Name of the storage credential. + * + * Required. This field must be set in requests. + */ nameArg?: string | undefined; credentialInfo?: UpdateAccountsStorageCredential | undefined; /** Optional. Supplying true to this argument skips validation of the updated set of credentials. */ @@ -178,9 +230,15 @@ export interface AwsIamRole { /** * The Amazon Resource Name (ARN) of the AWS IAM user managed by . * This is the identity that is going to assume the AWS IAM role. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ unityCatalogIamArn?: string | undefined; - /** The external ID used in role assumption to prevent the confused deputy problem. */ + /** + * The external ID used in role assumption to prevent the confused deputy problem. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ externalId?: string | undefined; } @@ -199,6 +257,8 @@ export interface AzureManagedIdentity { /** * The Azure resource ID of the Azure Databricks Access Connector. Use the format * `/subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.Databricks/accessConnectors/{connector-name}`. + * + * Required. This field must be set in requests. */ accessConnectorId?: string | undefined; /** @@ -208,17 +268,33 @@ export interface AzureManagedIdentity { * If this field is not provided, then we assume the AzureManagedIdentity is using the system-assigned identity. */ managedIdentityId?: string | undefined; - /** The internal ID that represents this managed identity. */ + /** + * The internal ID that represents this managed identity. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ credentialId?: string | undefined; } /** The Azure service principal configuration. Only applicable when purpose is **STORAGE**. */ export interface AzureServicePrincipal { - /** The directory ID corresponding to the Azure Active Directory (AAD) tenant of the application. */ + /** + * The directory ID corresponding to the Azure Active Directory (AAD) tenant of the application. + * + * Required. This field must be set in requests. + */ directoryId?: string | undefined; - /** The application ID of the application registration within the referenced AAD tenant. */ + /** + * The application ID of the application registration within the referenced AAD tenant. + * + * Required. This field must be set in requests. + */ applicationId?: string | undefined; - /** The client secret generated for the above app ID in AAD. */ + /** + * The client secret generated for the above app ID in AAD. + * + * Required. This field must be set in requests. + */ clientSecret?: string | undefined; } @@ -236,11 +312,23 @@ export interface AzureUserDelegationSas { * Read more at https://developers.cloudflare.com/r2/api/s3/tokens/ */ export interface CloudflareApiToken { - /** The access key ID associated with the API token. */ + /** + * The access key ID associated with the API token. + * + * Required. This field must be set in requests. + */ accessKeyId?: string | undefined; - /** The secret access token generated for the above access key ID. */ + /** + * The secret access token generated for the above access key ID. + * + * Required. This field must be set in requests. + */ secretAccessKey?: string | undefined; - /** The ID of the account associated with the API token. */ + /** + * The ID of the account associated with the API token. + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; } @@ -400,12 +488,21 @@ export interface CreateCredentialRequest { } export interface CreateCredentialsRequest { + /** Required. This field must be set in requests. */ accountId?: string | undefined; - /** The human-readable name of the credential configuration object. */ + /** + * The human-readable name of the credential configuration object. + * + * Required. This field must be set in requests. + */ credentialsName?: string | undefined; /** (-- NOTE(austin) This oneof is a future-looking definition when we add other clouds --) */ cloudCredentials?: - | {$case: 'awsCredentials'; awsCredentials: CreateCredentialAwsCredentials} + | { + $case: 'awsCredentials'; + /** Required. This field must be set in requests. */ + awsCredentials: CreateCredentialAwsCredentials; + } | undefined; } @@ -577,16 +674,32 @@ export interface Credentials { * -created Google Cloud Storage service account. */ export interface DatabricksGcpServiceAccount { - /** The email of the service account. */ + /** + * The email of the service account. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ email?: string | undefined; - /** The ID that represents the private key for this Service Account */ + /** + * The ID that represents the private key for this Service Account + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ privateKeyId?: string | undefined; - /** The internal ID that represents this managed identity. */ + /** + * The internal ID that represents this managed identity. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ credentialId?: string | undefined; } export interface DeleteCredentialRequest { - /** Name of the credential. */ + /** + * Name of the credential. + * + * Required. This field must be set in requests. + */ nameArg?: string | undefined; /** * Force an update even if there are dependent services (when purpose is @@ -600,13 +713,22 @@ export interface DeleteCredentialRequest { export interface DeleteCredentialResponse {} export interface DeleteCredentialsRequest { - /** Databricks Account API credential configuration ID */ + /** + * Databricks Account API credential configuration ID + * + * Required. This field must be set in requests. + */ credentialsId?: string | undefined; + /** Required. This field must be set in requests. */ accountId?: string | undefined; } export interface DeleteStorageCredentialRequest { - /** Name of the storage credential. */ + /** + * Name of the storage credential. + * + * Required. This field must be set in requests. + */ nameArg?: string | undefined; /** * Force an update even if there are dependent external locations or external @@ -641,9 +763,17 @@ export interface GcpServiceAccountKey { } export interface GenerateTemporaryPathCredentialRequest { - /** URL for path-based access. */ + /** + * URL for path-based access. + * + * Required. This field must be set in requests. + */ url?: string | undefined; - /** The operation being performed on the path. */ + /** + * The operation being performed on the path. + * + * Required. This field must be set in requests. + */ operation?: PathOperation | undefined; /** * Optional. When set to true, the service will not validate that the generated @@ -774,13 +904,22 @@ export interface GenerateTemporaryVolumeCredentialResponse { } export interface GetCredentialRequest { - /** Name of the credential. */ + /** + * Name of the credential. + * + * Required. This field must be set in requests. + */ nameArg?: string | undefined; } export interface GetCredentialsRequest { - /** Credential configuration ID */ + /** + * Credential configuration ID + * + * Required. This field must be set in requests. + */ credentialsId?: string | undefined; + /** Required. This field must be set in requests. */ accountId?: string | undefined; } @@ -790,11 +929,16 @@ export interface GetCredentialsRequest { * See https://github.com/databricks-eng/universe/pull/857047#discussion_r1924779791 for an example of a case when that wasn't possible. */ export interface GetStorageCredentialRequest { - /** Name of the storage credential. */ + /** + * Name of the storage credential. + * + * Required. This field must be set in requests. + */ nameArg?: string | undefined; } export interface ListCredentialsPublicRequest { + /** Required. This field must be set in requests. */ accountId?: string | undefined; } @@ -1073,7 +1217,11 @@ export interface UpdateAccountsStorageCredential { } export interface UpdateCredentialRequest { - /** Name of the credential. */ + /** + * Name of the credential. + * + * Required. This field must be set in requests. + */ nameArg?: string | undefined; /** New name of credential. */ newName?: string | undefined; @@ -1158,7 +1306,11 @@ export interface UpdateCredentialRequest { } export interface UpdateStorageCredentialRequest { - /** Name of the storage credential. */ + /** + * Name of the storage credential. + * + * Required. This field must be set in requests. + */ nameArg?: string | undefined; /** New name for the storage credential. */ newName?: string | undefined; diff --git a/packages/uc/entitytagassignments/src/v1/model.ts b/packages/uc/entitytagassignments/src/v1/model.ts index cc3bc74a..117edbd7 100644 --- a/packages/uc/entitytagassignments/src/v1/model.ts +++ b/packages/uc/entitytagassignments/src/v1/model.ts @@ -21,56 +21,113 @@ export type TagAssignmentSourceType = /** Request to create a new entity tag assignment */ export interface CreateEntityTagAssignmentRequest { + /** Required. This field must be set in requests. */ tagAssignment?: EntityTagAssignment | undefined; } /** Request to delete an entity tag assignment */ export interface DeleteEntityTagAssignmentRequest { - /** The fully qualified name of the entity to which the tag is assigned */ + /** + * The fully qualified name of the entity to which the tag is assigned + * + * Required. This field must be set in requests. + */ entityName?: string | undefined; - /** Required. The key of the tag to delete */ + /** + * Required. The key of the tag to delete + * + * Required. This field must be set in requests. + */ tagKey?: string | undefined; - /** The type of the entity to which the tag is assigned. */ + /** + * The type of the entity to which the tag is assigned. + * + * Required. This field must be set in requests. + */ entityType?: string | undefined; } /** Represents a tag assignment to an entity */ export interface EntityTagAssignment { - /** The fully qualified name of the entity to which the tag is assigned */ + /** + * The fully qualified name of the entity to which the tag is assigned + * + * Required. This field must be set in requests. Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ entityName?: string | undefined; - /** The key of the tag */ + /** + * The key of the tag + * + * Required. This field must be set in requests. Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ tagKey?: string | undefined; /** The value of the tag */ tagValue?: string | undefined; - /** The type of the entity to which the tag is assigned. */ + /** + * The type of the entity to which the tag is assigned. + * + * Required. This field must be set in requests. Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ entityType?: string | undefined; - /** The timestamp when the tag assignment was last updated */ + /** + * The timestamp when the tag assignment was last updated + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updateTime?: Temporal.Instant | undefined; - /** The user or principal who updated the tag assignment */ + /** + * The user or principal who updated the tag assignment + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updatedBy?: string | undefined; - /** The source type of the tag assignment, e.g., user-assigned or system-assigned */ + /** + * The source type of the tag assignment, e.g., user-assigned or system-assigned + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ sourceType?: TagAssignmentSourceType | undefined; } /** Request to get an entity tag assignment */ export interface GetEntityTagAssignmentRequest { - /** The fully qualified name of the entity to which the tag is assigned */ + /** + * The fully qualified name of the entity to which the tag is assigned + * + * Required. This field must be set in requests. + */ entityName?: string | undefined; - /** Required. The key of the tag */ + /** + * Required. The key of the tag + * + * Required. This field must be set in requests. + */ tagKey?: string | undefined; - /** The type of the entity to which the tag is assigned. */ + /** + * The type of the entity to which the tag is assigned. + * + * Required. This field must be set in requests. + */ entityType?: string | undefined; } /** Request to list entity tag assignments */ export interface ListEntityTagAssignmentsRequest { - /** The fully qualified name of the entity to which the tag is assigned */ + /** + * The fully qualified name of the entity to which the tag is assigned + * + * Required. This field must be set in requests. + */ entityName?: string | undefined; /** Optional. Maximum number of tag assignments to return in a single page */ maxResults?: number | undefined; /** Optional. Pagination token to retrieve the next page of results */ pageToken?: string | undefined; - /** The type of the entity to which the tag is assigned. */ + /** + * The type of the entity to which the tag is assigned. + * + * Required. This field must be set in requests. + */ entityType?: string | undefined; } @@ -83,7 +140,9 @@ export interface ListEntityTagAssignmentsResponse { /** Request to update an entity tag assignment */ export interface UpdateEntityTagAssignmentRequest { + /** Required. This field must be set in requests. */ tagAssignment?: EntityTagAssignment | undefined; + /** Required. This field must be set in requests. */ updateMask?: FieldMask | undefined; } diff --git a/packages/uc/externallineage/src/v1/model.ts b/packages/uc/externallineage/src/v1/model.ts index 386702ef..c4379fa5 100755 --- a/packages/uc/externallineage/src/v1/model.ts +++ b/packages/uc/externallineage/src/v1/model.ts @@ -53,15 +53,28 @@ export interface ColumnRelationship { } export interface CreateExternalLineageRelationshipRequest { + /** Required. This field must be set in requests. */ externalLineageRelationship?: CreateRequestExternalLineage | undefined; } export interface CreateRequestExternalLineage { - /** Unique identifier of the external lineage relationship. */ + /** + * Unique identifier of the external lineage relationship. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ id?: string | undefined; - /** Source object of the external lineage relationship. */ + /** + * Source object of the external lineage relationship. + * + * Required. This field must be set in requests. + */ source?: ExternalLineageRelationshipObject | undefined; - /** Target object of the external lineage relationship. */ + /** + * Target object of the external lineage relationship. + * + * Required. This field must be set in requests. + */ target?: ExternalLineageRelationshipObject | undefined; /** List of column relationships between source and target objects. */ columns?: ColumnRelationship[] | undefined; @@ -70,15 +83,28 @@ export interface CreateRequestExternalLineage { } export interface DeleteExternalLineageRelationshipRequest { + /** Required. This field must be set in requests. */ externalLineageRelationship?: DeleteRequestExternalLineage | undefined; } export interface DeleteRequestExternalLineage { - /** Unique identifier of the external lineage relationship. */ + /** + * Unique identifier of the external lineage relationship. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ id?: string | undefined; - /** Source object of the external lineage relationship. */ + /** + * Source object of the external lineage relationship. + * + * Required. This field must be set in requests. + */ source?: ExternalLineageRelationshipObject | undefined; - /** Target object of the external lineage relationship. */ + /** + * Target object of the external lineage relationship. + * + * Required. This field must be set in requests. + */ target?: ExternalLineageRelationshipObject | undefined; /** List of column relationships between source and target objects. */ columns?: ColumnRelationship[] | undefined; @@ -105,11 +131,23 @@ export interface ExternalLineageInfo { } export interface ExternalLineageRelationship { - /** Unique identifier of the external lineage relationship. */ + /** + * Unique identifier of the external lineage relationship. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ id?: string | undefined; - /** Source object of the external lineage relationship. */ + /** + * Source object of the external lineage relationship. + * + * Required. This field must be set in requests. + */ source?: ExternalLineageRelationshipObject | undefined; - /** Target object of the external lineage relationship. */ + /** + * Target object of the external lineage relationship. + * + * Required. This field must be set in requests. + */ target?: ExternalLineageRelationshipObject | undefined; /** List of column relationships between source and target objects. */ columns?: ColumnRelationship[] | undefined; @@ -202,9 +240,15 @@ export interface ListExternalLineageRelationshipsRequest { * The object to query external lineage relationships for. * Since this field is a query parameter, please flatten the nested fields. For example, if the object is a table, the query parameter should look like: * `object_info.table.name=main.sales.customers` + * + * Required. This field must be set in requests. */ objectInfo?: ExternalLineageRelationshipObject | undefined; - /** The lineage direction to filter on. */ + /** + * The lineage direction to filter on. + * + * Required. This field must be set in requests. + */ lineageDirection?: Direction_LineageDirection | undefined; /** * Specifies the maximum number of external lineage relationships to return in a single response. @@ -221,16 +265,30 @@ export interface ListExternalLineageRelationshipsResponse { } export interface UpdateExternalLineageRelationshipRequest { + /** Required. This field must be set in requests. */ externalLineageRelationship?: UpdateRequestExternalLineage | undefined; + /** Required. This field must be set in requests. */ updateMask?: FieldMask | undefined; } export interface UpdateRequestExternalLineage { - /** Unique identifier of the external lineage relationship. */ + /** + * Unique identifier of the external lineage relationship. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ id?: string | undefined; - /** Source object of the external lineage relationship. */ + /** + * Source object of the external lineage relationship. + * + * Required. This field must be set in requests. + */ source?: ExternalLineageRelationshipObject | undefined; - /** Target object of the external lineage relationship. */ + /** + * Target object of the external lineage relationship. + * + * Required. This field must be set in requests. + */ target?: ExternalLineageRelationshipObject | undefined; /** List of column relationships between source and target objects. */ columns?: ColumnRelationship[] | undefined; diff --git a/packages/uc/externallocations/src/v1/model.ts b/packages/uc/externallocations/src/v1/model.ts index 7be0bd8f..1561906a 100755 --- a/packages/uc/externallocations/src/v1/model.ts +++ b/packages/uc/externallocations/src/v1/model.ts @@ -28,7 +28,11 @@ export interface AwsSqsQueue { * Only required for provided_sqs. */ queueUrl?: string | undefined; - /** Unique identifier included in the name of file events managed cloud resources. */ + /** + * Unique identifier included in the name of file events managed cloud resources. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ managedResourceId?: string | undefined; } @@ -50,18 +54,34 @@ export interface AzureQueueStorage { * Only required for locations with a service principal storage credential */ resourceGroup?: string | undefined; - /** Unique identifier included in the name of file events managed cloud resources. */ + /** + * Unique identifier included in the name of file events managed cloud resources. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ managedResourceId?: string | undefined; } export interface CreateExternalLocationRequest { /** Skips validation of the storage credential associated with the external location. */ skipValidation?: boolean | undefined; - /** Name of the external location. */ + /** + * Name of the external location. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Path URL of the external location. */ + /** + * Path URL of the external location. + * + * Required. This field must be set in requests. + */ url?: string | undefined; - /** Name of the storage credential used with this location. */ + /** + * Name of the storage credential used with this location. + * + * Required. This field must be set in requests. + */ credentialName?: string | undefined; /** Indicates whether the external location is read-only. */ readOnly?: boolean | undefined; @@ -94,19 +114,29 @@ export interface CreateExternalLocationRequest { isolationMode?: IsolationMode | undefined; /** Indicates whether fallback mode is enabled for this external location. When fallback mode is enabled, the access to the location falls back to cluster credentials if UC credentials are not sufficient. */ fallback?: boolean | undefined; - /** The effective value of `enable_file_events` after applying server-side defaults. */ + /** + * The effective value of `enable_file_events` after applying server-side defaults. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ effectiveEnableFileEvents?: boolean | undefined; /** * The effective file event queue configuration after applying server-side defaults. * Always populated when a queue is provisioned, regardless of whether the user explicitly * set `enable_file_events`. Use this field instead of `file_event_queue` for reading * the actual queue state. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ effectiveFileEventQueue?: FileEventQueue | undefined; } export interface DeleteExternalLocationRequest { - /** Name of the external location. */ + /** + * Name of the external location. + * + * Required. This field must be set in requests. + */ nameArg?: string | undefined; /** Force deletion even if there are dependent external tables or mounts. */ force?: boolean | undefined; @@ -127,11 +157,23 @@ export interface EncryptionDetails { } export interface ExternalLocationInfo { - /** Name of the external location. */ + /** + * Name of the external location. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Path URL of the external location. */ + /** + * Path URL of the external location. + * + * Required. This field must be set in requests. + */ url?: string | undefined; - /** Name of the storage credential used with this location. */ + /** + * Name of the storage credential used with this location. + * + * Required. This field must be set in requests. + */ credentialName?: string | undefined; /** Indicates whether the external location is read-only. */ readOnly?: boolean | undefined; @@ -164,13 +206,19 @@ export interface ExternalLocationInfo { isolationMode?: IsolationMode | undefined; /** Indicates whether fallback mode is enabled for this external location. When fallback mode is enabled, the access to the location falls back to cluster credentials if UC credentials are not sufficient. */ fallback?: boolean | undefined; - /** The effective value of `enable_file_events` after applying server-side defaults. */ + /** + * The effective value of `enable_file_events` after applying server-side defaults. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ effectiveEnableFileEvents?: boolean | undefined; /** * The effective file event queue configuration after applying server-side defaults. * Always populated when a queue is provisioned, regardless of whether the user explicitly * set `enable_file_events`. Use this field instead of `file_event_queue` for reading * the actual queue state. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ effectiveFileEventQueue?: FileEventQueue | undefined; } @@ -194,12 +242,20 @@ export interface GcpPubsub { * Only required for provided_pubsub. */ subscriptionName?: string | undefined; - /** Unique identifier included in the name of file events managed cloud resources. */ + /** + * Unique identifier included in the name of file events managed cloud resources. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ managedResourceId?: string | undefined; } export interface GetExternalLocationRequest { - /** Name of the external location. */ + /** + * Name of the external location. + * + * Required. This field must be set in requests. + */ nameArg?: string | undefined; /** Whether to include external locations in the response for which the principal can only access selective metadata for */ includeBrowse?: boolean | undefined; @@ -247,7 +303,11 @@ export interface SseEncryptionDetails { } export interface UpdateExternalLocationRequest { - /** Name of the external location. */ + /** + * Name of the external location. + * + * Required. This field must be set in requests. + */ nameArg?: string | undefined; /** New name for the external location. */ newName?: string | undefined; @@ -255,11 +315,23 @@ export interface UpdateExternalLocationRequest { force?: boolean | undefined; /** Skips validation of the storage credential associated with the external location. */ skipValidation?: boolean | undefined; - /** Name of the external location. */ + /** + * Name of the external location. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Path URL of the external location. */ + /** + * Path URL of the external location. + * + * Required. This field must be set in requests. + */ url?: string | undefined; - /** Name of the storage credential used with this location. */ + /** + * Name of the storage credential used with this location. + * + * Required. This field must be set in requests. + */ credentialName?: string | undefined; /** Indicates whether the external location is read-only. */ readOnly?: boolean | undefined; @@ -292,13 +364,19 @@ export interface UpdateExternalLocationRequest { isolationMode?: IsolationMode | undefined; /** Indicates whether fallback mode is enabled for this external location. When fallback mode is enabled, the access to the location falls back to cluster credentials if UC credentials are not sufficient. */ fallback?: boolean | undefined; - /** The effective value of `enable_file_events` after applying server-side defaults. */ + /** + * The effective value of `enable_file_events` after applying server-side defaults. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ effectiveEnableFileEvents?: boolean | undefined; /** * The effective file event queue configuration after applying server-side defaults. * Always populated when a queue is provisioned, regardless of whether the user explicitly * set `enable_file_events`. Use this field instead of `file_event_queue` for reading * the actual queue state. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ effectiveFileEventQueue?: FileEventQueue | undefined; } diff --git a/packages/uc/externalmetadata/src/v1/model.ts b/packages/uc/externalmetadata/src/v1/model.ts index a2d3bd4c..ae1604f1 100755 --- a/packages/uc/externalmetadata/src/v1/model.ts +++ b/packages/uc/externalmetadata/src/v1/model.ts @@ -45,11 +45,23 @@ export interface DeleteExternalMetadataRequest { } export interface ExternalMetadata { - /** Name of the external metadata object. */ + /** + * Name of the external metadata object. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Type of external system. */ + /** + * Type of external system. + * + * Required. This field must be set in requests. + */ systemType?: SystemType | undefined; - /** Type of entity within the external system. */ + /** + * Type of entity within the external system. + * + * Required. This field must be set in requests. + */ entityType?: string | undefined; /** URL associated with the external metadata object. */ url?: string | undefined; @@ -61,17 +73,41 @@ export interface ExternalMetadata { properties?: Record | undefined; /** Owner of the external metadata object. */ owner?: string | undefined; - /** Unique identifier of parent metastore. */ + /** + * Unique identifier of parent metastore. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ metastoreId?: string | undefined; - /** Time at which this external metadata object was created. */ + /** + * Time at which this external metadata object was created. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createTime?: Temporal.Instant | undefined; - /** Username of external metadata object creator. */ + /** + * Username of external metadata object creator. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdBy?: string | undefined; - /** Time at which this external metadata object was last modified. */ + /** + * Time at which this external metadata object was last modified. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updateTime?: Temporal.Instant | undefined; - /** Username of user who last modified external metadata object. */ + /** + * Username of user who last modified external metadata object. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updatedBy?: string | undefined; - /** Unique identifier of the external metadata object. */ + /** + * Unique identifier of the external metadata object. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ id?: string | undefined; } @@ -96,6 +132,7 @@ export interface ListExternalMetadataResponseV2 { export interface UpdateExternalMetadataRequest { externalMetadata?: ExternalMetadata | undefined; + /** Required. This field must be set in requests. */ updateMask?: FieldMask | undefined; } diff --git a/packages/uc/functions/src/v1/model.ts b/packages/uc/functions/src/v1/model.ts index ff08e6b6..bd27cbaa 100755 --- a/packages/uc/functions/src/v1/model.ts +++ b/packages/uc/functions/src/v1/model.ts @@ -165,7 +165,11 @@ export interface CreateFunction { } export interface CreateFunctionRequest { - /** Partial __FunctionInfo__ specifying the function to be created. */ + /** + * Partial __FunctionInfo__ specifying the function to be created. + * + * Required. This field must be set in requests. + */ functionInfo?: CreateFunction | undefined; } @@ -176,7 +180,11 @@ export interface CredentialDependency { } export interface DeleteFunctionRequest { - /** The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__) . */ + /** + * The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__) . + * + * Required. This field must be set in requests. + */ fullNameArg?: string | undefined; /** Force deletion even if the function is notempty. */ force?: boolean | undefined; @@ -206,7 +214,11 @@ export interface DependencyList { /** A function that is dependent on a SQL object. */ export interface FunctionDependency { - /** Full name of the dependent function, in the form of __catalog_name__.__schema_name__.__function_name__. */ + /** + * Full name of the dependent function, in the form of __catalog_name__.__schema_name__.__function_name__. + * + * Required. This field must be set in requests. + */ functionFullName?: string | undefined; } @@ -274,13 +286,25 @@ export interface FunctionInfo { } export interface FunctionParameterInfo { - /** Name of Parameter. */ + /** + * Name of Parameter. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Full data type spec, SQL/catalogString text. */ + /** + * Full data type spec, SQL/catalogString text. + * + * Required. This field must be set in requests. + */ typeText?: string | undefined; /** Full data type spec, JSON-serialized. */ typeJson?: string | undefined; - /** Name of type (INT, STRUCT, MAP, etc.) */ + /** + * Name of type (INT, STRUCT, MAP, etc.) + * + * Required. This field must be set in requests. + */ typeName?: ColumnTypeName | undefined; /** Digits of precision; required on Create for DecimalTypes. */ typePrecision?: number | undefined; @@ -288,7 +312,11 @@ export interface FunctionParameterInfo { typeScale?: number | undefined; /** Format of IntervalType. */ typeIntervalType?: string | undefined; - /** Ordinal position of column (starting at position 0). */ + /** + * Ordinal position of column (starting at position 0). + * + * Required. This field must be set in requests. + */ position?: number | undefined; /** Function parameter mode. */ parameterMode?: FunctionParameterMode | undefined; @@ -305,16 +333,28 @@ export interface FunctionParameterInfos { } export interface GetFunctionRequest { - /** The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__). */ + /** + * The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__). + * + * Required. This field must be set in requests. + */ fullNameArg?: string | undefined; /** Whether to include functions in the response for which the principal can only access selective metadata for */ includeBrowse?: boolean | undefined; } export interface ListFunctionsRequest { - /** Name of parent catalog for functions of interest. */ + /** + * Name of parent catalog for functions of interest. + * + * Required. This field must be set in requests. + */ catalogName?: string | undefined; - /** Parent schema of functions. */ + /** + * Parent schema of functions. + * + * Required. This field must be set in requests. + */ schemaName?: string | undefined; /** Whether to include functions in the response for which the principal can only access selective metadata for */ includeBrowse?: boolean | undefined; @@ -342,12 +382,20 @@ export interface ListFunctionsResponse { /** A table that is dependent on a SQL object. */ export interface TableDependency { - /** Full name of the dependent table, in the form of __catalog_name__.__schema_name__.__table_name__. */ + /** + * Full name of the dependent table, in the form of __catalog_name__.__schema_name__.__table_name__. + * + * Required. This field must be set in requests. + */ tableFullName?: string | undefined; } export interface UpdateFunctionRequest { - /** The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__). */ + /** + * The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__). + * + * Required. This field must be set in requests. + */ fullNameArg?: string | undefined; /** Name of function, relative to parent schema. */ name?: string | undefined; diff --git a/packages/uc/grants/src/v1/model.ts b/packages/uc/grants/src/v1/model.ts index 8b8582ad..7cd6a121 100755 --- a/packages/uc/grants/src/v1/model.ts +++ b/packages/uc/grants/src/v1/model.ts @@ -25,7 +25,11 @@ export interface EffectivePrivilegeAssignment { } export interface GetEffectivePermissionsRequest { - /** Type of securable. */ + /** + * Type of securable. + * + * Required. This field must be set in requests. + */ securableType?: string | undefined; /** Full name of securable. */ securableFullName?: string | undefined; @@ -60,7 +64,11 @@ export interface GetEffectivePermissionsResponse { } export interface GetPermissionsRequest { - /** Type of securable. */ + /** + * Type of securable. + * + * Required. This field must be set in requests. + */ securableType?: string | undefined; /** Full name of securable. */ securableFullName?: string | undefined; @@ -117,7 +125,11 @@ export interface PrivilegeAssignment { } export interface UpdatePermissionsRequest { - /** Type of securable. */ + /** + * Type of securable. + * + * Required. This field must be set in requests. + */ securableType?: string | undefined; /** Full name of securable. */ securableFullName?: string | undefined; diff --git a/packages/uc/metastores/src/v1/model.ts b/packages/uc/metastores/src/v1/model.ts index 26b2b8d9..a84e47e3 100755 --- a/packages/uc/metastores/src/v1/model.ts +++ b/packages/uc/metastores/src/v1/model.ts @@ -23,11 +23,19 @@ export type DeltaSharingScope_Enum = /** The mapping from workspace to metastore. */ export interface AccountsCreateMetastoreAssignmentRequest { - /** account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html) */ + /** + * account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html) + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; /** Workspace ID. */ workspaceId?: bigint | undefined; - /** Unity Catalog metastore ID */ + /** + * Unity Catalog metastore ID + * + * Required. This field must be set in requests. + */ metastoreId?: string | undefined; metastoreAssignment?: MetastoreAssignment | undefined; } @@ -38,7 +46,11 @@ export interface AccountsCreateMetastoreAssignmentResponse {} /** Properties of the new metastore. */ export interface AccountsCreateMetastoreRequest { - /** account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html) */ + /** + * account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html) + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; metastoreInfo?: CreateAccountsMetastore | undefined; } @@ -49,11 +61,19 @@ export interface AccountsCreateMetastoreResponse { /** Delete a metastore assignment to a workspace */ export interface AccountsDeleteMetastoreAssignmentRequest { - /** account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html) */ + /** + * account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html) + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; /** Workspace ID. */ workspaceId?: bigint | undefined; - /** Unity Catalog metastore ID */ + /** + * Unity Catalog metastore ID + * + * Required. This field must be set in requests. + */ metastoreId?: string | undefined; } @@ -63,9 +83,17 @@ export interface AccountsDeleteMetastoreAssignmentResponse {} /** Delete a metastore for the given account */ export interface AccountsDeleteMetastoreRequest { - /** account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html) */ + /** + * account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html) + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; - /** Unity Catalog metastore ID */ + /** + * Unity Catalog metastore ID + * + * Required. This field must be set in requests. + */ metastoreId?: string | undefined; /** Force deletion even if the metastore is not empty. Default is false. */ force?: boolean | undefined; @@ -77,9 +105,17 @@ export interface AccountsDeleteMetastoreResponse {} /** Retrieves the assignment of which metastore to a given workspace */ export interface AccountsGetMetastoreAssignmentRequest { - /** account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html) */ + /** + * account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html) + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; - /** Workspace ID. */ + /** + * Workspace ID. + * + * Required. This field must be set in requests. + */ workspaceId?: bigint | undefined; } @@ -90,9 +126,17 @@ export interface AccountsGetMetastoreAssignmentResponse { /** Get a metastore for a given account */ export interface AccountsGetMetastoreRequest { - /** account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html) */ + /** + * account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html) + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; - /** Unity Catalog metastore ID */ + /** + * Unity Catalog metastore ID + * + * Required. This field must be set in requests. + */ metastoreId?: string | undefined; } @@ -103,7 +147,11 @@ export interface AccountsGetMetastoreResponse { /** List the metastores for an account */ export interface AccountsListMetastoresRequest { - /** account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html) */ + /** + * account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html) + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; } @@ -115,9 +163,17 @@ export interface AccountsListMetastoresResponse { /** Lists all workspace IDs for a given metastore */ export interface AccountsListWorkspaceIdsForMetastoreRequest { - /** account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html) */ + /** + * account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html) + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; - /** Unity Catalog metastore ID */ + /** + * Unity Catalog metastore ID + * + * Required. This field must be set in requests. + */ metastoreId?: string | undefined; } @@ -128,11 +184,19 @@ export interface AccountsListWorkspaceIdsForMetastoreResponse { /** The metastore assignment to update. */ export interface AccountsUpdateMetastoreAssignmentRequest { - /** account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html) */ + /** + * account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html) + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; /** Workspace ID. */ workspaceId?: bigint | undefined; - /** Unity Catalog metastore ID */ + /** + * Unity Catalog metastore ID + * + * Required. This field must be set in requests. + */ metastoreId?: string | undefined; metastoreAssignment?: MetastoreAssignment | undefined; } @@ -143,9 +207,17 @@ export interface AccountsUpdateMetastoreAssignmentResponse {} /** Properties of the metastore to change. */ export interface AccountsUpdateMetastoreRequest { - /** account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html) */ + /** + * account ID of any type. For non-E2 account types, get your account ID from the [Accounts Console](https://docs.databricks.com/administration-guide/account-settings/usage.html) + * + * Required. This field must be set in requests. + */ accountId?: string | undefined; - /** Unity Catalog metastore ID */ + /** + * Unity Catalog metastore ID + * + * Required. This field must be set in requests. + */ metastoreId?: string | undefined; /** Properties of the metastore to change. */ metastoreInfo?: UpdateAccountsMetastore | undefined; @@ -198,14 +270,24 @@ export interface CreateAccountsMetastore { } export interface CreateMetastoreAssignmentRequest { - /** A workspace ID. */ + /** + * A workspace ID. + * + * Required. This field must be set in requests. + */ workspaceId?: bigint | undefined; - /** The unique ID of the metastore. */ + /** + * The unique ID of the metastore. + * + * Required. This field must be set in requests. + */ metastoreId?: string | undefined; /** * The name of the default catalog in the metastore. * This field is deprecated. Please use "Default Namespace API" to * configure the default catalog for a workspace. + * + * Required. This field must be set in requests. */ defaultCatalogName?: string | undefined; } @@ -255,9 +337,17 @@ export interface CreateMetastoreRequest { } export interface DeleteMetastoreAssignmentRequest { - /** A workspace ID. */ + /** + * A workspace ID. + * + * Required. This field must be set in requests. + */ workspaceId?: bigint | undefined; - /** Query for the ID of the metastore to delete. */ + /** + * Query for the ID of the metastore to delete. + * + * Required. This field must be set in requests. + */ metastoreId?: string | undefined; } @@ -265,7 +355,11 @@ export interface DeleteMetastoreAssignmentRequest { export interface DeleteMetastoreAssignmentResponse {} export interface DeleteMetastoreRequest { - /** Unique ID of the metastore. */ + /** + * Unique ID of the metastore. + * + * Required. This field must be set in requests. + */ id?: string | undefined; /** Force deletion even if the metastore is not empty. Default is false. */ force?: boolean | undefined; @@ -281,7 +375,11 @@ export interface DeltaSharingScope {} export interface GetCurrentMetastoreAssignmentRequest {} export interface GetMetastoreRequest { - /** Unique ID of the metastore. */ + /** + * Unique ID of the metastore. + * + * Required. This field must be set in requests. + */ id?: string | undefined; } @@ -355,9 +453,17 @@ export interface ListMetastoresResponse { } export interface MetastoreAssignment { - /** The unique ID of the workspace. */ + /** + * The unique ID of the workspace. + * + * Required. This field must be set in requests. + */ workspaceId?: bigint | undefined; - /** The unique ID of the metastore. */ + /** + * The unique ID of the metastore. + * + * Required. This field must be set in requests. + */ metastoreId?: string | undefined; /** * The name of the default catalog in the metastore. This field is deprecated. @@ -449,7 +555,11 @@ export interface UpdateAccountsMetastore { } export interface UpdateMetastoreAssignmentRequest { - /** A workspace ID. */ + /** + * A workspace ID. + * + * Required. This field must be set in requests. + */ workspaceId?: bigint | undefined; /** The unique ID of the metastore. */ metastoreId?: string | undefined; @@ -465,7 +575,11 @@ export interface UpdateMetastoreAssignmentRequest { export interface UpdateMetastoreAssignmentResponse {} export interface UpdateMetastoreRequest { - /** Unique ID of the metastore. */ + /** + * Unique ID of the metastore. + * + * Required. This field must be set in requests. + */ id?: string | undefined; /** New name for the metastore. */ newName?: string | undefined; diff --git a/packages/uc/onlinetables/src/v1/model.ts b/packages/uc/onlinetables/src/v1/model.ts index d697bbca..47fadd59 100644 --- a/packages/uc/onlinetables/src/v1/model.ts +++ b/packages/uc/onlinetables/src/v1/model.ts @@ -133,14 +133,24 @@ export interface OnlineTable { name?: string | undefined; /** Specification of the online table. */ spec?: OnlineTableSpec | undefined; - /** Online Table data synchronization status */ + /** + * Online Table data synchronization status + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ status?: OnlineTableStatus | undefined; - /** Data serving REST API URL for this table */ + /** + * Data serving REST API URL for this table + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ tableServingUrl?: string | undefined; /** * The provisioning state of the online table entity in Unity Catalog. This is distinct from the * state of the data synchronization pipeline (i.e. the table may be in "ACTIVE" but the pipeline * may be in "PROVISIONING" as it runs asynchronously). + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ unityCatalogProvisioningState?: ProvisioningInfo_State | undefined; } diff --git a/packages/uc/registeredmodels/src/v1/model.ts b/packages/uc/registeredmodels/src/v1/model.ts index 2f05fbce..c4d30c4e 100755 --- a/packages/uc/registeredmodels/src/v1/model.ts +++ b/packages/uc/registeredmodels/src/v1/model.ts @@ -60,9 +60,17 @@ export interface CredentialDependency { } export interface DeleteModelVersionRequest { - /** The three-level (fully qualified) name of the model version */ + /** + * The three-level (fully qualified) name of the model version + * + * Required. This field must be set in requests. + */ fullNameArg?: string | undefined; - /** The integer version number of the model version */ + /** + * The integer version number of the model version + * + * Required. This field must be set in requests. + */ versionArg?: bigint | undefined; } @@ -70,9 +78,17 @@ export interface DeleteModelVersionRequest { export interface DeleteModelVersionResponse {} export interface DeleteRegisteredModelAliasRequest { - /** The three-level (fully qualified) name of the registered model */ + /** + * The three-level (fully qualified) name of the registered model + * + * Required. This field must be set in requests. + */ fullNameArg?: string | undefined; - /** The name of the alias */ + /** + * The name of the alias + * + * Required. This field must be set in requests. + */ aliasArg?: string | undefined; } @@ -80,7 +96,11 @@ export interface DeleteRegisteredModelAliasRequest { export interface DeleteRegisteredModelAliasResponse {} export interface DeleteRegisteredModelRequest { - /** The three-level (fully qualified) name of the registered model */ + /** + * The three-level (fully qualified) name of the registered model + * + * Required. This field must be set in requests. + */ fullNameArg?: string | undefined; } @@ -108,23 +128,43 @@ export interface DependencyList { /** A function that is dependent on a SQL object. */ export interface FunctionDependency { - /** Full name of the dependent function, in the form of __catalog_name__.__schema_name__.__function_name__. */ + /** + * Full name of the dependent function, in the form of __catalog_name__.__schema_name__.__function_name__. + * + * Required. This field must be set in requests. + */ functionFullName?: string | undefined; } export interface GetModelVersionByAliasRequest { - /** The three-level (fully qualified) name of the registered model */ + /** + * The three-level (fully qualified) name of the registered model + * + * Required. This field must be set in requests. + */ fullNameArg?: string | undefined; - /** The name of the alias */ + /** + * The name of the alias + * + * Required. This field must be set in requests. + */ aliasArg?: string | undefined; /** Whether to include aliases associated with the model version in the response */ includeAliases?: boolean | undefined; } export interface GetModelVersionRequest { - /** The three-level (fully qualified) name of the model version */ + /** + * The three-level (fully qualified) name of the model version + * + * Required. This field must be set in requests. + */ fullNameArg?: string | undefined; - /** The integer version number of the model version */ + /** + * The integer version number of the model version + * + * Required. This field must be set in requests. + */ versionArg?: bigint | undefined; /** Whether to include aliases associated with the model version in the response */ includeAliases?: boolean | undefined; @@ -133,7 +173,11 @@ export interface GetModelVersionRequest { } export interface GetRegisteredModelRequest { - /** The three-level (fully qualified) name of the registered model */ + /** + * The three-level (fully qualified) name of the registered model + * + * Required. This field must be set in requests. + */ fullNameArg?: string | undefined; /** Whether to include registered model aliases in the response */ includeAliases?: boolean | undefined; @@ -142,7 +186,11 @@ export interface GetRegisteredModelRequest { } export interface ListModelVersionsRequest { - /** The full three-level name of the registered model under which to list model versions */ + /** + * The full three-level name of the registered model under which to list model versions + * + * Required. This field must be set in requests. + */ fullNameArg?: string | undefined; /** * Maximum number of model versions to return. @@ -304,24 +352,48 @@ export interface RegisteredModelInfo { } export interface SetRegisteredModelAliasRequest { - /** The three-level (fully qualified) name of the registered model */ + /** + * The three-level (fully qualified) name of the registered model + * + * Required. This field must be set in requests. + */ fullNameArg?: string | undefined; - /** The name of the alias */ + /** + * The name of the alias + * + * Required. This field must be set in requests. + */ aliasArg?: string | undefined; - /** The version number of the model version to which the alias points */ + /** + * The version number of the model version to which the alias points + * + * Required. This field must be set in requests. + */ versionNum?: bigint | undefined; } /** A table that is dependent on a SQL object. */ export interface TableDependency { - /** Full name of the dependent table, in the form of __catalog_name__.__schema_name__.__table_name__. */ + /** + * Full name of the dependent table, in the form of __catalog_name__.__schema_name__.__table_name__. + * + * Required. This field must be set in requests. + */ tableFullName?: string | undefined; } export interface UpdateModelVersionRequest { - /** The three-level (fully qualified) name of the model version */ + /** + * The three-level (fully qualified) name of the model version + * + * Required. This field must be set in requests. + */ fullNameArg?: string | undefined; - /** The integer version number of the model version */ + /** + * The integer version number of the model version + * + * Required. This field must be set in requests. + */ versionArg?: bigint | undefined; /** The name of the parent registered model of the model version, relative to parent schema */ modelName?: string | undefined; @@ -371,7 +443,11 @@ export interface UpdateModelVersionRequest { } export interface UpdateRegisteredModelRequest { - /** The three-level (fully qualified) name of the registered model */ + /** + * The three-level (fully qualified) name of the registered model + * + * Required. This field must be set in requests. + */ fullNameArg?: string | undefined; /** New name for the registered model. */ newName?: string | undefined; diff --git a/packages/uc/resourcequotas/src/v1/model.ts b/packages/uc/resourcequotas/src/v1/model.ts index 7a20d00d..269f3ddc 100755 --- a/packages/uc/resourcequotas/src/v1/model.ts +++ b/packages/uc/resourcequotas/src/v1/model.ts @@ -29,11 +29,23 @@ export type SecurableType = | (string & {}); export interface GetQuotaRequest { - /** Securable type of the quota parent. */ + /** + * Securable type of the quota parent. + * + * Required. This field must be set in requests. + */ parentSecurableType?: string | undefined; - /** Full name of the parent resource. Provide the metastore ID if the parent is a metastore. */ + /** + * Full name of the parent resource. Provide the metastore ID if the parent is a metastore. + * + * Required. This field must be set in requests. + */ parentFullName?: string | undefined; - /** Name of the quota. Follows the pattern of the quota type, with "-quota" added as a suffix. */ + /** + * Name of the quota. Follows the pattern of the quota type, with "-quota" added as a suffix. + * + * Required. This field must be set in requests. + */ quotaName?: string | undefined; } diff --git a/packages/uc/rfa/src/v1/model.ts b/packages/uc/rfa/src/v1/model.ts index 049aa98b..c6f15f58 100644 --- a/packages/uc/rfa/src/v1/model.ts +++ b/packages/uc/rfa/src/v1/model.ts @@ -71,21 +71,37 @@ export type SpecialDestination = export interface AccessRequestDestinations { /** The access request destinations for the securable. */ destinations?: NotificationDestination[] | undefined; - /** The securable for which the access request destinations are being modified or read. */ + /** + * The securable for which the access request destinations are being modified or read. + * + * Required. This field must be set in requests. + */ securable?: Securable | undefined; /** * Indicates whether any destinations are hidden from the caller due to a lack of permissions. * This value is true if the caller does not have permission to see all destinations. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ areAnyDestinationsHidden?: boolean | undefined; /** * The source securable from which the destinations are inherited. Either the same value as securable (if destination * is set directly on the securable) or the nearest parent securable with destinations set. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ destinationSourceSecurable?: Securable | undefined; - /** The type of the securable. Redundant with the type in the securable object, but necessary for Terraform integration */ + /** + * The type of the securable. Redundant with the type in the securable object, but necessary for Terraform integration + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ securableType?: string | undefined; - /** The full name of the securable. Redundant with the name in the securable object, but necessary for Terraform integration */ + /** + * The full name of the securable. Redundant with the name in the securable object, but necessary for Terraform integration + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ fullName?: string | undefined; } @@ -198,8 +214,11 @@ export interface UpdateAccessRequestDestinationsRequest { /** * The access request destinations to assign to the securable. * For each destination, a **destination_id** and **destination_type** must be defined. + * + * Required. This field must be set in requests. */ accessRequestDestinations?: AccessRequestDestinations | undefined; + /** Required. This field must be set in requests. */ updateMask?: FieldMask | undefined; } diff --git a/packages/uc/schemas/src/v1/model.ts b/packages/uc/schemas/src/v1/model.ts index 78c78c9c..7e778106 100755 --- a/packages/uc/schemas/src/v1/model.ts +++ b/packages/uc/schemas/src/v1/model.ts @@ -17,9 +17,17 @@ export type CatalogType = | (string & {}); export interface CreateSchemaRequest { - /** Name of schema, relative to parent catalog. */ + /** + * Name of schema, relative to parent catalog. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Name of parent catalog. */ + /** + * Name of parent catalog. + * + * Required. This field must be set in requests. + */ catalogName?: string | undefined; /** Username of current owner of schema. */ owner?: string | undefined; @@ -54,14 +62,22 @@ export interface CreateSchemaRequest { browseOnly?: boolean | undefined; /** Custom maximum retention period in hours for the schema. */ customMaxRetentionHours?: bigint | undefined; - /** A map of key-value properties attached to the securable. */ + /** + * A map of key-value properties attached to the securable. + * + * Required. This field must be set in requests. + */ properties?: Record | undefined; /** A map of key-value properties attached to the securable. */ options?: Record | undefined; } export interface DeleteSchemaRequest { - /** Full name of the schema. */ + /** + * Full name of the schema. + * + * Required. This field must be set in requests. + */ fullNameArg?: string | undefined; /** Force deletion even if the schema is not empty. */ force?: boolean | undefined; @@ -71,7 +87,11 @@ export interface DeleteSchemaRequest { export interface DeleteSchemaResponse {} export interface EffectivePredictiveOptimizationFlag { - /** Whether predictive optimization should be enabled for this object and objects under it. */ + /** + * Whether predictive optimization should be enabled for this object and objects under it. + * + * Required. This field must be set in requests. + */ value?: string | undefined; /** The type of the object from which the flag was inherited. If there was no inheritance, this field is left blank. */ inheritedFromType?: string | undefined; @@ -80,14 +100,22 @@ export interface EffectivePredictiveOptimizationFlag { } export interface GetSchemaRequest { - /** Full name of the schema. */ + /** + * Full name of the schema. + * + * Required. This field must be set in requests. + */ fullNameArg?: string | undefined; /** Whether to include schemas in the response for which the principal can only access selective metadata for */ includeBrowse?: boolean | undefined; } export interface ListSchemasRequest { - /** Parent catalog for schemas of interest. */ + /** + * Parent catalog for schemas of interest. + * + * Required. This field must be set in requests. + */ catalogName?: string | undefined; /** * Maximum number of schemas to return. @@ -114,9 +142,17 @@ export interface ListSchemasResponse { } export interface SchemaInfo { - /** Name of schema, relative to parent catalog. */ + /** + * Name of schema, relative to parent catalog. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Name of parent catalog. */ + /** + * Name of parent catalog. + * + * Required. This field must be set in requests. + */ catalogName?: string | undefined; /** Username of current owner of schema. */ owner?: string | undefined; @@ -151,20 +187,36 @@ export interface SchemaInfo { browseOnly?: boolean | undefined; /** Custom maximum retention period in hours for the schema. */ customMaxRetentionHours?: bigint | undefined; - /** A map of key-value properties attached to the securable. */ + /** + * A map of key-value properties attached to the securable. + * + * Required. This field must be set in requests. + */ properties?: Record | undefined; /** A map of key-value properties attached to the securable. */ options?: Record | undefined; } export interface UpdateSchemaRequest { - /** Full name of the schema. */ + /** + * Full name of the schema. + * + * Required. This field must be set in requests. + */ fullNameArg?: string | undefined; /** New name for the schema. */ newName?: string | undefined; - /** Name of schema, relative to parent catalog. */ + /** + * Name of schema, relative to parent catalog. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Name of parent catalog. */ + /** + * Name of parent catalog. + * + * Required. This field must be set in requests. + */ catalogName?: string | undefined; /** Username of current owner of schema. */ owner?: string | undefined; @@ -199,7 +251,11 @@ export interface UpdateSchemaRequest { browseOnly?: boolean | undefined; /** Custom maximum retention period in hours for the schema. */ customMaxRetentionHours?: bigint | undefined; - /** A map of key-value properties attached to the securable. */ + /** + * A map of key-value properties attached to the securable. + * + * Required. This field must be set in requests. + */ properties?: Record | undefined; /** A map of key-value properties attached to the securable. */ options?: Record | undefined; diff --git a/packages/uc/secrets/src/v1/model.ts b/packages/uc/secrets/src/v1/model.ts index 993f865e..0bdd5ea8 100644 --- a/packages/uc/secrets/src/v1/model.ts +++ b/packages/uc/secrets/src/v1/model.ts @@ -10,6 +10,8 @@ export interface CreateSecretRequest { /** * The secret object to create. The **name**, **catalog_name**, **schema_name**, and **value** * fields are required. + * + * Required. This field must be set in requests. */ secret?: Secret | undefined; } @@ -19,6 +21,8 @@ export interface DeleteSecretRequest { /** * The three-level (fully qualified) name of the secret * (for example, **catalog_name.schema_name.secret_name**). + * + * Required. This field must be set in requests. */ fullName?: string | undefined; } @@ -28,6 +32,8 @@ export interface GetSecretRequest { /** * The three-level (fully qualified) name of the secret * (for example, **catalog_name.schema_name.secret_name**). + * + * Required. This field must be set in requests. */ fullName?: string | undefined; /** @@ -72,11 +78,17 @@ export interface ListSecretsRequest { /** Response message for ListSecrets. */ export interface ListSecretsResponse { - /** An array of secret objects. */ + /** + * An array of secret objects. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ secrets?: Secret[] | undefined; /** * Opaque token to retrieve the next page of results. Absent if there are no more pages. * **page_token** should be set to this value for the next request. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ nextPageToken?: string | undefined; } @@ -87,51 +99,97 @@ export interface ListSecretsResponse { * passwords, tokens, and keys. */ export interface Secret { - /** The name of the secret, relative to its parent schema. */ + /** + * The name of the secret, relative to its parent schema. + * + * Required. This field must be set in requests. Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ name?: string | undefined; /** * The owner of the secret. Defaults to the creating principal on creation. Can be updated to * transfer ownership of the secret to another principal. + * + * Input only. Provide this field in requests; it is never returned in responses. */ owner?: string | undefined; /** * The effective owner of the secret, which may differ from the directly-set **owner** due to * inheritance. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ effectiveOwner?: string | undefined; - /** Unique identifier of the metastore hosting the secret. */ + /** + * Unique identifier of the metastore hosting the secret. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ metastoreId?: string | undefined; - /** The time at which this secret was created. */ + /** + * The time at which this secret was created. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createTime?: Temporal.Instant | undefined; - /** The principal that created the secret. */ + /** + * The principal that created the secret. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ createdBy?: string | undefined; - /** The time at which this secret was last updated. */ + /** + * The time at which this secret was last updated. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updateTime?: Temporal.Instant | undefined; - /** The principal that last updated the secret. */ + /** + * The principal that last updated the secret. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updatedBy?: string | undefined; /** User-provided free-form text description of the secret. */ comment?: string | undefined; - /** The three-level (fully qualified) name of the secret, in the form of **catalog_name.schema_name.secret_name**. */ + /** + * The three-level (fully qualified) name of the secret, in the form of **catalog_name.schema_name.secret_name**. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ fullName?: string | undefined; - /** The name of the catalog where the schema and the secret reside. */ + /** + * The name of the catalog where the schema and the secret reside. + * + * Required. This field must be set in requests. Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ catalogName?: string | undefined; - /** The name of the schema where the secret resides. */ + /** + * The name of the schema where the secret resides. + * + * Required. This field must be set in requests. Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ schemaName?: string | undefined; /** * The secret value to store. This field is input-only and is not returned in responses — use * the **effective_value** field (via GetSecret with **include_value** set to true) to read the * secret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes * passwords, tokens, keys, and other sensitive credential data. + * + * Required. This field must be set in requests. Input only. Provide this field in requests; it is never returned in responses. */ value?: string | undefined; /** * The secret value. Only populated in responses when you have the **READ_SECRET** * privilege and **include_value** is set to true in the request. The maximum size is 60 KiB. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ effectiveValue?: string | undefined; /** * Indicates whether the principal is limited to retrieving metadata for the associated object * through the **BROWSE** privilege when **include_browse** is enabled in the request. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. */ browseOnly?: boolean | undefined; /** @@ -140,6 +198,7 @@ export interface Secret { * does not trigger any automatic actions or affect the secret's lifecycle. */ expireTime?: Temporal.Instant | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ externalSecretId?: string | undefined; } @@ -148,16 +207,22 @@ export interface UpdateSecretRequest { /** * The three-level (fully qualified) name of the secret * (for example, **catalog_name.schema_name.secret_name**). + * + * Required. This field must be set in requests. */ fullName?: string | undefined; /** * The secret object containing the fields to update. Only fields specified in **update_mask** * will be updated. + * + * Required. This field must be set in requests. */ secret?: Secret | undefined; /** * The field mask specifying which fields of the secret to update. Supported fields: **value**, * **comment**, **owner**, **expire_time**. + * + * Required. This field must be set in requests. */ updateMask?: FieldMask | undefined; } diff --git a/packages/uc/systemschemas/src/v1/model.ts b/packages/uc/systemschemas/src/v1/model.ts index 14abcd15..3da8c39a 100755 --- a/packages/uc/systemschemas/src/v1/model.ts +++ b/packages/uc/systemschemas/src/v1/model.ts @@ -3,9 +3,17 @@ import {z} from 'zod'; export interface DisableSystemSchemaRequest { - /** Full name of the system schema. */ + /** + * Full name of the system schema. + * + * Required. This field must be set in requests. + */ schema?: string | undefined; - /** The metastore ID under which the system schema lives. */ + /** + * The metastore ID under which the system schema lives. + * + * Required. This field must be set in requests. + */ metastoreId?: string | undefined; } @@ -13,9 +21,17 @@ export interface DisableSystemSchemaRequest { export interface DisableSystemSchemaResponse {} export interface EnableSystemSchemaRequest { - /** Full name of the system schema. */ + /** + * Full name of the system schema. + * + * Required. This field must be set in requests. + */ schema?: string | undefined; - /** The metastore ID under which the system schema lives. */ + /** + * The metastore ID under which the system schema lives. + * + * Required. This field must be set in requests. + */ metastoreId?: string | undefined; /** the catalog for which the system schema is to enabled in */ catalogName?: string | undefined; @@ -25,7 +41,11 @@ export interface EnableSystemSchemaRequest { export interface EnableSystemSchemaResponse {} export interface ListSystemSchemasRequest { - /** The ID for the metastore in which the system schema resides. */ + /** + * The ID for the metastore in which the system schema resides. + * + * Required. This field must be set in requests. + */ metastoreId?: string | undefined; /** * Maximum number of schemas to return. diff --git a/packages/uc/tables/src/v1/model.ts b/packages/uc/tables/src/v1/model.ts index 779cd79b..dbdcd33d 100755 --- a/packages/uc/tables/src/v1/model.ts +++ b/packages/uc/tables/src/v1/model.ts @@ -326,8 +326,13 @@ export interface ConnectionDependency { } export interface CreateTableConstraintRequest { - /** The full name of the table referenced by the constraint. */ + /** + * The full name of the table referenced by the constraint. + * + * Required. This field must be set in requests. + */ fullNameArg?: string | undefined; + /** Required. This field must be set in requests. */ constraint?: TableConstraint | undefined; } @@ -398,7 +403,11 @@ export interface CreateTableRequest { securableKindManifest?: SecurableKindManifest | undefined; /** The array of __ColumnInfo__ definitions of the table's columns. */ columns?: ColumnInfo[] | undefined; - /** A map of key-value properties attached to the securable. */ + /** + * A map of key-value properties attached to the securable. + * + * Required. This field must be set in requests. + */ properties?: Record | undefined; } @@ -409,13 +418,23 @@ export interface CredentialDependency { } export interface DeleteTableConstraintRequest { - /** Full name of the table referenced by the constraint. */ + /** + * Full name of the table referenced by the constraint. + * + * Required. This field must be set in requests. + */ fullNameArg?: string | undefined; - /** The name of the constraint to delete. */ + /** + * The name of the constraint to delete. + * + * Required. This field must be set in requests. + */ constraintName?: string | undefined; /** * If true, try deleting all child constraints of the current constraint. * If false, reject this operation if the current constraint has any child constraints. + * + * Required. This field must be set in requests. */ cascade?: boolean | undefined; } @@ -424,7 +443,11 @@ export interface DeleteTableConstraintRequest { export interface DeleteTableConstraintResponse {} export interface DeleteTableRequest { - /** Full name of the table. */ + /** + * Full name of the table. + * + * Required. This field must be set in requests. + */ fullNameArg?: string | undefined; } @@ -436,7 +459,11 @@ export interface DeleteTableResponse {} * This does not contain **delta.*** (input) properties in __TableInfo.properties__. */ export interface DeltaRuntimePropertiesKvPairs { - /** A map of key-value properties attached to the securable. */ + /** + * A map of key-value properties attached to the securable. + * + * Required. This field must be set in requests. + */ deltaRuntimeProperties?: Record | undefined; } @@ -460,7 +487,11 @@ export interface DependencyList { } export interface EffectivePredictiveOptimizationFlag { - /** Whether predictive optimization should be enabled for this object and objects under it. */ + /** + * Whether predictive optimization should be enabled for this object and objects under it. + * + * Required. This field must be set in requests. + */ value?: string | undefined; /** The type of the object from which the flag was inherited. If there was no inheritance, this field is left blank. */ inheritedFromType?: string | undefined; @@ -480,13 +511,29 @@ export interface EncryptionDetails { } export interface ForeignKeyConstraint { - /** The name of the constraint. */ + /** + * The name of the constraint. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Column names for this constraint. */ + /** + * Column names for this constraint. + * + * Required. This field must be set in requests. + */ childColumns?: string[] | undefined; - /** The full name of the parent constraint. */ + /** + * The full name of the parent constraint. + * + * Required. This field must be set in requests. + */ parentTable?: string | undefined; - /** Column names for this constraint. */ + /** + * Column names for this constraint. + * + * Required. This field must be set in requests. + */ parentColumns?: string[] | undefined; /** True if the constraint is RELY, false or unset if NORELY. */ rely?: boolean | undefined; @@ -494,12 +541,20 @@ export interface ForeignKeyConstraint { /** A function that is dependent on a SQL object. */ export interface FunctionDependency { - /** Full name of the dependent function, in the form of __catalog_name__.__schema_name__.__function_name__. */ + /** + * Full name of the dependent function, in the form of __catalog_name__.__schema_name__.__function_name__. + * + * Required. This field must be set in requests. + */ functionFullName?: string | undefined; } export interface GetTableRequest { - /** Full name of the table. */ + /** + * Full name of the table. + * + * Required. This field must be set in requests. + */ fullNameArg?: string | undefined; /** Whether delta metadata should be included in the response. */ includeDeltaMetadata?: boolean | undefined; @@ -510,7 +565,11 @@ export interface GetTableRequest { } export interface ListTableSummariesRequest { - /** Name of parent catalog for tables of interest. */ + /** + * Name of parent catalog for tables of interest. + * + * Required. This field must be set in requests. + */ catalogName?: string | undefined; /** * A sql LIKE pattern (% and _) for schema names. @@ -547,9 +606,17 @@ export interface ListTableSummariesResponse { } export interface ListTablesRequest { - /** Name of parent catalog for tables of interest. */ + /** + * Name of parent catalog for tables of interest. + * + * Required. This field must be set in requests. + */ catalogName?: string | undefined; - /** Parent schema of tables. */ + /** + * Parent schema of tables. + * + * Required. This field must be set in requests. + */ schemaName?: string | undefined; /** * Maximum number of tables to return. @@ -584,7 +651,11 @@ export interface ListTablesResponse { } export interface NamedTableConstraint { - /** The name of the constraint. */ + /** + * The name of the constraint. + * + * Required. This field must be set in requests. + */ name?: string | undefined; } @@ -651,9 +722,17 @@ export interface PolicyFunctionArgument { } export interface PrimaryKeyConstraint { - /** The name of the constraint. */ + /** + * The name of the constraint. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Column names for this constraint. */ + /** + * Column names for this constraint. + * + * Required. This field must be set in requests. + */ childColumns?: string[] | undefined; /** Column names that represent a timeseries. */ timeseriesColumns?: string[] | undefined; @@ -662,11 +741,17 @@ export interface PrimaryKeyConstraint { } export interface RowFilter { - /** The full name of the row filter SQL UDF. */ + /** + * The full name of the row filter SQL UDF. + * + * Required. This field must be set in requests. + */ functionName?: string | undefined; /** * The list of table columns to be passed as input to the row filter function. The column types * should match the types of the filter function arguments. + * + * Required. This field must be set in requests. */ inputColumnNames?: string[] | undefined; /** @@ -725,12 +810,20 @@ export interface TableConstraint { /** A table that is dependent on a SQL object. */ export interface TableDependency { - /** Full name of the dependent table, in the form of __catalog_name__.__schema_name__.__table_name__. */ + /** + * Full name of the dependent table, in the form of __catalog_name__.__schema_name__.__table_name__. + * + * Required. This field must be set in requests. + */ tableFullName?: string | undefined; } export interface TableExistsRequest { - /** Full name of the table. */ + /** + * Full name of the table. + * + * Required. This field must be set in requests. + */ fullNameArg?: string | undefined; } @@ -806,7 +899,11 @@ export interface TableInfo { securableKindManifest?: SecurableKindManifest | undefined; /** The array of __ColumnInfo__ definitions of the table's columns. */ columns?: ColumnInfo[] | undefined; - /** A map of key-value properties attached to the securable. */ + /** + * A map of key-value properties attached to the securable. + * + * Required. This field must be set in requests. + */ properties?: Record | undefined; } @@ -819,7 +916,11 @@ export interface TableSummary { } export interface UpdateTableRequest { - /** Full name of the table. */ + /** + * Full name of the table. + * + * Required. This field must be set in requests. + */ fullNameArg?: string | undefined; /** Name of table, relative to parent schema. */ name?: string | undefined; @@ -887,7 +988,11 @@ export interface UpdateTableRequest { securableKindManifest?: SecurableKindManifest | undefined; /** The array of __ColumnInfo__ definitions of the table's columns. */ columns?: ColumnInfo[] | undefined; - /** A map of key-value properties attached to the securable. */ + /** + * A map of key-value properties attached to the securable. + * + * Required. This field must be set in requests. + */ properties?: Record | undefined; } diff --git a/packages/uc/volumes/src/v1/model.ts b/packages/uc/volumes/src/v1/model.ts index 85887aee..c5d0c3ce 100755 --- a/packages/uc/volumes/src/v1/model.ts +++ b/packages/uc/volumes/src/v1/model.ts @@ -40,27 +40,58 @@ export interface CreateVolumeRequest { owner?: string | undefined; /** The comment attached to the volume */ comment?: string | undefined; - /** The three-level (fully qualified) name of the volume */ + /** + * The three-level (fully qualified) name of the volume + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ fullName?: string | undefined; - /** The unique identifier of the volume */ + /** + * The unique identifier of the volume + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ volumeId?: string | undefined; - /** The unique identifier of the metastore */ + /** + * The unique identifier of the metastore + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ metastoreId?: string | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ createdAt?: bigint | undefined; /** The identifier of the user who created the volume */ createdBy?: string | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ updatedAt?: bigint | undefined; - /** The identifier of the user who updated the volume last time */ + /** + * The identifier of the user who updated the volume last time + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updatedBy?: string | undefined; - /** The AWS access point to use when accesing s3 for this external location. */ + /** + * The AWS access point to use when accesing s3 for this external location. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ accessPoint?: string | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ encryptionDetails?: EncryptionDetails | undefined; - /** Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request. */ + /** + * Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ browseOnly?: boolean | undefined; } export interface DeleteVolumeRequest { - /** The three-level (fully qualified) name of the volume */ + /** + * The three-level (fully qualified) name of the volume + * + * Required. This field must be set in requests. + */ fullNameArg?: string | undefined; } @@ -79,16 +110,28 @@ export interface EncryptionDetails { } export interface GetVolumeRequest { - /** The three-level (fully qualified) name of the volume */ + /** + * The three-level (fully qualified) name of the volume + * + * Required. This field must be set in requests. + */ fullNameArg?: string | undefined; /** Whether to include volumes in the response for which the principal can only access selective metadata for */ includeBrowse?: boolean | undefined; } export interface ListVolumesRequest { - /** The identifier of the catalog */ + /** + * The identifier of the catalog + * + * Required. This field must be set in requests. + */ catalogName?: string | undefined; - /** The identifier of the schema */ + /** + * The identifier of the schema + * + * Required. This field must be set in requests. + */ schemaName?: string | undefined; /** Whether to include volumes in the response for which the principal can only access selective metadata for */ includeBrowse?: boolean | undefined; @@ -129,7 +172,11 @@ export interface SseEncryptionDetails { } export interface UpdateVolumeRequest { - /** The three-level (fully qualified) name of the volume */ + /** + * The three-level (fully qualified) name of the volume + * + * Required. This field must be set in requests. + */ fullNameArg?: string | undefined; /** New name for the volume. */ newName?: string | undefined; @@ -151,22 +198,49 @@ export interface UpdateVolumeRequest { owner?: string | undefined; /** The comment attached to the volume */ comment?: string | undefined; - /** The three-level (fully qualified) name of the volume */ + /** + * The three-level (fully qualified) name of the volume + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ fullName?: string | undefined; - /** The unique identifier of the volume */ + /** + * The unique identifier of the volume + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ volumeId?: string | undefined; - /** The unique identifier of the metastore */ + /** + * The unique identifier of the metastore + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ metastoreId?: string | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ createdAt?: bigint | undefined; /** The identifier of the user who created the volume */ createdBy?: string | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ updatedAt?: bigint | undefined; - /** The identifier of the user who updated the volume last time */ + /** + * The identifier of the user who updated the volume last time + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updatedBy?: string | undefined; - /** The AWS access point to use when accesing s3 for this external location. */ + /** + * The AWS access point to use when accesing s3 for this external location. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ accessPoint?: string | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ encryptionDetails?: EncryptionDetails | undefined; - /** Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request. */ + /** + * Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ browseOnly?: boolean | undefined; } @@ -189,22 +263,49 @@ export interface VolumeInfo { owner?: string | undefined; /** The comment attached to the volume */ comment?: string | undefined; - /** The three-level (fully qualified) name of the volume */ + /** + * The three-level (fully qualified) name of the volume + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ fullName?: string | undefined; - /** The unique identifier of the volume */ + /** + * The unique identifier of the volume + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ volumeId?: string | undefined; - /** The unique identifier of the metastore */ + /** + * The unique identifier of the metastore + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ metastoreId?: string | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ createdAt?: bigint | undefined; /** The identifier of the user who created the volume */ createdBy?: string | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ updatedAt?: bigint | undefined; - /** The identifier of the user who updated the volume last time */ + /** + * The identifier of the user who updated the volume last time + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ updatedBy?: string | undefined; - /** The AWS access point to use when accesing s3 for this external location. */ + /** + * The AWS access point to use when accesing s3 for this external location. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ accessPoint?: string | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ encryptionDetails?: EncryptionDetails | undefined; - /** Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request. */ + /** + * Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ browseOnly?: boolean | undefined; } diff --git a/packages/uc/workspacebindings/src/v1/model.ts b/packages/uc/workspacebindings/src/v1/model.ts index b1f16183..7ef2757f 100755 --- a/packages/uc/workspacebindings/src/v1/model.ts +++ b/packages/uc/workspacebindings/src/v1/model.ts @@ -14,7 +14,11 @@ export type BindingType = | (string & {}); export interface GetCatalogWorkspaceBindingsRequest { - /** The name of the catalog. */ + /** + * The name of the catalog. + * + * Required. This field must be set in requests. + */ catalogName?: string | undefined; } @@ -24,9 +28,17 @@ export interface GetCatalogWorkspaceBindingsResponse { } export interface GetWorkspaceBindingsRequest { - /** The type of the securable to bind to a workspace (catalog, storage_credential, credential, or external_location). */ + /** + * The type of the securable to bind to a workspace (catalog, storage_credential, credential, or external_location). + * + * Required. This field must be set in requests. + */ securableType?: string | undefined; - /** The name of the securable. */ + /** + * The name of the securable. + * + * Required. This field must be set in requests. + */ securableFullName?: string | undefined; /** * Maximum number of workspace bindings to return. @@ -51,7 +63,11 @@ export interface GetWorkspaceBindingsResponse { } export interface UpdateCatalogWorkspaceBindingsRequest { - /** The name of the catalog. */ + /** + * The name of the catalog. + * + * Required. This field must be set in requests. + */ catalogName?: string | undefined; /** A list of workspace IDs. */ assignWorkspaces?: bigint[] | undefined; @@ -65,9 +81,17 @@ export interface UpdateCatalogWorkspaceBindingsResponse { } export interface UpdateWorkspaceBindingsRequest { - /** The type of the securable to bind to a workspace (catalog, storage_credential, credential, or external_location). */ + /** + * The type of the securable to bind to a workspace (catalog, storage_credential, credential, or external_location). + * + * Required. This field must be set in requests. + */ securableType?: string | undefined; - /** The name of the securable. */ + /** + * The name of the securable. + * + * Required. This field must be set in requests. + */ securableFullName?: string | undefined; /** * List of workspace bindings to add. If a binding for the workspace already exists with a @@ -86,7 +110,11 @@ export interface UpdateWorkspaceBindingsResponse { } export interface WorkspaceBindingInfo { - /** Required */ + /** + * Required + * + * Required. This field must be set in requests. + */ workspaceId?: bigint | undefined; /** One of READ_WRITE/READ_ONLY. Default is READ_WRITE. */ bindingType?: BindingType | undefined; diff --git a/packages/vectorsearch/src/v1/model.ts b/packages/vectorsearch/src/v1/model.ts index 24ae016e..8f563da7 100755 --- a/packages/vectorsearch/src/v1/model.ts +++ b/packages/vectorsearch/src/v1/model.ts @@ -123,9 +123,17 @@ export interface ColumnInfo { } export interface CreateEndpointRequest { - /** Name of the AI Search endpoint */ + /** + * Name of the AI Search endpoint + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Type of endpoint */ + /** + * Type of endpoint + * + * Required. This field must be set in requests. + */ endpointType?: EndpointType | undefined; /** The budget policy id to be applied */ budgetPolicyId?: string | undefined; @@ -140,12 +148,25 @@ export interface CreateEndpointRequest { } export interface CreateVectorIndexRequest { - /** Name of the index */ + /** + * Name of the index + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** Name of the endpoint to be used for serving the index */ + /** + * Name of the endpoint to be used for serving the index + * + * Required. This field must be set in requests. + */ endpointName?: string | undefined; - /** Primary key of the index */ + /** + * Primary key of the index + * + * Required. This field must be set in requests. + */ primaryKey?: string | undefined; + /** Required. This field must be set in requests. */ indexType?: VectorIndexType | undefined; indexSpec?: | { @@ -164,7 +185,11 @@ export interface CreateVectorIndexRequest { } export interface CustomTag { - /** Key field for an AI Search endpoint tag. */ + /** + * Key field for an AI Search endpoint tag. + * + * Required. This field must be set in requests. + */ key?: string | undefined; /** [Optional] Value field for an AI Search endpoint tag. */ value?: string | undefined; @@ -172,9 +197,17 @@ export interface CustomTag { /** Request payload for deleting data from a vector index. */ export interface DeleteDataVectorIndexRequest { - /** Name of the vector index where data is to be deleted. Must be a Direct Vector Access Index. */ + /** + * Name of the vector index where data is to be deleted. Must be a Direct Vector Access Index. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** List of primary keys for the data to be deleted. */ + /** + * List of primary keys for the data to be deleted. + * + * Required. This field must be set in requests. + */ primaryKeys?: string[] | undefined; } @@ -186,7 +219,11 @@ export interface DeleteDataVectorIndexResponse { } export interface DeleteEndpointRequest { - /** Name of the AI Search endpoint */ + /** + * Name of the AI Search endpoint + * + * Required. This field must be set in requests. + */ name?: string | undefined; } @@ -194,7 +231,11 @@ export interface DeleteEndpointRequest { export interface DeleteEndpointResponse {} export interface DeleteVectorIndexRequest { - /** Name of the index */ + /** + * Name of the index + * + * Required. This field must be set in requests. + */ name?: string | undefined; } @@ -356,12 +397,20 @@ export interface FacetResultData { } export interface GetEndpointRequest { - /** Name of the endpoint */ + /** + * Name of the endpoint + * + * Required. This field must be set in requests. + */ name?: string | undefined; } export interface GetVectorIndexRequest { - /** Name of the index */ + /** + * Name of the index + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** * If true, the URL returned for the index is guaranteed to be compatible with the reranker. @@ -390,7 +439,11 @@ export interface ListValue { } export interface ListVectorIndexRequest { - /** Name of the endpoint */ + /** + * Name of the endpoint + * + * Required. This field must be set in requests. + */ endpointName?: string | undefined; /** Token for pagination */ pageToken?: string | undefined; @@ -472,9 +525,17 @@ export interface MiniVectorIndex { } export interface PatchEndpointBudgetPolicyRequest { - /** Name of the AI Search endpoint */ + /** + * Name of the AI Search endpoint + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** The budget policy id to be applied */ + /** + * The budget policy id to be applied + * + * Required. This field must be set in requests. + */ budgetPolicyId?: string | undefined; } @@ -485,7 +546,11 @@ export interface PatchEndpointBudgetPolicyResponse { } export interface PatchEndpointRequest { - /** Name of the AI Search endpoint */ + /** + * Name of the AI Search endpoint + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** * Target QPS for the endpoint. Best-effort; the system does not guarantee this QPS @@ -496,7 +561,11 @@ export interface PatchEndpointRequest { /** Request payload for getting next page of results. */ export interface QueryVectorIndexNextPageRequest { - /** Name of the vector index to query. */ + /** + * Name of the vector index to query. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** Name of the endpoint. */ endpointName?: string | undefined; @@ -505,11 +574,19 @@ export interface QueryVectorIndexNextPageRequest { } export interface QueryVectorIndexRequest { - /** Name of the vector index to query. */ + /** + * Name of the vector index to query. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** Number of results to return. Defaults to 10. */ numResults?: number | undefined; - /** List of column names to include in the response. */ + /** + * List of column names to include in the response. + * + * Required. This field must be set in requests. + */ columns?: string[] | undefined; /** * JSON string representing query filters. @@ -610,7 +687,11 @@ export interface ResultManifest { /** Request to retrieve user-visible metrics */ export interface RetrieveUserVisibleMetricsRequest { - /** AI Search endpoint name */ + /** + * AI Search endpoint name + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** Start time for metrics query */ startTime?: Temporal.Instant | undefined; @@ -633,7 +714,11 @@ export interface RetrieveUserVisibleMetricsResponse { } export interface ScanVectorIndexRequest { - /** Name of the vector index to scan. */ + /** + * Name of the vector index to scan. + * + * Required. This field must be set in requests. + */ name?: string | undefined; /** Number of results to return. Defaults to 10. */ numResults?: number | undefined; @@ -655,7 +740,11 @@ export interface Struct { } export interface SyncVectorIndexRequest { - /** Name of the vector index to synchronize. Must be a Delta Sync Index. */ + /** + * Name of the vector index to synchronize. Must be a Delta Sync Index. + * + * Required. This field must be set in requests. + */ name?: string | undefined; } @@ -663,9 +752,17 @@ export interface SyncVectorIndexRequest { export interface SyncVectorIndexResponse {} export interface UpdateEndpointCustomTagsRequest { - /** Name of the AI Search endpoint */ + /** + * Name of the AI Search endpoint + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** The new custom tags for the AI Search endpoint */ + /** + * The new custom tags for the AI Search endpoint + * + * Required. This field must be set in requests. + */ customTags?: CustomTag[] | undefined; } @@ -677,9 +774,17 @@ export interface UpdateEndpointCustomTagsResponse { } export interface UpsertDataVectorIndexRequest { - /** Name of the vector index where data is to be upserted. Must be a Direct Vector Access Index. */ + /** + * Name of the vector index where data is to be upserted. Must be a Direct Vector Access Index. + * + * Required. This field must be set in requests. + */ name?: string | undefined; - /** JSON string representing the data to be upserted. */ + /** + * JSON string representing the data to be upserted. + * + * Required. This field must be set in requests. + */ inputsJson?: string | undefined; } diff --git a/packages/warehouses/src/v1/model.ts b/packages/warehouses/src/v1/model.ts index 2567c2a0..0d954472 100755 --- a/packages/warehouses/src/v1/model.ts +++ b/packages/warehouses/src/v1/model.ts @@ -771,9 +771,15 @@ export interface CreateDefaultWarehouseOverrideRequest { * Required. The ID to use for the override, which will become the final component * of the override's resource name. * Can be a numeric user ID or the literal string "me" for the current user. + * + * Required. This field must be set in requests. */ defaultWarehouseOverrideId?: string | undefined; - /** Required. The default warehouse override to create. */ + /** + * Required. The default warehouse override to create. + * + * Required. This field must be set in requests. + */ defaultWarehouseOverride?: DefaultWarehouseOverride | undefined; } @@ -894,9 +900,17 @@ export interface DefaultWarehouseOverride { * Format: default-warehouse-overrides/{default_warehouse_override_id} */ name?: string | undefined; - /** The ID component of the resource name (user ID). */ + /** + * The ID component of the resource name (user ID). + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ defaultWarehouseOverrideId?: string | undefined; - /** The type of override behavior. */ + /** + * The type of override behavior. + * + * Required. This field must be set in requests. + */ type?: DefaultWarehouseOverrideType | undefined; /** * The specific warehouse ID when type is CUSTOM. @@ -911,6 +925,8 @@ export interface DeleteDefaultWarehouseOverrideRequest { * Required. The resource name of the default warehouse override to delete. * Format: default-warehouse-overrides/{default_warehouse_override_id} * The default_warehouse_override_id can be a numeric user ID or the literal string "me" for the current user. + * + * Required. This field must be set in requests. */ name?: string | undefined; } @@ -924,7 +940,11 @@ export interface DeleteWarehouseResponse {} * warehouse is retained. Thus, this API is not idempotent. */ export interface EditWarehouseRequest { - /** Required. Id of the warehouse to configure. */ + /** + * Required. Id of the warehouse to configure. + * + * Required. This field must be set in requests. + */ id?: string | undefined; /** * Logical name for the cluster. @@ -1030,7 +1050,11 @@ export interface EndpointConfPair { } export interface EndpointHealth { - /** Health status of the endpoint. */ + /** + * Health status of the endpoint. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ status?: EndpointHealth_Status | undefined; /** Deprecated. split into summary and details for security */ message?: string | undefined; @@ -1043,7 +1067,11 @@ export interface EndpointHealth { } export interface EndpointInfo { - /** unique identifier for warehouse */ + /** + * unique identifier for warehouse + * + * Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ id?: string | undefined; /** * Logical name for the cluster. @@ -1148,7 +1176,11 @@ export interface EndpointInfo { jdbcUrl?: string | undefined; /** ODBC parameters for the SQL warehouse */ odbcParams?: OdbcParams | undefined; - /** Optional health status. Assume the warehouse is healthy if this field is not set. */ + /** + * Optional health status. Assume the warehouse is healthy if this field is not set. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ health?: EndpointHealth | undefined; } @@ -1167,18 +1199,28 @@ export interface GetDefaultWarehouseOverrideRequest { * Required. The resource name of the default warehouse override to retrieve. * Format: default-warehouse-overrides/{default_warehouse_override_id} * The default_warehouse_override_id can be a numeric user ID or the literal string "me" for the current user. + * + * Required. This field must be set in requests. */ name?: string | undefined; } /** Fetches the warehouse info for a single SQL warehouse. */ export interface GetWarehouseRequest { - /** Required. Id of the SQL warehouse. */ + /** + * Required. Id of the SQL warehouse. + * + * Required. This field must be set in requests. + */ id?: string | undefined; } export interface GetWarehouseResponse { - /** unique identifier for warehouse */ + /** + * unique identifier for warehouse + * + * Immutable. Set this field when the resource is created; it cannot be changed afterward. + */ id?: string | undefined; /** * Logical name for the cluster. @@ -1283,7 +1325,11 @@ export interface GetWarehouseResponse { jdbcUrl?: string | undefined; /** ODBC parameters for the SQL warehouse */ odbcParams?: OdbcParams | undefined; - /** Optional health status. Assume the warehouse is healthy if this field is not set. */ + /** + * Optional health status. Assume the warehouse is healthy if this field is not set. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ health?: EndpointHealth | undefined; } @@ -1458,6 +1504,8 @@ export interface UpdateDefaultWarehouseOverrideRequest { * Required. The default warehouse override to update. * The name field must be set in the format: default-warehouse-overrides/{default_warehouse_override_id} * The default_warehouse_override_id can be a numeric user ID or the literal string "me" for the current user. + * + * Required. This field must be set in requests. */ defaultWarehouseOverride?: DefaultWarehouseOverride | undefined; /** @@ -1465,6 +1513,8 @@ export interface UpdateDefaultWarehouseOverrideRequest { * Only the fields specified in the mask will be updated. * Use "*" to update all fields. * When allow_missing is true, this field is ignored and all fields are applied. + * + * Required. This field must be set in requests. */ updateMask?: FieldMask | undefined; /** @@ -1494,7 +1544,11 @@ export interface WarehouseTypePair { * This API is idempotent. */ export interface DeleteWarehouseRequest { - /** Required. Id of the SQL warehouse. */ + /** + * Required. Id of the SQL warehouse. + * + * Required. This field must be set in requests. + */ id?: string | undefined; } @@ -1527,7 +1581,11 @@ export interface ListWarehousesRequest { * This API is idempotent. */ export interface StartRequest { - /** Required. Id of the SQL warehouse. */ + /** + * Required. Id of the SQL warehouse. + * + * Required. This field must be set in requests. + */ id?: string | undefined; } @@ -1536,7 +1594,11 @@ export interface StartRequest { * This API is idempotent. */ export interface StopRequest { - /** Required. Id of the SQL warehouse. */ + /** + * Required. Id of the SQL warehouse. + * + * Required. This field must be set in requests. + */ id?: string | undefined; } diff --git a/packages/workspaces/src/v1/model.ts b/packages/workspaces/src/v1/model.ts index 5234157f..85321b38 100755 --- a/packages/workspaces/src/v1/model.ts +++ b/packages/workspaces/src/v1/model.ts @@ -139,6 +139,7 @@ export interface CloudResourceContainer { } export interface CreateWorkspaceRequest { + /** Required. This field must be set in requests. */ accountId?: string | undefined; /** The human-readable name of the workspace. */ workspaceName?: string | undefined; @@ -193,7 +194,9 @@ export interface CreateWorkspaceRequest { } export interface DeleteWorkspaceRequest { + /** Required. This field must be set in requests. */ workspaceId?: bigint | undefined; + /** Required. This field must be set in requests. */ accountId?: string | undefined; } @@ -230,7 +233,9 @@ export interface GcpManagedNetworkConfig { } export interface GetWorkspaceRequest { + /** Required. This field must be set in requests. */ workspaceId?: bigint | undefined; + /** Required. This field must be set in requests. */ accountId?: string | undefined; } @@ -246,6 +251,7 @@ export interface GkeConfig { } export interface ListWorkspacesRequest { + /** Required. This field must be set in requests. */ accountId?: string | undefined; } @@ -254,28 +260,49 @@ export interface ListWorkspacesResponse { } export interface UpdateWorkspaceRequest { + /** Required. This field must be set in requests. */ customerFacingWorkspace?: Workspace | undefined; updateMask?: FieldMask | undefined; } export interface Workspace { - /** A unique integer ID for the workspace */ + /** + * A unique integer ID for the workspace + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ workspaceId?: bigint | undefined; /** The human-readable name of the workspace. */ workspaceName?: string | undefined; awsRegion?: string | undefined; - /** Time in epoch milliseconds when the workspace was created. */ + /** + * Time in epoch milliseconds when the workspace was created. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ creationTime?: bigint | undefined; deploymentName?: string | undefined; - /** The status of a workspace */ + /** + * The status of a workspace + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ workspaceStatus?: WorkspaceStatus | undefined; - /** account ID. */ + /** + * account ID. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ accountId?: string | undefined; /** ID of the workspace's credential configuration object. */ credentialsId?: string | undefined; /** ID of the workspace's storage configuration object. */ storageConfigurationId?: string | undefined; - /** Message describing the current workspace status. */ + /** + * Message describing the current workspace status. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ workspaceStatusMessage?: string | undefined; networkConfig?: | { @@ -291,6 +318,7 @@ export interface Workspace { gcpManagedNetworkConfig: GcpManagedNetworkConfig; } | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ pricingTier?: PricingTier | undefined; /** * ID of the workspace's private access settings object. Only used for PrivateLink. You must specify this ID if you are using [AWS PrivateLink](https://aws.amazon.com/privatelink/) for either front-end (user-to-workspace connection), back-end (data plane to control plane connection), or both connection types. @@ -312,6 +340,7 @@ export interface Workspace { * DEPRECATED. Use `network_id` instead. */ network?: WorkspaceNetwork | undefined; + /** Output only. The server sets this field in responses; any value sent in a request is ignored. */ azureWorkspaceInfo?: AzureWorkspaceInfo | undefined; gkeConfig?: GkeConfig | undefined; cloudResourceContainer?: CloudResourceContainer | undefined; @@ -322,9 +351,17 @@ export interface Workspace { customTags?: Record | undefined; /** The object ID of network connectivity config. */ networkConnectivityConfigId?: string | undefined; - /** The storage mode of the workspace. */ + /** + * The storage mode of the workspace. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ storageMode?: StorageMode | undefined; - /** The compute mode of the workspace. */ + /** + * The compute mode of the workspace. + * + * Output only. The server sets this field in responses; any value sent in a request is ignored. + */ computeMode?: ComputeMode | undefined; /** * A client owned field used to indicate the workspace status that the client expects to be in.